diff --git a/doc/source/V2_00.rst b/doc/source/V2_00.rst index c910ca05e3db8d2660bda7a913735e6ea6096ddc..30437f0f0fa9ae2f664be51f338ab7e7250be469 100644 --- a/doc/source/V2_00.rst +++ b/doc/source/V2_00.rst @@ -89,36 +89,26 @@ a mobile phone connected to the wifi of the Raspberry Pi, one can see this interface, upload sequence, change parameters, run sequence and download data. To configure the Raspberry Pi to act as an access point and run -the webserver automatically on start, see instructions in 'runOnStart.sh'. +the webserver automatically on start, see instructions on `raspap.com <https://raspap.com/>`_ and in 'runOnStart.sh'. Once configure, the webserver should start by itself on start and once connected to the Pi, the user can go to `10.3.141.1:8080 <http://10.3.141.1:8080>`_ to access the interface. .. figure:: img/http-interface-pseudo-section.png - :width: 400px - :align: center - :height: 350px - :alt: Web Interface - :caption: Web interface with its interactive pseudo-section. - :figclass: align-center + + Web interface with its interactive pseudo-section. + .. figure:: img/http-interface-evolution.png - :width: 400px - :align: center - :height: 350px - :alt: Evolution of apparent resistivity with time - :caption: Evolution of quadrupole apparent resistivity with time. - :figclass: align-center + + Evolution of quadrupole apparent resistivity with time. + .. figure:: img/http-interface-rs.png - :width: 400px - :align: center - :height: 350px - :alt: Contact resistance check - :caption: Contact resistance check. - :figclass: align-center - + + Contact resistance check. + **Python interface** @@ -189,7 +179,51 @@ files (.json and .py). ***MQTT interface*** -Interface to communicate with the Pi designed for the Internet of Things (IoT). +Interface to communicate with the Pi designed for the Internet of Things (IoT). This interface enable to control a network of OhmPi remotely through an MQTT broker. An example of MQTT broker that can be used is `Mosquitto <https://mosquitto.org/>`_. Commands are received by ohmpi.py script and processed. All commands are sent in JSON format following the Python API with args and kwargs: + +.. code-block:: json + :caption: Updating acquisition settings. + + { + "cmd_id": "3fzxv121UITwGjWYgcz4xw", + "cmd": "update_settings", + "kwargs": { + "config": { + "nb_meas": 2, + "nb_electrodes": 10, + "nb_stack": 2, + "injection_duration": 2, + "sequence_delay": 100 + } + } + } + + +.. code-block:: json + :caption: Check contact resistances + + { + "cmd_id": "3fzxv121UITwGjWYgcz4xw", + "cmd": "rs_check", + } + +.. code-block:: json + :caption: Running same sequence multiple times (nb_meas). + + { + "cmd_id": "3fzxv121UITwGjWYgcz4Yw", + "cmd": "run_multiple_sequences", + } + +.. code-block:: json + :caption: Interrupt current acquisition. + + { + "cmd_id": "3fzxv121UITwGjWYgcz4xw", + "cmd": "update_settings", + } + +