设备通讯协议.docx

文档介绍：该【设备通讯协议 】是由【爱的奉献】上传分享，文档一共【23】页，该文档可以免费在线阅读，需要了解更多关于【设备通讯协议 】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。设备通信协议
目录
1.
适用范围
..........................................................................................................................错误!未定义书签。
2.
协议框架
..........................................................................................................................错误!未定义书签。
3.
协议内容
..........................................................................................................................错误!未定义书签。
设备内部组网协议(或者
MCU透传模式协议)........
错误!未定义书签。
通讯命令格式........................................
错误!未定义书签。
配对机制............................................
错误!未定义书签。
连接机制............................................
错误!未定义书签。
心跳机制............................................
错误!未定义书签。
设备与云端通讯协议.............................
错误!未定义书签。
通讯命令格式........................................
错误!未定义书签。
连接流程............................................
错误!未定义书签。
数据包格式定义.................................
错误!未定义书签。
设备间通讯数据格式...........................
错误!未定义书签。
设备与云、APP通讯数据格式..........................
错误!未定义书签。
4.
公共命令定义...............................................
错误!未定义书签。
5.
编码表.....................................................
错误!未定义书签。
节点类型编码表..................................
错误!未定义书签。
命令回应编码表..................................
错误!未定义书签。
适用范围
本协议定义WiFi模块与MCU控制单元,WiFi模块与云APP间,以及主从模块之间的通讯协议框架。
协议框架
协议基于二进制协议框架,完成命令发送接收、命令上报、内部组网等功能。
协议内容
设备内部组网协议(或者 MCU透传模式协议)
备内部组网协议包括设备配对、连接、心跳机制等,目的是将一个子设备加入到设备组中,并保持连接。
通讯命令格式
采用二进制的通讯协议格式,包格式如下表:
同步头
Head
包长度(变
加密随
源设备
源设备
CMDKey
CMDID
Payload
CRC(
Option
长)
机
数
类
型
编
码
Opti
(Option
(Option
(Option
on)
)
)
)
2B
1B
1~2B
1B
1B
3B
1B
1B
NB
2B
详细的包格式在后续章节介绍
配对机制
配对机制仅适用于设备内组网模式, MCU透传模式不需要组网协议。
进入配对模式由主从设备分别触发,只有在进入配对模式后,才处理相关的配对命令。
从设备进入配对模式后定时发送配对请求,直到收到请求回应。
主设备收到请求后分配一个设备 ID给从设备,标识此ID被占用,并等待采集器的上线通知,
一定时间内收到通知之后确认存入设备列表,如果没有上线通知,则认为设备没有配对成功,从子设备中删除。
从设备收到配对回应后存储设备 ID,并且发送上线通知,收到上线通知后完成配对。
配对的过程如下图所示:
主模块 从模块
进入配对模式
从设备发送配对
请求
主设备回应请求
从设备上线
主设备回应设备上线
配对结束
连接机制
设备每次上电连接需要发送上线通知以及连接所需要的参数给主设备,如下图所示:
WiFi模块 MCU/从模块
上线通知
上线通知回应
WiFi通路配置(仅
用于透传模式 )
云连接成功 (仅
用于透传模式 )
命令交互
状态上报
心跳机制
使用对等的心跳机制,主设备和从设备都可以发现对方的异常状态。
设备与云端通讯协议
设备与云端通讯协议基于 MQTT协议,数据包使用 MQTT协议传输,数据加密方式采用 SSL
加密,命令码采用 2进制命令格式同设备间通讯协议。
MQTT通讯框架
本协议是针对与设备的数据通信,目前通信节点包括:设备、云端和APP终端三方。WIFI上的协议采用MQTT协议框架,串口上的通信采用包含包头和校验的二进制协议,通信包采用二进制格式传输,高位在前低位在后。
此协议定义的 MQTTTopic类型有以下 2种:
① 单播,unicast
/u/{TargetType}/{TargetID}
② 广播,broadcast
/b/{SourceType}/{SourceID}
注释:
TargetType:目标设备类型, TargetID:目标设备编码
SourceType:源设备类型, SourceID:源设备编码
通讯命令格式
设备与云端、APP的通讯命令分为 4种:
请求与回应、通知命令、广播命令,具体的命令以及格式在后面章节介绍。
连接流程
设备连接云端的步骤如下图:
WiFi模块 云
等待连接路由
等待MCU上
电,获取密钥
https获取server
信息
https发送server
信息
建立MQTT连接
订阅设备主题
命令交互
状态上报
数据包格式定义
数据包的格式根据通讯双方的不同、数据链路的差异会有不同的包格式,本协议为尽量保证数据包格式的统一,做了几点规划:
数据包格式中核心的部分包括CMDID和CMDPayload,这两部分格式所有的包中保持一致,CMDID1个字节,CMDPayload紧跟CMDID长度N字节。
设备间通讯,包括内部命令、外部转发命令等的数据包格式虽然可能不一样,但是都可以通过包头中的Option字节进行区分,可以公用相同的解析函数
外部串口通讯的命令格式与设备间通讯格式保持一致。

同步头
Head
包长度(变
加密随
源设备
源设备
CMDKey
CMD
Payload
CRC(
Option
长)
机
数
类
型
编
码
ID
Opti
(Option
(Option
(Option
on)
)
)
)
2B
1B
1~2B
1B
1B
3B
1B
1B
NB
2B
Fixheader
固定帧头,格式如下表:
同步头
2Byte

HeadOption
1Byte

包长度(1~2Byte

变长)
同步头:
0x5CFE
HeadOption:
Bit7
Bit6
Bit5
Bit4
Bit3
Bit2
Bit1
Bit0
预留
预留
预留
预留
CheckSu
广播类
CRC校验
加密选项
m校验
型链路
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 设备自定义设备内部消息