From 5bc7cafcbdf6ed63bf5df2d93ed8a272475210ea Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Wed, 17 Jan 2024 15:31:48 +0100 Subject: [PATCH] updates doc software --- .../source_rst/software/operations/config.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index dac9410d..98e73953 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -27,15 +27,24 @@ Configuration file structure ---------------------------- The configuration is written in a python file structured in a series of dictionnaries related to: + #. OHMPI_CONFIG: the OhmPi instrument information (id of the instrument and default settings) + #. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power). + #. the logging dictionnaries divided in: -* EXEC_LOGGING_CONFIG -* DATA_LOGGING_CONFIG -*SOH_LOGGING_CONFIG + + * EXEC_LOGGING_CONFIG + + * DATA_LOGGING_CONFIG + + *SOH_LOGGING_CONFIG + #. the MQTT dictionnaries divided in: -* MQTT_LOGGING_CONFIG -* MQTT_CONTROL_CONFIG + + * MQTT_LOGGING_CONFIG + + * MQTT_CONTROL_CONFIG .. toctree:: :maxdepth: 2 -- GitLab