Skip to main content

MQTT Topics Overview

Data Orchestrator MQTT v1 Protocol relies on few well known reserved topics.

TopicPurposePublished ByQoSPayload Format
<realm name>/<device id>IntrospectionDevice2ASCII plain text, ':' and ';' delimited
<realm name>/<device id>/capabilitiesCapabilitiesDevice2BSON
<realm name>/<device id>/control/emptyCacheEmpty CacheDevice2ASCII plain text (always "1")
<realm name>/<device id>/control/consumer/propertiesPurge PropertiesData Orchestrator2deflated plain text
<realm name>/<device id>/control/producer/propertiesPurge PropertiesDevice2deflated plain text
<realm name>/<device id>/<interface name>/<path>Publish DataBoth0, 1, 2BSON (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.