数组及可变长数组数据类型
场景说明
有一款烟感设备,具有如下特征:
- 具有烟雾报警功能(火灾等级)和温度上报功能,支持同时上报烟雾报警(火灾等级)和温度,也支持单独上报温度。
- 具备描述信息上报功能,描述信息支持数组和可变长度数组两种类型。
说明:
该场景旨在讲解数组及可变长度数组数据类型的编解码插件开发方式,数据上报和命令下发的插件开发方式类似,本章节以数据上报为例进行说明,因此省略命令下发的相关步骤。
Profile定义
在烟感产品的开发空间完成Profile定义。
编解码插件开发
本章只讲解描述信息(other_info)上报消息的插件开发步骤,烟雾报警(level)和温度(temperature)上报消息的插件开发步骤,请参见多条数据上报消息。
- 在烟感产品的开发空间,选择“编解码插件开发”。
- 配置数据上报消息,上报火灾等级和温度,操作步骤详见2。
- 配置数据上报消息,只上报温度,操作步骤详见3。
- 配置数据上报消息,上报数组类型的描述信息。
添加messageId字段,表示消息种类。在本场景中,0x0用于标识上报火灾等级和温度的消息,0x1用于标识只上报温度的消息,0x2用于标识上报描述信息(数组类型)的消息。
添加other_info字段,表示数组类型的描述信息。在本场景中,“长度”配置为5个字节。
- 配置数据上报消息,上报可变长度数组类型的描述信息。
添加messageId字段,表示消息种类。在本场景中,0x0用于标识上报火灾等级和温度的消息,0x1用于标识只上报温度的消息,0x3用于标识上报描述信息(可变长度数组类型)的消息。
添加length字段,表示数组长度。“数据类型”根据可变长度数组的长度进行配置,长度在255以内,配置为“int8u”。
添加other_info字段,表示可变长度数组类型的描述信息。“长度关联字段”选择“length”,“长度关联字段差值”和“数值长度”自动填充。
- 拖动右侧“设备模型”区域的属性字段,与数据上报消息的相应字段建立映射关系。
- 点击“保存”,并在插件保存成功后点击“部署”,将编解码插件部署到物联网平台。
调测编解码插件
- 在烟感产品的开发空间,选择“在线调测”,使用虚拟设备调试编解码插件。
勾选“没有真实的物理设备”,点击“创建”。
- 使用设备模拟器上报数组类型的描述信息。
十六进制码流示例:0211223344。02表示messageId,此消息上报数组类型的描述信息;11223344表示描述信息,长度为4个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=null}。描述信息不足5个字节,编解码插件无法解析。
十六进制码流示例:021122334455。02表示messageId,此消息上报数组类型的描述信息;1122334455表示描述信息,长度为5个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=ESIzRF=}。描述信息长度为5个字节,编解码插件解析成功。
十六进制码流示例:02112233445566。02表示messageId,此消息上报数组类型的描述信息;112233445566表示描述信息,长度为6个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=ESIzRF=}。描述信息长度超过5个字节,编解码插件截取前5个字节进行解析。
- 使用设备模拟器上报可变长度数组类型的描述信息。
十六进制码流示例:030101。03表示messageId,此消息上报可变长度数组类型的描述信息;01表示描述信息长度(1个字节),长度为1个字节;01表示描述信息,长度为1个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=AQ==}。AQ==是01经过base64编码后的值。
十六进制码流示例:03020102。03表示messageId,此消息上报可变长度数组类型的描述信息;02表示描述信息长度(2个字节),长度为1个字节;0102表示描述信息,长度为2个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=AQI=}。AQI=是01经过base64编码后的值。
十六进制码流示例:03030102。03表示messageId,此消息上报可变长度数组类型的描述信息;03表示描述信息长度(3个字节),长度为1个字节;0102表示描述信息,长度为2个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=null}。描述信息长度不足3个字节,编解码插件解析失败。
十六进制码流示例:0303010203。03表示messageId,此消息上报可变长度数组类型的描述信息;03表示描述信息长度(3个字节),长度为1个字节;010203表示描述信息,长度为3个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=AQID}。AQID是010203经过base64编码后的值。
十六进制码流示例:030301020304。03表示messageId,此消息上报可变长度数组类型的描述信息;03表示描述信息长度(3个字节),长度为1个字节;01020304表示描述信息,长度为4个字节。
在“应用模拟器”区域查看数据上报的结果:{other_info=AQID}。描述信息长度超过3个字节,编解码插件截取前3个字节进行解析,AQID是010203经过base64编码后的值。
base64编码方式说明
base64编码方式会把3个8位字节(3*8=24)转化为4个6位字节(4*6=24),并在每个6位字节前补两个0,构成4个8位字节的形式。如果要进行编码的码流不足3个字节,则用0填充,使用0填充的字节经编码输出的字符为“=”。
base64可以将16进制码流当做字符或者数值进行编码,两种方式获得的编码结果不同。以16进制码流01为例进行说明:
- 把01当作字符,不足3个字符,补1个0,得到010。通过查询ASCII码表,将字符转换为8位二进制数,即:0转换为00110000、1转换为00110001,因此010可以转换为001100000011000100110000(3*8=24)。再转换为4个6位字节:001100、000011、000100、110000,并在每个6位字节前补两个0,得到:00001100、00000011、00000100、00110000。这4个8位字节对应的10进制数分别为12、3、4、48,通过查询base64编码表,获得M(12)、D(3)、E(4),由于3个字符中,最后一个字符通过补0获得,因此第4个8位字节使用“=”表示。最终,把01当做字符,通过base64编码得到MDE=。
- 把01当作数值(即1),不足3个字符,补两个0,得到100。将数值转换为8位2进制数,即:0转换为00000000、1转换为00000001,因此100可以转换为000000010000000000000000(3*8=24)。在转换为4个6位字节:000000、010000、000000、000000,并在每个6位字节前补两个0,得到:00000000、00010000、00000000、00000000。这4个8位字节对应的10进制数分别为:0、16、0、0,通过查询base64编码表,获得A(0)、Q(16),由于3个数值中,最后两个数值通过补0获得,因此第3、4个8位字节使用“=”表示。最终,把01当作数值,通过base64编码得到AQ==。
总结
- 当数据类型为数组或可变长度数组时,插件是按照base64进行编解码的:上报数据时,将16进制码流进行base64编码,比如:01编码为“AQ==”;命令下发时,将字符进行base64解码,比如:“AQ==”解码为01。
- 当某字段的数据类型为可变长度数组时,该字段需要关联长度字段,长度字段的数据类型必须为int。
- 针对可变长度数组,命令下发和数据上报的编解码插件开发方式相同。
- 在线开发的编解码插件使用base64进行编码时,是将16进制码流当做数值进行编码。