This topic provides a sample script for parsing data from custom topics in Python.


  • Parsing data from custom topics is supported only for the China (Shanghai) region.
  • When you configure devices, attach the ? _sn=default tag to custom topics. IoT Platform only parses data from custom topics that are attached with the tag.

    For example, if you need to parse the data that is sent by a device to the /${productKey}/${deviceName}/user/update topic into JSON data, you must define the topic as follows when configuring the device: /${productKey}/${deviceName}/user/update? _sn=default.

    Note When you create a custom topic in the IoT Platform console, define the topic without adding the tag.
  • IoT Platform parses only data submitted by devices to the cloud, and does not parse downstream data sent from the cloud.
  • IoT Platform parses only payloads submitted to the cloud and returns the parsed payloads.
  • Topics in which data resides do not change before or after parsing. For example, a device sends data to the /${productKey}/${deviceName}/user/update topic, and the parsed data still resides in this topic.

Script Template

SELF_DEFINE_TOPIC_UPDATE_FLAG = '/user/update'  #Custom topic: /user/update
SELF_DEFINE_TOPIC_ERROR_FLAG = '/user/update/error'  #Custom topic: /user/update/error

# Convert data from devices to JSON data.The function is called when devices report data through a custom topic to IoT Platform.
# Input: A topic string. It is the topic for devices reporting messages.   
# Input: A rawData list. The list elements must be of the Int type and cannot be empty.
# Output: A jsonObj dictionary. It cannot be empty.    
def transform_payload(topic, rawData):
   jsonObj = {}
   return jsonObj


Note The following script is used only to parse custom topic data. If the Data Format of the product is Custom, you also need to write a script for parsing TSL data. For more information about parsing TSL data, see Example for parsing TSL data.
# coding=utf-8
SELF_DEFINE_TOPIC_UPDATE_FLAG = '/user/update'  #Custom topic: /user/update
SELF_DEFINE_TOPIC_ERROR_FLAG = '/user/update/error'  #Custom topic: /user/update/error

# Sample data
# Custom topic: /user/update reports data
# Input parameters: topic: /{productKey}/{deviceName}/user/update and bytes: 0x000000000100320100000000
# Output parameters:
#  {
#     "prop_float": 0,
#     "prop_int16": 50,
#     "prop_bool": 1,
#     "topic": "/{productKey}/{deviceName}/user/update"
#   }
def transform_payload(topic, bytes):
    uint8Array = []
    for byteValue in bytes:
        uint8Array.append(byteValue & 0xff)

    jsonMap = {}
        jsonMap['topic'] = topic
        jsonMap['errorCode'] = bytes_to_int(uint8Array[0:1])

        jsonMap['topic'] = topic
        jsonMap['prop_int16'] = bytes_to_int(uint8Array[5:7])
        jsonMap['prop_bool'] = bytes_to_int(uint8Array[7: 8])
        jsonMap['prop_float'] = bytes_to_int(uint8Array[8:])

    return jsonMap

# Converts a byte array to an integer type
def bytes_to_int(bytes):
    data = ['%02X' % i for i in bytes]
    return int(''.join(data), 16)