migrate parameters

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.

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!

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!
 

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).

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.

param-docs/parameter-pages/AutoTimer/Intervall.md

@@ -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.

param-docs/parameter-pages/DataLogging/DataFilesRetention.md

@@ -1,4 +1,4 @@
-# Parameter `DataLogRetentionInDays`
+# Parameter `DataFilesRetention`
 Default Value: `3`
 
 

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!
+    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!

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!
+    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!

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).

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!

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).

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.
+

param-docs/parameter-pages/MQTT/SetRetainFlag.md

@@ -1,5 +0,0 @@
-# Parameter `SetRetainFlag`
-Default Value: `true`
-
-Enable or disable the retain flag for all MQTT entries.
-

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!

param-docs/parameter-pages/System/AutoAdjustSummertime.md

@@ -1,5 +0,0 @@
-# Parameter `AutoAdjustSummertime`
-Default Value: `false`
-
-!!! Note
-    This parameter is not accessible through the Web Interface Configuration Page!

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`.

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!

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)

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