updated parameters

docs/Configuration.md

@@ -72,8 +72,3 @@ Details on the image recognition flow can be found in the other project here: ht
 
 The ```config.ini``` here has the same functionality and options, but a slightly different syntax due to a own written ini-parser is used. Migration see [here](outdated--Migrate-Old-Config-To-New-Config.md).
 
-
-
-### Integration into Home Assistant
-
-Thanks to the help of the user @deadly667 here are some hints for the integration into the home assistant: [[Integration-Home-Assistant]]

docs/MQTT-API.md

@@ -15,6 +15,7 @@ The following parameters have to be defined:
 
 ### Status
 `MainTopic`/{status topic}, e.g. `watermeter/status`
+
 * #### Connection
 
 * #### Interval

param-docs/expert-params.txt

@@ -21,6 +21,7 @@ IO4
 IO12
 IO13
 AutoStart
-AutoStart
 Hostname
 RSSIThreashold
+TimeServer
+FlipImageSize

param-docs/parameter-pages/Alignment/FlipImageSize.md

@@ -1,11 +1,13 @@
 # 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!
 
 ## Description
-Please fill me with an explanation and useful links
+This parameter can be used to rotate the viewport together with the alignment rotation:
 
+![](img/flipImageSize.png)  

param-docs/parameter-pages/Analog/LogImageLocation.md

@@ -5,3 +5,6 @@ Default Value: `/log/analog`
 ## Description
 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 support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!
+

param-docs/parameter-pages/AutoTimer/AutoStart.md

@@ -4,8 +4,9 @@ Default Value: `true`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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).

param-docs/parameter-pages/AutoTimer/Intervall.md

@@ -1,10 +1,6 @@
 # Parameter `Intervall`
 Default Value: `5`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Interval in minutes in which the Flow (Digitization Round) is run.
-
+If a rund takes longer than this interval, the next round gets postponed until the current round completes.

param-docs/parameter-pages/DataLogging/DataLogActive.md

@@ -1,10 +1,8 @@
 # Parameter `DataLogActive`
 Default Value: `true`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Activate data logging to SD-Card.
 
+!!! Warning
+    A SD-Card has limited write cycles. Since the device does not support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md

@@ -4,7 +4,5 @@ Default Value: `3`
 
 
 
-
 ## Description
-Please fill me with an explanation and useful links
+Number of days to keep the data files (`0` = forever).
-

param-docs/parameter-pages/Debug/Logfile.md

@@ -1,10 +1,18 @@
 # Parameter `Logfile`
-Default Value: `1`
+Default Value: `1` (`ERROR`)
-
-
-
-
 
 ## Description
-Please fill me with an explanation and useful links
+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 support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

param-docs/parameter-pages/Debug/LogfileRetentionInDays.md

@@ -1,10 +1,5 @@
 # Parameter `LogfileRetentionInDays`
 Default Value: `3`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Number of days to keep the log files (`0` = forever).
-

param-docs/parameter-pages/Digits/LogImageLocation.md

@@ -4,3 +4,5 @@ Default Value: `/log/digit`
 ## Description
 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 support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

param-docs/parameter-pages/GPIO/IO0.md

@@ -4,8 +4,19 @@ Default Value: `input disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 0 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 0 enable HTTP`: Enable HTTP write/read
+- `GPIO 0 name`: MQTT topic name (empty = `GPIO0`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/IO1.md

@@ -4,8 +4,17 @@ Default Value: `input disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 1 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 1 enable HTTP`: Enable HTTP write/read
+- `GPIO 1 name`: MQTT topic name (empty = `GPIO1`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/IO12.md

@@ -4,8 +4,17 @@ Default Value: `input-pullup disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 12 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 12 enable HTTP`: Enable HTTP write/read
+- `GPIO 12 name`: MQTT topic name (empty = `GPIO12`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/IO13.md

@@ -4,8 +4,17 @@ Default Value: `input-pullup disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 13 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 13 enable HTTP`: Enable HTTP write/read
+- `GPIO 13 name`: MQTT topic name (empty = `GPIO13`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/IO3.md

@@ -4,8 +4,17 @@ Default Value: `input disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 3 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 3 enable HTTP`: Enable HTTP write/read
+- `GPIO 3 name`: MQTT topic name (empty = `GPIO3`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/IO4.md

@@ -4,8 +4,18 @@ Default Value: `built-in-led disabled 10 false false`
 !!! Warning
     This is an **Expert Parameter**! Only change it if you understand what it does!
 
-
-
 ## Description
-Please fill me with an explanation and useful links
+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
+- `GPIO 4 enable MQTT`: Enable MQTT publishing/subscribing
+- `GPIO 4 enable HTTP`: Enable HTTP write/read
+- `GPIO 4 name`: MQTT topic name (empty = `GPIO4`). Allowed characters: `a-z, A-Z, 0-9, _, -`.

param-docs/parameter-pages/GPIO/LEDColor.md

@@ -1,10 +1,6 @@
 # Parameter `LEDColor`
 Default Value: `150 150 150`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Color of the attached LEDs to GPIO12 in (R)ed, (G)reen (B)lue from `0` (full off) .. `255` (full on). 
-
+(See `IO12` parameter).

param-docs/parameter-pages/GPIO/LEDNumbers.md

@@ -1,10 +1,5 @@
 # Parameter `LEDNumbers`
 Default Value: `2`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Number of LEDs on the external LED-stripe attached to GPIO12 (See `IO12` parameter).
-

param-docs/parameter-pages/GPIO/LEDType.md

@@ -1,10 +1,5 @@
 # Parameter `LEDType`
 Default Value: `WS2812`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Type of the `WS2812x` which is connected to GPIO12 (See `IO12` parameter).
-

param-docs/parameter-pages/InfluxDB/Database.md

@@ -1,10 +1,5 @@
 # Parameter `Database`
 Default Value: ``
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Name of the Database into which to publish the values.
-

param-docs/parameter-pages/InfluxDB/Measurement.md

@@ -1,10 +1,5 @@
 # Parameter `Measurement`
 Default Value: `undefined`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Name of the Measurement to use to publish the value.
-

param-docs/parameter-pages/InfluxDB/Uri.md

@@ -1,10 +1,8 @@
 # Parameter `Uri`
 Default Value: `undefined`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. `http://IP-Address:Port`.
 
+!!! Note
+    Currently only InfluxDB v1 is supported!

param-docs/parameter-pages/InfluxDB/password.md

@@ -1,10 +1,8 @@
 # Parameter `password`
 Default Value: `undefined`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Password for the InfluxDB v1 authentication.
 
+!!! Note
+    Currently only InfluxDB v1 is supported!

param-docs/parameter-pages/InfluxDB/user.md

@@ -1,10 +1,9 @@
 # Parameter `user`
 Default Value: `undefined`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Username for the InfluxDB v1 authentication.
+
+!!! Note
+    Currently only InfluxDB v1 is supported!
 

param-docs/parameter-pages/MQTT/ClientID.md

@@ -1,10 +1,7 @@
 # Parameter `ClientID`
 Default Value: `watermeter`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+ClientID to connect to the MQTT broker.
 
+If disabled, the `hostname` will be used.

param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md

@@ -1,10 +1,7 @@
 # Parameter `HomeassistantDiscovery`
 Default Value: `true`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Enable or disable the Homeassistant Discovery.
 
+See [here](../Integration-Home-Assistant) for details about the discovery.

param-docs/parameter-pages/MQTT/MainTopic.md

@@ -1,10 +1,16 @@
 # Parameter `MainTopic`
 Default Value: `watermeter`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+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.
+
 

param-docs/parameter-pages/MQTT/MeterType.md

@@ -1,10 +1,12 @@
 # Parameter `MeterType`
 Default Value: `other`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+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`!

param-docs/parameter-pages/MQTT/SetRetainFlag.md

@@ -1,10 +1,6 @@
 # Parameter `SetRetainFlag`
 Default Value: `true`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Enable or disable the retain flag for all MQTT entries.
 

param-docs/parameter-pages/MQTT/Uri.md

@@ -1,10 +1,5 @@
 # Parameter `Uri`
 Default Value: `mqtt://IP-ADRESS:1883`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+URI to the MQTT broker including the port. E.g. `mqtt://IP-Address:Port`.
-

param-docs/parameter-pages/MQTT/password.md

@@ -1,10 +1,6 @@
 # Parameter `password`
 Default Value: `PASSWORD`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Password for MQTT authentication.
 

param-docs/parameter-pages/MQTT/user.md

@@ -1,10 +1,5 @@
 # Parameter `user`
 Default Value: `USERNAME`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+Username for MQTT authentication.
-

param-docs/parameter-pages/MakeImage/Brightness.md

@@ -3,6 +3,7 @@ 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.
 
 ## Description
 Image Brightness (`-2` .. `2`) 

param-docs/parameter-pages/MakeImage/Contrast.md

@@ -3,9 +3,10 @@ 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.
 
 ## Description
 Image Contrast (`-2` .. `2`)
+
 !!! Note
     Camera driver is not fully supporting this setting yet (no impact on image) 
-

param-docs/parameter-pages/MakeImage/LEDIntensity.md

@@ -3,9 +3,7 @@ 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.
-
 
 ## Description
-Please fill me with an explanation and useful links
+Set the Flash LED Intensity.
-

param-docs/parameter-pages/MakeImage/LogImageLocation.md

@@ -3,3 +3,6 @@ Default Value: `/log/source`
 
 ## Description
 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 support [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card!

param-docs/parameter-pages/MakeImage/Saturation.md

@@ -3,10 +3,10 @@ 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.
 
 ## Description
 Image Saturation (`-2` .. `2`)
+
 !!! Note
     Camera driver is not fully supporting this setting yet (no impact on image)!
-
-

param-docs/parameter-pages/PostProcessing/<NUMBER>.DecimalShift.md

@@ -4,4 +4,3 @@ Default Value: `0`
 ## Description
 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.
-

param-docs/parameter-pages/PostProcessing/<NUMBER>.IgnoreLeadingNaN.md

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

param-docs/parameter-pages/System/AutoAdjustSummertime.md

@@ -1,8 +1,6 @@
 # Parameter `AutoAdjustSummertime`
 Default Value: `false`
 
-
-
 !!! Note
     This parameter is not accessible through the Web Interface Configuration Page!
 

param-docs/parameter-pages/System/Hostname.md

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

param-docs/parameter-pages/System/RSSIThreashold.md

@@ -0,0 +1,10 @@
+# Parameter `RSSIThreashold`
+Default Value: ``
+
+## Description
+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.
+
+!!! Note
+    Due to a typo, the parameter is wrongly named `RSSIThreashold`.

param-docs/parameter-pages/System/SetupMode.md

@@ -1,11 +1,8 @@
 # Parameter `SetupMode`
 Default Value: `true`
 
-
-
 !!! Note
     This parameter is not accessible through the Web Interface Configuration Page!
 
 ## Description
-Please fill me with an explanation and useful links
+Set this parameter to `true` to stay in the Setup Mode after the next start of the device.
-

param-docs/parameter-pages/System/TimeServer.md

@@ -1,10 +1,11 @@
 # Parameter `TimeServer`
 Default Value: `pool.ntp.org`
 
-
+!!! Warning
-
+    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 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 (`""`).
+In such case the time always starts at `01.01.1970` after each power cycle!

param-docs/parameter-pages/System/TimeZone.md

@@ -1,10 +1,6 @@
 # Parameter `TimeZone`
 Default Value: `CET-1CEST,M3.5.0,M10.5.0/3`
 
-
-
-
-
 ## Description
-Please fill me with an explanation and useful links
+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.

param-docs/templates/overview.md

@@ -7,4 +7,8 @@ In such case the functionality gets disabled respectively the default values wil
 !!! 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!
 
+!!! Note
+    Due to a typo, one of the sections is called `MakeImage` instead of `TakeImage`!
+    For backwards compatibility, this did not get changed.
+
 ---