This commit is contained in:
CaCO3
2023-02-20 23:40:53 +01:00
parent 39da2f8679
commit 57f79414b1
23 changed files with 48 additions and 1 deletions

View File

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

View File

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

View File

@@ -1,3 +1,6 @@
# Parameter `ROIImagesRetention`
Default Value: `3`
Unit: Days
Days to keep the separated analog images (`0` = forever).

View File

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

View File

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

View File

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

View File

@@ -1,3 +1,6 @@
# Parameter `ROIImagesRetention`
Default Value: `3`
Unit: Days
Days to keep the separated digit images (`0` = forever).

View File

@@ -1,4 +1,5 @@
# Parameter `AllowNegativeRates`
!!! Warning
This parameter is unused!
Use [`NUMBER.AllowNegativeRates`](../Parameters/#PostProcessing-NUMBER.AllowNegativeRates) instead!

View File

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

View File

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

View File

@@ -1,5 +1,6 @@
# Parameter `<NUMBERS>.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!

View File

@@ -1,5 +1,6 @@
# Parameter `<NUMBER>.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.

View File

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

View File

@@ -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`)

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -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)!

View File

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

View File

@@ -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
<hr style="border:2px solid">