From 57f79414b1e5f6f3c1610d3ddbd0418c5e40c153 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Mon, 20 Feb 2023 23:40:53 +0100 Subject: [PATCH] . --- param-docs/parameter-pages/Alignment/SearchFieldX.md | 2 ++ param-docs/parameter-pages/Alignment/SearchFieldY.md | 2 ++ param-docs/parameter-pages/Analog/ROIImagesRetention.md | 3 +++ param-docs/parameter-pages/AutoTimer/AutoStart.md | 3 +++ param-docs/parameter-pages/DataLogging/DataLogActive.md | 1 + param-docs/parameter-pages/Debug/LogLevel.md | 2 +- param-docs/parameter-pages/Digits/ROIImagesRetention.md | 3 +++ .../parameter-pages/PostProcessing/AllowNegativeRates.md | 1 + .../PostProcessing/CheckDigitIncreaseConsistency.md | 2 ++ param-docs/parameter-pages/PostProcessing/ErrorMessage.md | 2 ++ .../PostProcessing/NUMBER.AllowNegativeRates.md | 1 + .../PostProcessing/NUMBER.ExtendedResolution.md | 1 + .../parameter-pages/PostProcessing/PreValueAgeStartup.md | 2 ++ param-docs/parameter-pages/TakeImage/Brightness.md | 2 ++ param-docs/parameter-pages/TakeImage/Contrast.md | 3 +++ param-docs/parameter-pages/TakeImage/FixedExposure.md | 2 ++ param-docs/parameter-pages/TakeImage/ImageQuality.md | 3 +++ param-docs/parameter-pages/TakeImage/ImageSize.md | 2 ++ param-docs/parameter-pages/TakeImage/LEDIntensity.md | 2 ++ param-docs/parameter-pages/TakeImage/RawImagesLocation.md | 1 + param-docs/parameter-pages/TakeImage/Saturation.md | 3 +++ .../parameter-pages/TakeImage/WaitBeforeTakingPicture.md | 2 ++ param-docs/templates/overview.md | 4 ++++ 23 files changed, 48 insertions(+), 1 deletion(-) diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md index eaba45a..7246383 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldX.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldX.md @@ -1,6 +1,8 @@ # Parameter `SearchFieldX` Default Value: `20` +Unit: Pixels + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md index 0051caf..fc2eaa3 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldY.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldY.md @@ -1,6 +1,8 @@ # Parameter `SearchFieldY` Default Value: `20` +Unit: Pixels + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/Analog/ROIImagesRetention.md b/param-docs/parameter-pages/Analog/ROIImagesRetention.md index 4cc0cb2..a36d06b 100644 --- a/param-docs/parameter-pages/Analog/ROIImagesRetention.md +++ b/param-docs/parameter-pages/Analog/ROIImagesRetention.md @@ -1,3 +1,6 @@ # Parameter `ROIImagesRetention` Default Value: `3` + +Unit: Days + Days to keep the separated analog images (`0` = forever). diff --git a/param-docs/parameter-pages/AutoTimer/AutoStart.md b/param-docs/parameter-pages/AutoTimer/AutoStart.md index e6004b2..fff75c8 100644 --- a/param-docs/parameter-pages/AutoTimer/AutoStart.md +++ b/param-docs/parameter-pages/AutoTimer/AutoStart.md @@ -1,8 +1,11 @@ # Parameter `AutoStart` Default Value: `true` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Automatically start the Flow (Digitization Rounds) immediately after power up. + !!! Note Typically this is set to `true`. The only reason to set it to `false` is debugging or if you want to trigger it manually using the [REST API](../REST-API) or [MQTT-API](../MQTT-API). \ No newline at end of file diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md index 62e4e97..5724382 100644 --- a/param-docs/parameter-pages/DataLogging/DataLogActive.md +++ b/param-docs/parameter-pages/DataLogging/DataLogActive.md @@ -1,5 +1,6 @@ # Parameter `DataLogActive` Default Value: `true` Activate data logging to SD-Card. + !!! Warning 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/LogLevel.md b/param-docs/parameter-pages/Debug/LogLevel.md index baf5a7a..8cbccd5 100644 --- a/param-docs/parameter-pages/Debug/LogLevel.md +++ b/param-docs/parameter-pages/Debug/LogLevel.md @@ -7,7 +7,7 @@ Available options: - `3`: `INFO` - `4`: `DEBUG` 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 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/Digits/ROIImagesRetention.md b/param-docs/parameter-pages/Digits/ROIImagesRetention.md index 16e8064..2d6ca9e 100644 --- a/param-docs/parameter-pages/Digits/ROIImagesRetention.md +++ b/param-docs/parameter-pages/Digits/ROIImagesRetention.md @@ -1,3 +1,6 @@ # Parameter `ROIImagesRetention` Default Value: `3` + +Unit: Days + Days to keep the separated digit images (`0` = forever). diff --git a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md index 68229ad..4290f8c 100644 --- a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md +++ b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md @@ -1,4 +1,5 @@ # Parameter `AllowNegativeRates` + !!! Warning This parameter is unused! Use [`NUMBER.AllowNegativeRates`](../Parameters/#PostProcessing-NUMBER.AllowNegativeRates) instead! diff --git a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md index 9dbfd1d..8612cd1 100644 --- a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md +++ b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md @@ -1,6 +1,8 @@ # Parameter `CheckDigitIncreaseConsistency` Default Value: `false` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + An additional consistency check. It especially improves the zero crossing check between digits. diff --git a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md b/param-docs/parameter-pages/PostProcessing/ErrorMessage.md index 2fdf152..2213efb 100644 --- a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md +++ b/param-docs/parameter-pages/PostProcessing/ErrorMessage.md @@ -1,6 +1,8 @@ # Parameter `ErrorMessage` Default Value: `true` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Do not show error message in return value. In an error case, the last valid number will be used for the various transmission protocols (MQTT, InfluxDB, REST, ...). diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md index 825f358..c35c52f 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md @@ -1,5 +1,6 @@ # Parameter `.AllowNegativeRates` Default Value: `false` Allow a meter to count backwards (decreasing values). + !!! Note This is unusual (it means there is a negative rate) and not wanted in most cases! diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md b/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md index 3d0d74c..42ff288 100644 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md +++ b/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md @@ -1,5 +1,6 @@ # Parameter `.ExtendedResolution` Default Value: `false` Use the decimal place of the last analog counter for increased accuracy. + !!! Note This parameter is only supported on the `*-class*` and `*-const` models! See [Choosing-the-Model](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md index a58fa86..0c5987b 100644 --- a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md +++ b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md @@ -1,5 +1,7 @@ # Parameter `PreValueAgeStartup` Default Value: `720` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Time in minutes, how long a previous read value is valid after reboot. diff --git a/param-docs/parameter-pages/TakeImage/Brightness.md b/param-docs/parameter-pages/TakeImage/Brightness.md index cf9862b..4b259bb 100644 --- a/param-docs/parameter-pages/TakeImage/Brightness.md +++ b/param-docs/parameter-pages/TakeImage/Brightness.md @@ -1,6 +1,8 @@ # Parameter `Brightness` Default Value: `0` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! This parameter can also be set on the Reference Image configuration. + Image Brightness (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/Contrast.md b/param-docs/parameter-pages/TakeImage/Contrast.md index 8ddbc10..f1b358e 100644 --- a/param-docs/parameter-pages/TakeImage/Contrast.md +++ b/param-docs/parameter-pages/TakeImage/Contrast.md @@ -1,8 +1,11 @@ # Parameter `Contrast` Default Value: `0` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! This parameter can also be set on the Reference Image configuration. + Image Contrast (`-2` .. `2`) + !!! Note Camera driver is not fully supporting this setting yet (no impact on image) diff --git a/param-docs/parameter-pages/TakeImage/FixedExposure.md b/param-docs/parameter-pages/TakeImage/FixedExposure.md index 4b665b8..f3c044c 100644 --- a/param-docs/parameter-pages/TakeImage/FixedExposure.md +++ b/param-docs/parameter-pages/TakeImage/FixedExposure.md @@ -1,6 +1,8 @@ # Parameter `FixedExposure` Default Value: `false` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Fixes the illumination setting of camera at the startup and uses this later --> individual round is faster. diff --git a/param-docs/parameter-pages/TakeImage/ImageQuality.md b/param-docs/parameter-pages/TakeImage/ImageQuality.md index b5cb038..6968ca6 100644 --- a/param-docs/parameter-pages/TakeImage/ImageQuality.md +++ b/param-docs/parameter-pages/TakeImage/ImageQuality.md @@ -1,7 +1,10 @@ # Parameter `ImageQuality` Default Value: `12` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Quality index for pictures. `0` (high) .. `63` (low) + !!! Warning Values below `12` can result in reboots as the image gets larger and might no longer fit in the available RAM! diff --git a/param-docs/parameter-pages/TakeImage/ImageSize.md b/param-docs/parameter-pages/TakeImage/ImageSize.md index c2c6f3a..8f7c7d4 100644 --- a/param-docs/parameter-pages/TakeImage/ImageSize.md +++ b/param-docs/parameter-pages/TakeImage/ImageSize.md @@ -1,7 +1,9 @@ # Parameter `ImageSize` Default Value: `VGA` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Size of the camera picture. Available options: - `VGA` (640 x 480 pixel) diff --git a/param-docs/parameter-pages/TakeImage/LEDIntensity.md b/param-docs/parameter-pages/TakeImage/LEDIntensity.md index 391eba0..212d1f8 100644 --- a/param-docs/parameter-pages/TakeImage/LEDIntensity.md +++ b/param-docs/parameter-pages/TakeImage/LEDIntensity.md @@ -1,6 +1,8 @@ # Parameter `LEDIntensity` Default Value: `50` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! This parameter can also be set on the Reference Image configuration. + Set the Flash LED Intensity. diff --git a/param-docs/parameter-pages/TakeImage/RawImagesLocation.md b/param-docs/parameter-pages/TakeImage/RawImagesLocation.md index 1a3cee1..035a60c 100644 --- a/param-docs/parameter-pages/TakeImage/RawImagesLocation.md +++ b/param-docs/parameter-pages/TakeImage/RawImagesLocation.md @@ -1,5 +1,6 @@ # 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 do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/TakeImage/Saturation.md b/param-docs/parameter-pages/TakeImage/Saturation.md index f67a451..461164d 100644 --- a/param-docs/parameter-pages/TakeImage/Saturation.md +++ b/param-docs/parameter-pages/TakeImage/Saturation.md @@ -1,8 +1,11 @@ # Parameter `Saturation` Default Value: `0` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! This parameter can also be set on the Reference Image configuration. + Image Saturation (`-2` .. `2`) + !!! Note Camera driver is not fully supporting this setting yet (no impact on image)! diff --git a/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md b/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md index 3f6e368..b4e0827 100644 --- a/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md +++ b/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md @@ -1,5 +1,7 @@ # Parameter `WaitBeforeTakingPicture` Default Value: `5` + !!! Warning This is an **Expert Parameter**! Only change it if you understand what it does! + Waiting time between switching illumination on and taking the picture (in seconds)- diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md index a8547ce..512b7b6 100644 --- a/param-docs/templates/overview.md +++ b/param-docs/templates/overview.md @@ -2,8 +2,12 @@ This page lists all available [Configuration](../Configuration) Parameters. If a parameter or section has a tick box on its left side, you can disable it. In such case the functionality gets disabled respectively the default values will be used. + !!! 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! + ## List of all Parameters + $TOC +
\ No newline at end of file