一、描述

事件上报适用设备状态变化通知、埋点事件记录等场景。当设备发生了预定义的事件时，设备会将事件信息上报给云端平台。主要有以下几个示例场景：

• 实时监测和预测维护：通过物模型事件上报，设备可以实时监测自身的状态和性能指标。这使得设备能够及时检测到潜在的故障或异常情况，并提前采取措施进行维护。通过监测关键参数，设备可以预测性地进行维护，避免设备故障和停机时间的增加，从而提高设备的可靠性和性能。

• 报警和告警通知：物模型事件可以用于报警、告警、错误信息通知的触发。当设备检测到特定的事件或条件时，例如安全传感器探测到入侵或火灾报警器探测到烟雾，设备可以生成相应的事件并将其上报给云端平台。云端平台可以根据这些事件触发警报通知，通知相关的用户、管理员或其他系统。

二、数据交互图

三、通讯协议

3.1 通讯方式

3.2 Topic定义

3.3 method 枚举

四、场景示例

示例以门锁设备为例，事件为门锁的开关，定义事件名为switch， 输出属性名为 type ，值有 fingerprint、password等值。

4.1 设备上报事件触发

1. 上报物模型事件触发

设备事件触发，上报到物模型服务，使用Topic: /${productId}/${deviceId}/thing/event/up 上报，发送的JSON格式如下：

{
  "method":"reported",
  "messageId":"157889065984",
  "eventIdentifier":"switch"，
  "module":"default",
  "output":{
    "type":"fingerprint"
  },
  "time":1686540549041
}

字段说明：

2. 校验事件信息后保存事件

物模型服务接收到事件上报消息后，会根据物模型的TSL文件进行校验事件的输出参数等，如校验通过，则进行保存，不通过则响应错误信息。

3. 返回上报物模型事件结果

物模型服务处理上报物模型消息后，发送结果到Topic：/${productId}/${deviceId}/thing/event/up/reply

1）若成功保存，发送到该Topic的JSON格式如下：

{
    "messageId":"157889065984",
    "method":"reported",
    "payload":{
        "code":0
    }
}

2）若保存失败，发送到该Topic的消息为：

{
    "messageId":"157889065984",
    "method":"reported",
    "payload":{
        "code": ${errorcode},
        "msg": "${errormessage}"
    }
}

字段说明：

4. 查询设备事件上报记录

应用程序通过 获取设备事件 接口获取设备事件上报的记录。

5. 返回设备事件上报记录结果

物模型服务查询设备的事件上报记录返回到应用程序。

4.2 获取事件上报频率

1. 发送获取属性值消息

设备在获取物模型属性的最新上报频率时，可发送消息到Topic:/${productId}/${deviceId}/thing/property/up，发送的JSON格式如下：

{
  "method":"getFrequency",
  "messageId":"157889065989",
  "events": {
        "default":[
              "switch"
         ]
   }
}

字段说明：

2. 下发获取属性频率信息

物模型服务在进行校验属性物模型之后，发送结果到Topic:/${productId}/${deviceId}/thing/property/up/reply中。

1）若成功获取，发送到该Topic的JSON格式如下：

{
    "method":"getFrequency",
    "messageId":"157889065989",
    "payload":{
        "code":0,
        "default":{
            "switch":5
        }
    }
}

2）若获取失败，发送到该Topic的消息为：

{
    "messageId":"157889065989",
    "method":"getFrequency",
    "payload":{
        "code": ${errorcode},
        "msg": "${errormessage}"
    }
}

字段说明：

五、错误码