The device is capable to register to a MQTT broker to publish data and subscribe to specific topics.
!!! Note: Only MQTT v3.1.1 is supported.
The MQTT service has to be enabled and configured properly via web interface (Settings > Configuration > section MQTT).
The following parameter are minimum required to use MQTT API: : URI, Main Topic, Client ID
All data gets located under the MainTopic which is defined in device configuration. The main topic can be flat
watermeter or even be nested multiple times, e.g. water/mainwatermeter or water/building1/meter1/....
Further details can be found in the respective MQTT API topic cluster description.
| MQTT API Topic Cluster | Description | JSON / Topics | Depre- cated* |
|---|---|---|---|
| Device Info | Device Info (Static topic content) | JSON | |
| Device Status | Device Status (Variable topic content) | Topics | |
| Process Control | Process Control (Topics to control process) | Topics | |
| Process Data | Process Data (Number sequence data / results) | JSON + Topics | |
| Process Status | Process Status (Variable topic content) | Topics | |
| Home Assistant | Home Assistant Discovery Topics | JSON | |
| GPIO Control / Status | General Purpose Input / Output Control / Status | Topcis |
*MQTT topics which are marked as deprecated will be completely removed (functionality merged in another endpoint) or modified in upcoming major release. Check changelog for breaking changes.
Check migration notes for migrated MQTT topics: Migration notes