设备通信协议.docx
《设备通信协议.docx》由会员分享，可在线阅读，更多相关《设备通信协议.docx（31页珍藏版）》请在冰点文库上搜索。
设备通信协议
设备通信协议
适用范围
本协议概念WiFi模块与MCU操纵单元，WiFi模块与云APP间，和主从模块之间的通信协议框架。
1.协议框架
协议基于二进制协议框架，完成命令发送接收、命令上报、内部组网等功能。
2.协议内容
设备内部组网协议（或MCU透传模式协议）
备内部组网协议包括设备配对、连接、心跳机制等，目的是将一个子设备加入到设备组中，并维持连接。
通信命令格式
采纳二进制的通信协议格式，包格式如下表：
同步头
Head
Option
包长度（变长）
加密随机数（Option）
源设备类型（Option）
源设备编码（Option）
CMDKey
CMDID
Payload
CRC（Option）
2B
1B
1~2B
1B
1B
3B
1B
1B
NB
2B
详细的包格式在后续章节介绍
配对机制
配对机制仅适用于设备内组网模式，MCU透传模式不需要组网协议。
进入配对模式由主从设备别离触发，只有在进入配对模式后，才处置相关的配对命令。
从设备进入配对模式后按时发送配对请求，直到收到请求回应。
主设备收到请求后分派一个设备ID给从设备，标识此ID被占用，并等待搜集器的上线通知，一按时刻内收到通知以后确认存入设备列表，若是没有上线通知，那么以为设备没有配对成功，从子设备中删除。
从设备收到配对回应后存储设备ID，而且发送上线通知，收到上线通知后完成配对。
配对的进程如以下图所示：
连接机制
设备每次上电连接需要发送上线通知和连接所需要的参数给主设备，如以下图所示：
心跳机制
利用对等的心跳机制，主设备和从设备都能够发觉对方的异样状态。
设备与云端通信协议
设备与云端通信协议基于MQTT协议，数据包利用MQTT协议传输，数据加密方式采纳SSL加密，命令码采纳2进制命令格式同设备间通信协议。
MQTT通信框架
本协议是针对与设备的数据通信，目前通信节点包括：
设备、云端和APP终端三方。
WIFI上的协议采纳MQTT协议框架，串口上的通信采纳包括包头和校验的二进制协议，通信包采纳二进制格式传输，高位在前低位在后。
Ø此协议概念的MQTTTopic类型有以下2种：
1单播，unicast
/u/{TargetType}/{TargetID}
2广播，broadcast
/b/{SourceType}/{SourceID}
注释：
TargetType：
目标设备类型，TargetID：
目标设备编码
SourceType：
源设备类型，SourceID：
源设备编码
通信命令格式
设备与云端、APP的通信命令分为4种：
请求与回应、通知命令、广播命令，具体的命令和格式在后面章节介绍。
连接流程
设备连接云端的步骤如以下图：
数据包格式概念
数据包的格式依照通信两边的不同、数据链路的不同会有不同的包格式，本协议为尽可能保证数据包格式的统一，做了几点计划：
1.数据包格式中核心的部份包括CMDID和CMDPayload，这两部份格式所有的包中维持一致，CMDID1个字节，CMDPayload紧跟CMDID长度N字节。
2.设备间通信，包括内部命令、外部转发命令等的数据包格式尽管可能不一样，可是都能够通过包头中的Option字节进行区分，能够公用相同的解析函数
3.外部串口通信的命令格式与设备间通信格式维持一致。
3.3.1设备间通信数据格式
同步头
Head
Option
包长度（变长）
加密随机数（Option）
源设备类型（Option）
源设备编码（Option）
CMDKey
CMDID
Payload
CRC（Option）
2B
1B
1~2B
1B
1B
3B
1B
1B
NB
2B
Fixheader
固定帧头，格式如下表：
同步头
HeadOption
包长度（变长）
2Byte
1Byte
1~2Byte
同步头：
0x5CFE
HeadOption：
Bit7
Bit6
Bit5
Bit4
Bit3
Bit2
Bit1
Bit0
预留
预留
预留
预留
CheckSum校验
广播类型链路
CRC校验
加密选项
typedefenum
{
OPTIONAL_ENCRYPT_BIT=（1<<0）,
OPTIONAL_CRC_BIT=（1<<1）,
OPTIONAL_BROADCAST_DATALINK_BIT=（1<<2）,
OPTIONAL_CHECKSUM_BIT=（1<<3）,
}OptionalBitsT;
包长度：
长度包括本字节以后的所有数据的长度
长度是1~2个字节
字节数
取值
长度范围
1
0x0~0x7F
0~127
2
0x0180~0x7FFF
128~16383
长度的编码方式参考MQTT：
如长度是321=（65+2*128），那么会被编码为两个字节，低字节为65+128=193.高字节为2。
可变包格式
可变包格式需要通过HeadOption来解析，格式如下表：
OptionBit0
OptionBit2
OptionBit1
OptionBit3
加密随机数
设备类型
设备编码
消息体......
CRC校验
CheckSum
1Byte
1Byte
3Byte
......
2Byte
1Byte
异或随机数：
如HeadOption中的加密选项为0，那么加密随机数那个字节不存在，同时数据可不能进行加密
源设备信息：
用于广播类型的数据链路，需要标识数据的来源。
CRC校验：
采纳16bit的CRC算法，CRC算法参照附录。
CheckSum:
采纳8Bit的和校验，用于对数据长度比较灵敏，可是又需要进行数据校验的场景
设备编码和设备类型：
Payload中可能需要用到的内部设备Type和ID的概念：
内部设备Type和设备ID在设备配对时由主设备分派给从设备，
其中Type由主设备获取到从设备的DeviceType以后映射一个数值，并分派给从设备，成立映射关系。
ID的3字节组成为：
Byte3
Byte2
Byte1
随机数，避免不同子网的ID冲突
ID序号，由主设备维护
命令消息体
结构如下表
CMDkey
CMDID
Payload
1Byte
1Byte
NByte
CMDKey：
命令标识，要紧作用是标识命令的类型和编号，由主设备生成，发送给从设备，从设备将key返回给主设备，另外在还标识命令的类型
CMDKey
描述
备注
1
设备内部消息（组网、透传模式的内部消息）
这些命令没有重发机制，不能保障一定到达
2
Notify类消息
3
Broadcast类消息
4~31
预留reserved
32~255
动态分配的key，用于数据的转发、透传
此范围的命令如果没有回复会重发，重发一定次数后丢弃，所以此消息可能会多次到达
CMDID:
命令码，1个字节
命令码
描述
1
配对请求
2
配对请求回应
3
设备启动通知
4
设备启动回应
5
WiFi就绪通知
6
WiFi断开通知
7
云就绪通知
8
云断开通知
9
WiFi上电通知
10
WiFi模块配置完成通知
11
退出WiFi模块配置
12
退出WiFi模块配置回应
13
重新配置WiFi模块
14
重新配置WiFi模块回应
15
设置WiFi模块串口波特率
16
设置WiFi模块串口波特率回应
17
查询WiFi模块串口波特率
18
查询WiFi模块串口波特率回应
WiFi模块消息起始
32
设备上线通知
33
WiFi配置完成通知
34
获取设备WiFi模块监控信息
35
获取设备WiFi模块监控信息回应
36
设置路由器信息
37
设置路由器信息的回应
38
删除子设备
39
删除子设备回应
40
获取在线设备列表
41
获取在线设备列表回应
42
设置设备拥有者
43
设置设备拥有者回应
44
设置配对模式
45
设置配对模式回应
46
在线设备列表变更通知
47~63
WiFi模块预留
所有设备公共命令起始
64
主MCUOTA传输文件
65
主MCUOTA传输文件回应
66
设置出厂参数
67
设置出厂参数回应
68
DebugLog输出控制
69
DebugLog输出控制回应
70
DebugLog信息输出
71
从MCUOTA传输文件
72
从MCUOTA传输文件回应
73
云端推送通知信息
76
OTA完成通知上报
77~95
设备公共命令预留
设备业务命令起始
96~127
设备自定义设备内部消息
128~255
设备自定义设备与云端/APP通讯消息
Payload：
命令数据,N字节
实例
一个所有Option都打开的包结构如下：
同步头
Head
Option
包长度（变长）
加密随机数（Option）
源设备类型（Option）
源设备编码（Option）
CMDKey
CMDID
Payload
CRC（Option）
2B
1B
1~2B
1B
1B
3B
1B
1B
NB
2B
数据组包实例
以下是利用CRC校验，而且加密的数据包的组包进程：
假设命令包是1234,4个字节，此刻要组包
1：
CRC
第一步计算这4个字节的crc值，假设算出来是五、6
第一步CRC以后的数据包就变成了一、二、3、4、五、6,6个字节
2：
加密
加密第一步：
加入一个随机数，假设那个随机数是0，此刻包确实是7个字节了，0、一、二、3、4、五、6
加密第二步：
异或，将除加密随机数外的其他数据都和加密随机数进行异或，取得得数据应该是0、一、二、3、4、五、6
机密第三步：
查表加密，假设表中0对应的是六、1对应的是5依次类推，那么查表以后的数据变成了六、五、4、3、二、一、0
加密终止,payload最终确实是六、五、4、3、二、一、0了
3：
加入包头
Payload是7个字节，optional是CRC和加密，那么包头为FE5C0307
最终包数据为：
FE5C030706050403020100
解包的进程与组包相反
设备与云、APP通信数据格式
命令数据格式：
源设备类型
源设备ID
CMDID
5Byte
12Byte
1Byte
NByte
3.3.2Pad串口通信数据格式
下行数据格式，PAD->设备
同步头
Head
Option
包长度（变长）
加密随机数（Option）
源设备类型（Option）
源设备编码（Option）
源设备GUID
目标设备GUID
CMDID
Payload
CRC（Option）
2B
1B
1~2B
1B
1B
3B
34字节
1B
NB
2B
上行数据格式，设备->PAD
同步头
Head
Option
包长度（变长）
加密随机数（Option）
源设备类型（Option）
源设备编码（Option）
源设备GUID
CMDID
Payload
CRC（Option）
2B
1B
1~2B
1B
1B
3B
34字节
1B
NB
2B
4.公共命令概念
下表是公共命令码和命令数据的概念，此表仅涉及到上文提到的CMDID和命令信息码（或答复码），命令中的其他部份数据请参考上文中的数据包概念。
命令码
命令描述
通信方
命令组成
备注
设备内部命令起始
1
请求配对
从设备->主设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙业务设备类型[5Byte]
∙当前的内部设备类型[1Byte]
∙当前的内部设备编码[3Byte]，全0表示未配置过，非全0表示之前配置过
∙设备业务编码长度[1Byte]
∙设备业务编码[NByte]
∙
5个字节的业务设备类型，需要向乐君申请，并且保存在从设备中
设备业务编码是用从设备自行定义的设备ID字符串，不超过32字节
2
请求配对回应
主设备->从设备
∙CMDKey,0x01
∙CMDID[1Byte]
∙RC[1Byte],参考RC表
∙分配的设备类型[1Byte]
∙分配的设备ID[3Byte]
3
设备启动通知
MCU/从设备->主设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙版本号[1Byte]
∙子设备类型[1Byte],参考章节：
子设备类型表
∙业务设备类型[5Byte]
∙内部设备类型[1Byte]
∙内部设备编码[3Byte]
∙设备业务编码长度[1Byte]
∙设备业务编码[NByte]
∙
4
设备启动通知的回应
主设备->MCU/从设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],参考RC表
5
WiFi就绪通知
主设备->MCU/从设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
6
WiFi断开通知
主设备->MCU/从设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
7
云就绪通知
主设备->MCU/从设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
8
云断开通知
主设备->MCU/从设备
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
9
WiFi模块上电通知
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
WiFi模块上电后定时发送上电通知给MCU，直至MCU上报上线通知给WiFi模块（适用于用于透传模式）
10
WiFi模块配置完成通知
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],0成功，3超时，4退出
11
退出WiFi模块配置
MCU->WiFi模块
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
12
退出WiFi模块配置回应
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],0成功，1失败
13
重新配置WiFi模块
MCU->WiFi模块
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
14
重新配置WiFi模块回应
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],0成功，1失败
15
设置WiFi模块串口波特率
MCU->WiFi模块
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙Baudrate[4Byte]
Baudrate取值：
9600
19200
38400
57600
115200
其他值返回fail
默认值是9600
16
设置WiFi模块串口波特率回应
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],0成功，1失败
返回值以新设置的波特率发送
17
查询WiFi模块串口波特率
MCU->WiFi模块
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙
18
查询WiFi模块串口波特率回应
WiFi模块->MCU
∙CMDKey[1Byte],0x01
∙CMDID[1Byte]
∙RC[1Byte],0成功，1失败
∙Baudrate[4Byte]
∙
WiFi模块命令起始
32
设备信息上报
WiFi模块->Cloud/APP
∙CMDID[1Byte]
∙Num［1Byte］，设备个数
∙设备拥有者的小智ID[string,10字节]
∙WiFi模块Mac地址[ASCII,12字节]
∙GUID[ASCII,17字节]、设备业务编码长度[1Byte]、设备业务编码[NByte]、固件版本［1BYTE］、设备硬件架构类型[1BYTE]、设置是否在线[1Byte]，若干
MQTT主题：
/b/{SourceType}/{SourceID}
第一个设备是主设备
设备硬件架构类型参考
“设备硬件架构类型编码表”
设备是否在线，0不在线，1在线
33
WiFi配置完成通知
WiFi模块->APP
∙CMDID[1Byte]
∙设备GUID[ASCII,17字节]
∙用户的小智ID[string,10字节]
∙设备业务编码长度[1Byte]
∙设备业务编码[NByte]
MQTT主题：
/u/{TargetType}/{TargetID}
34
获取WiFi模块监控数据
Cloud/APP->WiFi模块
∙CMDID[1Byte]
∙
35
获取WiFi模块监控数据回应
WiFi模块->Cloud/APP
∙CMDID[1Byte]
∙WiFi模块连接信号强度[1Byte]，有符号的1个字节，一般范围在-100Dbm~0Dbm
∙WiFi模块型号[16byte],小于16字节的字符串
36
设置WiFi配置信息
APP/Cloud/串口控制端->设备
∙CMDID[1Byte]
∙是否设置拥有者ID[1Byte]，0不设置，1设置
∙设备拥有者的小智ID[string,10字节]
∙是否设置路由器信息[1Byte],0不设置，1设置
∙SSIDLen，用户名长度[1BYTE]，用户名长度小于等于32字节
∙PWDLen，密码长度[1BYTE]，密码小于等于64字节
∙SSID
∙PWD
37
设置WiFi配置信息回应
设备->APP/Cloud/串口控制端
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败
∙
38
删除子设备
APP/Cloud/串口控制端->设备
∙CMDID[1Byte]
∙GUID[ASCII,17字节]
∙
39
删除子设备回应
设备->APP/Cloud/串口控制端
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败
∙
40
获取设备列表
APP/Cloud/串口控制端->主设备
∙CMDID[1Byte]
∙
41
获取设备列表回应
主设备->APP/Cloud/串口控制端
∙CMDID[1Byte]
∙Num［1Byte］，设备个数
∙设备拥有者的小智ID[string,10字节]
∙WiFi模块Mac地址[ASCII,12字节]
∙GUID[ASCII,17字节]、设备业务编码长度[1Byte]、设备业务编码[NByte]、
设备是否在线，0不在线，1在线
固件版本［1BYTE］、设备硬件架构类型[1BYTE]、设置是否在线[1Byte]，若干
∙
44
设置设备进入配对模式
App/Cloud/串口控制端->设备
∙CMDID[1Byte]
∙
45
设置设备进入配对模式回应
设备->App/Cloud/串口控制端
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败）[BYTE]
∙
47
设置设备退出配对模式
App/Cloud/串口控制端->设备
∙CMDID[1Byte]
∙
48
设置设备退出配对模式回应
设备->App/Cloud/串口控制端
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败）[BYTE]
49
请求同步时间
设备->Cloud
∙CMDID[1Byte]
∙
50
请求同步时间回应
Cloud->设备
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败）[BYTE]
∙RTC时间[67Byte]，格式是{秒-分-时-日-月-年-星期几}，各一个字节
∙
星期几的范围从1~7,1表示星期一
51
扫描AP列表
控制端->设备
∙CMDID[1Byte]
∙
52
扫描AP列表回应
设备到控制端
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败）[BYTE]
∙APNumber[1Byte]，扫描到的AP数量
∙AP信息{
[32Byte]，SSID
[1Byte]，RSSI信号强度
}若干
SSID为字符串，最大32字节，返回数据中固定32字节位置存放SSID。
信号强度取值范围0~100
所有设备公共命令起始
64
主MCUOTA传输文件
Cloud->设备
∙CMDID[1Byte]
∙总包数[2Byte]
∙当前包号[2Byte]
∙包内容[NBYTE,最大长度1024]
65
主MCUOTA传输文件回应
设备->Cloud
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败，32包号错误，33数据校验错误）[1BYTE]
∙当前包号[2Byte]
66
设置出厂信息
App/Cloud->设备
∙CMDID[1Byte]
∙设备ID[12Byte]
∙设备业务ID长度[1Byte]
设备业务ID长度为0表示不需要设备业务ID
∙设备业务ID[NByte]
暂时只需要工厂测试程序支持
67
设置出厂信息回应
设备->App/Cloud
∙CMDID[1Byte]
∙RC（参考命令回应编码表：
0成功，1失败
∙
68
DebugLog输出控制
App/Cloud->设备
∙CMDID[1Byte]
∙DebugLog开关[1Byte],0关，1开
∙是否掉电保存[1Byte],0掉电不保存，1掉电保存
暂时云端实现
69
Deb
升级会员 