From 47907aaa2bab784a0df46e0822e861df76f02181 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Mon, 20 Feb 2023 23:02:05 +0100 Subject: [PATCH] migrate parameters (#19) Co-authored-by: CaCO3 --- README.md | 2 +- .../parameter-pages/Analog/ExtendedResolution.md | 4 ++-- .../{LogImageLocation.md => ROIImagesLocation.md} | 4 ++-- ...LogfileRetentionInDays.md => ROIImagesRetention.md} | 2 +- param-docs/parameter-pages/AutoTimer/Interval.md | 5 +++++ param-docs/parameter-pages/AutoTimer/Intervall.md | 9 --------- ...DataLogRetentionInDays.md => DataFilesRetention.md} | 2 +- .../parameter-pages/DataLogging/DataLogActive.md | 2 +- .../parameter-pages/Debug/{Logfile.md => LogLevel.md} | 4 ++-- ...{LogfileRetentionInDays.md => LogfilesRetention.md} | 2 +- .../{LogImageLocation.md => ROIImagesLocation.md} | 4 ++-- ...LogfileRetentionInDays.md => ROIImagesRetention.md} | 2 +- param-docs/parameter-pages/MQTT/RetainMessages.md | 5 +++++ param-docs/parameter-pages/MQTT/SetRetainFlag.md | 5 ----- .../PostProcessing/AllowNegativeRates.md | 10 +++------- .../parameter-pages/System/AutoAdjustSummertime.md | 5 ----- .../System/{RSSIThreashold.md => RSSIThreshold.md} | 5 +---- .../{MakeImage => TakeImage}/Brightness.md | 0 .../{MakeImage => TakeImage}/Contrast.md | 0 .../parameter-pages/{MakeImage => TakeImage}/Demo.md | 0 .../{MakeImage => TakeImage}/FixedExposure.md | 0 .../{MakeImage => TakeImage}/ImageQuality.md | 0 .../{MakeImage => TakeImage}/ImageSize.md | 0 .../{MakeImage => TakeImage}/LEDIntensity.md | 0 .../RawImagesLocation.md} | 4 ++-- .../RawImagesRetention.md} | 2 +- .../{MakeImage => TakeImage}/Saturation.md | 0 .../WaitBeforeTakingPicture.md | 0 param-docs/templates/overview.md | 4 ---- 29 files changed, 31 insertions(+), 51 deletions(-) rename param-docs/parameter-pages/Analog/{LogImageLocation.md => ROIImagesLocation.md} (57%) rename param-docs/parameter-pages/Analog/{LogfileRetentionInDays.md => ROIImagesRetention.md} (67%) create mode 100644 param-docs/parameter-pages/AutoTimer/Interval.md delete mode 100644 param-docs/parameter-pages/AutoTimer/Intervall.md rename param-docs/parameter-pages/DataLogging/{DataLogRetentionInDays.md => DataFilesRetention.md} (67%) rename param-docs/parameter-pages/Debug/{Logfile.md => LogLevel.md} (77%) rename param-docs/parameter-pages/Debug/{LogfileRetentionInDays.md => LogfilesRetention.md} (66%) rename param-docs/parameter-pages/Digits/{LogImageLocation.md => ROIImagesLocation.md} (56%) rename param-docs/parameter-pages/Digits/{LogfileRetentionInDays.md => ROIImagesRetention.md} (67%) create mode 100644 param-docs/parameter-pages/MQTT/RetainMessages.md delete mode 100644 param-docs/parameter-pages/MQTT/SetRetainFlag.md delete mode 100644 param-docs/parameter-pages/System/AutoAdjustSummertime.md rename param-docs/parameter-pages/System/{RSSIThreashold.md => RSSIThreshold.md} (71%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/Brightness.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/Contrast.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/Demo.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/FixedExposure.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/ImageQuality.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/ImageSize.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/LEDIntensity.md (100%) rename param-docs/parameter-pages/{MakeImage/LogImageLocation.md => TakeImage/RawImagesLocation.md} (55%) rename param-docs/parameter-pages/{MakeImage/LogfileRetentionInDays.md => TakeImage/RawImagesRetention.md} (66%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/Saturation.md (100%) rename param-docs/parameter-pages/{MakeImage => TakeImage}/WaitBeforeTakingPicture.md (100%) diff --git a/README.md b/README.md index 594b6aa..6d6ef50 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ The script `concat-parameter-pages.py` in `param-docs` should be run whenever on It then concatenates all pages into the single `../docs/Parameters.md` which gets be added to the `mkdocs` documentation. ### Template Generator -The script `param-docs/generate-param-doc-pages.py` should be run whenever a new parameter gets added to the config file. +The script `generate-param-doc-pages.py` should be run whenever a new parameter gets added to the config file. It then checks if there is already page for each of the parameters. - If no page exists yet, a templated page gets generated. - Existing pages do not get modified. diff --git a/param-docs/parameter-pages/Analog/ExtendedResolution.md b/param-docs/parameter-pages/Analog/ExtendedResolution.md index bb8be5e..7fef77a 100644 --- a/param-docs/parameter-pages/Analog/ExtendedResolution.md +++ b/param-docs/parameter-pages/Analog/ExtendedResolution.md @@ -1,5 +1,5 @@ # Parameter `ExtendedResolution` -Default Value: `true` !!! WARNING - This parameter got replaced by [`NUMBER.ExtendedResolution`](../Parameters/#PostProcessing-NUMBER.ExtendedResolution)! + This parameter is unused! + Use [`NUMBER.ExtendedResolution`](../Parameters/#PostProcessing-NUMBER.ExtendedResolution) instead! diff --git a/param-docs/parameter-pages/Analog/LogImageLocation.md b/param-docs/parameter-pages/Analog/ROIImagesLocation.md similarity index 57% rename from param-docs/parameter-pages/Analog/LogImageLocation.md rename to param-docs/parameter-pages/Analog/ROIImagesLocation.md index 1deebe6..e1575ec 100644 --- a/param-docs/parameter-pages/Analog/LogImageLocation.md +++ b/param-docs/parameter-pages/Analog/ROIImagesLocation.md @@ -1,9 +1,9 @@ -# Parameter `LogImageLocation` +# Parameter `ROIImagesLocation` Default Value: `/log/analog` Location to store separated analog images on the SD-Card for logging. !!! Warning - A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! + A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md b/param-docs/parameter-pages/Analog/ROIImagesRetention.md similarity index 67% rename from param-docs/parameter-pages/Analog/LogfileRetentionInDays.md rename to param-docs/parameter-pages/Analog/ROIImagesRetention.md index 8651cf5..e095b09 100644 --- a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/Analog/ROIImagesRetention.md @@ -1,4 +1,4 @@ -# Parameter `LogfileRetentionInDays` +# Parameter `ROIImagesRetention` Default Value: `3` Days to keep the separated analog images (`0` = forever). diff --git a/param-docs/parameter-pages/AutoTimer/Interval.md b/param-docs/parameter-pages/AutoTimer/Interval.md new file mode 100644 index 0000000..b03fd44 --- /dev/null +++ b/param-docs/parameter-pages/AutoTimer/Interval.md @@ -0,0 +1,5 @@ +# Parameter `Interval` +Default Value: `5` + +Interval in minutes in which the Flow (Digitization Round) is run. +If a round takes longer than this interval, the next round gets postponed until the current round completes. diff --git a/param-docs/parameter-pages/AutoTimer/Intervall.md b/param-docs/parameter-pages/AutoTimer/Intervall.md deleted file mode 100644 index 45b5529..0000000 --- a/param-docs/parameter-pages/AutoTimer/Intervall.md +++ /dev/null @@ -1,9 +0,0 @@ -# Parameter `Intervall` -Default Value: `5` - -Interval in minutes in which the Flow (Digitization Round) is run. -If a rund takes longer than this interval, the next round gets postponed until the current round completes. - -!!! Note - Due to a typo, it is called `Intervall` instead of `Interval`. - For backwards compatibility, this did not get changed. \ No newline at end of file diff --git a/param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md b/param-docs/parameter-pages/DataLogging/DataFilesRetention.md similarity index 67% rename from param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md rename to param-docs/parameter-pages/DataLogging/DataFilesRetention.md index b925184..683ce2b 100644 --- a/param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md +++ b/param-docs/parameter-pages/DataLogging/DataFilesRetention.md @@ -1,4 +1,4 @@ -# Parameter `DataLogRetentionInDays` +# Parameter `DataFilesRetention` Default Value: `3` diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md index 5786210..85e9da1 100644 --- a/param-docs/parameter-pages/DataLogging/DataLogActive.md +++ b/param-docs/parameter-pages/DataLogging/DataLogActive.md @@ -4,4 +4,4 @@ Default Value: `true` Activate data logging to SD-Card. !!! Warning - A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! \ No newline at end of file + A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! \ No newline at end of file diff --git a/param-docs/parameter-pages/Debug/Logfile.md b/param-docs/parameter-pages/Debug/LogLevel.md similarity index 77% rename from param-docs/parameter-pages/Debug/Logfile.md rename to param-docs/parameter-pages/Debug/LogLevel.md index feab73b..cf55284 100644 --- a/param-docs/parameter-pages/Debug/Logfile.md +++ b/param-docs/parameter-pages/Debug/LogLevel.md @@ -1,4 +1,4 @@ -# Parameter `Logfile` +# Parameter `LogLevel` Default Value: `1` (`ERROR`) Define the log level for the logging to the SD-Card. @@ -14,4 +14,4 @@ As higher the level, as more log messages get written to the SD-Card. !!! Warning `DEBUG` or `INFO` might damage the SD-Card if enabled long term due to excessive writes to the SD-Card! - A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! \ No newline at end of file + A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! \ No newline at end of file diff --git a/param-docs/parameter-pages/Debug/LogfileRetentionInDays.md b/param-docs/parameter-pages/Debug/LogfilesRetention.md similarity index 66% rename from param-docs/parameter-pages/Debug/LogfileRetentionInDays.md rename to param-docs/parameter-pages/Debug/LogfilesRetention.md index 72597ae..52efcc1 100644 --- a/param-docs/parameter-pages/Debug/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/Debug/LogfilesRetention.md @@ -1,4 +1,4 @@ -# Parameter `LogfileRetentionInDays` +# Parameter `LogfilesRetention` Default Value: `3` Number of days to keep the log files (`0` = forever). diff --git a/param-docs/parameter-pages/Digits/LogImageLocation.md b/param-docs/parameter-pages/Digits/ROIImagesLocation.md similarity index 56% rename from param-docs/parameter-pages/Digits/LogImageLocation.md rename to param-docs/parameter-pages/Digits/ROIImagesLocation.md index 949f660..a0150c7 100644 --- a/param-docs/parameter-pages/Digits/LogImageLocation.md +++ b/param-docs/parameter-pages/Digits/ROIImagesLocation.md @@ -1,7 +1,7 @@ -# Parameter `LogImageLocation` +# Parameter `ROIImagesLocation` Default Value: `/log/digit` Location to store separated digit images on the SD-Card for logging. !!! Warning - A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! + A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md b/param-docs/parameter-pages/Digits/ROIImagesRetention.md similarity index 67% rename from param-docs/parameter-pages/Digits/LogfileRetentionInDays.md rename to param-docs/parameter-pages/Digits/ROIImagesRetention.md index 40fe6d3..513b3ab 100644 --- a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/Digits/ROIImagesRetention.md @@ -1,4 +1,4 @@ -# Parameter `LogfileRetentionInDays` +# Parameter `ROIImagesRetention` Default Value: `3` Days to keep the separated digit images (`0` = forever). diff --git a/param-docs/parameter-pages/MQTT/RetainMessages.md b/param-docs/parameter-pages/MQTT/RetainMessages.md new file mode 100644 index 0000000..f461381 --- /dev/null +++ b/param-docs/parameter-pages/MQTT/RetainMessages.md @@ -0,0 +1,5 @@ +# Parameter `RetainMessages` +Default Value: `true` + +Enable or disable the [Retain Flag](https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/) for all MQTT entries. + diff --git a/param-docs/parameter-pages/MQTT/SetRetainFlag.md b/param-docs/parameter-pages/MQTT/SetRetainFlag.md deleted file mode 100644 index 8d089d6..0000000 --- a/param-docs/parameter-pages/MQTT/SetRetainFlag.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `SetRetainFlag` -Default Value: `true` - -Enable or disable the retain flag for all MQTT entries. - diff --git a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md index f0a48ad..4290f8c 100644 --- a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md +++ b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md @@ -1,9 +1,5 @@ # Parameter `AllowNegativeRates` -Default Value: `false` - - - - - -Please fill me with an explanation and useful links +!!! Warning + This parameter is unused! + Use [`NUMBER.AllowNegativeRates`](../Parameters/#PostProcessing-NUMBER.AllowNegativeRates) instead! diff --git a/param-docs/parameter-pages/System/AutoAdjustSummertime.md b/param-docs/parameter-pages/System/AutoAdjustSummertime.md deleted file mode 100644 index c2f27f7..0000000 --- a/param-docs/parameter-pages/System/AutoAdjustSummertime.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `AutoAdjustSummertime` -Default Value: `false` - -!!! Note - This parameter is not accessible through the Web Interface Configuration Page! diff --git a/param-docs/parameter-pages/System/RSSIThreashold.md b/param-docs/parameter-pages/System/RSSIThreshold.md similarity index 71% rename from param-docs/parameter-pages/System/RSSIThreashold.md rename to param-docs/parameter-pages/System/RSSIThreshold.md index f10f039..c3cba97 100644 --- a/param-docs/parameter-pages/System/RSSIThreashold.md +++ b/param-docs/parameter-pages/System/RSSIThreshold.md @@ -1,9 +1,6 @@ -# Parameter `RSSIThreashold` +# Parameter `RSSIThreshold` Default Value: `''` WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system. Possible values: `-100` .. `0`, `0` = disabled. It gets automatically transferred to `/wlan.ini` on the SD-Card at next startup. - -!!! Note - Due to a typo, the parameter is wrongly named `RSSIThreashold`. \ No newline at end of file diff --git a/param-docs/parameter-pages/MakeImage/Brightness.md b/param-docs/parameter-pages/TakeImage/Brightness.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/Brightness.md rename to param-docs/parameter-pages/TakeImage/Brightness.md diff --git a/param-docs/parameter-pages/MakeImage/Contrast.md b/param-docs/parameter-pages/TakeImage/Contrast.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/Contrast.md rename to param-docs/parameter-pages/TakeImage/Contrast.md diff --git a/param-docs/parameter-pages/MakeImage/Demo.md b/param-docs/parameter-pages/TakeImage/Demo.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/Demo.md rename to param-docs/parameter-pages/TakeImage/Demo.md diff --git a/param-docs/parameter-pages/MakeImage/FixedExposure.md b/param-docs/parameter-pages/TakeImage/FixedExposure.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/FixedExposure.md rename to param-docs/parameter-pages/TakeImage/FixedExposure.md diff --git a/param-docs/parameter-pages/MakeImage/ImageQuality.md b/param-docs/parameter-pages/TakeImage/ImageQuality.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/ImageQuality.md rename to param-docs/parameter-pages/TakeImage/ImageQuality.md diff --git a/param-docs/parameter-pages/MakeImage/ImageSize.md b/param-docs/parameter-pages/TakeImage/ImageSize.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/ImageSize.md rename to param-docs/parameter-pages/TakeImage/ImageSize.md diff --git a/param-docs/parameter-pages/MakeImage/LEDIntensity.md b/param-docs/parameter-pages/TakeImage/LEDIntensity.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/LEDIntensity.md rename to param-docs/parameter-pages/TakeImage/LEDIntensity.md diff --git a/param-docs/parameter-pages/MakeImage/LogImageLocation.md b/param-docs/parameter-pages/TakeImage/RawImagesLocation.md similarity index 55% rename from param-docs/parameter-pages/MakeImage/LogImageLocation.md rename to param-docs/parameter-pages/TakeImage/RawImagesLocation.md index 5188933..ff13ae2 100644 --- a/param-docs/parameter-pages/MakeImage/LogImageLocation.md +++ b/param-docs/parameter-pages/TakeImage/RawImagesLocation.md @@ -1,7 +1,7 @@ -# Parameter `LogImageLocation` +# Parameter `RawImagesLocation` Default Value: `/log/source` Location on the SD-Card to store the raw images for logging. !!! Warning - A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! + A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md b/param-docs/parameter-pages/TakeImage/RawImagesRetention.md similarity index 66% rename from param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md rename to param-docs/parameter-pages/TakeImage/RawImagesRetention.md index d0d8d42..80bbb86 100644 --- a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/TakeImage/RawImagesRetention.md @@ -1,4 +1,4 @@ -# Parameter `LogfileRetentionInDays` +# Parameter `RawImagesRetention` Default Value: `15` Number of days to keep the raw images (`0` = forever) diff --git a/param-docs/parameter-pages/MakeImage/Saturation.md b/param-docs/parameter-pages/TakeImage/Saturation.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/Saturation.md rename to param-docs/parameter-pages/TakeImage/Saturation.md diff --git a/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md b/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md similarity index 100% rename from param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md rename to param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md index e7d79ad..33166a0 100644 --- a/param-docs/templates/overview.md +++ b/param-docs/templates/overview.md @@ -7,10 +7,6 @@ In such case the functionality gets disabled respectively the default values wil !!! 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! -!!! Note - Due to a typo, one of the sections is called `MakeImage` instead of `TakeImage`! - For backwards compatibility, this did not get changed. - ## List of all Parameters $TOC