Skip to content
GitLab
Commit 2d9aa6fe authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

parent 0f97c74d
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 57 deletions
+18 -57
doc/source/source_rst/software/operations/config.rst
+ 18
− 57
View file @ 2d9aa6fe
...@@ -63,63 +63,24 @@ The configuration is written in a python file structured in a series of dictiona ...@@ -63,63 +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).
.. flat-table:: flat-table example +----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+
:header-rows: 2 | Main Key | Module Key | Value |
:stub-columns: 1 | | |===================================================+=================+======================================================+
:widths: 1 1 2 1 2 | | | Description | Expected Value | Value description |
:class: my-class +==========+================+===================================================+========================================================================+
:name: my-flat-table | ctl | model | Controller of the OhmPi system. | raspberry_pi | Defines a Raspberry Pi as controller. |
+----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+
* - :rspan:`1` Main Key | pwr | model | Type of power unit. | pwr_batt | Defines an external battery as power unit. |
- :rspan:`1` Module key | | | |-----------------+------------------------------------------------------+
- :cspan:`2` Value | | | | pwr_dps5005 | Defines an external DPS 5005 as power unit |
+----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+
* - Description | | voltage | Defines default output voltage in V. | float) e.g. 12. | Sets 12 V as default voltage. |
- Expected Value +----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+
- Value description | | interface_name | interface used for communication with controller. | none | Sets no software communication (e.g. for 'pwr_batt') |
| | | |-----------------+------------------------------------------------------+
* - 'ctl' | | | | modbus | Sets a modubs connection |
- 'model' +----------+----------------+---------------------------------------------------+-----------------+------------------------------------------------------+
- Controller of the OhmPi system.
- 'raspberry_pi' (string)
- Defines a Raspberry Pi as controller.
* - :rspan:`4` 'pwr'
- :rspan:`1` 'model'
- :rspan:`1` Type of power unit.
- 'pwr batt'
- Defines an external battery as power unit.
*
- 'dps_5005'
- Defines an external DPS 5005 as power unit
*
- 'voltage'
- Defines default output voltage in V.
- (float) e.g. 12.
- Sets voltage to 12 V by default.
*
- :rspan:`1` 'interface_name'
- :rspan:`1` interface used for communication with controller.
- 'modbus'
- Sets a modubs connection
*
- 'none'
- Sets no software communication (e.g. for 'pwr_batt')
+------------+--------------+-----------------------------------------------------------------------------------------+
| Main key | Module_key | Value |
| | +============================+==============================+=============================+
| | | Type | Expected value | Description |
+============|==============+============================+==============================+=============================+
| 'ctl' | 'model' | string | 'raspberry_pi' | contains informations related to controller unit, 'raspberry_pi' only implemented so far |
+------------+--------------+----------------------------+------------------------------+-----------------------------+
.. 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