diff --git a/generate-param-docs/concat-parameter-pages.py b/generate-param-docs/concat-parameter-pages.py index 416d862..b20a7a8 100644 --- a/generate-param-docs/concat-parameter-pages.py +++ b/generate-param-docs/concat-parameter-pages.py @@ -25,9 +25,6 @@ def appendParameterFile(folder, file): - - - # Create templated overview markdown file if os.path.exists(parameterOverviewFile): os.remove(parameterOverviewFile) @@ -43,7 +40,7 @@ for folder in folders: # Add section with open(parameterOverviewFile, 'a') as overviewFileHandle: - overviewFileHandle.write("\n## %s\n\n" % folder) + overviewFileHandle.write("\n## [%s]\n\n" % folder) files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*'))) for file in files: diff --git a/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md b/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md index c9ce2b4..910a6c0 100644 --- a/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md +++ b/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md @@ -1,5 +1,6 @@ -# `AlignmentAlgo` +# Parameter `AlignmentAlgo` Default Value: `Default` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md b/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md index f14bc88..60cfee1 100644 --- a/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md +++ b/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md @@ -1,5 +1,6 @@ -# `FlipImageSize` +# Parameter `FlipImageSize` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/InitialMirror.md b/generate-param-docs/parameter-docs/Alignment/InitialMirror.md index cdd8844..af6211a 100644 --- a/generate-param-docs/parameter-docs/Alignment/InitialMirror.md +++ b/generate-param-docs/parameter-docs/Alignment/InitialMirror.md @@ -1,5 +1,6 @@ -# `InitialMirror` +# Parameter `InitialMirror` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/InitialRotate.md b/generate-param-docs/parameter-docs/Alignment/InitialRotate.md index 21c9fcd..7185c02 100644 --- a/generate-param-docs/parameter-docs/Alignment/InitialRotate.md +++ b/generate-param-docs/parameter-docs/Alignment/InitialRotate.md @@ -1,5 +1,6 @@ -# `InitialRotate` +# Parameter `InitialRotate` Default Value: `179` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md b/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md index f99005f..ff6714d 100644 --- a/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md +++ b/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md @@ -1,5 +1,6 @@ -# `SearchFieldX` +# Parameter `SearchFieldX` Default Value: `20` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md b/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md index b3fe25f..b0089fb 100644 --- a/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md +++ b/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md @@ -1,5 +1,6 @@ -# `SearchFieldY` +# Parameter `SearchFieldY` Default Value: `20` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md b/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md index d7efa9d..2293653 100644 --- a/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md +++ b/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md @@ -1,5 +1,6 @@ -# `CNNGoodThreshold` +# Parameter `CNNGoodThreshold` Default Value: `0.5` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md b/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md index bad308a..d56fdaa 100644 --- a/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md +++ b/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md @@ -1,5 +1,6 @@ -# `ExtendedResolution` +# Parameter `ExtendedResolution` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/LogImageLocation.md b/generate-param-docs/parameter-docs/Analog/LogImageLocation.md index a20b312..d452034 100644 --- a/generate-param-docs/parameter-docs/Analog/LogImageLocation.md +++ b/generate-param-docs/parameter-docs/Analog/LogImageLocation.md @@ -1,5 +1,6 @@ -# `LogImageLocation` +# Parameter `LogImageLocation` Default Value: `/log/analog` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md index 692af02..84de177 100644 --- a/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md +++ b/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md @@ -1,5 +1,6 @@ -# `LogfileRetentionInDays` +# Parameter `LogfileRetentionInDays` Default Value: `3` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/Model.md b/generate-param-docs/parameter-docs/Analog/Model.md index 47e8bad..861db58 100644 --- a/generate-param-docs/parameter-docs/Analog/Model.md +++ b/generate-param-docs/parameter-docs/Analog/Model.md @@ -1,5 +1,6 @@ -# `Model` +# Parameter `Model` Default Value: `/config/ana-cont_11.3.1_s2.tflite` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md b/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md index 215b392..40e662c 100644 --- a/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md +++ b/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md @@ -1,5 +1,6 @@ -# `AutoStart` +# Parameter `AutoStart` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/AutoTimer/Intervall.md b/generate-param-docs/parameter-docs/AutoTimer/Intervall.md index 23ce9ca..9a5afb8 100644 --- a/generate-param-docs/parameter-docs/AutoTimer/Intervall.md +++ b/generate-param-docs/parameter-docs/AutoTimer/Intervall.md @@ -1,5 +1,6 @@ -# `Intervall` +# Parameter `Intervall` Default Value: `5` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md b/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md index aeee096..2508627 100644 --- a/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md +++ b/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md @@ -1,5 +1,6 @@ -# `DataLogActive` +# Parameter `DataLogActive` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md b/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md index b4bc9ee..c862e94 100644 --- a/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md +++ b/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md @@ -1,5 +1,6 @@ -# `DataLogRetentionInDays` +# Parameter `DataLogRetentionInDays` Default Value: `3` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Debug/Logfile.md b/generate-param-docs/parameter-docs/Debug/Logfile.md index 1a85e32..74e928f 100644 --- a/generate-param-docs/parameter-docs/Debug/Logfile.md +++ b/generate-param-docs/parameter-docs/Debug/Logfile.md @@ -1,5 +1,6 @@ -# `Logfile` +# Parameter `Logfile` Default Value: `1` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md index 692af02..84de177 100644 --- a/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md +++ b/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md @@ -1,5 +1,6 @@ -# `LogfileRetentionInDays` +# Parameter `LogfileRetentionInDays` Default Value: `3` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md b/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md index d7efa9d..2293653 100644 --- a/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md +++ b/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md @@ -1,5 +1,6 @@ -# `CNNGoodThreshold` +# Parameter `CNNGoodThreshold` Default Value: `0.5` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/LogImageLocation.md b/generate-param-docs/parameter-docs/Digits/LogImageLocation.md index c250af9..77ce82f 100644 --- a/generate-param-docs/parameter-docs/Digits/LogImageLocation.md +++ b/generate-param-docs/parameter-docs/Digits/LogImageLocation.md @@ -1,5 +1,6 @@ -# `LogImageLocation` +# Parameter `LogImageLocation` Default Value: `/log/digit` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md index 692af02..84de177 100644 --- a/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md +++ b/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md @@ -1,5 +1,6 @@ -# `LogfileRetentionInDays` +# Parameter `LogfileRetentionInDays` Default Value: `3` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/Model.md b/generate-param-docs/parameter-docs/Digits/Model.md index bd6fb05..d1fcab2 100644 --- a/generate-param-docs/parameter-docs/Digits/Model.md +++ b/generate-param-docs/parameter-docs/Digits/Model.md @@ -1,5 +1,6 @@ -# `Model` +# Parameter `Model` Default Value: `/config/dig-cont_0600_s3.tflite` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO0.md b/generate-param-docs/parameter-docs/GPIO/IO0.md index a7d9d40..c323713 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO0.md +++ b/generate-param-docs/parameter-docs/GPIO/IO0.md @@ -1,5 +1,6 @@ -# `IO0` +# Parameter `IO0` Default Value: `input disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO1.md b/generate-param-docs/parameter-docs/GPIO/IO1.md index 8f14564..a19739d 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO1.md +++ b/generate-param-docs/parameter-docs/GPIO/IO1.md @@ -1,5 +1,6 @@ -# `IO1` +# Parameter `IO1` Default Value: `input disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO12.md b/generate-param-docs/parameter-docs/GPIO/IO12.md index dff56cf..00e7fd1 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO12.md +++ b/generate-param-docs/parameter-docs/GPIO/IO12.md @@ -1,5 +1,6 @@ -# `IO12` +# Parameter `IO12` Default Value: `input-pullup disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO13.md b/generate-param-docs/parameter-docs/GPIO/IO13.md index 4b2c3a5..09f067d 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO13.md +++ b/generate-param-docs/parameter-docs/GPIO/IO13.md @@ -1,5 +1,6 @@ -# `IO13` +# Parameter `IO13` Default Value: `input-pullup disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO3.md b/generate-param-docs/parameter-docs/GPIO/IO3.md index f8f8fed..d7af763 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO3.md +++ b/generate-param-docs/parameter-docs/GPIO/IO3.md @@ -1,5 +1,6 @@ -# `IO3` +# Parameter `IO3` Default Value: `input disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO4.md b/generate-param-docs/parameter-docs/GPIO/IO4.md index f484206..a52fdf8 100644 --- a/generate-param-docs/parameter-docs/GPIO/IO4.md +++ b/generate-param-docs/parameter-docs/GPIO/IO4.md @@ -1,5 +1,6 @@ -# `IO4` +# Parameter `IO4` Default Value: `built-in-led disabled 10 false false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDColor.md b/generate-param-docs/parameter-docs/GPIO/LEDColor.md index 9f9d9da..d3d06dc 100644 --- a/generate-param-docs/parameter-docs/GPIO/LEDColor.md +++ b/generate-param-docs/parameter-docs/GPIO/LEDColor.md @@ -1,5 +1,6 @@ -# `LEDColor` +# Parameter `LEDColor` Default Value: `150 150 150` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md b/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md index 9282b82..dc06fef 100644 --- a/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md +++ b/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md @@ -1,5 +1,6 @@ -# `LEDNumbers` +# Parameter `LEDNumbers` Default Value: `2` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDType.md b/generate-param-docs/parameter-docs/GPIO/LEDType.md index 5596ff6..8901862 100644 --- a/generate-param-docs/parameter-docs/GPIO/LEDType.md +++ b/generate-param-docs/parameter-docs/GPIO/LEDType.md @@ -1,5 +1,6 @@ -# `LEDType` +# Parameter `LEDType` Default Value: `WS2812` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md b/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md index 2197cd3..a1a9390 100644 --- a/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md +++ b/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md @@ -1,5 +1,6 @@ -# `MainTopicMQTT` +# Parameter `MainTopicMQTT` Default Value: `wasserzaehler/GPIO` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Database.md b/generate-param-docs/parameter-docs/InfluxDB/Database.md index 7841653..191f894 100644 --- a/generate-param-docs/parameter-docs/InfluxDB/Database.md +++ b/generate-param-docs/parameter-docs/InfluxDB/Database.md @@ -1,5 +1,6 @@ -# `Database` +# Parameter `Database` Default Value: `` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Measurement.md b/generate-param-docs/parameter-docs/InfluxDB/Measurement.md index d961549..37e0666 100644 --- a/generate-param-docs/parameter-docs/InfluxDB/Measurement.md +++ b/generate-param-docs/parameter-docs/InfluxDB/Measurement.md @@ -1,5 +1,6 @@ -# `Measurement` +# Parameter `Measurement` Default Value: `undefined` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Uri.md b/generate-param-docs/parameter-docs/InfluxDB/Uri.md index ee8df73..dbd59bb 100644 --- a/generate-param-docs/parameter-docs/InfluxDB/Uri.md +++ b/generate-param-docs/parameter-docs/InfluxDB/Uri.md @@ -1,5 +1,6 @@ -# `Uri` +# Parameter `Uri` Default Value: `undefined` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/password.md b/generate-param-docs/parameter-docs/InfluxDB/password.md index fa4d205..0f6c10c 100644 --- a/generate-param-docs/parameter-docs/InfluxDB/password.md +++ b/generate-param-docs/parameter-docs/InfluxDB/password.md @@ -1,5 +1,6 @@ -# `password` +# Parameter `password` Default Value: `undefined` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/user.md b/generate-param-docs/parameter-docs/InfluxDB/user.md index 1d8c728..71d70d6 100644 --- a/generate-param-docs/parameter-docs/InfluxDB/user.md +++ b/generate-param-docs/parameter-docs/InfluxDB/user.md @@ -1,5 +1,6 @@ -# `user` +# Parameter `user` Default Value: `undefined` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/ClientID.md b/generate-param-docs/parameter-docs/MQTT/ClientID.md index e4c586b..526dd4a 100644 --- a/generate-param-docs/parameter-docs/MQTT/ClientID.md +++ b/generate-param-docs/parameter-docs/MQTT/ClientID.md @@ -1,5 +1,6 @@ -# `ClientID` +# Parameter `ClientID` Default Value: `watermeter` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md b/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md index 2fc3d00..35a2465 100644 --- a/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md +++ b/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md @@ -1,5 +1,6 @@ -# `HomeassistantDiscovery` +# Parameter `HomeassistantDiscovery` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/MainTopic.md b/generate-param-docs/parameter-docs/MQTT/MainTopic.md index 2c61b3e..9af1294 100644 --- a/generate-param-docs/parameter-docs/MQTT/MainTopic.md +++ b/generate-param-docs/parameter-docs/MQTT/MainTopic.md @@ -1,5 +1,6 @@ -# `MainTopic` +# Parameter `MainTopic` Default Value: `watermeter` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/MeterType.md b/generate-param-docs/parameter-docs/MQTT/MeterType.md index 26ffb70..1c0bcbb 100644 --- a/generate-param-docs/parameter-docs/MQTT/MeterType.md +++ b/generate-param-docs/parameter-docs/MQTT/MeterType.md @@ -1,5 +1,6 @@ -# `MeterType` +# Parameter `MeterType` Default Value: `other` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md b/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md index f8461d6..d535fff 100644 --- a/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md +++ b/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md @@ -1,5 +1,6 @@ -# `SetRetainFlag` +# Parameter `SetRetainFlag` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/Uri.md b/generate-param-docs/parameter-docs/MQTT/Uri.md index d18a02a..c54fde4 100644 --- a/generate-param-docs/parameter-docs/MQTT/Uri.md +++ b/generate-param-docs/parameter-docs/MQTT/Uri.md @@ -1,5 +1,6 @@ -# `Uri` +# Parameter `Uri` Default Value: `mqtt://IP-ADRESS:1883` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/password.md b/generate-param-docs/parameter-docs/MQTT/password.md index 49cc2a1..e997146 100644 --- a/generate-param-docs/parameter-docs/MQTT/password.md +++ b/generate-param-docs/parameter-docs/MQTT/password.md @@ -1,5 +1,6 @@ -# `password` +# Parameter `password` Default Value: `PASSWORD` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/user.md b/generate-param-docs/parameter-docs/MQTT/user.md index a05829a..3efded9 100644 --- a/generate-param-docs/parameter-docs/MQTT/user.md +++ b/generate-param-docs/parameter-docs/MQTT/user.md @@ -1,5 +1,6 @@ -# `user` +# Parameter `user` Default Value: `USERNAME` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Brightness.md b/generate-param-docs/parameter-docs/MakeImage/Brightness.md index 6db7665..d796136 100644 --- a/generate-param-docs/parameter-docs/MakeImage/Brightness.md +++ b/generate-param-docs/parameter-docs/MakeImage/Brightness.md @@ -1,5 +1,6 @@ -# `Brightness` +# Parameter `Brightness` Default Value: `0` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Contrast.md b/generate-param-docs/parameter-docs/MakeImage/Contrast.md index e96a404..185df70 100644 --- a/generate-param-docs/parameter-docs/MakeImage/Contrast.md +++ b/generate-param-docs/parameter-docs/MakeImage/Contrast.md @@ -1,5 +1,6 @@ -# `Contrast` +# Parameter `Contrast` Default Value: `0` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Demo.md b/generate-param-docs/parameter-docs/MakeImage/Demo.md index e0351b5..6b67f78 100644 --- a/generate-param-docs/parameter-docs/MakeImage/Demo.md +++ b/generate-param-docs/parameter-docs/MakeImage/Demo.md @@ -1,5 +1,6 @@ -# `Demo` +# Parameter `Demo` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md b/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md index d38efc8..5c4095d 100644 --- a/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md +++ b/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md @@ -1,5 +1,6 @@ -# `FixedExposure` +# Parameter `FixedExposure` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md b/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md index 4a56a96..0de391f 100644 --- a/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md +++ b/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md @@ -1,5 +1,6 @@ -# `ImageQuality` +# Parameter `ImageQuality` Default Value: `12` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/ImageSize.md b/generate-param-docs/parameter-docs/MakeImage/ImageSize.md index 24fec88..502644e 100644 --- a/generate-param-docs/parameter-docs/MakeImage/ImageSize.md +++ b/generate-param-docs/parameter-docs/MakeImage/ImageSize.md @@ -1,5 +1,6 @@ -# `ImageSize` +# Parameter `ImageSize` Default Value: `VGA` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md b/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md index e49e411..1e2c04d 100644 --- a/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md +++ b/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md @@ -1,5 +1,6 @@ -# `LEDIntensity` +# Parameter `LEDIntensity` Default Value: `50` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md b/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md index 2c02431..cd97eb7 100644 --- a/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md +++ b/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md @@ -1,5 +1,6 @@ -# `LogImageLocation` +# Parameter `LogImageLocation` Default Value: `/log/source` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md index c0110e1..8fd1156 100644 --- a/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md +++ b/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md @@ -1,5 +1,6 @@ -# `LogfileRetentionInDays` +# Parameter `LogfileRetentionInDays` Default Value: `15` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Saturation.md b/generate-param-docs/parameter-docs/MakeImage/Saturation.md index 6ebaf6c..62848c6 100644 --- a/generate-param-docs/parameter-docs/MakeImage/Saturation.md +++ b/generate-param-docs/parameter-docs/MakeImage/Saturation.md @@ -1,5 +1,6 @@ -# `Saturation` +# Parameter `Saturation` Default Value: `0` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md b/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md index 4b60e31..5baa40b 100644 --- a/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md +++ b/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md @@ -1,5 +1,6 @@ -# `WaitBeforeTakingPicture` +# Parameter `WaitBeforeTakingPicture` Default Value: `5` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md b/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md index 62618c2..f7d95e1 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md +++ b/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md @@ -1,5 +1,6 @@ -# `AllowNegativeRates` +# Parameter `AllowNegativeRates` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md b/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md index 118096b..cfe1dd8 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md +++ b/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md @@ -1,5 +1,6 @@ -# `CheckDigitIncreaseConsistency` +# Parameter `CheckDigitIncreaseConsistency` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md b/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md index cae0644..ce1e5e5 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md +++ b/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md @@ -1,5 +1,6 @@ -# `ErrorMessage` +# Parameter `ErrorMessage` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md b/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md index ba5ec69..07f0291 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md +++ b/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md @@ -1,5 +1,6 @@ -# `PreValueAgeStartup` +# Parameter `PreValueAgeStartup` Default Value: `720` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md b/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md index 536b0b3..83284be 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md +++ b/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md @@ -1,5 +1,6 @@ -# `PreValueUse` +# Parameter `PreValueUse` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md b/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md index 84ea5cb..451ea40 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md @@ -1,5 +1,6 @@ -# `main.AnalogDigitalTransitionStart` +# Parameter `main.AnalogDigitalTransitionStart` Default Value: `9.2` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md b/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md index e802e8c..bc81943 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md @@ -1,5 +1,6 @@ -# `main.DecimalShift` +# Parameter `main.DecimalShift` Default Value: `0` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md b/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md index bde10f4..70ffa8f 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md @@ -1,5 +1,6 @@ -# `main.ExtendedResolution` +# Parameter `main.ExtendedResolution` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md b/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md index f3f175d..83dc58b 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md @@ -1,5 +1,6 @@ -# `main.IgnoreLeadingNaN` +# Parameter `main.IgnoreLeadingNaN` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md index 9567608..8d599d9 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md @@ -1,5 +1,6 @@ -# `main.MaxRateType` +# Parameter `main.MaxRateType` Default Value: `AbsoluteChange` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md index ffa7461..a6fd392 100644 --- a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md +++ b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md @@ -1,5 +1,6 @@ -# `main.MaxRateValue` +# Parameter `main.MaxRateValue` Default Value: `0.05` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md b/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md index b25220e..a41f0f9 100644 --- a/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md +++ b/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md @@ -1,5 +1,6 @@ -# `AutoAdjustSummertime` +# Parameter `AutoAdjustSummertime` Default Value: `false` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/Hostname.md b/generate-param-docs/parameter-docs/System/Hostname.md index 14931dc..622c7de 100644 --- a/generate-param-docs/parameter-docs/System/Hostname.md +++ b/generate-param-docs/parameter-docs/System/Hostname.md @@ -1,5 +1,6 @@ -# `Hostname` +# Parameter `Hostname` Default Value: `undefined` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/SetupMode.md b/generate-param-docs/parameter-docs/System/SetupMode.md index 08fbe9b..938ca9c 100644 --- a/generate-param-docs/parameter-docs/System/SetupMode.md +++ b/generate-param-docs/parameter-docs/System/SetupMode.md @@ -1,5 +1,6 @@ -# `SetupMode` +# Parameter `SetupMode` Default Value: `true` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/TimeServer.md b/generate-param-docs/parameter-docs/System/TimeServer.md index 9a3172b..729bf4d 100644 --- a/generate-param-docs/parameter-docs/System/TimeServer.md +++ b/generate-param-docs/parameter-docs/System/TimeServer.md @@ -1,5 +1,6 @@ -# `TimeServer` +# Parameter `TimeServer` Default Value: `pool.ntp.org` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/TimeZone.md b/generate-param-docs/parameter-docs/System/TimeZone.md index 500c879..d5366ec 100644 --- a/generate-param-docs/parameter-docs/System/TimeZone.md +++ b/generate-param-docs/parameter-docs/System/TimeZone.md @@ -1,5 +1,6 @@ -# `TimeZone` +# Parameter `TimeZone` Default Value: `CET-1CEST,M3.5.0,M10.5.0/3` ## Description -## Example +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/templates/overview.md b/generate-param-docs/templates/overview.md index e750578..f1d575c 100644 --- a/generate-param-docs/templates/overview.md +++ b/generate-param-docs/templates/overview.md @@ -1,9 +1,7 @@ # Parameters -This page lists all available Configuration Parameters. - -Click on them to get detailed information about them. +This page lists all available [Configuration](../Configuration) Parameters. -``` -Note: This is an auto-generated page! -``` +!!! Note + This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details! + --- diff --git a/generate-param-docs/templates/parameter.md b/generate-param-docs/templates/parameter.md index c0ae2f0..fafd0f8 100644 --- a/generate-param-docs/templates/parameter.md +++ b/generate-param-docs/templates/parameter.md @@ -1,5 +1,6 @@ -# `$NAME` +# Parameter `$NAME` Default Value: `$DEFAULT` ## Description -## Example +Please fill me with an explanation and useful links +