From 6cfbbd418050a502886ad963aaf18df6f5116c09 Mon Sep 17 00:00:00 2001 From: George Ruinelli Date: Wed, 22 Feb 2023 09:34:08 +0100 Subject: [PATCH] fix lists --- docs/Integration-Home-Assistant.md | 1 + param-docs/parameter-pages/Alignment/AlignmentAlgo.md | 1 + param-docs/parameter-pages/Debug/LogLevel.md | 1 + param-docs/parameter-pages/GPIO/IO0.md | 1 + param-docs/parameter-pages/GPIO/IO1.md | 1 + param-docs/parameter-pages/GPIO/IO12.md | 1 + param-docs/parameter-pages/GPIO/IO13.md | 1 + param-docs/parameter-pages/GPIO/IO3.md | 1 + param-docs/parameter-pages/GPIO/IO4.md | 1 + param-docs/parameter-pages/MQTT/MainTopic.md | 2 ++ param-docs/parameter-pages/TakeImage/ImageSize.md | 1 + 11 files changed, 12 insertions(+) diff --git a/docs/Integration-Home-Assistant.md b/docs/Integration-Home-Assistant.md index b321ed0..ca97ddf 100644 --- a/docs/Integration-Home-Assistant.md +++ b/docs/Integration-Home-Assistant.md @@ -175,6 +175,7 @@ This would return: To do such a REST call, you need to create a REST sensor: ```yaml sensor: + - platform: rest name: "Gasmeter JSON" resource: http:///json diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md index 9c066a2..7d66f61 100644 --- a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md +++ b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md @@ -6,6 +6,7 @@ Default Value: `Default` 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 diff --git a/param-docs/parameter-pages/Debug/LogLevel.md b/param-docs/parameter-pages/Debug/LogLevel.md index e6bacfe..9bc6e8a 100644 --- a/param-docs/parameter-pages/Debug/LogLevel.md +++ b/param-docs/parameter-pages/Debug/LogLevel.md @@ -2,6 +2,7 @@ Default Value: `1` (`ERROR`) Define the log level for the logging to the SD-Card. Available options: + - `1`: `ERROR` - `2`: `WARNING` - `3`: `INFO` diff --git a/param-docs/parameter-pages/GPIO/IO0.md b/param-docs/parameter-pages/GPIO/IO0.md index 1b9a625..a9b180a 100644 --- a/param-docs/parameter-pages/GPIO/IO0.md +++ b/param-docs/parameter-pages/GPIO/IO0.md @@ -12,6 +12,7 @@ This parameter can be used to configure the GPIO `IO0` pin. 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 diff --git a/param-docs/parameter-pages/GPIO/IO1.md b/param-docs/parameter-pages/GPIO/IO1.md index fdf7340..481a847 100644 --- a/param-docs/parameter-pages/GPIO/IO1.md +++ b/param-docs/parameter-pages/GPIO/IO1.md @@ -10,6 +10,7 @@ This parameter can be used to configure the GPIO `IO1` pin. 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 diff --git a/param-docs/parameter-pages/GPIO/IO12.md b/param-docs/parameter-pages/GPIO/IO12.md index f773b64..f5f62b8 100644 --- a/param-docs/parameter-pages/GPIO/IO12.md +++ b/param-docs/parameter-pages/GPIO/IO12.md @@ -10,6 +10,7 @@ This parameter can be used to configure the GPIO `IO12` pin. 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 diff --git a/param-docs/parameter-pages/GPIO/IO13.md b/param-docs/parameter-pages/GPIO/IO13.md index ff9b92c..64bd642 100644 --- a/param-docs/parameter-pages/GPIO/IO13.md +++ b/param-docs/parameter-pages/GPIO/IO13.md @@ -10,6 +10,7 @@ This parameter can be used to configure the GPIO `IO13` pin. 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 diff --git a/param-docs/parameter-pages/GPIO/IO3.md b/param-docs/parameter-pages/GPIO/IO3.md index a2e45d5..7d00209 100644 --- a/param-docs/parameter-pages/GPIO/IO3.md +++ b/param-docs/parameter-pages/GPIO/IO3.md @@ -10,6 +10,7 @@ This parameter can be used to configure the GPIO `IO3` pin. 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 diff --git a/param-docs/parameter-pages/GPIO/IO4.md b/param-docs/parameter-pages/GPIO/IO4.md index 08dcdbf..f59883d 100644 --- a/param-docs/parameter-pages/GPIO/IO4.md +++ b/param-docs/parameter-pages/GPIO/IO4.md @@ -11,6 +11,7 @@ This parameter can be used to configure the GPIO `IO4` pin. 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 diff --git a/param-docs/parameter-pages/MQTT/MainTopic.md b/param-docs/parameter-pages/MQTT/MainTopic.md index aa375db..d3f9cbf 100644 --- a/param-docs/parameter-pages/MQTT/MainTopic.md +++ b/param-docs/parameter-pages/MQTT/MainTopic.md @@ -2,9 +2,11 @@ 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. diff --git a/param-docs/parameter-pages/TakeImage/ImageSize.md b/param-docs/parameter-pages/TakeImage/ImageSize.md index 8f7c7d4..9545336 100644 --- a/param-docs/parameter-pages/TakeImage/ImageSize.md +++ b/param-docs/parameter-pages/TakeImage/ImageSize.md @@ -6,5 +6,6 @@ Default Value: `VGA` Size of the camera picture. Available options: + - `VGA` (640 x 480 pixel) - `QVGA` (320 x 240 pixel)