Command Line Interface
======================

In general the interface is distributed into a server side and a client.
The server runs on the compute that is connected to the sensor and the pump.
It executes the commands that are send to it from the client.
To access the command type

.. code-block:: sh
    :caption: look at cli

    measure --help


Server Interface
----------------

To start a server you may use a command similar to this one

.. code-block:: sh
    :caption: start a server

    measure server start --pump-port /dev/ttyS4 --sensor-port /dev/ttyS11 --storage-directory /your/favorite/dir

All three arguments are essential for starting a server. For finding the specific
port on your computer unplug the device and list all ports taken via:

.. code-block:: sh
    :caption: check for ports

    python -m serial.tools.list_ports)

After plugging in the device take a look which port were added using the same
command.

.. click:: glc_sensor_measurements.cli:server
    :prog: server
    :commands: start
    :nested: full


Client Interface
----------------

When interacting with the server you may use the client interface, i.e. you can
monitor the current of the sensor via.

.. code-block:: sh
    :caption: client monitoring example

    measure client monitor --channel 123.456.789.123:50051 --duration 2.5

Monitoring is just one option, all the commands that are provided by the
server are:

.. click:: glc_sensor_measurements.cli:client
    :prog: client
    :nested: full