Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-08 12:36:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

updated parameters

Browse Source
This commit is contained in:
CaCO3
2023-02-05 01:12:38 +01:00
parent 80af3abe3d
commit b9dceabaad
49 changed files with 191 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
param-docs/parameter-pages/MQTT/ClientID.md
View File

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

7
param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md
View File

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

16
param-docs/parameter-pages/MQTT/MainTopic.md
View File

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

12
param-docs/parameter-pages/MQTT/MeterType.md
View File

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

6
param-docs/parameter-pages/MQTT/SetRetainFlag.md
View File

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

7
param-docs/parameter-pages/MQTT/Uri.md
View File

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

6
param-docs/parameter-pages/MQTT/password.md
View File

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

7
param-docs/parameter-pages/MQTT/user.md
View File

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