Move param doc (#2843)

moved param doc from docs repo to here
This commit is contained in:
CaCO3
2024-01-31 21:53:56 +01:00
committed by GitHub
parent 4990858101
commit 8410df6144
104 changed files with 958 additions and 18 deletions

View File

@@ -0,0 +1,18 @@
# Parameter `CACert`
Default Value: `""`
Example: `/config/certs/RootCA.pem`.
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the CA certificate file.
This is part of the configuration to enable TLS for MQTT.
The CA Certificate is used by the client to validate the broker is who it claims to be.
It allows the client to authenticate the server, which is the first part of the MTLS handshake.
Usually there is a common RootCA certificate for the MQTT broker
!!! Note
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!

View File

@@ -0,0 +1,19 @@
# Parameter `ClientCert`
Default Value: `""`
Example: `/config/certs/client.pem.crt`.
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the Client Certificate file.
This is part of the configuration to enable TLS for MQTT.
The Client Certificate is used by the client to prove its identity to the server, in conjunction with the Client Key.
It is the second part of the MTLS handshake.
Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker
!!! Note
If set, `ClientKey` must be set too
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!

View File

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

View File

@@ -0,0 +1,19 @@
# Parameter `ClientKey`
Default Value: `""`
Example: `/config/certs/client.pem.key`.
!!! Warning
This is an **Expert Parameter**! Only change it if you understand what it does!
Path to the Client Key file.
This is part of the configuration to enable TLS for MQTT.
The Client Key is used by the client to prove its identity to the server, in conjunction with the Client Certificate.
It is the second part of the MTLS handshake.
Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker
!!! Note
If set, `ClientCert` must be set too
This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`!

View File

@@ -0,0 +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

@@ -0,0 +1,18 @@
# 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`
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`: 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.
!!! Note
The main topic is allowed to contain `/` which can be used to split it into multiple levels, eg. `/basement/meters/watermeter/1/` if you have multiple water meters in your basement.

View File

@@ -0,0 +1,11 @@
# 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`!

View File

@@ -0,0 +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

@@ -0,0 +1,4 @@
# Parameter `Uri`
Default Value: `mqtt://example.com:1883`
URI to the MQTT broker including the port. E.g. `mqtt://192.168.1.1:1883`.

View File

@@ -0,0 +1,4 @@
# Parameter `password`
Default Value: `PASSWORD`
Password for MQTT authentication.

View File

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