设备 - 事件 - 事件上报

大约 3 分钟

设备 - 事件 - 事件上报

事件上报

sys/{product_id}/{device_id}/thing/event/up

说明:

设备端用于上报当前事件

示例:

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "identifier": "powerEvent",
    "params": {
        "value": {
            "Power": "on",
            "WF": "2"
        },
        "time": 1524448722000
    },
    "method": "thing.event.up"
}

字段说明:

参数类型说明
idString 消息ID号。String类型的数字,取值范围0~4294967295,且每个消息ID在当前设备中具有唯一性。
versionString协议版本号,目前协议版本号唯一取值为1.0。
identifierString为物模型中定义的事件标识符,若为自定义模块,则为${tsl.functionBlockId}:${tsl.event.identifier}
sysObject扩展功能的参数,其下包含各功能字段。
ackIntegersys下的扩展功能字段,表示是否返回响应数据。
  • 1:云端返回响应数据。
  • 0:云端不返回响应数据。
methodString请求方法。例如:thing.event.up
paramsObject上报事件的输出参数。
valueObject 事件的输出参数信息。如以上示例中的两个参数Power(电源)和WF(工作电流)的信息。
{
    "Power": "on",
    "WF": "2"
}
timeLong事件上报的时间戳,类型为UTC毫秒级时间。

该参数为可选字段。根据您的业务场景决定消息中是否带时间戳。如果消息频繁,需根据时间戳判断消息顺序,建议消息中带有时间戳。

  • 若上传time,物联网平台的云端保存上传的时间作为事件上报时间。
  • 若不上传time,物联网平台的云端自动生成事件上报时间并保存。

事件上报回复

sys/{product_id}/{device_id}/thing/event/up/response

成功返回示例:

{
    "code": 200,
    "data": {},
    "id": "123",
    "message": "success",
    "method": "thing.event.up",
    "version": "1.0"
}

失败返回示例:

{
    "code": 460,
    "data": {},
    "id": "123",
    "message": "request parameter error!",
    "method": "thing.event.up",
    "version": "1.0"
}

说明

服务端响应事件上报结果

字段说明:

参数类型说明
idString消息ID号,String类型的数字,取值范围0~4294967295,且每个消息ID在当前设备中具有唯一性。
codeInteger结果状态码。 具体参考设备端通用code
说明 物联网平台会对设备上报的事件做校验。通过产品的TSL描述判断上报的事件是否符合定义的事件格式。不合格的事件会直接被过滤掉,并返回失败的错误码。
dataObject请求成功时,返回的数据固定为空。
messageString返回结果信息。请求成功时,返回success。
methodString响应数据对应的请求方法,与请求参数中method相同。
versionString协议版本号,与请求参数中version相同。