字符串及可变长字符串的编解码插件

如果该烟感设备需要支持描述信息上报功能，描述信息支持字符串和可变长度字符串两种类型，则按照以下步骤创建消息。

产品模型定义

重新创建一个烟感产品，并在烟感产品的开发空间完成产品模型定义。

图20 模型定义-smokedetector携带other_info

编解码插件开发

1. 在烟感产品的开发空间，选择“插件开发”，单击“图形化开发”。
2. 单击“新增消息”，新增消息“other_info”，上报字符串类型的描述信息。配置此步骤的主要目的是，将设备上传的字符串二进制码流消息解码成JSON格式，以便 物联网平台 理解。配置示例如下：
   • 消息名：other_info
   • 消息类型：数据上报
   • 添加响应字段：是。添加响应字段后，物联网平台在收到设备上报的数据后，会下发用户设置的响应数据到设备。
   • 响应数据：AAAA0000（默认）
   图21 插件开发-新增消息other_info
   
   1. 单击“添加字段”，添加messageId字段，表示消息种类。在本场景中，0x0用于标识上报火灾等级和温度的消息，0x1用于标识只上报温度的消息，0x2用于标识上报描述信息（字符串类型）的消息。messageId、数据类型、长度、默认值、偏移值的说明可参考1。
      图22 插件开发-添加字段messageId(0x2)
      
   2. 添加other_info字段，表示字符串类型的描述信息。在本场景中，字符串类型的字段数据类型选择“string”，“长度”配置 6个字节。字段名、默认值、偏移值的说明可参考2。
      图23 插件开发-添加字段other_info
      

3. 单击“新增消息”，新增“other_info2”消息名，配置数据上报消息，上报可变长度字符串类型的描述信息。配置此步骤的主要目的是，将设备上传的可变长度字符串二进制码流消息解码成JSON格式，以便物联网平台理解。配置示例如下：
   • 消息名：other_info2
   • 消息类型：数据上报
   • 添加响应字段：是。添加响应字段后，物联网平台在收到设备上报的数据后，会下发用户设置的响应数据到设备。
   • 响应数据：AAAA0000（默认）
   图24 插件开发-新增消息other_info2
   
   1. 添加messageId字段，表示消息种类。在本场景中，0x0用于标识上报火灾等级和温度的消息，0x1用于标识只上报温度的消息，0x3用于标识上报描述信息（可变长度字符串类型）的消息。messageId、数据类型、长度、默认值、偏移值的说明可参考1。
      图25 插件开发-添加字段messageId(0x3)
      
   2. 添加length字段，表示可变字符串长度。“数据类型”根据可变长度字符串的长度进行配置，此场景可变字符串长度在255以内，配置为“int8u”。长度、默认值、偏移值的说明可参考2。
      图26 插件开发-添加字段length
      
   3. 添加other_info字段，数据类型选择“varstring”，表示可变长度字符串类型的描述信息。“长度关联字段”选择“length”，表示当前可变长字符串的长度由上报的length的值决定。“掩码”默认为“0xff”，用来计算该字段实际生效的长度，例如：“长度关联字段”length的值为5，其对应的二进制为：00000101，此时若掩码为0xff，对应的二进制为：11111111，那么两者进行“与“运算之后的结果为00000101，即十进制的5，那么该字段实际生效的长度为5个字节。如上报数据为03051234567890，表示当前上报的数据对应的是messageId为03的的message，可变长字符串长度为5个字节，可变长参数other_info对应的码流为1234567890。
      图27 插件开发-添加字段other_info为varstring
      

4. 拖动右侧“设备模型”区域的属性字段，与数据上报消息的相应字段建立映射关系。
   图28 插件开发-数据上报字段映射关系
   

5. 单击“保存”，并在插件保存成功后单击“部署”，将编解码插件部署到物联网平台。
   图29 插件开发-部署插件
   

调测编解码插件

1. 在烟感产品的开发空间，选择“在线调试”，并单击“新增测试设备”。
2. 用户可根据自己的业务场景，选择使用真实设备或者虚拟设备进行调测。具体调测步骤请参考在线调试。本文以虚拟设备为例，调测编解码插件。

   在弹出的“新增测试设备”窗口，选择“虚拟设备”，单击“确定”，创建一个虚拟设备。虚拟设备名称包含 “DeviceSimulator”字样，每款产品下只能创建一个虚拟设备。

   图30 在线调试-创建虚拟设备
   

3. 单击“调试”，进入调试界面。
   图31 在线调试-进入调试
   

4. 使用设备模拟器上报字符串类型的描述信息。

   十六进制码流示例：0231。02表示messageId，此消息上报字符串类型的描述信息；31表示描述信息，长度为1个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=null}。描述信息不足6个字节，编解码插件无法解析。

   图32 在线调试-模拟数据上报other_info长度不足
   

   十六进制码流示例：02313233343536。02表示messageId，此消息上报字符串类型的描述信息；313233343536表示描述信息，长度为6个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=123456}。描述信息长度为6个字节，编解码插件解析成功。

   图33 在线调试-模拟数据上报other_info长度合适
   

   十六进制码流示例：023132333435363738。02表示messageId，此消息上报字符串类型的描述信息；3132333435363738表示描述信息，长度为8个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=123456}。描述信息长度超过6个字节，编解码插件截取前6个字节进行解析。

   图34 在线调试-模拟数据上报other_info长度过长
   

   十六进制码流示例：02013132333435。02表示messageId，此消息上报字符串类型的描述信息；013132333435表示描述信息，长度为6个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=\u000112345}。01在ASCII码表里表示“标题开始”，无法用具体字符表示，因此编解码插件解析为\u0001。

   图35 在线调试-模拟数据上报other_info ASCII码
   

5. 使用设备模拟器上报可变长度字符串类型的描述信息。

   十六进制码流示例：030141。03表示messageId，此消息上报可变长度字符串类型的描述信息；01表示描述信息长度；41表示描述信息，长度为1个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=A}。41是A的十六进制ASCII码。

   图36 在线调试-模拟数据上报other_info可变长字符串1
   

   十六进制码流示例：03024142。03表示messageId，此消息上报可变长度字符串类型的描述信息；02表示描述信息的长度；4142表示描述信息，长度为2个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=AB}。4142是AB的十六进制ASCII码。

   图37 在线调试-模拟数据上报other_info可变长字符串2
   

   十六进制码流示例：030341424344。03表示messageId，此消息上报可变长度字符串类型的描述信息；03表示描述信息长度；41424344表示描述信息，长度为4个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=ABC}。描述信息长度超过3个字节，编解码插件截取前3个字节进行解析，414243是ABC的十六进制ASCII码。

   图38 在线调试-模拟数据上报other_info可变长字符串3
   

   十六进制码流示例：0304414243。03表示messageId，此消息上报可变长度字符串类型的描述信息；04表示字符串长度；414243表示描述信息，长度为4个字节。

   在“应用模拟器”区域查看数据上报的结果：{other_info=null}。描述信息长度不足4个字节，编解码插件解析失败。

   图39 在线调试-模拟数据上报other_info可变长字符串4
   

总结

• 当数据类型为字符串或可变长度字符串时，插件是按照ASCII码进行编解码的：上报数据时，将16进制码流解码为对应字符串，比如：21解析为“!”、31解析为“1”、41解析为“A”；下发命令时，将字符串编码对应的16进制码流，比如：“！”编码为21，“1”编码为31，“A”编码为41。
• 当某字段的数据类型为可变长度字符串时，该字段需要关联长度字段，长度字段的数据类型必须为int。
• 针对可变长度字符串，命令下发和数据上报的编解码插件开发方式相同。
• 图形化开发的编解码插件使用ASCII码16进制的标准表对字符串和可变长度字符串进行编解码。解码时（数据上报），如果解析结果无法使用具体字符表示，如：标题开始、正文开始、正文结束等，则使用\u+2字节码流值表示（例如：01解析为\u0001，02解析为\u0002）；如果解析结果可以使用具体字符表示，则使用具体字符。