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

updates software doc

parent c8719874
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 62 additions and 19 deletions
+62 -19
doc/source/source_rst/software/operations/config.rst
+ 62
− 19
View file @ a36bb128
......@@ -125,25 +125,68 @@ The configuration is written in a python file structured in a series of dictiona
+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+
.. _table_mux_config:
.. table:: MUX board config in HARDWARE_CONFIG
+----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Module Key | Value |
| +--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| | Description | Expected Value | Value description |
+================+==================================================+=========================+=================================================================+
| model | Type of Mux board. | mux_2024_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2024_0_X` |
| | +-------------------------+-----------------------------------------------------------------+
| | | mux_2023_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2023_0_X` |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| electrodes | List of electrodes addressed by the MUX board | | *array-like*, | Sets electrode IDs addressed by the MUX board |
| | | | e.g. range(1,65) | |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| roles | roles addressed by the MUX board | | *string, list* | Sets roles addressed by the MUX board |
| | | | of 'A', 'B', 'M', 'N' | |
+----------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
.. table:: MUX board general config in HARDWARE_CONFIG
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Module Key | Value |
| +--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| | Description | Expected Value | Value description |
+====================+==================================================+=========================+=================================================================+
| model | Type of Mux board. | mux_2024_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2024_0_X` |
| | +-------------------------+-----------------------------------------------------------------+
| | | mux_2023_0_X | | Load RX defined in |
| | | | | :func:`ohmpi.hardware_components.mux_2023_0_X` |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| electrodes | List of electrodes addressed by the MUX board | | *array-like*, | Sets electrode IDs addressed by the MUX board |
| | | | e.g. range(1,65) | |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| roles | roles addressed by the MUX board | | *string, list* | | Sets roles addressed by the MUX board. |
| | | | of 'A', 'B', 'M', 'N' | | If *string*, MUX addresses only 1 role (for MUX 2023) |
| | | | | | For MUX 2024: |
| | | | or *dict*, e.g. | | * Number of roles defines if MUX set up in 2 or 4 roles mode.|
| | | | {'A':'X','B':'Y', | | * *list* or *array* order determines physical cabling |
| | | | 'M':'XX','N':'YY'} | | * *dict* values rely on annotation on MUX 2024 board |
| | | | | | 'X', 'Y', 'XX', 'YY' |
| | | | | | |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| voltage_max | Maximum injected voltage managed by the MUX board| *float*, e.g. 50. | Sets maximum voltage to 50 V. |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| current_max | Maximum current [in A] managed by the MUX board | *float*, e.g. 3. | Sets maximum current to 3 A. |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| i2c_ext_tca_address| I2C address of I2C extension | None *(default)* | No I2C extensions cabled. |
| | +-------------------------+-----------------------------------------------------------------+
| | | *hex integer*, e.g. 0x71| Address of I2C extension |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| i2c_ext_tca_channel| Channel of the I2C extension | *int* 0 - 7 | Channel used in case I2C extension configured. |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
.. table:: MUX 2023 board specific config in HARDWARE_CONFIG
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Module Key | Value |
| +--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| | Description | Expected Value | Value description |
+====================+==================================================+=========================+=================================================================+
| mux_tca_address | I2C address of MUX board | | *hex integer* | Address of MUX board |
| | | | 0x70 - 0x77 | |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
.. table:: MUX 2024 board specific config in HARDWARE_CONFIG
+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Module Key | Value |
| +--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| | Description | Expected Value | Value description |
+====================+==================================================+=========================+=================================================================+
| addr1 | Physical position of jumper on addr1 | | *string* 'up' or 'down| | This will compute I2C address of MUX board based on addr1 |
| | | | | and addr 2 configuration. |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
| addr2 | Physical position of jumper on addr1 | | *string* 'up' or 'down| | This will compute I2C address of MUX board based on addr1 |
| | | | | and addr 2 configuration. |
+--------------------+--------------------------------------------------+-------------------------+-----------------------------------------------------------------+
.. code-block:: python
:caption: HARDWARE_CONFIG: Dictionary containing configuration of the hardware system and how it is assembled.
r_shunt = 2. # Value of the shunt resistor in Ohm.
......
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