What data can be forwarded by AMQP server-side subscriptions in IoT Platform?

Updated at:

This topic describes the message types that can be forwarded by AMQP server-side subscriptions.

Message type

Topic description

References

Messages reported by devices: Custom topics

A custom topic for which the Operation permission is set to Publish. The topic used to forward messages in a custom data format is the same as the original custom topic.

Use custom topics for communication

Messages reported by devices: Thing Specification Language (TSL) model data

The message forwarding topics include the following:

  • Topic for devices to report property data: /${productKey}/${deviceName}/thing/event/property/post.

  • Topic for devices to report event data: /${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post.

  • Topic for devices to report property data in batches: /${productKey}/${deviceName}/thing/property/batch/post.

  • Topic for devices to report event data in batches: /${productKey}/${deviceName}/thing/event/batch/post.

  • Topic for devices to return response messages to commands from the cloud: /${productKey}/${deviceName}/thing/downlink/reply/message.

The corresponding topics for devices to report raw data are as follows:

  • Topic for devices to report properties: /sys/${productKey}/${deviceName}/thing/event/property/post.

  • Topics for devices to report events: /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post and /sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId}:{tsl.event.identifier}/post.

  • Topic for devices to report property and event data in batches: /sys/${productKey}/${deviceName}/thing/event/property/batch/post.

  • Topic for devices to return response messages to commands from the cloud: /sys/${productKey}/${deviceName}/thing/service/${tsl.service.identifier}_reply

Device status change notifications

IoT Platform directly forwards messages about device online and offline status changes. The topic is /as/mqtt/status/${productKey}/${deviceName}.

Device online and offline status

Gateway reports discovered sub-devices

A topic specific to gateway devices: /${productKey}/${deviceName}/thing/list/found. Gateways use this topic to report information about discovered sub-devices to IoT Platform for forwarding.

Gateway discovers sub-devices

Device topology changes

A topic specific to gateway devices: /${productKey}/${deviceName}/thing/topo/lifecycle. This topic is used to forward messages about the creation and removal of the topological relationship between a sub-device and a gateway.

Device topology changes

The corresponding topic for devices to report raw data is: /sys/${productKey}/${deviceName}/thing/topo/change.

Notify a gateway of topology changes

Device lifecycle changes

IoT Platform directly forwards messages about device operations such as creation, deletion, disabling, and enabling. The topic is /${productKey}/${deviceName}/thing/lifecycle.

Device lifecycle changes

Historical TSL model data reporting

The message forwarding topics include the following:

  • Topic for devices to report historical property data: /${productKey}/${deviceName}/thing/event/property/history/post.

  • Topic for devices to report historical event data: /${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/history/post.

The corresponding topic for devices to report historical TSL model data is: /sys/${productKey}/${deviceName}/thing/event/property/history/post.

Report historical TSL model data

Device tag changes

The topic for forwarding changes in device tag information is: /${productKey}/${deviceName}/thing/deviceinfo/update.

Device tag changes

The corresponding topic for devices to report raw data is: /sys/${productKey}/${deviceName}/thing/deviceinfo/update.

Report tag information

OTA update device status notifications

The message forwarding topics include the following:

  • Topic for devices to report over-the-air (OTA) update results: /${productKey}/${deviceName}/ota/upgrade.

  • Topic for devices to report OTA update progress: /${productKey}/${deviceName}/ota/progress/post.

The corresponding topic for devices to report update progress is: /ota/device/progress/${productKey}/${deviceName}.

Device reports update progress

OTA module version number reporting

The topic for forwarding changes to the OTA module version number reported by a device is: /${productKey}/${deviceName}/ota/version/post.

OTA module version number change notifications

The corresponding topic for devices to report the OTA module version is: /ota/device/inform/${productKey}/${deviceName}.

Device reports OTA module version

OTA update batch status notifications

IoT Platform directly forwards notifications about OTA update batch status changes. The topic is: /${productKey}/${packageId}/${jobId}/ota/job/status.

OTA update batch status notifications

References

Configure an AMQP server-side subscription