设备通讯协议

设备通信协议

1.适用范围 (3)

2.协议框架 (3)

3.协议内容 (3)

3.1设备内部组网协议（或者MCU透传模式协议） (3)

3.1.1 通讯命令格式 (3)

3.1.2 配对机制 (3)

3.1.3 连接机制 (4)

3.1.4 心跳机制 (5)

3.2 设备与云端通讯协议 (5)

3.2.1 通讯命令格式 (5)

3.2.2 连接流程 (5)

3.3 数据包格式定义 (6)

3.3.1 设备间通讯数据格式 (6)

3.3.2 设备与云、APP通讯数据格式 (11)

4. ..............................................................................................................................................公共命令定义 11

5. ........................................................................................................................................................... 编码表 18

5.1节点类型编码表 (18)

5.2命令回应编码表 (18)

1.适用范围

本协议定义WiFi模块与MCU控制单元，WiFi模块与云APP间，以及主从模块之间的通讯协议框架。

2.协议框架

协议基于二进制协议框架，完成命令发送接收、命令上报、内部组网等功能。

3.协议内容

3.1设备内部组网协议（或者MCU透传模式协议）

备内部组网协议包括设备配对、连接、心跳机制等，目的是将一个子设备加入到设备组中，并保持连接。3.1.1 通讯命令格式

采用二进制的通讯协议格式，包格式如下表：

详细的包格式在后续章节介绍

3.1.2 配对机制

配对机制仅适用于设备内组网模式，MCU透传模式不需要组网协议。

进入配对模式由主从设备分别触发，只有在进入配对模式后，才处理相关的配对命令。

从设备进入配对模式后定时发送配对请求，直到收到请求回应。

主设备收到请求后分配一个设备ID给从设备，标识此ID被占用，并等待采集器的上线通知，一定时间内收到通知之后确认存入设备列表，如果没有上线通知，则认为设备没有配对成功，从子设备中删除。

从设备收到配对回应后存储设备ID，并且发送上线通知，收到上线通知后完成配对。

配对的过程如下图所示：

3.1.3 连接机制

设备每次上电连接需要发送上线通知以及连接所需要的参数给主设备，如下图所示：

3.1.4 心跳机制

使用对等的心跳机制，主设备和从设备都可以发现对方的异常状态。

3.2 设备与云端通讯协议

设备与云端通讯协议基于MQTT协议，数据包使用MQTT协议传输，数据加密方式采用SSL加密，命令码采用2进制命令格式同设备间通讯协议。

3.2.1 MQTT通讯框架

本协议是针对与设备的数据通信，目前通信节点包括：设备、云端和APP终端三方。WIFI上的协议采用MQTT 协议框架，串口上的通信采用包含包头和校验的二进制协议，通信包采用二进制格式传输，高位在前低位在后。

?此协议定义的MQTT Topic类型有以下2种：

①单播，unicast

/u/{TargetType}/{TargetID}

②广播，broad cast

/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设备间通讯数据格式

3.3.1.1 Fix header

固定帧头，格式如下表：

同步头：

0x5CFE

typedef enum

{

OPTIONAL_ENCRYPT_BIT = (1<<0),

OPTIONAL_CRC_BIT = (1<<1),

OPTIONAL_BROADCAST_DA TALINK_BIT = (1<<2),

OPTIONAL_CHECKSUM_BIT = (1<<3),

} OptionalBitsT;

包长度：

长度包括本字节之后的所有数据的长度

长度是1~2个字节

长度的编码方式参考MQTT：

如长度是321=(65 + 2*128) ，那么会被编码为两个字节，低字节为65+128 = 193. 高字节为2。

3.3.1.2 可变包格式

异或随机数：

如Head Option中的加密选项为0，那么加密随机数这个字节不存在，同时数据不会进行加密

源设备信息：

用于广播类型的数据链路，需要标识数据的来源。

CRC校验：

采用16bit的CRC算法，CRC算法参照附录。

CheckSum:

采用8Bit的和校验，用于对数据长度比较敏感，但是又需要进行数据校验的场景

设备编码和设备类型：

Payload中可能需要用到的内部设备Type和ID的定义：

内部设备Type和设备ID在设备配对时由主设备分配给从设备，

其中Type由主设备获取到从设备的Device Type之后映射一个数值，并分配给从设备，建立映射关系。

3.3.1.3命令消息体

结构如下表

CMD Key：

命令标识，主要作用是标识命令的类型以及编号，由主设备生成，发送给从设备，从设备将key返回给主设备，

CMD ID:

Payload：

命令数据, N字节

5.4 实例

3.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通讯数据格式

命令数据格式：

3.3.2Pad串口通讯数据格式

4.公共命令定义

下表是公共命令码以及命令数据的定义，此表仅涉及到上文提到的CMD ID和命令信息码（或回复码），命令中的其他部分数据请参考上文中的数据包定义。

5.编码表

5.1节点类型编码表

5.2命令回应编码表

5.3 子设备类型表

5.4 设备硬件架构类型编码表

6.附录

6.1 CRC校验算法

static const uint8 c_crc_htalbe[] = // CRC 高8位查表

{