Commit 44a87507 authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates config doc

Showing with 9 additions and 4 deletions
+9 -4
...@@ -61,10 +61,15 @@ HARDWARE_CONFIG = { ...@@ -61,10 +61,15 @@ HARDWARE_CONFIG = {
Parameters Parameters
---------- ----------
'ctl': dict 'ctl': dict
contains informationb related to controller unit with the following keys: Describing the controller unit with the following keys:
* 'model': string, model type of the controller. Currently only 'raspberry_pi" * 'model': string
model type of the controller. Currently only 'raspberry_pi"
'pwr': dict '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
''' '''
......
...@@ -204,4 +204,4 @@ The configuration is written in a python file structured in a series of dictiona ...@@ -204,4 +204,4 @@ The configuration is written in a python file structured in a series of dictiona
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
.. autofunction:: HARDWARE_CONFIG .. autofunction:: congifs.config_example.HARDWARE_CONFIG
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