diff --git a/configs/config_example.py b/configs/config_example.py index afaaee88247f02a8e7f01d52aa27b44ce4e8b66e..576bb10d9730081703aa57723a96ab4ad6410f07 100644 --- a/configs/config_example.py +++ b/configs/config_example.py @@ -61,10 +61,15 @@ HARDWARE_CONFIG = { Parameters ---------- 'ctl': dict - contains informationb related to controller unit with the following keys: - * 'model': string, model type of the controller. Currently only 'raspberry_pi" + Describing the controller unit with the following keys: + * 'model': string + model type of the controller. Currently only 'raspberry_pi" 'pwr': dict - 'model': string, model type of the power module. 'pwr_batt', 'pwr_dps5005" + Describing the power module with the following keys: + * 'model': string, + model type of the power module. 'pwr_batt', 'pwr_dps5005" + * 'voltage': float + default voltage of the ''' diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index 02c0a6272c0b4038a11bba7f71744f2a9b31d574..4d06aaf6055a4fc08d78ff4debcfe4aa04f74bda 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -204,4 +204,4 @@ The configuration is written in a python file structured in a series of dictiona :maxdepth: 2 :caption: Contents: -.. autofunction:: HARDWARE_CONFIG +.. autofunction:: congifs.config_example.HARDWARE_CONFIG