设备通讯协议.doc

设备通信协议目录1.适用范围32.协议框架33.协议内容33.1设备内部组网协议〔或者MCU透传模式协议〕33.1.1 通讯命令格式33.1.2 配对机制33.1.3 连接机制43.1.4 心跳机制53.2 设备与云端通讯协议53.2.1 通讯命令格式53.2.2 连接流程53.3 数据包格式定义6设备间通讯数据格式63.3.2 设备与云、APP通讯数据格式94.公共命令定义105.编码表115.1节点类型编码表115.2命令回应编码表111. 适用范围本协议定义WiFi模块与MCU控制单元，WiFi模块与云APP间，以及主从模块之间的通讯协议框架2. 协议框架协议基于二进制协议框架，完成命令发送接收、命令上报、内部组网等功能3. 协议内容3.1设备内部组网协议〔或者MCU透传模式协议〕备内部组网协议包括设备配对、连接、心跳机制等，目的是将一个子设备参加到设备组中，并保持连接3.1.1 通讯命令格式采用二进制的通讯协议格式，包格式如下表：同步头HeadOption包长度(变长)加密随机数(Option)源设备类型(Option)源设备编码(Option)CMD KeyCMD IDPayloadCRC(Option)2B1B1~2 B1B1B3B1B1BNB2B详细的包格式在后续章节介绍3.1.2 配对机制配对机制仅适用于设备内组网模式，MCU透传模式不需要组网协议。

进入配对模式由主从设备分别触发，只有在进入配对模式后，才处理相关的配对命令从设备进入配对模式后定时发送配对请求，直到收到请求回应主设备收到请求后分配一个设备ID给从设备，标识此ID被占用，并等待采集器的上线通知，一定时间内收到通知之后确认存入设备列表，如果没有上线通知，则认为设备没有配对成功，从子设备中删除从设备收到配对回应后存储设备ID，并且发送上线通知，收到上线通知后完成配对配对的过程如下列图所示：3.1.3连接机制设备每次上电连接需要发送上线通知以及连接所需要的参数给主设备，如下列图所示：3.1.4心跳机制使用对等的心跳机制，主设备和从设备都可以发现对方的异常状态3.2 设备与云端通讯协议设备与云端通讯协议基于MQTT协议，数据包使用MQTT协议传输，数据加密方式采用SSL加密，命令码采用2进制命令格式同设备间通讯协议MQTT通讯框架本协议是针对与设备的数据通信，目前通信节点包括：设备、云端和APP终端三方WIFI上的协议采用MQTT协议框架，串口上的通信采用包含**和校验的二进制协议，通信包采用二进制格式传输，高位在前低位在后Ø 此协议定义的MQTT Topic类型有以下2种：① 单播，unicast/u/{TargetType}/{TargetID}② 播送，broadcast/b/{SourceType}/{SourceID}注释：TargetType：目标设备类型，TargetID：目标设备编码SourceType：源设备类型，SourceID：源设备编码3.2.2 通讯命令格式设备与云端、APP的通讯命令分为4种：请求与回应、通知命令、播送命令，具体的命令以及格式在后面章节介绍。

3.2.2 连接流程设备连接云端的步骤如下列图：3.3数据包格式定义数据包的格式根据通讯双方的不同、数据链路的差异会有不同的包格式，本协议为尽量保证数据包格式的统一，做了几点规划：1. 数据包格式中核心的局部包括CMD ID和CMD Payload，这两局部格式所有的包中保持一致，CMD ID 1个字节，CMD Payload紧跟CMD ID长度N字节2. 设备间通讯，包括内部命令、外部转发命令等的数据包格式虽然可能不一样，但是都可以通过**中的Option字节进展区分，可以公用一样的解析函数3. 外部串口通讯的命令格式与设备间通讯格式保持一致3.3.1 设备间通讯数据格式同步头HeadOption包长度(变长)加密随机数(Option)源设备类型(Option)源设备编码(Option)CMD KeyCMD IDPayloadCRC(Option)2B1B1~2 B1B1B3B1B1BNB2B3.3.1.1 Fi* header固定帧头，格式如下表：同步头Head Option包长度(变长)2Byte1Byte1~2 Byte同步头：0*5CFEHead Option：Bit7Bit6Bit5Bit4Bit3Bit2Bit1Bit0预留预留预留预留CheckSum校验播送类型链路CRC校验加密选项typedef enum{ OPTIONAL_ENCRYPT_BIT = (1<<0), OPTIONAL_CRC_BIT = (1<<1), OPTIONAL_BROADCAST_DATALINK_BIT = (1<<2), OPTIONAL_CHECKSUM_BIT = (1<<3),} OptionalBitsT;包长度：长度包括本字节之后的所有数据的长度长度是1~2个字节字节数取值长度范围10*0~0*7F0~12720*0180~0*7FFF128~16383长度的编码方式参考MQTT：如长度是321=(65 + 2*128) ，则会被编码为两个字节，低字节为65+128 = 193. 高字节为2。

3.3.1.2 可变包格式可变包格式需要通过Head Option来解析，格式如下表：Option Bit0Option Bit2Option Bit1Option Bit3加密随机数设备类型设备编码消息体......CRC校验CheckSum1Byte1Byte3Byte......2Byte1Byte异或随机数：如Head Option中的加密选项为0，则加密随机数这个字节不存在，同时数据不会进展加密源设备信息：用于播送类型的数据链路，需要标识数据的来源CRC校验：采用16bit的CRC算法，CRC算法参照附录CheckSum:采用8Bit的和校验，用于对数据长度比拟敏感，但是又需要进展数据校验的场景设备编码和设备类型：Payload中可能需要用到的内部设备Type和ID的定义：内部设备Type和设备ID在设备配对时由主设备分配给从设备，其中Type由主设备获取到从设备的Device Type之后映射一个数值，并分配给从设备，建立映射关系ID的3字节构成为：Byte3Byte2Byte 1随机数，防止不同子网的ID冲突ID序号，由主设备维护3.3.1.3命令消息体构造如下表CMD keyCMD IDPayload1Byte1ByteN ByteCMD Key：命令标识，主要作用是标识命令的类型以及编号，由主设备生成，发送给从设备，从设备将key返回给主设备，另外在还标识命令的类型CMD Key描述备注1设备内部消息(组网、透传模式的内部消息)这些命令没有重发机制，不能保障一定到达2Notify类消息3Broadcast类消息4~31预留reserved32~255动态分配的key，用于数据的转发、透传此范围的命令如果没有回复会重发，重发一定次数后丢弃，所以此消息可能会屡次到达CMD ID:命令码，1个字节命令码描述1配对请求2配对请求回应3设备启动通知4设备启动回应5WiFi就绪通知6WiFi断开通知7云就绪通知8云断开通知9WiFi上电通知10WiFi模块配置完成通知11退出WiFi模块配置12退出WiFi模块配置回应13重新配置WiFi模块14重新配置WiFi模块回应15设置WiFi模块串口波特率16设置WiFi模块串口波特率回应17查询WiFi模块串口波特率18查询WiFi模块串口波特率回应WiFi模块消息起始32设备上线通知33WiFi配置完成通知34获取设备WiFi模块监控信息35获取设备WiFi模块监控信息回应36设置路由器信息37设置路由器信息的回应38删除子设备39删除子设备回应40获取设备列表41获取设备列表回应42设置设备拥有者43设置设备拥有者回应44设置配对模式45设置配对模式回应46设备列表变更通知47~63WiFi模块预留所有设备公共命令起始64主MCU OTA传输文件65主MCU OTA传输文件回应66设置出厂参数67设置出厂参数回应68Debug Log输出控制69Debug Log输出控制回应70Debug Log信息输出71从MCU OTA传输文件72从MCU OTA传输文件回应73云端推送通知信息76OTA完成通知上报77~95设备公共命令预留设备业务命令起始96~127设备自定义设备内部消息128~255设备自定义设备与云端/APP通讯消息Payload：命令数据, N字节5.4 实例一个所有Option都翻开的包构造如下：同步头HeadOption包长度(变长)加密随机数(Option)源设备类型(Option)源设备编码(Option)CMD KeyCMD IDPayloadCRC(Option)2B1B1~2 B1B1B3B1B1BNB2B3.3.1.4 数据组包实例以下是使用CRC校验，并且加密的数据包的组包过程：假设命令包是1 2 3 4,4个字节，现在要组包1：CRC第一步计算这4个字节的crc值，假设算出来是5、6第一步CRC之后的数据包就变成了1、2、3、4、5、6, 6个字节2：加密 加密第一步：参加一个随机数，假设这个随机数是0 ，现在包就是7个字节了，0、1、2、3、4、5、6 加密第二步：异或 ，将除加密随机数外的其他数据都和加密随机数进展异或，得到得数据应该是0、1、2、3、4、5、6 **第三步：查表加密，假设表中0对应的是6、1对应的是5依次类推，则查表之后的数据变为了6、5、4、3、2、1、0加密完毕,payload最终就是6、5、4、3、2、1、0了 3：参加**Payload是7个字节，optional是CRC和加密，则**为FE 5C 03 07最终包数据为：FE 5C 03 07 06 05 04 03 02 01 00解包的过程与组包相反3.3.2 设备与云、APP通讯数据格式命令数据格式：源设备类型源设备IDCMD ID5Byte12Byte1ByteN Byte3.3.2 Pad串口通讯数据格式下行。