Skip to content
GitLab
Commit 52fb8bb9 authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

parent 7c7628ae
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 59 additions and 58 deletions
+59 -58
doc/source/source_rst/software/operations/config.rst
+ 59
− 58
View file @ 52fb8bb9
...@@ -63,64 +63,65 @@ The configuration is written in a python file structured in a series of dictiona ...@@ -63,64 +63,65 @@ 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).
.. table:: HARDWARE_CONFIG .. table:: HARDWARE_CONFIG
+----------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| 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 | none | Sets no software communication (e.g. for 'pwr_batt') | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | with controller. | | | | | interface_name | | Interface used for communication | none | Sets no software communication (e.g. for 'pwr_batt') |
| | | +------------------+-----------------------------------------------------------------+ | | | | with controller. | | |
| | | | modbus | Sets a modubs connection | | | | +------------------+-----------------------------------------------------------------+
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | modbus | Sets a modubs connection |
| tx | model | Type of transmitter. | mb_2024_0_2 | | Load TX defined in | +----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` | | tx | model | Type of transmitter. | mb_2024_0_2 | | Load TX defined in |
| | | +------------------+-----------------------------------------------------------------+ | | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` |
| | | | mb_2023_0_X | | Load TX defined in | | | | +------------------+-----------------------------------------------------------------+
| | | | | | :func:`ohmpi.hardware_components.mb_2023_0_X` | | | | | mb_2023_0_X | | Load TX defined in |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | | | :func:`ohmpi.hardware_components.mb_2023_0_X` |
| | voltage_max | Maximum voltage supported by the TX board [V] | Float, e.g. 50. | | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | voltage_max | Maximum voltage supported by the TX board [V] |*float*, e.g. 50. | |
| | current_max | Maximum current supported by TX board [A] | Float, e.g. 0.05 | Is function of r_shunt. Can be calculated as 4.80/(50*r_shunt) | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | current_max | Maximum current supported by TX board [A] |*float*, e.g. 0.05| Is function of r_shunt. Can be calculated as 4.80/(50*r_shunt) |
| | r_shunt | Value (in Ohms) of shunt resistor mounted on TX. | Float, e.g. 2. | 2 Ohms resistor. | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | r_shunt | Value (in Ohms) of shunt resistor mounted on TX. | *float*, e.g. 2. | 2 Ohms resistor. |
| | interface_name | | Name of interface used for communication with | | | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | controller | i2c | I2C connector 1 | | | interface_name | | Name of interface used for communication with | | |
| | | +------------------+-----------------------------------------------------------------+ | | | | controller | i2c | I2C connector 1 |
| | | | i2c_ext | I2C connector 2 | | | | +------------------+-----------------------------------------------------------------+
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | i2c_ext | I2C connector 2 |
| rx | model | Type of transmitter. | mb_2024_0_2 | | Load RX defined in | +----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` | | rx | model | Type of transmitter. | mb_2024_0_2 | | Load RX defined in |
| | | +------------------+-----------------------------------------------------------------+ | | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` |
| | | | mb_2023_0_X | | Load RX defined in | | | | +------------------+-----------------------------------------------------------------+
| | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` | | | | | mb_2023_0_X | | Load RX defined in |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | | | :func:`ohmpi.hardware_components.mb_2024_0_2` |
| | latency | | Latency in seconds in continuous mode | | | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | (related to ADS) | Float, e.g. 0.01 | 10 ms | | | latency | | Latency in seconds in continuous mode | | |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | (related to ADS) |*float*, e.g. 0.01| 10 ms |
| | sampling_rate | Number of samples per second | Int, e.g. 50 | 50 samples per seconds. | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | sampling_rate | Number of samples per second | *int*, e.g. 50 | 50 samples per seconds. |
| | interface_name | | Name of interface used for communication with | | | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | controller | i2c | I2C connector 1 | | | interface_name | | Name of interface used for communication with | | |
| | | +------------------+-----------------------------------------------------------------+ | | | | controller | i2c | I2C connector 1 |
| | | | i2c_ext | I2C connector 2 | | | | +------------------+-----------------------------------------------------------------+
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | i2c_ext | I2C connector 2 |
| mux | boards | | Dictionary containing all MUX boards of the | | | +----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | system and the associated specific | | | | mux | boards | | Dictionary containing all MUX boards of the | | |
| | | | configuration. | mux_id | Dictionary | | | | | system and the associated specific | | |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | configuration. | mux_id | Dictionary |
| | default | | Dictionary containing configuration applicable | | | | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | to all MUX boards of the systems | deffault_dict | Dictionary | | | default | | Dictionary containing configuration applicable | | |
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ | | | | to all MUX boards of the systems | deffault_dict | Dictionary |
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
.. 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