diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md index 075ad60..9c066a2 100644 --- a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md +++ b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md @@ -1,7 +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 diff --git a/param-docs/parameter-pages/Alignment/FlipImageSize.md b/param-docs/parameter-pages/Alignment/FlipImageSize.md index 1a303bc..5f088c4 100644 --- a/param-docs/parameter-pages/Alignment/FlipImageSize.md +++ b/param-docs/parameter-pages/Alignment/FlipImageSize.md @@ -1,8 +1,11 @@ # 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) diff --git a/param-docs/parameter-pages/Alignment/InitialMirror.md b/param-docs/parameter-pages/Alignment/InitialMirror.md index 0a8f78f..9382cf8 100644 --- a/param-docs/parameter-pages/Alignment/InitialMirror.md +++ b/param-docs/parameter-pages/Alignment/InitialMirror.md @@ -1,7 +1,7 @@ # Parameter `InitialMirror` Default Value: `false` -!!! Note - This parameter is not accessible through the Web Interface Configuration Page! +Option for initially mirroring the image on the original x-axis. -Please fill me with an explanation and useful links +!!! Note + This parameter is accessible on the Reference Image Page but not on the Config page! diff --git a/param-docs/parameter-pages/Alignment/InitialRotate.md b/param-docs/parameter-pages/Alignment/InitialRotate.md index af5b48b..c03937d 100644 --- a/param-docs/parameter-pages/Alignment/InitialRotate.md +++ b/param-docs/parameter-pages/Alignment/InitialRotate.md @@ -1,7 +1,8 @@ # Parameter `InitialRotate` Default Value: `179` -!!! Note - This parameter is not accessible through the Web Interface Configuration Page! +Initial rotation of image before alignment in degree (1...359) + +!!! Note + This parameter is accessible on the Reference Image Page but not on the Config page! -Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md index 9386f98..eaba45a 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldX.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldX.md @@ -1,5 +1,7 @@ # 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. diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md index a49484b..0051caf 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldY.md +++ b/param-docs/parameter-pages/Alignment/SearchFieldY.md @@ -1,5 +1,7 @@ # 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. diff --git a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md index c94091f..acff4a5 100644 --- a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md +++ b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md @@ -1,7 +1,10 @@ # 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! diff --git a/param-docs/parameter-pages/Analog/ExtendedResolution.md b/param-docs/parameter-pages/Analog/ExtendedResolution.md index b56c505..711fd4e 100644 --- a/param-docs/parameter-pages/Analog/ExtendedResolution.md +++ b/param-docs/parameter-pages/Analog/ExtendedResolution.md @@ -1,4 +1,5 @@ # Parameter `ExtendedResolution` -!!! WARNING + +!!! Warning This parameter is unused! Use [`NUMBER.ExtendedResolution`](../Parameters/#PostProcessing-NUMBER.ExtendedResolution) instead! diff --git a/param-docs/parameter-pages/Analog/ROIImagesLocation.md b/param-docs/parameter-pages/Analog/ROIImagesLocation.md index 994a74b..3591a54 100644 --- a/param-docs/parameter-pages/Analog/ROIImagesLocation.md +++ b/param-docs/parameter-pages/Analog/ROIImagesLocation.md @@ -2,5 +2,6 @@ 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! diff --git a/param-docs/parameter-pages/Debug/LogLevel.md b/param-docs/parameter-pages/Debug/LogLevel.md index e505299..baf5a7a 100644 --- a/param-docs/parameter-pages/Debug/LogLevel.md +++ b/param-docs/parameter-pages/Debug/LogLevel.md @@ -7,6 +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! \ No newline at end of file diff --git a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md index e75fc2f..0485129 100644 --- a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md +++ b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md @@ -1,7 +1,10 @@ # 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! diff --git a/param-docs/parameter-pages/Digits/ROIImagesLocation.md b/param-docs/parameter-pages/Digits/ROIImagesLocation.md index 0732350..7143bc4 100644 --- a/param-docs/parameter-pages/Digits/ROIImagesLocation.md +++ b/param-docs/parameter-pages/Digits/ROIImagesLocation.md @@ -1,5 +1,6 @@ # 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! diff --git a/param-docs/parameter-pages/GPIO/IO0.md b/param-docs/parameter-pages/GPIO/IO0.md index 970a7ba..1b9a625 100644 --- a/param-docs/parameter-pages/GPIO/IO0.md +++ b/param-docs/parameter-pages/GPIO/IO0.md @@ -1,12 +1,16 @@ # 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 diff --git a/param-docs/parameter-pages/GPIO/IO1.md b/param-docs/parameter-pages/GPIO/IO1.md index daf1a38..fdf7340 100644 --- a/param-docs/parameter-pages/GPIO/IO1.md +++ b/param-docs/parameter-pages/GPIO/IO1.md @@ -1,10 +1,14 @@ # 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 diff --git a/param-docs/parameter-pages/GPIO/IO12.md b/param-docs/parameter-pages/GPIO/IO12.md index aae89c2..f773b64 100644 --- a/param-docs/parameter-pages/GPIO/IO12.md +++ b/param-docs/parameter-pages/GPIO/IO12.md @@ -1,10 +1,14 @@ # 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 diff --git a/param-docs/parameter-pages/GPIO/IO13.md b/param-docs/parameter-pages/GPIO/IO13.md index f77c57a..ff9b92c 100644 --- a/param-docs/parameter-pages/GPIO/IO13.md +++ b/param-docs/parameter-pages/GPIO/IO13.md @@ -1,10 +1,14 @@ # 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 diff --git a/param-docs/parameter-pages/GPIO/IO3.md b/param-docs/parameter-pages/GPIO/IO3.md index 87b8597..a2e45d5 100644 --- a/param-docs/parameter-pages/GPIO/IO3.md +++ b/param-docs/parameter-pages/GPIO/IO3.md @@ -1,10 +1,14 @@ # 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 diff --git a/param-docs/parameter-pages/GPIO/IO4.md b/param-docs/parameter-pages/GPIO/IO4.md index f756132..08dcdbf 100644 --- a/param-docs/parameter-pages/GPIO/IO4.md +++ b/param-docs/parameter-pages/GPIO/IO4.md @@ -1,11 +1,15 @@ # 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 diff --git a/param-docs/parameter-pages/InfluxDB/Uri.md b/param-docs/parameter-pages/InfluxDB/Uri.md index 1cf7cdb..4ca9f43 100644 --- a/param-docs/parameter-pages/InfluxDB/Uri.md +++ b/param-docs/parameter-pages/InfluxDB/Uri.md @@ -1,5 +1,6 @@ # 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! diff --git a/param-docs/parameter-pages/MQTT/MeterType.md b/param-docs/parameter-pages/MQTT/MeterType.md index 99343e6..3e5ba41 100644 --- a/param-docs/parameter-pages/MQTT/MeterType.md +++ b/param-docs/parameter-pages/MQTT/MeterType.md @@ -1,8 +1,10 @@ # 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`! diff --git a/param-docs/parameter-pages/System/Hostname.md b/param-docs/parameter-pages/System/Hostname.md index c199809..6c435cb 100644 --- a/param-docs/parameter-pages/System/Hostname.md +++ b/param-docs/parameter-pages/System/Hostname.md @@ -1,6 +1,8 @@ # 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. diff --git a/param-docs/parameter-pages/System/SetupMode.md b/param-docs/parameter-pages/System/SetupMode.md index b97248e..18fcdaa 100644 --- a/param-docs/parameter-pages/System/SetupMode.md +++ b/param-docs/parameter-pages/System/SetupMode.md @@ -1,5 +1,7 @@ # 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. diff --git a/param-docs/parameter-pages/System/TimeServer.md b/param-docs/parameter-pages/System/TimeServer.md index ae092a8..f10713d 100644 --- a/param-docs/parameter-pages/System/TimeServer.md +++ b/param-docs/parameter-pages/System/TimeServer.md @@ -1,7 +1,9 @@ # 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 (`""`).