diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index e8f690b197edc9155025f6a7412fd8759b4439a1..3114749fe42a8f757c7556cb26522247924b18a1 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -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.