Data format

Messages about device properties reported by devices

By using the following topic, you can obtain the device properties reported by devices.

Topic：/sys/{productKey}/{deviceName}/thing/event/property/post

Data format:

{
    "iotId":"4z819VQHk6VSLmmBJfrf00107ee200",
    "productKey":"1234556554",
    "deviceName":"deviceName1234",
    "gmtCreate":1510799670074,
    "deviceType":"Ammeter",
    "items":{
        "Power":{
            "value":"on",
            "time":1510799670074
        },
        "Position":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    }
}

Parameter descriptions:

Messages about events reported by devices

By using the following topic, you can obtain event information reported by devices.

Topic: /sys/{productKey}/{deviceName}/thing/event/{tsl.event.identifier}/post

Data format:

{
    "identifier":"BrokenInfo",
    "Name": "Damage rate report ",
    "type":"info",
    "iotId":"4z819VQHk6VSLmmBJfrf00107ee200",
    "productKey":"X5eCzh6fEH7",
    "deviceName":"5gJtxDVeGAkaEztpisjX",
    "gmtCreate":1510799670074,
    "value":{
        "Power": "on",
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "time":1510799670074
}

Parameter descriptions:

Device lifecycle change messages

By using the following topic, you can obtain messages about device creation and deletion, and about devices being enabled and disabled.

Topic: /sys/{productKey}/{deviceName}/thing/lifecycle

Data format:

{
"action" : "create|delete|enable|disable",
"iotId" : "4z819VQHk6VSLmmBJfrf00107ee200",
"productKey" : "X5eCzh6fEH7",
"deviceName" : "5gJtxDVeGAkaEztpisjX",
"deviceSecret" : "", 
"messageCreateTime": 1510292739881 
}

Parameter descriptions:

Device topological relationship update messages

By using the following topic, you can obtain messages about topological relationship creation and removal between sub-devices and gateways.

Topic: /sys/{productKey}/{deviceName}/thing/topo/lifecycle

Data format:

{
"action" : "add|remove|enable|disable",
"gwIotId": "4z819VQHk6VSLmmBJfrf00107ee200",
"gwProductKey": "1234556554",
"gwDeviceName": "deviceName1234",
"devices": [
        {
"iotId": "4z819VQHk6VSLmmBJfrf00107ee201",
"productKey": "12345565569",
"deviceName": "deviceName1234"
       }
    ],

"messageCreateTime": 1510292739881
}

Parameter descriptions:

Messages about detected sub-devices reported by gateways

In some cases, gateways can detect sub-devices and report their information. By using the following topic, you can obtain the sub-device information reported by gateways.

Topic: /sys/{productKey}/{deviceName}/thing/list/found

Data format:

{
    "gwIotId":"4z819VQHk6VSLmmBJfrf00107ee200",
    "gwProductKey":"1234556554",
    "gwDeviceName":"deviceName1234",
    "devices":[
        {
            "iotId":"4z819VQHk6VSLmmBJfrf00107ee201",
            "productKey":"12345565569",
            "deviceName":"deviceName1234"
        }
    ]
}

Parameter descriptions:

Devices return result data to the cloud

By using the following topic, you can obtain request execution results from devices when you send operation requests to devices using an asynchronous method. If an error occurs when sending the request, you will receive an error message from this topic.

Topic: /sys/{productKey}/{deviceName}/thing/downlink/reply/message

Data format:

{
    "gmtCreate":1510292739881,
    "iotId":"4z819VQHk6VSLmmBJfrf00107ee200",
    "productKey":"1234556554",
    "deviceName":"deviceName1234",
    "requestId":1234,
    "code":200,
    "message":"success",
    "topic":"/sys/1234556554/deviceName1234/thing/service/property/set",
    "data":{

    }
}

Parameter descriptions

Response information:

Messages about device status

By using the following topic, you can obtain the online and offline status of devices.

Topic: {productKey}/{deviceName}/mqtt/status

Data format:

{
    "productKey":"1234556554",
    "deviceName":"deviceName1234",
    "gmtCreate":1510799670074,
    "deviceType":"Ammeter",
    "iotId":"4z819VQHk6VSLmmBJfrf00107ee200",
    "action":"online|offline",
    "status":{
        "value":"1",
        "time":1510292697471
    }
}

Parameter descriptions: