Skip to content
GitLab
Commit 79a119d0 authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

parent 16e18d7b
master 144-create-testing-framework-for-tests-automation v2024_rc v2024.0.35 v2024.0.34 v2024.0.33 v2024.0.32 v2024.0.31 v2024.0.30 v2024.0.29 v2024.0.28 v2024.0.27 v2024.0.26 v2024.0.25 v2024.0.24 v2024.0.23 v2024.0.22 v2024.0.21 v2024.0.20 v2024.0.19 v2024.0.18 v2024.0.17 v2024.0.16 v2024.0.15 v2024.0.14 v2024.0.13 v2024.0.12 v2024.0.11 v2024.0.10 v2024.0.9 v2024.0.8 v2024.0.7 v2024.0.0
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 18 additions and 18 deletions
+18 -18
doc/source/source_rst/software/operations/config.rst
+ 18
− 18
View file @ 79a119d0
...@@ -63,24 +63,24 @@ The configuration is written in a python file structured in a series of dictiona ...@@ -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). #. 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 | | Main Key | Module Key | Value |
| | +===================================================+=================+======================================================+ | | +=============================================+=================+======================================================+
| | | Description | Expected Value | Value description | | | | Description | Expected Value | Value description |
+==========+================+===================================================+========================================================================+ +==========+================+=============================================+=================+======================================================+
| ctl | model | Controller of the OhmPi system. | raspberry_pi | Defines a Raspberry Pi as controller. | | 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 | model | Type of power unit. | pwr_batt | Defines an external battery as power unit. |
| | | |-----------------+------------------------------------------------------+ | | | |-----------------+------------------------------------------------------+
| | | | pwr_dps5005 | Defines an external DPS 5005 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. | | | voltage | Defines default output voltage in V. | float) e.g. 12. | Sets 12 V as default voltage. |
| +----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ | +----------------+---------------------------------------------+-----------------+------------------------------------------------------+
| | interface_name | interface used for communication | | | | | interface_name | Interface used for communication | | |
| | | with controller. | none | Sets no software communication (e.g. for 'pwr_batt') | | | | with controller. | none | Sets no software communication (e.g. for 'pwr_batt') |
| | | |-----------------+------------------------------------------------------+ | | | |-----------------+------------------------------------------------------+
| | | | modbus | Sets a modubs connection | | | | | modbus | Sets a modubs connection |
+----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+ +----------+----------------+---------------------------------------------+-----------------+------------------------------------------------------+
.. autodata:: configs.config_example.HARDWARE_CONFIG .. autodata:: configs.config_example.HARDWARE_CONFIG
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment