diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index 8b11b93a409049118a3bd3614c405a0dcedf0145..7851402bf8f086431438a21345ca3941626d46d4 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -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). .. table:: HARDWARE_CONFIG -+----------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| Main Key | Module Key | Value | -| | +--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| | | Description | Expected Value | Value description | -+==========+================+==================================================+==================+=================================================================+ -| 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_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. | -| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| | 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` | -| | | +------------------+-----------------------------------------------------------------+ -| | | | 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. | | -| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| | 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. | -| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| | 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` | -| | | +------------------+-----------------------------------------------------------------+ -| | | | 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 | -| +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| | 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 | -| | | +------------------+-----------------------------------------------------------------+ -| | | | i2c_ext | I2C connector 2 | -+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ -| 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 | -+----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + + +----------+----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Main Key | Module Key | Value | + | | +--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | | | Description | Expected Value | Value description | + +==========+================+==================================================+==================+=================================================================+ + | 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_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. | + | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | | 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` | + | | | +------------------+-----------------------------------------------------------------+ + | | | | 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. | | + | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | | 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. | + | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | | 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` | + | | | +------------------+-----------------------------------------------------------------+ + | | | | 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 | + | +----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | | 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 | + | | | +------------------+-----------------------------------------------------------------+ + | | | | i2c_ext | I2C connector 2 | + +----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ + | 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 | + +----------+----------------+--------------------------------------------------+------------------+-----------------------------------------------------------------+ .. autodata:: configs.config_example.HARDWARE_CONFIG