This commit is contained in:
CaCO3
2023-02-20 23:29:45 +01:00
parent 864cbe61be
commit 2eb8f6fb0f
74 changed files with 2 additions and 178 deletions

View File

@@ -1,13 +1,9 @@
# Parameter `AlignmentAlgo`
Default Value: `Default`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Algorithm used for the alignment step.
Available options:
- `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

View File

@@ -1,12 +1,8 @@
# Parameter `FlipImageSize`
Default Value: `false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
!!! Note
This parameter is not accessible through the Web Interface Configuration Page!
This parameter can be used to rotate the viewport together with the alignment rotation:
![](../img/flipImageSize.png)

View File

@@ -1,10 +1,6 @@
# Parameter `InitialMirror`
Default Value: `false`
!!! Note
This parameter is not accessible through the Web Interface Configuration Page!
Please fill me with an explanation and useful links

View File

@@ -1,10 +1,6 @@
# Parameter `InitialRotate`
Default Value: `179`
!!! Note
This parameter is not accessible through the Web Interface Configuration Page!
Please fill me with an explanation and useful links

View File

@@ -1,7 +1,5 @@
# Parameter `SearchFieldX`
Default Value: `20`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
`x` size (width) in which the reference is searched.
X-size (width) in which the reference is searched.

View File

@@ -1,8 +1,5 @@
# Parameter `SearchFieldY`
Default Value: `20`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
`y` size (height) in which the reference is searched.
Y-size (height) in which the reference is searched.

View File

@@ -1,10 +1,7 @@
# Parameter `CNNGoodThreshold`
Default Value: `0.5`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Threshold above which the classification should be to accept the value (only meaningful for digits).
!!! Warning
This is only supported for the `ana-class100` models!

View File

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

View File

@@ -1,4 +1,3 @@
# Parameter `Model`
Default Value: `/config/ana-cont_11.3.1_s2.tflite`
Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details.

View File

@@ -1,9 +1,6 @@
# 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 do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

View File

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

View File

@@ -1,11 +1,8 @@
# 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,4 @@
# 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.

View File

@@ -2,6 +2,4 @@
Default Value: `3`
Number of days to keep the data files (`0` = forever).

View File

@@ -1,7 +1,5 @@
# 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

@@ -1,17 +1,12 @@
# Parameter `LogLevel`
Default Value: `1` (`ERROR`)
Define the log level for the logging to the SD-Card.
Available options:
- `1`: `ERROR`
- `2`: `WARNING`
- `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,4 +1,3 @@
# Parameter `LogfilesRetention`
Default Value: `3`
Number of days to keep the log files (`0` = forever).

View File

@@ -1,10 +1,7 @@
# Parameter `CNNGoodThreshold`
Default Value: `0.5`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Threshold above which the classification should be to accept the value (only meaningful for digits).
!!! Warning
This is only supported for the `dig-class100` models!

View File

@@ -1,4 +1,3 @@
# Parameter `Model`
Default Value: `/config/dig-cont_0600_s3.tflite`
Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details.

View File

@@ -1,7 +1,5 @@
# 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 do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

View File

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

View File

@@ -1,18 +1,13 @@
# Parameter `IO0`
Default Value: `input disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO0` pin.
!!! Warning
This pin is only usable with restrictions!
It must be disabled when the camera is used.
Additionally, it is used to activate Bootloader mode and must therefore be HIGH after a reset!
Parameters:
- `GPIO 0 state`: One of `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 0 use interrupt`: Enable interrupt trigger
- `GPIO 0 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,16 +1,11 @@
# Parameter `IO1`
Default Value: `input disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO1` pin.
!!! Warning
This pin is by default used for the serial communication as TX pin (USB logging)!
Parameters:
- `GPIO 1 state`: One of `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 1 use interrupt`: Enable interrupt trigger
- `GPIO 1 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,16 +1,11 @@
# Parameter `IO12`
Default Value: `input-pullup disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO12` pin.
!!! Note
This pin is usable without known restrictions!
Parameters:
- `GPIO 12 state`: One of `external-flash-ws281x`, `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 12 use interrupt`: Enable interrupt trigger
- `GPIO 12 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,16 +1,11 @@
# Parameter `IO13`
Default Value: `input-pullup disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO13` pin.
!!! Note
This pin is usable without known restrictions!
Parameters:
- `GPIO 13 state`: One of `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 13 use interrupt`: Enable interrupt trigger
- `GPIO 13 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,16 +1,11 @@
# Parameter `IO3`
Default Value: `input disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO3` pin.
!!! Warning
This pin is by default used for the serial communication as RX pin (USB logging)!
Parameters:
- `GPIO 3 state`: One of `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 3 use interrupt`: Enable interrupt trigger
- `GPIO 3 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,17 +1,12 @@
# Parameter `IO4`
Default Value: `built-in-led disabled 10 false false`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
This parameter can be used to configure the GPIO `IO4` pin.
!!! Warning
This pin is only usable with restrictions!
By default, it is used for build-in flash light (onboard LED).
Parameters:
- `GPIO 4 state`: One of `built-in-led`, `input`, `input pullup`, `input pulldown` or `output`.
- `GPIO 4 use interrupt`: Enable interrupt trigger
- `GPIO 4 PWM duty resolution`: LEDC PWM duty resolution in bit

View File

@@ -1,5 +1,4 @@
# Parameter `LEDColor`
Default Value: `150 150 150`
Color of the attached LEDs to GPIO12 in (R)ed, (G)reen (B)lue from `0` (full off) .. `255` (full on).
(See `IO12` parameter).

View File

@@ -1,4 +1,3 @@
# Parameter `LEDNumbers`
Default Value: `2`
Number of LEDs on the external LED-stripe attached to GPIO12 (See `IO12` parameter).

View File

@@ -1,4 +1,3 @@
# Parameter `LEDType`
Default Value: `WS2812`
Type of the `WS2812x` which is connected to GPIO12 (See `IO12` parameter).

View File

@@ -1,10 +1,6 @@
# Parameter `MainTopicMQTT`
Default Value: `wasserzaehler/GPIO`
!!! Note
This parameter is not accessible through the Web Interface Configuration Page!
Please fill me with an explanation and useful links

View File

@@ -1,4 +1,3 @@
# Parameter `Database`
Default Value: `''`
Name of the Database into which to publish the values.

View File

@@ -1,4 +1,3 @@
# Parameter `Measurement`
Default Value: `undefined`
Name of the Measurement to use to publish the value.

View File

@@ -1,7 +1,5 @@
# Parameter `Uri`
Default Value: `undefined`
URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. `http://192.168.1.1:8086`.
!!! Note
Currently only InfluxDB v1 is supported!

View File

@@ -1,7 +1,5 @@
# Parameter `password`
Default Value: `undefined`
Password for the InfluxDB v1 authentication.
!!! Note
Currently only InfluxDB v1 is supported!

View File

@@ -1,8 +1,5 @@
# Parameter `user`
Default Value: `undefined`
Username for the InfluxDB v1 authentication.
!!! Note
Currently only InfluxDB v1 is supported!

View File

@@ -1,6 +1,4 @@
# Parameter `ClientID`
Default Value: `watermeter`
ClientID to connect to the MQTT broker.
If disabled, the `hostname` will be used.

View File

@@ -1,6 +1,4 @@
# Parameter `HomeassistantDiscovery`
Default Value: `true`
Enable or disable the Homeassistant Discovery.
See [here](../Integration-Home-Assistant) for details about the discovery.

View File

@@ -1,15 +1,10 @@
# Parameter `MainTopic`
Default Value: `watermeter`
MQTT main topic, under which the counters are published.
The single value will be published with the following key: `MAINTOPIC/NUMBER/RESULT_TOPIC` where:
- `NUMBER` is the name of the value (a meter might have more than one value).
The names get defined in the analog and digital ROI configuration (defaults to `main`).
- `RESULT_TOPIC` can be one of `value`, `rate`, `timestamp`, `error`, ....
The general connection status can be found in `MAINTOPIC/CONNECTION`.
See [MQTT Result Topics](../MQTT-API#result) for a full list of topics.

View File

@@ -1,11 +1,8 @@
# Parameter `MeterType`
Default Value: `other`
Select the Meter Type so the sensors have the right units in Homeassistant.
!!! Note
For `Watermeter` you need to have Homeassistant 2022.11 or newer!
Please also make sure that the selected Meter Type matches the dimension of the value provided by the meter!
Eg. if your meter provides `m³`, you need to also set it to `m³`.
Alternatively you can set the parameter `DecimalShift` to `3` so the value is converted to `liters`!

View File

@@ -1,5 +1,3 @@
# 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.

View File

@@ -1,4 +1,3 @@
# Parameter `Uri`
Default Value: `mqtt://IP-ADRESS:1883`
URI to the MQTT broker including the port. E.g. `mqtt://192.168.1.1:1883`.

View File

@@ -1,5 +1,3 @@
# Parameter `password`
Default Value: `PASSWORD`
Password for MQTT authentication.

View File

@@ -1,4 +1,3 @@
# Parameter `user`
Default Value: `USERNAME`
Username for MQTT authentication.

View File

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

View File

@@ -1,9 +1,6 @@
# 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,8 +1,6 @@
# 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,7 +1,5 @@
# 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,6 +1,5 @@
# Parameter `<NUMBER>.AnalogDigitalTransitionStart`
Default Value: `9.2`
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.

View File

@@ -1,5 +1,4 @@
# Parameter `<NUMBER>.DecimalShift`
Default Value: `0`
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.

View File

@@ -1,7 +1,5 @@
# 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,8 +1,5 @@
# Parameter `<NUMBER>.IgnoreLeadingNaN`
Default Value: `true`
Leading `N`'s will be deleted before further processing.
This is only relevant for models which use `N`!
See [here](../Choosing-the-Model) for details.

View File

@@ -1,5 +1,4 @@
# Parameter `<NUMBER>.MaxRateType`
Default Value: `AbsoluteChange`
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).

View File

@@ -1,6 +1,4 @@
# Parameter `<NUMBER>.MaxRateValue`
Default Value: `0.05`
Maximum change of a reading.
Depending on the settings of `<NUMBER>.MaxRateType` it is either treated as `absolute` or `relative`!

View File

@@ -1,7 +1,5 @@
# 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,5 +1,4 @@
# Parameter `PreValueUse`
Default Value: `true`
Use the previous value (value from previous round) for consistency checks.
This also works through a reboot of the device!

View File

@@ -1,8 +1,6 @@
# Parameter `Hostname`
Default Value: `undefined`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Hostname for the device.
It gets automatically transferred to `/wlan.ini` on the SD-Card at next startup.

View File

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

View File

@@ -1,7 +1,5 @@
# Parameter `SetupMode`
Default Value: `true`
!!! Note
This parameter is not accessible through the Web Interface Configuration Page!
Set this parameter to `true` to stay in the Setup Mode after the next start of the device.

View File

@@ -1,9 +1,7 @@
# Parameter `TimeServer`
Default Value: `pool.ntp.org`
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Time server to synchronize system time. If it is disabled or `undefined`, `pool.ntp.org` will be used.
You can also set it to the IP of your router. Many routers like Fritzboxes can act as a local NTP server.
To disable NTP, you need to activate it but set the TimeServer config to be empty (`""`).

View File

@@ -1,5 +1,4 @@
# Parameter `TimeZone`
Default Value: `CET-1CEST,M3.5.0,M10.5.0/3`
Time zone in POSIX syntax (Europe/Berlin = `CET-1CEST,M3.5.0,M10.5.0/3` - incl. daylight saving)
Check the table on `http://<DEVICE IP>/timezones.html` to find the settings for your region.

View File

@@ -1,8 +1,6 @@
# 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,11 +1,8 @@
# 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,5 @@
# Parameter `Demo`
Default Value: `false`
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.

View File

@@ -1,9 +1,6 @@
# 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,9 +1,7 @@
# 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,11 +1,8 @@
# 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)
- `QVGA` (320 x 240 pixel)

View File

@@ -1,8 +1,6 @@
# 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,7 +1,5 @@
# 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,4 +1,3 @@
# Parameter `RawImagesRetention`
Default Value: `15`
Number of days to keep the raw images (`0` = forever)

View File

@@ -1,11 +1,8 @@
# 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,7 +1,5 @@
# 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

@@ -1,13 +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!
## List of all Parameters
$TOC
<hr style="border:2px solid">

View File

@@ -1,8 +1,5 @@
# Parameter `$NAME`
Default Value: `$DEFAULT`
$EXPERT_PARAMETER
$HIDDEN_IN_UI
Please fill me with an explanation and useful links.