Skip to content
GitLab
Commit 06cd435c authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

parent 9afeba60
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 23 additions and 18 deletions
+23 -18
doc/source/source_rst/software/operations/config.rst
+ 23
− 18
View file @ 06cd435c
......@@ -76,14 +76,16 @@ The configuration is written in a python file structured in a series of dictiona
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | 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') |
| | interface_name | | Interface used for communication | none | Sets no software communication (e.g. for 'pwr_batt') |
| | | | with controller. | | |
| | | +------------------+-----------------------------------------------------------------+
| | | | 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.ohmpihardware_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.ohmpihardware_components.mb_2023_0_X` |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | voltage_max | Maximum voltage supported by the TX board [V] | Float, e.g. 50. | |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
......@@ -91,30 +93,33 @@ The configuration is written in a python file structured in a series of dictiona
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | 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 |
|----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| 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.ohmpihardware_components.mb_2024_0_2` |
| +--------------- +--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | | | mb_2023_0_X | Load RX defined in :func:ohmpi.hardware_components.mb_2023_0_X |
| | | | mb_2023_0_X | | Load RX defined in |
| | | | | | :func:`ohmpi.ohmpihardware_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. |
| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| | 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 |
|----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| mux | boards | Dictionary containing all MUX boards of the | | |
| | | system and the associated specific configuration.| mux_id | Dictionary |
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
| mux | boards | | Dictionary containing all MUX boards of the | | |
| | | | 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 |
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
......
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