Quickstart
==========

Installation
------------

.. code-block:: bash

   pip install -e ".[dev]"

Hello, Arduino
--------------

.. code-block:: python

   from cuewire import ArduinoSerial

   with ArduinoSerial("/dev/ttyUSB0") as ard:
       ard.set_write_out(True)
       ard.reset_clock()

The context manager runs the ``50 1337`` comm-test handshake on
entry and closes the port on exit.  If the Arduino does not echo
``50 1337`` within the timeout, a :class:`~cuewire.CommTestError`
is raised.

Hüpfburg rocking-platform rig
-----------------------------

.. code-block:: python

   from cuewire import HuepfburgRig, LedMode, LedPattern

   with HuepfburgRig("/dev/ttyUSB0") as rig:
       rig.set_led_mode(LedMode.DOWN_CYCLE, settle_s=1.0)
       rig.set_led_pattern(LedPattern.STRIPES, settle_s=1.0)
       rig.set_led_period(0.5, settle_s=1.0)
       params = rig.get_exp_parameters()
       print(params)

CLI
---

.. code-block:: bash

   cuewire list-ports
   cuewire test /dev/ttyUSB0
   cuewire run-experiment experiments/configs/rocking.toml