mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-07 03:57:00 +03:00
update param config
This commit is contained in:
@@ -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", "")
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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`)
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)!
|
||||
|
||||
|
||||
|
||||
@@ -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)-
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
# Parameter `<NUMBER>.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.
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
# Parameter `<NUMBER>.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.
|
||||
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
# Parameter `<NUMBER>.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.
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
# Parameter `<NUMBER>.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`!
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
# Parameter `<NUMBER>.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).
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
# Parameter `<NUMBER>.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 `<NUMBER>.MaxRateType` it is either treated as `absolute` or `relative`!
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# Parameter `<NUMBERS>.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!
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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, ...).
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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!
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user