设备批量上报属性、事件

更新时间:

Topic和数据格式(上行):

  • 请求Topic:/sys/${productKey}/${deviceName}/thing/event/property/batch/post

  • 响应Topic:/sys/${productKey}/${deviceName}/thing/event/property/batch/post_reply

请求数据格式:

{
    "id": "123", 
    "version": "1.0",
    "sys":{
        "ack":0
    }, 
    "method": "thing.event.property.batch.post", 
    "params": {
        "properties": {
            "Power": [
                {
                    "value": "on", 
                    "time": 1524448722000
                },
                {
                    "value": "off", 
                    "time": 1524448722001
                }
            ], 
            "WF": [
                {
                    "value": 3, 
                    "time": 1524448722000
                },
                {
                    "value": 4, 
                    "time": 1524448722009
                }
            ]
        }, 
        "events": {
            "alarmEvent": [
                {
                    "value": {
                        "Power": "on", 
                        "WF": "2"
                    }, 
                    "time": 1524448722000
                },
                {
                    "value": {
                        "Power": "on", 
                        "WF": "2"
                    }, 
                    "time": 1524448722000
                }
            ]
        }
    }
}

响应数据格式:

  • 成功返回示例:

{
    "code": 200,
    "data": {},
    "id": "123",
    "message": "success",
    "method": "thing.event.property.batch.post",
    "version": "1.0"
}
  • 失败返回示例:

{
    "code": 9201,
    "data": {},
    "id": "123",
    "message": "device offLine",
    "method": "thing.event.property.batch.post",
    "version": "1.0"
}

参数说明:

参数

类型

说明

id

String

消息ID号。String类型的数字,取值范围0~4294967295,且每个消息ID在当前设备中具有唯一性。

version

String

协议版本号,目前协议版本号唯一取值为1.0。

sys

Object

扩展功能的参数,其下包含各功能字段。

说明

使用设备端SDK开发时,如果未设置扩展功能,则无此参数,相关功能保持默认配置。

ack

Integer

sys下的扩展功能字段,表示是否返回响应数据。

  • 1:云端返回响应数据。

  • 0:云端不返回响应数据。

重要

如果未配置该功能,则无此参数,云端默认返回响应数据。

method

String

请求方法。取固定值:thing.event.property.batch.post

params

Object

请求参数。

properties

Object

属性,包含属性标识符、属性值value和属性生成的时间time

如以上示例中,设备上报了的两个属性Power(电源)和WF(工作电流)的批量信息。

如果是自定义模块属性,属性标识符格式为${属性标识符}。例如:

"Power": {
  "value": "on",
  "time": 1524448722000
}

events

Object

事件,包含事件标识符、事件输出参数value和事件生成的时间time

如以上示例中,上报了事件alarmEvent(告警事件)及对应事件参数Power(电源)和WF(工作电流)的批量信息。

如果是自定义模块事件,事件标识符格式为${事件标识符}

例如:

"test:alarmEvent": {
  "value": {
    "Power": "on", 
    "WF": "2"
  }, 
  "time": 1524448722000
}

数据格式说明:

参数

类型

说明

id

String

消息ID号,String类型的数字,取值范围0~4294967295,且每个消息ID在当前设备中具有唯一性。

code

Integer

结果状态码,具体参考设备端通用code

data

Object

请求成功时,返回的数据固定为空。

message

String

返回结果信息。请求成功时,返回success。

method

String

响应数据对应的请求方法,与请求参数中method相同。

version

String

协议版本号,与请求参数中version相同。