Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-10 13:36:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update Configuration-Parameter-Details.md

Browse Source
This commit is contained in:
Slider0007
2023-01-23 19:56:19 +01:00
committed by GitHub
parent f2f9740bf8
commit 279f2e9468
1 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/Configuration-Parameter-Details.md
View File

@@ -157,13 +157,27 @@ Intervall = 4.85
This paragraph is used to automatically trigger the periodic automated readout. This paragraph is used to automatically trigger the periodic automated readout.
| Parameter | Meaning | Options/Examples | | Parameter | Meaning | Options/Examples |
| --------- | ----------------------------------------------- | ------------------------------------------------------------ | | --------- | ----------------------------------------------- | ------------------------------------------------------------ |
| AutoStart | Automatically trigger the readout after startup | | | AutoStart | Automatically trigger the readout after startup | |
| Intervall | Readout interval in minutes | Values smaller than 2 minutes do not make sense, as this is the time for one detection | | Intervall | Readout interval in minutes | Values smaller than 2 minutes do not make sense, as this is the time for one detection |
### [DataLogging]
```
[DataLogging]
DataLogActive = true
DataLogRetentionInDays = 3
```
This paragraph is used to control the logging of the result data to a spectific folder of SD-Card -> \log\data\...
| Parameter | Meaning | Options/Examples |
| ---------------------- | -------------------------------------------------------- | -------------------------------------------------- |
| DataLogActive | Activate data logging to SD-Card | |
| DataLogRetentionInDays | Number of days, for which the log files should be stored | 0 = keep forever |
### [Debug] ### [Debug]
``` ```
@@ -175,13 +189,12 @@ LogfileRetentionInDays = 2
This paragraph is used to switch on an extended logging. It is optional and by default only a minimum logging is enabled. This paragraph is used to switch on an extended logging. It is optional and by default only a minimum logging is enabled.
**:bangbang: Attention:** in case of extended logging the size of the log file (`/log.txt`, `/alignment.txt`) might increase rapidly, therefore manually deletion from time to time is recommended **:bangbang: Attention:** in case of extended logging the size of the log file (`/log.txt`, `/alignment.txt`) might increase rapidly, therefore manually deletion from time to time is recommended
| Parameter | Meaning | Options/Examples |
| ---------------------- | -------------------------------------------------------- | -------------------------------------------------- |
| Logfile | Turn on (true) or off (false) the extended logging | parameter and section optional |
| LogfileRetentionInDays | Number of days, for which the log files should be stored | 0 = keep forever |
| Parameter | Meaning | Options/Examples |
| ---------------------- | -------------------------------------------------------- | ------------------------------ |
| Logfile | Turn on (true) or off (false) the extended logging | parameter and section optional |
| LogfileRetentionInDays | Number of days, for which the log files should be stored | 0 = keep forever |
### [System] ### [System]
``` ```
@@ -195,16 +208,13 @@ SetupMode = false
This paragraph is used to switch on an extended logging. It is optional and by default only a minimum logging is enabled. This paragraph is used to switch on an extended logging. It is optional and by default only a minimum logging is enabled.
**:bangbang: Attention:** in case of extended logging the size of the log file (`/log.txt`, `/alignment.txt`) might increase rapidly, therefore manually deletion from time to time is recommended **:bangbang: Attention:** in case of extended logging the size of the log file (`/log.txt`, `/alignment.txt`) might increase rapidly, therefore manually deletion from time to time is recommended
| Parameter | Meaning | Options/Examples | | Parameter | Meaning | Options/Examples |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| TimeZone | TimeZone of the system can be specified | Central european, with summertime adjustement: `CET-1CEST,M3.5.0,M10.5.0/3` | | TimeZone | TimeZone of the system can be specified | Central european, with summertime adjustement: `CET-1CEST,M3.5.0,M10.5.0/3` |
| TimeServer | An dedicated time server can be specified. | default = `pool.ntp.org` | | TimeServer | An dedicated time server can be specified. | default = `pool.ntp.org` |
| Hostname | Additionally to the `wlan.ini` the hostname can be specified. It will be transferred to the `wlan.ini` and initiate a reboot | | | Hostname | Additionally to the `wlan.ini` the hostname can be specified. It will be transferred to the `wlan.ini` and initiate a reboot | |
| SetupMode | If enabled, the server starts in an initial setup mode. This is automatically disabled at the end of the setup | | | SetupMode | If enabled, the server starts in an initial setup mode. This is automatically disabled at the end of the setup |
### [Ende] ### [Ende]
No function, just to mark, that the config is done! No function, just to mark, that the config is done!