From 80af3abe3d57676461b54ebc8c7dd390711b9694 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Sat, 4 Feb 2023 22:46:05 +0100 Subject: [PATCH] update param config --- param-docs/generate-param-doc-pages.py | 2 +- param-docs/parameter-pages/Alignment/AlignmentAlgo.md | 9 +++++---- param-docs/parameter-pages/Alignment/SearchFieldX.md | 7 ++----- param-docs/parameter-pages/Alignment/SearchFieldY.md | 6 ++---- param-docs/parameter-pages/Analog/CNNGoodThreshold.md | 8 ++++---- param-docs/parameter-pages/Analog/LogImageLocation.md | 5 +---- .../parameter-pages/Analog/LogfileRetentionInDays.md | 7 +------ param-docs/parameter-pages/Analog/Model.md | 7 +------ param-docs/parameter-pages/AutoTimer/AutoStart.md | 2 +- param-docs/parameter-pages/Digits/CNNGoodThreshold.md | 8 ++++---- param-docs/parameter-pages/Digits/LogImageLocation.md | 6 +----- .../parameter-pages/Digits/LogfileRetentionInDays.md | 6 +----- param-docs/parameter-pages/Digits/Model.md | 7 +------ param-docs/parameter-pages/GPIO/IO0.md | 2 +- param-docs/parameter-pages/GPIO/IO1.md | 2 +- param-docs/parameter-pages/GPIO/IO12.md | 2 +- param-docs/parameter-pages/GPIO/IO13.md | 2 +- param-docs/parameter-pages/GPIO/IO3.md | 2 +- param-docs/parameter-pages/GPIO/IO4.md | 2 +- param-docs/parameter-pages/MakeImage/Brightness.md | 7 ++----- param-docs/parameter-pages/MakeImage/Contrast.md | 8 ++++---- param-docs/parameter-pages/MakeImage/Demo.md | 11 ++++------- param-docs/parameter-pages/MakeImage/FixedExposure.md | 7 +++---- param-docs/parameter-pages/MakeImage/ImageQuality.md | 9 ++++----- param-docs/parameter-pages/MakeImage/ImageSize.md | 9 +++++---- param-docs/parameter-pages/MakeImage/LEDIntensity.md | 2 +- .../parameter-pages/MakeImage/LogImageLocation.md | 7 +------ .../MakeImage/LogfileRetentionInDays.md | 7 +------ param-docs/parameter-pages/MakeImage/Saturation.md | 9 +++++---- .../MakeImage/WaitBeforeTakingPicture.md | 7 ++----- .../.AnalogDigitalTransitionStart.md | 10 ++++------ .../PostProcessing/.DecimalShift.md | 7 ++----- .../PostProcessing/.ExtendedResolution.md | 7 +------ .../PostProcessing/.IgnoreLeadingNaN.md | 7 ++----- .../PostProcessing/.MaxRateType.md | 8 ++------ .../PostProcessing/.MaxRateValue.md | 7 ++----- .../PostProcessing/.AllowNegativeRates.md | 8 ++++++++ .../PostProcessing/CheckDigitIncreaseConsistency.md | 7 +++---- .../parameter-pages/PostProcessing/ErrorMessage.md | 8 +++----- .../PostProcessing/PreValueAgeStartup.md | 7 ++----- .../parameter-pages/PostProcessing/PreValueUse.md | 8 ++------ param-docs/parameter-pages/System/Hostname.md | 2 +- param-docs/templates/overview.md | 5 ++++- 43 files changed, 99 insertions(+), 167 deletions(-) create mode 100644 param-docs/parameter-pages/PostProcessing/.AllowNegativeRates.md diff --git a/param-docs/generate-param-doc-pages.py b/param-docs/generate-param-doc-pages.py index b936912..5f41dae 100644 --- a/param-docs/generate-param-doc-pages.py +++ b/param-docs/generate-param-doc-pages.py @@ -83,7 +83,7 @@ for section in config: content = content.replace("$DEFAULT", value) if parameter in expertParameters: - content = content.replace("$EXPERT_PARAMETER", "!!! Warning\n This is an expert parameter!") # Note: Needs a 4 whitespace Intent! + content = content.replace("$EXPERT_PARAMETER", "!!! Warning\n This is an **Expert Parameter**! Only change it if you understand what it does!") # Note: Needs a 4 whitespace Intent! else: content = content.replace("$EXPERT_PARAMETER", "") diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md index c66e035..bfff8af 100644 --- a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md +++ b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md @@ -2,10 +2,11 @@ Default Value: `Default` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +Algorithm used for the alignment step. +- `Default`: Use only red color channel +- `HighAccuracy`: Use all 3 color Channels (3x slower) +- `Fast`: First time use `HighAccuracy`, then only check if the image is shifted diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md index 6ffc029..ea0f1ef 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldX.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldX.md @@ -2,10 +2,7 @@ Default Value: `20` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +`x` size (width) in which the reference is searched. diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md index 0301ae3..23554eb 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldY.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldY.md @@ -2,10 +2,8 @@ Default Value: `20` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +`y` size (height) in which the reference is searched. diff --git a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md index aa41390..38404c8 100644 --- a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md +++ b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md @@ -2,10 +2,10 @@ Default Value: `0.5` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +Threshold above which the classification should be to accept the value (only meaningful for digits). +!!! Warning + EXPERIMENTAL - NOT WORKING FOR ALL CNNs! diff --git a/param-docs/parameter-pages/Analog/LogImageLocation.md b/param-docs/parameter-pages/Analog/LogImageLocation.md index 48039d0..08f5b2b 100644 --- a/param-docs/parameter-pages/Analog/LogImageLocation.md +++ b/param-docs/parameter-pages/Analog/LogImageLocation.md @@ -2,9 +2,6 @@ Default Value: `/log/analog` - - - ## Description -Please fill me with an explanation and useful links +Location to store separated analog images on the SD-Card for logging. diff --git a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md b/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md index e1a3ba5..218ea5c 100644 --- a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md @@ -1,10 +1,5 @@ # Parameter `LogfileRetentionInDays` Default Value: `3` - - - - ## Description -Please fill me with an explanation and useful links - +Days to keep the separated analog images (`0` = forever). diff --git a/param-docs/parameter-pages/Analog/Model.md b/param-docs/parameter-pages/Analog/Model.md index 98ee24d..301e8e5 100644 --- a/param-docs/parameter-pages/Analog/Model.md +++ b/param-docs/parameter-pages/Analog/Model.md @@ -1,10 +1,5 @@ # Parameter `Model` Default Value: `/config/ana-cont_11.3.1_s2.tflite` - - - - ## Description -Please fill me with an explanation and useful links - +Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/AutoTimer/AutoStart.md b/param-docs/parameter-pages/AutoTimer/AutoStart.md index c1bfec1..4389509 100644 --- a/param-docs/parameter-pages/AutoTimer/AutoStart.md +++ b/param-docs/parameter-pages/AutoTimer/AutoStart.md @@ -2,7 +2,7 @@ Default Value: `true` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md index aa41390..38404c8 100644 --- a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md +++ b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md @@ -2,10 +2,10 @@ Default Value: `0.5` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +Threshold above which the classification should be to accept the value (only meaningful for digits). +!!! Warning + EXPERIMENTAL - NOT WORKING FOR ALL CNNs! diff --git a/param-docs/parameter-pages/Digits/LogImageLocation.md b/param-docs/parameter-pages/Digits/LogImageLocation.md index 2dfda72..b0f7998 100644 --- a/param-docs/parameter-pages/Digits/LogImageLocation.md +++ b/param-docs/parameter-pages/Digits/LogImageLocation.md @@ -1,10 +1,6 @@ # Parameter `LogImageLocation` Default Value: `/log/digit` - - - - ## Description -Please fill me with an explanation and useful links +Location to store separated digit images on the SD-Card for logging. diff --git a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md b/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md index e1a3ba5..f111dc3 100644 --- a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md @@ -1,10 +1,6 @@ # Parameter `LogfileRetentionInDays` Default Value: `3` - - - - ## Description -Please fill me with an explanation and useful links +Days to keep the separated digit images (`0` = forever). diff --git a/param-docs/parameter-pages/Digits/Model.md b/param-docs/parameter-pages/Digits/Model.md index 442cf75..a76c4a1 100644 --- a/param-docs/parameter-pages/Digits/Model.md +++ b/param-docs/parameter-pages/Digits/Model.md @@ -1,10 +1,5 @@ # Parameter `Model` Default Value: `/config/dig-cont_0600_s3.tflite` - - - - ## Description -Please fill me with an explanation and useful links - +Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/GPIO/IO0.md b/param-docs/parameter-pages/GPIO/IO0.md index ff5d73d..6f1882f 100644 --- a/param-docs/parameter-pages/GPIO/IO0.md +++ b/param-docs/parameter-pages/GPIO/IO0.md @@ -2,7 +2,7 @@ Default Value: `input disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/GPIO/IO1.md b/param-docs/parameter-pages/GPIO/IO1.md index 9dffdf5..9262eca 100644 --- a/param-docs/parameter-pages/GPIO/IO1.md +++ b/param-docs/parameter-pages/GPIO/IO1.md @@ -2,7 +2,7 @@ Default Value: `input disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/GPIO/IO12.md b/param-docs/parameter-pages/GPIO/IO12.md index 1c1b080..70d392a 100644 --- a/param-docs/parameter-pages/GPIO/IO12.md +++ b/param-docs/parameter-pages/GPIO/IO12.md @@ -2,7 +2,7 @@ Default Value: `input-pullup disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/GPIO/IO13.md b/param-docs/parameter-pages/GPIO/IO13.md index 751dcb9..af04781 100644 --- a/param-docs/parameter-pages/GPIO/IO13.md +++ b/param-docs/parameter-pages/GPIO/IO13.md @@ -2,7 +2,7 @@ Default Value: `input-pullup disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/GPIO/IO3.md b/param-docs/parameter-pages/GPIO/IO3.md index cd06e25..efb6281 100644 --- a/param-docs/parameter-pages/GPIO/IO3.md +++ b/param-docs/parameter-pages/GPIO/IO3.md @@ -2,7 +2,7 @@ Default Value: `input disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/GPIO/IO4.md b/param-docs/parameter-pages/GPIO/IO4.md index e2abbd5..25a0f0e 100644 --- a/param-docs/parameter-pages/GPIO/IO4.md +++ b/param-docs/parameter-pages/GPIO/IO4.md @@ -2,7 +2,7 @@ Default Value: `built-in-led disabled 10 false false` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/MakeImage/Brightness.md b/param-docs/parameter-pages/MakeImage/Brightness.md index 58b5fe0..698937f 100644 --- a/param-docs/parameter-pages/MakeImage/Brightness.md +++ b/param-docs/parameter-pages/MakeImage/Brightness.md @@ -2,10 +2,7 @@ Default Value: `0` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +Image Brightness (`-2` .. `2`) diff --git a/param-docs/parameter-pages/MakeImage/Contrast.md b/param-docs/parameter-pages/MakeImage/Contrast.md index dfb736a..4830bd8 100644 --- a/param-docs/parameter-pages/MakeImage/Contrast.md +++ b/param-docs/parameter-pages/MakeImage/Contrast.md @@ -2,10 +2,10 @@ Default Value: `0` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +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/MakeImage/Demo.md b/param-docs/parameter-pages/MakeImage/Demo.md index ceea6b7..688c753 100644 --- a/param-docs/parameter-pages/MakeImage/Demo.md +++ b/param-docs/parameter-pages/MakeImage/Demo.md @@ -1,10 +1,7 @@ # Parameter `Demo` -Default Value: `true` - - - - +Default Value: `false` ## Description -Please fill me with an explanation and useful links - +Enable to use demo images instead of the real camera images. +Make sure to have a `/demo` folder on your SD-Card and it contains the expected files! +Check [here](../Demo-Mode) for details. diff --git a/param-docs/parameter-pages/MakeImage/FixedExposure.md b/param-docs/parameter-pages/MakeImage/FixedExposure.md index a85593f..3df0ff4 100644 --- a/param-docs/parameter-pages/MakeImage/FixedExposure.md +++ b/param-docs/parameter-pages/MakeImage/FixedExposure.md @@ -2,10 +2,9 @@ Default Value: `false` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +Fixes the illumination setting of camera at the startup and uses this later --> +individual round is faster. diff --git a/param-docs/parameter-pages/MakeImage/ImageQuality.md b/param-docs/parameter-pages/MakeImage/ImageQuality.md index 75855b9..234fa40 100644 --- a/param-docs/parameter-pages/MakeImage/ImageQuality.md +++ b/param-docs/parameter-pages/MakeImage/ImageQuality.md @@ -2,10 +2,9 @@ Default Value: `12` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +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/MakeImage/ImageSize.md b/param-docs/parameter-pages/MakeImage/ImageSize.md index 65c3579..9134c26 100644 --- a/param-docs/parameter-pages/MakeImage/ImageSize.md +++ b/param-docs/parameter-pages/MakeImage/ImageSize.md @@ -2,10 +2,11 @@ Default Value: `VGA` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +Size of the camera picture. +Available options: +- `VGA` (640 x 480 pixel) +- `QVGA` (320 x 240 pixel) diff --git a/param-docs/parameter-pages/MakeImage/LEDIntensity.md b/param-docs/parameter-pages/MakeImage/LEDIntensity.md index 43b684b..c86e5bc 100644 --- a/param-docs/parameter-pages/MakeImage/LEDIntensity.md +++ b/param-docs/parameter-pages/MakeImage/LEDIntensity.md @@ -2,7 +2,7 @@ Default Value: `50` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/parameter-pages/MakeImage/LogImageLocation.md b/param-docs/parameter-pages/MakeImage/LogImageLocation.md index 71a3e95..a0fedac 100644 --- a/param-docs/parameter-pages/MakeImage/LogImageLocation.md +++ b/param-docs/parameter-pages/MakeImage/LogImageLocation.md @@ -1,10 +1,5 @@ # Parameter `LogImageLocation` Default Value: `/log/source` - - - - ## Description -Please fill me with an explanation and useful links - +Location on the SD-Card to store the raw images for logging. diff --git a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md b/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md index 9a64b83..227c7fc 100644 --- a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md +++ b/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md @@ -1,10 +1,5 @@ # Parameter `LogfileRetentionInDays` Default Value: `15` - - - - ## Description -Please fill me with an explanation and useful links - +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/MakeImage/Saturation.md index 15e6f12..abb8abd 100644 --- a/param-docs/parameter-pages/MakeImage/Saturation.md +++ b/param-docs/parameter-pages/MakeImage/Saturation.md @@ -2,10 +2,11 @@ Default Value: `0` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +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/MakeImage/WaitBeforeTakingPicture.md b/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md index 2c357b7..ba01a64 100644 --- a/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md +++ b/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md @@ -2,10 +2,7 @@ Default Value: `5` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +Waiting time between switching illumination on and taking the picture (in seconds)- diff --git a/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md b/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md index cbc5a63..bb1d173 100644 --- a/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md +++ b/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md @@ -1,10 +1,8 @@ # Parameter `.AnalogDigitalTransitionStart` Default Value: `9.2` - - - - ## Description -Please fill me with an explanation and useful links - +This can be used if you have wrong values, but the recognition of the individual ROIs are correct. +Look for the start of changing of the first digit and note the analog pointer value behind. +Set it here. Only used on combination of digits and analog pointers. +See [here](../Watermeter-specific-analog---digital-transition) for details. diff --git a/param-docs/parameter-pages/PostProcessing/.DecimalShift.md b/param-docs/parameter-pages/PostProcessing/.DecimalShift.md index 80de13e..b904cd1 100644 --- a/param-docs/parameter-pages/PostProcessing/.DecimalShift.md +++ b/param-docs/parameter-pages/PostProcessing/.DecimalShift.md @@ -1,10 +1,7 @@ # Parameter `.DecimalShift` Default Value: `0` - - - - ## Description -Please fill me with an explanation and useful links +Shift the decimal separator (positiv or negativ). +Eg. to move from 'm³' to 'liter' (1 m³ equals 1000 liters), you need to set it to +3. diff --git a/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md b/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md index 6039c2f..8ba58ef 100644 --- a/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md +++ b/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md @@ -1,10 +1,5 @@ # Parameter `.ExtendedResolution` Default Value: `false` - - - - ## Description -Please fill me with an explanation and useful links - +Use the decimal place of the last analog counter for increased accuracy. diff --git a/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md b/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md index 9dbcba4..60ef7ad 100644 --- a/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md +++ b/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md @@ -1,10 +1,7 @@ # Parameter `.IgnoreLeadingNaN` Default Value: `true` - - - - ## Description -Please fill me with an explanation and useful links +Leading `N`'s will be deleted before further processing. +This is only relevant for models which use `N`! diff --git a/param-docs/parameter-pages/PostProcessing/.MaxRateType.md b/param-docs/parameter-pages/PostProcessing/.MaxRateType.md index 6604f94..a611563 100644 --- a/param-docs/parameter-pages/PostProcessing/.MaxRateType.md +++ b/param-docs/parameter-pages/PostProcessing/.MaxRateType.md @@ -1,10 +1,6 @@ # Parameter `.MaxRateType` Default Value: `AbsoluteChange` - - - - ## Description -Please fill me with an explanation and useful links - +Defines if the **Change Rate** compared to the previous value is calculated as absolute change (`AbsoluteChange`) or +as rate normalized to the interval (`RateChange` = change/minute). diff --git a/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md b/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md index c94d8ee..3d86488 100644 --- a/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md +++ b/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md @@ -1,10 +1,7 @@ # Parameter `.MaxRateValue` Default Value: `0.05` - - - - ## Description -Please fill me with an explanation and useful links +Maximum change of a reading. +Depending on the settings of `.MaxRateType` it is either treated as `absolute` or `relative`! diff --git a/param-docs/parameter-pages/PostProcessing/.AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/.AllowNegativeRates.md new file mode 100644 index 0000000..1fdca3c --- /dev/null +++ b/param-docs/parameter-pages/PostProcessing/.AllowNegativeRates.md @@ -0,0 +1,8 @@ +# Parameter `.AllowNegativeRates` +Default Value: `false` + +## Description +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/CheckDigitIncreaseConsistency.md b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md index d45f679..432b8df 100644 --- a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md +++ b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md @@ -2,10 +2,9 @@ Default Value: `false` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links +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 c097fd4..1790254 100644 --- a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md +++ b/param-docs/parameter-pages/PostProcessing/ErrorMessage.md @@ -2,10 +2,8 @@ Default Value: `true` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +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/PreValueAgeStartup.md b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md index e284a06..670be86 100644 --- a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md +++ b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md @@ -2,10 +2,7 @@ Default Value: `720` !!! Warning - This is an expert parameter! - - + This is an **Expert Parameter**! Only change it if you understand what it does! ## Description -Please fill me with an explanation and useful links - +Time in minutes, how long a previous read value is valid after reboot. diff --git a/param-docs/parameter-pages/PostProcessing/PreValueUse.md b/param-docs/parameter-pages/PostProcessing/PreValueUse.md index 51f2b7d..9dc1655 100644 --- a/param-docs/parameter-pages/PostProcessing/PreValueUse.md +++ b/param-docs/parameter-pages/PostProcessing/PreValueUse.md @@ -1,10 +1,6 @@ # Parameter `PreValueUse` Default Value: `true` - - - - ## Description -Please fill me with an explanation and useful links - +Use the previous value (value from previous round) for consistency checks. +This also work through a reboot of the device! diff --git a/param-docs/parameter-pages/System/Hostname.md b/param-docs/parameter-pages/System/Hostname.md index 45e149b..09b3191 100644 --- a/param-docs/parameter-pages/System/Hostname.md +++ b/param-docs/parameter-pages/System/Hostname.md @@ -2,7 +2,7 @@ Default Value: `undefined` !!! Warning - This is an expert parameter! + This is an **Expert Parameter**! Only change it if you understand what it does! diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md index f1d575c..ef91fc2 100644 --- a/param-docs/templates/overview.md +++ b/param-docs/templates/overview.md @@ -1,6 +1,9 @@ # Parameters 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!