MQTT Topics Overview
Data Orchestrator MQTT v1 Protocol relies on few well known reserved topics.
| Topic | Purpose | Published By | QoS | Payload Format |
|---|---|---|---|---|
<realm name>/<device id> | Introspection | Device | 2 | ASCII plain text, ':' and ';' delimited |
<realm name>/<device id>/capabilities | Capabilities | Device | 2 | BSON |
<realm name>/<device id>/control/emptyCache | Empty Cache | Device | 2 | ASCII plain text (always "1") |
<realm name>/<device id>/control/consumer/properties | Purge Properties | Data Orchestrator | 2 | deflated plain text |
<realm name>/<device id>/control/producer/properties | Purge Properties | Device | 2 | deflated plain text |
<realm name>/<device id>/<interface name>/<path> | Publish Data | Both | 0, 1, 2 | BSON (or empty) |
For clarity reasons all <realm name>/<device id> prefixes will be omitted on the following paragraphs, those topics will be called device topics.
Topics are not bidirectional, devices must not publish data for server owned topics and viceversa, ownership is explicitly stated in interfaces files.