From 79a119d05ad83c7abcb275e1639be51d92a572c9 Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Fri, 19 Jan 2024 13:36:55 +0100 Subject: [PATCH] updates software doc --- .../source_rst/software/operations/config.rst | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index a9f2fbdc..97e76d0e 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -63,24 +63,24 @@ The configuration is written in a python file structured in a series of dictiona #. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power). -+----------+----------------+----------------------------------------------------------------------------------------------------------------------------+ -| Main Key | Module Key | Value | -| | +===================================================+=================+======================================================+ -| | | Description | Expected Value | Value description | -+==========+================+===================================================+========================================================================+ -| ctl | model | Controller of the OhmPi system. | raspberry_pi | Defines a Raspberry Pi as controller. | -+----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ -| pwr | model | Type of power unit. | pwr_batt | Defines an external battery as power unit. | -| | | |-----------------+------------------------------------------------------+ -| | | | pwr_dps5005 | Defines an external DPS 5005 as power unit | -| +----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ -| | voltage | Defines default output voltage in V. | float) e.g. 12. | Sets 12 V as default voltage. | -| +----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ -| | interface_name | interface used for communication | | | -| | | with controller. | none | Sets no software communication (e.g. for 'pwr_batt') | -| | | |-----------------+------------------------------------------------------+ -| | | | modbus | Sets a modubs connection | -+----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ ++----------+----------------+----------------------------------------------------------------------------------------------------------------------+ +| Main Key | Module Key | Value | +| | +=============================================+=================+======================================================+ +| | | Description | Expected Value | Value description | ++==========+================+=============================================+=================+======================================================+ +| ctl | model | Controller of the OhmPi system. | raspberry_pi | Defines a Raspberry Pi as controller. | ++----------+----------------+---------------------------------------------+-----------------+------------------------------------------------------+ +| pwr | model | Type of power unit. | pwr_batt | Defines an external battery as power unit. | +| | | |-----------------+------------------------------------------------------+ +| | | | pwr_dps5005 | Defines an external DPS 5005 as power unit | +| +----------------+---------------------------------------------+-----------------+------------------------------------------------------+ +| | voltage | Defines default output voltage in V. | float) e.g. 12. | Sets 12 V as default voltage. | +| +----------------+---------------------------------------------+-----------------+------------------------------------------------------+ +| | interface_name | Interface used for communication | | | +| | | with controller. | none | Sets no software communication (e.g. for 'pwr_batt') | +| | | |-----------------+------------------------------------------------------+ +| | | | modbus | Sets a modubs connection | ++----------+----------------+---------------------------------------------+-----------------+------------------------------------------------------+ .. autodata:: configs.config_example.HARDWARE_CONFIG -- GitLab