设备接入 IOTDA-图形化开发插件:数据上报和命令下发
数据上报和命令下发
场景说明
有一款烟感设备,具有如下特征:
- 具有烟雾报警功能(火灾等级)和温度上报功能。
- 支持远程控制命令,可远程打开报警功能。比如火灾现场温度,远程打开烟雾报警,提醒住户疏散。
- 支持上报命令执行结果。
产品模型定义
- level:火灾级别,用于表示火灾的严重程度。
- temperature:温度,用于表示火灾现场温度。
- SET_ALARM:打开或关闭告警命令,value=0表示关闭,value=1表示打开。
图1 模型定义-smokedetector
编解码插件开发
- 在烟感产品的开发空间,选择“插件开发”,单击“图形化开发”。
- 单击“新增消息”,新增“smokerinfo”消息。配置此步骤的主要目的是,将设备上传的二进制码流消息解码成JSON格式,以便 物联网平台 理解。配置示例如下:
- 消息名:smokerinfo
- 消息类型:数据上报。
- 添加响应字段:是。添加响应字段后,物联网平台在收到设备上报的数据后,会下发用户设置的响应数据到设备。
- 响应数据:AAAA0000(默认)
图2 插件开发-新增消息smokerinfo- 单击“添加字段”,勾选“标记为地址域”,添加messageId字段,表示消息类型。在本场景中,上报火灾等级和温度的消息类型是0x0。设备上报消息时,每条消息首个字段就是messageId。如设备上报消息为0001013A,第一个字段00就是表示此条消息是上报火灾级别和温度的消息。后续字段01和013A分别代表火灾级别和温度。如果只有一条数据上报消息和一条命令下发消息,可以不添加messageId字段。
- “数据类型”根据数据上报消息种类的数量进行配置。messageId字段默认的数据类型为int8u。
- “偏移值”是根据字段位置和字段的字节数的配置自动填充的。messageId为此消息的第一个字段,起始位置为0,字节长度为1,终点位置为1。所以偏移值为0-1。
- “长度”是根据“数据类型”的配置自动填充的。
- “默认值”可以修改,但必须为十六进制格式,且设备数据上报消息的对应字段必须和此处的默认值保持一致。
图3 插件开发-添加字段messageId
- 添加level字段,表示火灾级别。
- “字段名”只能输入包含字母、数字、_和$,且不能以数字开头的字符。
- “数据类型”根据设备上报数据的实际情况进行配置,需要和产品模型相应字段的定义相匹配。产品模型中定义的火灾级别level属性的数据类型为int,最大值为9。所以选择的数据类型为int8u。
- “偏移值”是根据字段位置和字段的字节数的配置自动填充的。“level”字段的起始位置就是前一字段的终点,前一字段“messageId”的终点位置为1,所以“level”字段的起始位置为1。“level”字段长度为1个字节,终点为2。所以“偏移值”为1-2。
- “长度”根据“数据类型”的配置自动填充。
- “默认值”不填。此处火灾级别level不固定,无默认值。
图4 插件开发-添加字段level
- 添加temperature字段,表示温度。
- “数据类型”,在产品模型中,temperature属性的“数据类型”为int,最大值1000,因此在插件中定义temperature字段的“数据类型”为“int16u”,以满足temperature属性的取值范围。
- “偏移值”是根据与首字段的间隔的字符数自动配置的。“temperature”字段的起始位置就是前一字段的终点,前一字段“level”的终点位置为2,所以“temperature”字段的起始位置为2。“temperature”字段长度为2个字节,终点为4。所以“偏移值”为2-4。
- “长度”根据数据类型的配置自动填充。
- “默认值”不填,此处温度temperature的值不固定,无默认值。
图5 插件开发-添加字段temperature
- 单击“新增消息”,新增“SET_ALARM”消息,设置火灾告警的温度阈值。例如超过60摄氏度,设备上报告警。配置此步骤的主要目的是,将平台下发的JSON格式命令消息编码成二进制数据,以便烟感设备理解。配置示例如下:
- 消息名:SET_ALARM
- 消息类型:命令下发
- 添加响应字段:是。添加响应字段后,设备在接收命令后,可以上报命令执行结果。您可以根据自己的需求,选择是否添加响应字段。
图6 插件开发-新增消息SET_ALARM
- 单击“添加字段”,添加messageId字段,表示消息类型。例如,设置火灾告警阈值的消息类型为0x3。messageId、数据类型、长度、默认值、偏移值的说明可参考1。
图7 插件开发-添加命令字段messageId(0x3)
- 添加mid字段。这里的mid字段是由平台生成和下发的,用于将下发的命令和命令下发响应消息关联。mid字段的数据类型默认为int16u。长度、默认值、偏移值的说明可参考2。
图8 插件开发-添加命令字段mid
- 添加value字段,表示下发命令的参数值。例如,下发火灾告警的温度阈值。数据类型、长度、默认值、偏移值的说明可以参考2。
图9 插件开发-添加命令字段value
- 单击“添加响应字段”,添加“messageId”字段,表示消息类型。命令下发响应消息为上行消息,需要通过messageId和数据上报消息进行区分。上报火灾告警温度阈值的消息类型为0x4。messageId、数据类型、长度、默认值、偏移值的说明可参考1。
图10 插件开发-添加响应字段messageId(0x4)
- 添加mid字段。这里的mid字段需要跟平台下发的命令里的mid字段保持一致,用于将下发的命令和命令执行结果进行关联。mid字段的数据类型默认为int16u。长度、默认值、偏移值的说明可参考2。
图11 插件开发-添加响应字段mid
- 添加errcode字段,用于表示命令执行状态:00表示成功,01表示失败,如果未携带该字段,则默认命令执行成功。errcode字段的数据类型默认为int8u。长度、默认值、偏移值的说明可参考2。
图12 插件开发-添加响应字段errcode
- 添加result字段,用于表示命令执行结果。例如,设备向平台返回当前的告警阈值。
图13 插件开发-添加响应字段result
- 单击“添加字段”,添加messageId字段,表示消息类型。例如,设置火灾告警阈值的消息类型为0x3。messageId、数据类型、长度、默认值、偏移值的说明可参考1。
- 拖动右侧“设备模型”区域的属性字段和命令字段,数据上报消息和命令下发消息的相应字段建立映射关系。
图14 插件开发-在线开发插件smokerdetector
- 单击“保存”,并在插件保存成功后单击“部署”,将编解码插件部署到物联网平台。
图15 插件开发-部署插件
调测编解码插件
- 在烟感产品的开发空间,选择“在线调试”,并单击“新增测试设备”。
- 用户可根据自己的业务场景,选择使用真实设备或者虚拟设备进行调测。具体调测步骤请参考在线调试。本文以虚拟设备为例,调测编解码插件。
在弹出的“新增测试设备”窗口,选择“虚拟设备”,单击“确定”,创建一个虚拟设备。虚拟设备名称包含 “DeviceSimulator”字样,每款产品下只能创建一个虚拟设备。
图16 在线调试-创建虚拟设备 - 单击“调试”,进入调试界面。
图17 在线调试-进入调试
- 使用设备模拟器进行数据上报。十六进制码流示例:0008016B。00为地址域messageId,08表示火灾级别level,长度为1个字节;016B表示温度,长度为2个字节。
在“应用模拟器”区域查看数据上报的结果:{level=8, temperature=363}。8为十六进制数08转换为十进制的数值;363为十六进制数016B转换为十进制的数值。
在设备模拟器区域看到平台下发的响应数据AAAA0000。
图18 在线调试-模拟数据上报smokerdetector - 使用应用模拟器进行命令下发,输入value值为1,可看到应用模拟下发命令{ "serviceId": "Smokeinfo", "method": "SET_ALARM", "paras": "{\"value\":1}" }。
在“设备模拟器”区域查看命令接收的结果:03000101。03为地址域messageId,0001为mid字段,01为十进制数1转换为十六进制的数值。
图19 在线调试-模拟命令下发smokerdetector使用CoAP的虚拟设备在线调试时,若下发命令后设备模拟器未接收到对应的命令,可以先上报一次属性后,再下发。
总结
- 如果插件需要对命令执行结果进行解析,则必须在命令和命令响应中定义mid字段。
- 命令下发的mid是2个字节,对于每个设备来说,mid从1递增到65535,对应码流为0001到FFFF。
- 设备执行完命令,命令执行结果上报中的mid要与收到命令中的mid保持一致,这样平台才能刷新对应命令的状态。