Platform topics

fastbeeAbout 2 min

Tips

Custom devices, DTUs, and communication modules usually use one subscribe topic and one publish topic.

{productId}: platform product ID.
{deviceNum}: device number, such as IMEI, MAC address, or a unique number generated by the platform.
Topics marked as deprecated are no longer used after version 2.x.

1. Server-side topics

Tips

Platform command delivery topic: /{productId}/{deviceNum}/function/get.
The server subscribes with wildcards so it can receive messages from all devices.

/{productId}/{deviceNum}/function/get         Publish properties or services.
/{productId}/{deviceNum}/status/post          Publish device status.
/{productId}/{deviceNum}/ntp/get              Publish time synchronization.
/{productId}/{deviceNum}/upgrade/get          Publish OTA upgrade. New topic.

/+/+/info/post                                Subscribe to device information.
/+/+/ntp/post                                 Subscribe to time synchronization.
/+/+/event/post                               Subscribe to events.
/+/+/property/post                            Subscribe to properties or services.
/+/+/upgrade/reply                            Subscribe to OTA upgrade reply. New topic.

# Deprecated
/{productId}/{deviceNum}/property/get         Publish properties. Deprecated.
/+/+/function/post                            Subscribe to services. Deprecated.
/+/+/property-offline/post                    Subscribe to properties in shadow mode. Deprecated.
/+/+/function-offline/post                    Subscribe to services in shadow mode. Deprecated.

2. Device-side topics

Tips

Devices mainly report status and data, and subscribe to commands delivered by the platform.

/{productId}/{deviceNum}/property/post: publish properties or services.
/{productId}/{deviceNum}/function/get: subscribe to properties or services.

/{productId}/{deviceNum}/property/post        Publish properties or services.
/{productId}/{deviceNum}/event/post           Publish events.
/{productId}/{deviceNum}/monitor/post         Publish real-time monitoring data.
/{productId}/{deviceNum}/info/post            Publish device information.
/{productId}/{deviceNum}/ntp/post             Publish time synchronization.
/{productId}/{deviceNum}/upgrade/reply        Publish OTA upgrade reply. New topic.

/{productId}/{deviceNum}/function/get         Subscribe to properties or services.
/{productId}/{deviceNum}/info/get             Subscribe to device information.
/{productId}/{deviceNum}/ntp/get              Subscribe to time synchronization.
/{productId}/{deviceNum}/ota/get              Subscribe to device upgrade. Old topic.
/{productId}/{deviceNum}/monitor/get          Subscribe to real-time monitoring requests, including count and interval.
/{productId}/{deviceNum}/upgrade/get          Subscribe to OTA upgrade. New topic.

# Deprecated
/{productId}/{deviceNum}/function/post        Publish services. Deprecated.
/{productId}/{deviceNum}/property/get         Subscribe to properties. Deprecated.
/{productId}/{deviceNum}/property-online/get  Subscribe to online-mode properties. Deprecated.
/{productId}/{deviceNum}/function-online/get  Subscribe to online-mode services. Deprecated.

3. User-side topics

User-side clients include the web client, Mini Program, and mobile app. They mainly subscribe to data for real-time UI display, such as device status and thing model command results.

Tips

/{productId}/{deviceNum}/ws/service: subscribe to properties or services through MQTT over WebSocket.
/{productId}/{deviceNum}/status/post: subscribe to device status.

/{productId}/{deviceNum}/monitor/get               Publish real-time monitoring request, including count and interval.
/{productId}/{deviceNum}/ota/get                   Publish device upgrade request. Old topic.

/{productId}/{deviceNum}/ws/service                Subscribe to properties or services through MQTT over WebSocket.
/{productId}/{deviceNum}/status/post               Subscribe to device status.
/{productId}/{deviceNum}/monitor/post              Subscribe to real-time monitoring data.

# Deprecated
/{productId}/{deviceNum}/function/post             Subscribe to services. Deprecated.
/{productId}/{deviceNum}/property-online/get       Publish online-mode properties. Deprecated.
/{productId}/{deviceNum}/function-online/get       Publish online-mode services. Deprecated.
/{productId}/{deviceNum}/property-offline/post     Publish shadow-mode properties from the user side. Deprecated.
/{productId}/{deviceNum}/function-offline/post     Publish shadow-mode services from the user side. Deprecated.