This commit is contained in:
George Ruinelli
2023-02-22 10:45:31 +01:00
parent 53d64d9ff3
commit d6af7252dc
35 changed files with 100 additions and 29 deletions

View File

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

View File

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

View File

@@ -1,12 +1,15 @@
# 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:
The single value will be published with the following key: `MAINTOPIC/NUMBER/RESULT_TOPIC`
- `NUMBER` is the name of the value (a meter might have more than one value).
With:
- `NUMBER`: 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`, ....
- `RESULT_TOPIC`: Automatically filled with the right name, eg. `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,5 +1,6 @@
# Parameter `MeterType`
Default Value: `other`
Select the Meter Type so the sensors have the right units in Homeassistant.
!!! Note

View File

@@ -1,3 +1,4 @@
# 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,3 +1,4 @@
# 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,3 +1,4 @@
# Parameter `password`
Default Value: `PASSWORD`
Password for MQTT authentication.

View File

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