简体中文
简体中文
English
联系我们
注册
登录
语言
简体中文
简体中文
English
联系我们
登录
注册
返回主站
layout空间导航

MCU 对接协议

更新时间:2021-05-30 17:04:27下载pdf

涂鸦 Wi-Fi 门锁串口通用协议为涂鸦定制的 Wi-Fi 模组串口通用协议,主要用于涂鸦 Wi-Fi 模组与其它门锁 MCU 串口直连做串口通信,其架构框图如下图所示。

MCU 对接协议

串口通信约定

  • 波特率:115200
  • 数据位:8
  • 奇偶校验:无
  • 停止位:1
  • 数据流控:无
  • MCU:用户控制板控制芯片,与涂鸦模组通过串口对接,协议设计上,所有包的交互为全双工通信设计

帧格式说明

字段 字节数 说明
帧头 2 固定为0x55aa
版本 1 升级扩展用
命令字 1 具体帧类型
数据长度 2 大端
数据 N -
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

说明:

  • 所有大于1个字节的数据均采用大端模式传输。

  • 协议中所有举例说明数据都是十六进制数据。

  • Wi-Fi模组主动发起的通信发送包超时时间为 500ms,重传次数为 2 次。

  • 一般情况下,采用同命令字一发一收同步机制,即一方发出命令,另一方应答,若发送方超时未收到正确的响应包,则超时传输,如下图所示:

    MCU 对接协议

    说明:具体通信方式以 协议详述 章节中为准。

  • MCU状态上报则采用同步模式,MCU状态上报“命令字”为 y,如下所示:

    MCU 统计数据上报:

    MCU 对接协议

DP 格式(状态数据单元)

字段 长度 说明
dp_id 1 dp点的指令码
dp_type 1 dp点的数据类型
dp_data_len 2 dp点的数据长度
dp_data_value dp_data_len dp点的数据(具体请看dp点详解)

dp_type数据类型及取值范围

dp_type 取值 长度(byte) 说明
raw 0 1~255 原始类型,详见dp点详解
bool 1 1 布尔值
value 2 4 值类型(int)
string 3 0~255 字符串(可能为空)
enum 4 1 枚举值

特别说明

  • 整套协议针对使用Wi-Fi模组且没法使用外电的设备。开发MCU程序的时候,对于断电管理尤为重要,在我们可以完成功能的前提下尽量减少Wi-Fi模组的上电时间,是节约设备功耗的关键。对于数据上传部分我们有给出大体的控制流程图,开发者可以根据自己设备的特性来选择协议中自己需要用到的功能。实际的开发中开发者可以根据自己的需要实时调整相关控制逻辑。
  • 实际产品很多日常设备中设备不开启 Wi-Fi 功能也可以正常使用,不排除用户在拿到设备的同时由于种种原因不使用Wi-Fi这个功能,为了防止这种情况下给 Wi-Fi 模组上电造成不必要的电能损耗,我们在设备端可以设计一个物理按键或者相关选项,只有当用户主动打开这个按键或则选项我们MCU才在每次数据变动的时候才去给Wi-Fi模组上电传输相关数据。

非保活 Wi-Fi 门锁对接

表格色块说明:通用接口拓展接口

帧名称 命令字 门锁基础版 门锁传图版
查询产品信息 0X01 支持 支持
报告设备联网状态 0X02 支持 支持
重置 Wi-Fi 0X03 支持 支持
重置 Wi-Fi-选择配置模式 0X04 支持 支持
实时状态上报 0X05 支持 支持
记录型状态上报 0X08 支持 支持
模组命令下发 0X09 支持 支持
获取本地时间 0X06 支持 支持
模组功能性测试 0X07 支持
(但不推荐,可用0XF0)
支持
(但不推荐,可用0XF0)
请求 Wi-Fi 模组固件升级 0X0A 支持
(WBR1和WBR3暂不支持)
可支持(但不推荐,可用0x21替换)
请求 MCU 固件升级 0X0C 支持
(WBR1和WBR3暂不支持)
可支持(但不推荐,可用0x21替换)
升级启动 0X0D 支持 支持
升级包传输 0X0E 支持 支持
查询当前连接路由信号强度 0X0B 支持 支持
请求云端临时密码(只支持单组) 0X11 支持 支持
动态密码校验 0X12 支持 支持
请求云端临时密码(支持多组) 0X13 支持 支持
请求云端临时密码(带schedule列表) 0X14 支持 支持
获取dp缓存命令 0X15 支持 支持
离线动态密码 0X16 支持 支持
上报MCU的SN号 0X17 支持 支持
模组重置状态通知 0X25 支持 支持
密码进制服务 0X1C 支持 支持
模组功能性测试 0XF0 支持 支持
自动升级 0X21 支持 支持
事件状态通知 0X60 不支持 支持
图片上传 0X61 不支持 支持
图片上传结果反馈 0X62 不支持 支持
图片上传状态获取 0X63 不支持 支持
触发抓拍命令 0X64 不支持 支持
触发结果通知 0X62 不支持 支持
图像寄存器配置 0X66 不支持 支持
图像参数配置 0X65 不支持 支持

协议详述

查询产品信息

  • product ID:对应涂鸦开发者平台 PID (产品标识),由涂鸦云开发者平台生成,用于云端记录产品相关信息
  • 产品信息由 product ID、MCU软件版本构成
  • MCU软件版本号格式定义:采用点分十进制形式,”x.x.x”(0<=x<=99),x为十进制数

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x01
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组发送:

55 aa 00 01 00 00 00

MCU返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x01
数据长度 2 N
数据 N {“p”:”vHXEcqntLpkAlOsy”, “v”:”1.0.0”, ”n”:0, ”cap”:0}
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

p 表示产品ID。
参数为用户在涂鸦官网创建的产品 PID:vHXEcqntLpkAIOsy

v 表示MCU版本
此处表示MCU版本为 1.0.0

n 字段(可选):表示模式的配网模式:

  • smartconfig、AP切换配网模式(默认为该模式)

    两种传统配网模式互相切换,每次复位会切换到另一种配网模式。

  • 仅仅只有AP配网模式(暂不支持)

    这种模式下产品只能通过AP连接的方式进行设备配网。

    cap字段表示设备能力:

    • bit0: 表示设备当前支持的拍照功能:
      0:不支持拍照/图片传输功能;
      1:支持拍照/图片传输功能;
    • bit1:表示设备采用哪种通信方式上传图片(仅在bit0为 1 时有效):
      0:表示串口;
      1:表示 SPI;
    • bit2:表示设备是否为运营商门锁(暂不支持此功能):
      0:表示不支持;
      1:表示支持;
    • bit3:表示设备是否支持模组重置状态通知:
      0:表示不支持;
      1:表示支持;

    注意:预留未使用位请按照 0 填充。

    例:{“p”:”vHXEcqntLpkAlOsy”,“v”:”1.0.0”,”n”:0,”cap”:11}

    MCU 返回例子信息:
    55 AA 00 01 00 2D 7B 22 70 22 3A 22 66 66 78 70 67 6A 71 64 6E 71 61 6C 6D 6B 64 6B 22 2C 22 76 22 3A 22 31 2E 30 2E 30 22 2C 22 63 61 70 22 3A 31 31 7D 95

报告设备联网状态

设备联网状态 描述 状态值
状态1 smartconfig 配置状态 0x00
状态2 AP 配置状态 0x01
状态3 Wi-Fi 已配置但未连上路由器 0x02
状态4 Wi-Fi 已配置且连上路由器 0x03
状态5 已连上路由器且连接到云端 0x04
状态6 Wi-Fi 设备处于低功耗模式 0x05
状态7 Wi-Fi设备处于 smartconfig 和 ap 共存配置状态 0x06 (暂不支持)
  • 设备联网状态:1 smartconfig 配置状态 2 AP 配置状态 3 Wi-Fi配置成功但未连上路由器 4 Wi-Fi配置成功且连上路由器 5 设备连接到路由器且连接到云端。
  • 当模组的Wi-Fi状态发生变化,则会主动下发Wi-Fi状态 至MCU。
  • 状态包用于MCU设备得知模组目前的状态,两种配置状态需要MCU做相关的配网显示。
  • 原则上我们要求我们的用户需要做两种配网方式,第一种配网方式存在少部分路由兼容性问题,第二种配网方式是确保设备可以联网成功的保障。
  • 在未配网前,模组上电默认处于低功耗状态。需要MCU主动发 重置Wi-Fi 指令后,模组才会进入配网状态。
  • 手机移除设备后,模组进入低功耗状态,需要MCU主动发 重置Wi-Fi 指令后,模组才会进入待配网状态。
  • Wi-Fi模组进入配网模式后,如果在 10S 内未连接路由并且模组断电了,下次模组上电后依旧保持上一次的配网状态。

注意:MCU在收到已连接路由器且连接到云端的状态之后,禁止立即给模组断电!需延时至少 3s 后断电,否则可能导致模组无法正常工作。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x02
数据长度 2 0x0001
数据 1 指示 Wi-Fi 工作状态:
0x00:状态1
0x01:状态2
0x02:状态3
0x03:状态4
0x04:状态5
0x05:状态6
0x06:状态7
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组发送:

55 aa 00 02 00 01 04 06 (已连上路由器且连接到云端)

MCU返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x02
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU返回:

55 aa 00 02 00 00 01

重置Wi-Fi

  • smartconfig&AP共存配网模式 :重置后仍然为共存配网状态;
  • 仅仅只有AP配网模式:重置后仍然为ap配网模式;
  • 传统两种配网模式互换配网模式:重置Wi-Fi状态转化如下图所示:

MCU 对接协议

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x03
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU发送:

55 aa 00 03 00 00 02

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x03
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

55 aa 00 03 00 00 02

重置Wi-Fi(选择配置模式)

  • 此重置指令只针对 查询产品信息 设置的 Wi-Fi 模式为传统的工作模式才有效
  • 相对于 重置Wi-Fi 而言,此帧提供MCU根据自身需求选择重置 Wi-Fi 后的配置方式
  • MCU接入用户可选择性的实现该协议

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x04
数据长度 2 0x0001
数据 1 0x00:进入 smartconifg 配置模式
0x01:进入热点连网模式
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU 发送控制模组进入热点连网模式:

55 aa 00 04 00 01 01 05

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x04
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

55 aa 00 04 00 00 03

实时状态上报

使用场景:对于类似报警器要求实时推送的设备,我们就可以通过本条命令上报相关状态数据。

说明:当MCU需要上报实时状态的数据时,可通过该协议上报数据

  • 状态数据会直接上报到云端,故设备联网状态必须为已连接到云端,否则数据上报失败。

  • 该条指令为同步指令,MCU数据上报后需等待模组返回上报结果,等待超时时间 5 秒。

  • 需要等待模组发送连接上服务器的网络状态包,再发送需要发送的统计数据包,这里的数据上传没有储存功能,这强制等待 8s 还没收到连接上服务器的网络状态包,也强制给设备断电。

  • 可以支持多个数据单元上报,和单个数据单元上报,用户根据自己的需要来选择发送组包的方式。具体数据包可以下面的例子。

    大致操作的流程图:

    MCU 对接协议

MCU发送 :

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x05
数据长度 2 取决于 状态数据单元 类型以及个数
数据 N 一个或多个 状态数据单元
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x05
数据长度 2 0x0001
数据 1 0x00 成功 0x01 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

“单个状态数据单元”上报例子:

DP 109 bool型变量,数值为1

55 aa 00 05 00 05 6d 01 00 01 01 79

“多个状态数据单元”上报例子:

DP 109 bool型变量,数值为1

DP 102 string型变量,“201804121507”(具体传输对应ASCII值)

55 aa 00 05 00 15 6d 01 00 01 01 66 03 00 0c 32 30 31 38 30 34 31 32 31 35 30 37 5d

记录型状态上报

使用场景:对于类似门锁等记录型的设备,包含多个 DP 点数据需要服务端作为整条记录处理,在短暂断网的情况下本条命令会保存下无法上报成功的数据,本条命令可以满足记录型设备的上报需求。这里的上报需要带上时间为本地时间。

说明:当MC 需要记录型数据是由多个 DP 点组合的整条数据,需要整体上报,可通过该命令往Wi-Fi模组发送,并且当有数据上报时设备断网的情况下,该数据会储存在本地,下次连云成功后模组会将这条数据再次上传,并把之前储存的数据上报。

  • 当有滞留记录每次上报成功一条,模组就会主动发送一条 09 命令字数据为 01 的回复包。MCU可以根据这个回复做超时断电处理。

  • 网络正常下模组上电后正常需要 4S 左右连接上服务器,每当有记录产生给设备上电后,可以等Wi-Fi模组发送协议文档中设备联网状态包所描述的的设备联网状态包,当强制等待 6S 以上还没收到模组连接上服务器的包,也将该条指令MCU数据上报后需等待模组返回上报结果。

  • 单次记录上报的数据区域(多个状态数据单元)最大长度为 80,根据实际的 DP 点的数据最后组合实际储存的长度会有所变化,当没有网络的状态下,超过限制长度 Wi-Fi 模组会返回记录发送失败。

  • 可以储存历史记录的条数最长限制到 20 条,当超过 20 条从最早储存的记录开始覆盖,如此循环覆盖。

  • 当 Wi-Fi 模组接受到一条数据成功推送,或者当没有网络状态下,记录成功存储进 flash 中也会当做推送成功(00)。当有网络推送成功一条,还有滞留记录的话会返回 01 ,其他的情况均返回推送失败 02 。

  • 时间数据的应用是为了保证记录数据在设备没有网络的情况下和实际发生的事件一致。如果以记录到达服务端的时间为准,当设备暂时处于没有网络的状态下产生的记录数据,当下次使用网络恢复正常时,这个时候上传的记录时间便和实际发生的事件不符合。所以当设备第一次和 Wi-Fi 模组配网的时候,网络环境可以保证的情况下,可以通过协议获取到想要的时间数据。每次上传记录的时候带上当前设备的时间数据,服务端的记录时间便会以设备给的时间为准。。

  • 由于设备在全世界各地涉及到时区和夏令时等事件因素,记录的时间的处理也给与两个时间的协议区分。当设备没有显示屏的需求,设备通过协议获取格林时间在设备中运行,当有相关上报数据产生的时候便按照协议给与当前设备运行的格林时间的数据。有些设备,比如门锁需要显示当地的时间,门锁可以通过协议获取本地时间,这个时间模组有加上时区包括夏令时的因素,确保时间和当地的时间可以对上。当有相关上报数据产生的时候便按照协议给与当前设备运行的本地时间的数据。

    上报大致操作流程如下图所示。

    MCU 对接协议

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x08
数据长度 2 取决于 状态数据单元 类型以及个数
数据 7 (1) 数据长度为 7 字节:
(2)Data[0] 为这条数据传输是否带本地时间标志位:
0 表示这条数据不带门锁给的时间,后面的时间数据,模组认为数据无效不处理
1 表示后面的时间数据有效,时间数据为设备所在的当地时间。
2 表示后面的时间数据有效,时间数据为格林时间。
(3)Data[1] 为年份, 0x00 表示 2000 年。
(4)Data[2] 为月份,从 1 开始到 12 结束。
(5)Data[3] 为日期,从 1 开始到 31 结束。
(6)Data[4] 为时钟,从 0 开始到 23 结束。
(7)Data[5] 为分钟,从 0 开始到 59 结束。
(8)Data[6] 为秒钟,从 0 开始到 59 结束
- N 一个或多个组合 参考本文 状态数据单元
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x08
数据长度 2 0x0001
数据 1 0x00 上报成功
0x01 当前记录上报成功,并且还有滞留记录需要上报
0x02 上报失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

具体上报数据包举例:

  • 单个状态数据单元上报例子:

    DP 109 bool型变量,数值为 1

    • 服务端当前时间为准:

      55 aa 00 08 00 0c 00 12 04 13 0d 04 14 6d 01 00 01 01 d1

    • 设备本地时间(2018/04/19/ 13点3分29秒)为准

      55 aa 00 08 00 0c 01 12 04 13 0d 03 1d 6d 01 00 01 01 da

    • 设备当前格林时间(2018/04/19/ 5点3分29秒)为准

      55 aa 00 08 00 0c 02 12 04 13 05 03 1d 6d 01 00 01 01 d3

  • “多个状态数据单元”上报例子:

    DP 109 bool型变量,数值为 1

    DP 102 string型变量,“201804121507”(具体传输对应 ASCII 值)

    • 服务端时间为准

      55 aa 00 08 00 1c 00 12 04 13 0d 06 04 *6d 01 00 01 01* *66 03 00 0c 32 30 31 38 30 34 31 32 31 35 30 37* a7

    • 设备本地时间(2018/04/19/ 13点3分29秒)为准

      55 aa 00 08 00 1c 01 12 04 13 0d 08 2e 6d 01 00 01 01 66 03 00 0c 32 30 31 38 30 34 31 32 31 35 30 37 d4

    • 设备格林时间(2018/04/19/ 5点3分29秒)为准

      55 aa 00 08 00 1c 02 12 04 13 05 08 2e 6d 01 00 01 01 66 03 00 0c 32 30 31 38 30 34 31 32 31 35 30 37 cd

  • 组合开门方式上报说明:

    组合开门方式根据相关的开门方式的DP,一个完整包上传相关组合DP的数据,完成组合开门方式的数据上报。

    密码+指纹开锁数据上报:

    55 aa 00 08 00 17 00 13 02 0D 06 33 03 (密码开锁)02 02 00 04 00 00 00 01 (指纹开锁)01 02 00 04 00 00 00 05 91

模组命令下发

“命令下发”为异步处理协议,MCU收到相关控制包,确认接收到回复下发包后,完成相关控制动作,MCU状态反馈通过MCU的状态上报来实现。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x09
数据长度 2 取决于“命令数据单元”类型以及个数
数据 N 状态数据单元
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组下发控制命令:(系统开关对应 3 号 DP,使用 bool型变量,开机数值为 1 )

55 aa 00 09 0005 *03 01 00* *01 01* 13

MCU回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x09
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU确认回复:

55 aa 03 09 00 00 08

获取本地时间

  • 需要等待设备连接上网络(也就是收到设备联网状态包命令 状态 5 )后开始发送获取本地时间的数据包。
  • 在设备连接上服务器后,在网络情况非常差的情况下,有可能会获取时间数据失败。对于依赖时间的设备(例如门锁),当本地时间没有经过校准,会获取失败。需要做一个间隔 3S 的获取时间值,确保时间数据获取成功。
  • 模组每次上电在未联网成功之前无法获取时间,待模组入网校时完成后,可随时获取时间。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x06
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU获取本地时间:

55 aa 00 06 00 00 05

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x06
数据长度 2 0x0008
数据 Data 数据长度为 8 字节:
Data[0] 为是否获取时间成功标志,为 0 表示失败,为 1 表示成功
Data[1] 为年份, 0x00 表示 2000 年
Data[2] 为月份,从 1 开始到 12 结束
Data[3] 为日期,从 1 开始到 31 结束
Data[4] 为时钟,从 0 开始到 23 结束
Data[5] 为分钟,从 0 开始到 59 结束
Data[6] 为秒钟,从 0 开始到 59 结束
Data[7] 为星期,从 1 开始到 7 结束,1 代表星期一
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回本地时间数据:

55 aa 00 06 00 08 01 12 09 11 10 09 05 01 59

本地时间:18年9月17日16时9分5秒星期一

  • 如果设备在国内激活使用,则当地时间为北京时间(东 8 区)
  • 如果设备在国外激活使用,则当地时间为设备所处时区时间。

获取格林时间

  • 格林时间不带有时区和夏令时相关因素,如果设备具有动态密码功能(门锁等)但是不需要显示设备所在的当地时间,本地只需要实现格林时间,记录上传走带记录型上报的通道,上报的时间也需要是格林时间。

  • 带动态密码功能的设备,并且门锁也要显示设备所在当地的当前时间,本地在跑跑格林时间的同时,需要在定时获取本地时间,本地储存格林时间和当地时间的时间差,每次显示本地时间的时候在格林时间的基础上加上时间差。记录上传走带记录型上报的通道给的时间也需要是格林时间。

  • 模组每次上电在未为联网成功之前无法获取时间,待模组入网校时完成后,可随时获取时间。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x10
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU获取格林时间:

55 aa 00 10 00 00 0F

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x10
数据长度 2 0x0008
数据 8 数据长度为 8 字节:
Data[0] 为是否获取时间成功标志,为 0 表示失败,为 1 表示成功
Data[1] 为年份, 0x00 表示 2000 年
Data[2] 为月份,从 1 开始到 12 结束
Data[3] 为日期,从 1 开始到 31 结束
Data[4] 为时钟,从 0 开始到 23 结束
Data[5] 为分钟,从 0 开始到 59 结束
Data[6] 为秒钟,从 0 开始到 59 结束
Data[7] 为星期,从 1 开始到 7 结束,1 代表星期一
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回设备格林时间:

55 aa 00 10 00 08 01 12 09 11 08 15 03 01 65

格林时间:2018年9月17日8时21分3秒星期一

请求Wi-Fi模组固件升级

  • Wi-Fi模组的电源通断是由MCU去控制的,当我们MCU需要去升级 Wi-Fi 模组的固件便可以通过下面的命令去拉取最新固件。MCU主板根据Wi-Fi模组的回复包决定是否需要给Wi-Fi模组断电。MCU当发送 0a 命令等待 5s 没有收到相关回复便把Wi-Fi模组断电。当模组回复正在更新固件,MCU 也需要起一个定时当处于正在更新固件超过 60s 没有收到固件升级成功,也强制认为固件升级失败给Wi-Fi模组断电。

MCU 发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0a
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU请求Wi-Fi固件升级:

55 aa 00 0a 00 00 09

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0a
数据长度 2 0x0001
数据 1 0x00 (开始检测固件更新)不可断电
0x01(已经是最新固件) 断电
0x02(正在更新固件)不可断电
0x03(固件更新成功)断电
0x04(固件更新失败)断电
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组升级状态返回:

55 aa 00 0a 00 01 00 0a (收到升级请求包立马返回)

55 aa 00 0a 00 01 01 0b (拉取服务端信息返回没有固件需要更新)

请求 MCU 固件升级

  • 当MCU收到模组返回固件更新完成之后,说明服务端MCU的升级文件已经全部拉取完成并且完成了串口数据传输。注意MCU在收到完整升级文件后,确认拉取文件没有问题,这个时候模组会重新发送查询信息,MCU需要返回相关产品信息和在升级服务器后台填写一致的新的软件版本号。
  • MCU大小以“涂鸦 IoT 可以上传固件大小”为准。
  • 用户在涂鸦 IoT 平台配置MCU升级时,配置MCU升级方式为 App 静默升级

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0c
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU请求MCU固件升级

55 aa 00 0c 00 00 0b

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0c
数据长度 2 0x0001
数据 1 0x00 (开始检测固件更新)不可断电
0x01(已经是最新固件) 断电
0x02(正在更新固件)不可断电
0x03(固件更新成功)断电
0x04(固件更新失败)断电
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组升级状态返回:

55 aa 00 0c 00 01 00 0c (收到升级请求包立马返回)

55 aa 00 0c 00 01 01 0d (拉取服务端信息返回没有固件需要更新)

升级启动

  • 当 MCU 触发了模组去升级 MCU 固件,并且服务端也配置了更高版本的 MCU 固件,且升级方式也符合,模组便会返回给 MCU 相关 MCU 需要升级的固件包的文件大小。
  • MCU 返回时可根据需要选择单包传输大小,若不选择则默认为 256B。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0d
数据长度 2 0x0004
数据 4 固件包字节数,unsigned int,大端
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组发送文件包大小:

55 aa 00 0d 00 04 00 00 68 00 78 (固件包长度 26624,即 26KB )

MCU返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0d
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU确认包回复:

55 aa 00 0d 00 01 00 0d(单包大小 256B )

升级包传输

  • 升级包传输数据格式:包偏移(unsigned short) + 包数据

  • MCU 若收到该帧数据长度为 4 且包偏移 >= 固件大小,则包传输结束

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0e
数据长度 2 0x0004 + 数据包长度
数据 N 前四字节,固定为包偏移,后面为数据包内容
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组发送文件数据:

若要升级的文件大小 530Byte,(最后一包数据可不回复)

  • 第一包数据,包偏移为0x00000000,数据包长度为256

    55aa 00 0e 0104 00000000 xx…xx XX

  • 第二包数据,包偏移为0x00000100,数据包长度为256

    55aa 00 0e 0104 00000100 xx…xx XX

  • 第三包数据,包偏移为0x00000200,数据包长度为18

    55aa 00 0e 0016 00000200 xx…xx XX

  • 最后一包,包偏移为0x00000212,数据包长度为0

    55aa 00 0e 0004 00000212 xx...xx XX

MCU返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0e
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU每包数据包确认:

55aa 00 0e 0000 0d

查询连接路由信号强度

  • 当需要查询设备连接路由器当前的路由的信号强度,前提是收到设备的网络状态包得知设备已经成功连接上路由器,否则发送此命令将返回失败的结果。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0b
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU获取设备连接的路由器强度:

55 aa 00 0b 00 00 0a

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x0b
数据长度 2 0x0002
数据 2 数据长度为 2 字节:
Data[0]:0x00 失败, 0x01 成功。
当 Data[0] 为0x01,即成功时 Data[1] 表示信号强度 (0-100, 0信号最差,100信号最强)。
当Data[0]为 0x00,即失败时,Data[1] 为 0x00,表示设备未连接上路由
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回当前强度值(80):

55 aa 00 0b 00 02 01 50 5D

动态密码校验

  • 协议中的时间数据用于运算当前的动态密码。动态密码运算时间都为当前的格林时间,设备需要给模组格林时间数据。
  • App 端可以设置动态密码校验权限,动态密码的生成算法会使用管理员密码,来参与结果混算。设备每次请求校验动态密码的时候,都需要给模组当前门锁所有的管理员密码(暂时不支持)
  • 发送包的数据长度至少为15字节,时间数据+密码+传输的管理员密码组数(不包含可选项管理员密码)

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x12
数据长度 2 0x0006+0x08+0x01+N
数据 6 数据长度为 6 字节: 设备当前格林时间:
Data[0] 为年份, 0x00 表示 2000 年 Data[1] 为月份,从 1 开始到 12 结束。
Data[2] 为日期,从 1 开始到 31 结束。
Data[3] 为时钟,从 0 开始到 23 结束。
Data[4] 为分钟,从 0 开始到 59 结束。
Data[5] 为秒钟,从 0 开始到 59 结束
- 8 用户输入的密码数据:Data[6]~Data[13]
数据内容范围为 ‘0’~’9’数据传输使用ASCII码
- 1 管理员密码组数(0~10)
有多少组管理员密码后面带上相应组数数据(暂时不支持)默认填0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU发送带两组长度为 6 的管理员密码的数据包:

55 aa 00 12 00 1C 12 09 11 06 22 29 31 35 39 35 30 31 35 38 02 06 *35 32 31 33 31 34* 35 32 31 33 31 33 b3

第一组密码数据:521314

第二组密码数据:521313

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x12
数据长度 2 0x0001
数据 1 0x00 (密码核对通过) 0x01 (密码核对失败)//通信操作错误码 0x02 (设备未激活) 0x03 (数据长度错误)
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回密码校验失败:

55 aa 00 12 00 01 01 13

请求云端临时密码(只支持单组)

  • 需要在 App 端创建当前时间的密码,设备才能拉取到当前生效的密码。
  • 该接口只支持拉取一组临时密码。此为早期门锁通用固件 1.0.0 的接口,需要结合对应的早期门锁面板使用。之后所有版本(大于 1.0.0 )的模组固件,App 面板临时密码均使用创建多组临时密码的接口,获取相关密码数据。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x11
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取当前生效临时密码:

55 aa 00 11 00 00 10

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x11
数据长度 2 0x0007+N(临时密码)
数据 7+N 数据长度为7+N字节:
Data[0] 为是否获取密码成功标志,为0表示失败,后面不会带上相关密码和有效时间数据,数据内容长度为 1,为1表示成功密码有效截至日期(格林时间)。
Data[1] 为年份, 0x00 表示 2000 年。
Data[2] 为月份,从 1 开始到 12 结束。
Data[3] 为日期,从 1 开始到 31 结束。
Data[4] 为时钟,从 0 开始到 23 结束。
Data[5] 为分钟,从 0 开始到 59 结束 Data[6] 为秒钟,从 0 开始到 59 结束临时密码(N)密码数据传输字符的 ASCII 码
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回当前密码:

55 aa 00 11 00 0d 01 10 04 13 05 06 07 31 32 33 34 35 36 8c

格林时间2016年4月19日5时6分7秒

密码 “123456”,密码部分传输的字符是ASCII码

请求云端临时密码(支持多组)

  • 为将临时密码和其他密码作区分,App 设计上使用 7 位临时密码,门锁主板当检测到用户使用的是多组临时密码才去调用此接口去云端拉取相关数据,更新本地的密码数据和状态,这样可以最大程度节约功耗。
  • 注意模组给门锁给的相关时间数据都是基于格林时间,请门锁本地通过获取格林时间的接口同步自己的时钟数据。
  • 密码每次服务端都是全量下发,门锁需要每次根据服务端返回的所有密码和状态进行更新。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x13
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取当前生效临时密码:

55 aa 00 13 00 00 12

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x13
数据长度 2 0x0001+N(临时密码)
数据 1+N 数据长度为1+N字节:
Data[0] 为是否获取密码成功标志,为0表示失败,后面不会带上相关密码和有效时间数据,数据内容长度为 1,为1表示成功
Data[1] 密码组数(0 ~10)当密码组数为0的时候表示面板没有创建密码。串口传输不会带上相关密码和有效时间数据
Data[2] 密码长度(后面每组的密码长度保持一致) //第一组密码相关数据
Data[3] 密码编号 (实际编号需要在密码编号的数据上加900)(1 ~ 50)
Data[4] 密码有效次数 为 0:表示不限制次数密码-有效期内可以不限次数开门。为 1:表示一次性密码-有效期内只能开一次门
Data[5] 密码当前状态 0:表示密码有效 1:表示面板已经进行了删除操作此密码无效密码生效日期(格林时间)
Data[6] 为年份, 0x00 表示 2000年
Data[7] 为月份,从 1 开始到 12 结束
Data[8] 为日期,从 1 开始到 31 结束
Data[9] 为时钟,从 0 开始到 23 结束
Data[10] 为分钟,从 0 开始到 59 结束
Data[11] 为秒钟,从 0 开始到 59 结束密码截至日期(格林时间)
Data[12] 为年份, 0x00 表示 2000 年
Data[13] 为月份,从 1 开始到 12 结束
Data[14] 为日期,从 1 开始到 31 结束
Data[15] 为时钟,从 0 开始到 23 结束
Data[16] 为分钟,从 0 开始到 59 结束。
Data[17] 为秒钟,从 0 开始到 59 结束。
临时密码(具体字节数N=data[2])(密码数据传输字符的 ASCII 码)
//第二组密码数据…
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

Wi-Fi模组返回当前10组密码数据密码

55 AA 00 13 00 DF 01 0A 07 0A 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 09 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 08 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 07 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 06 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 05 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 04 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 03 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 02 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 01 00 00 12 06 1C 08 15 07 14 05 16 13 01 07 31 32 33 34 35 36 37 C6

状态数据单元

  • datapoint命令/状态数据单元如下所示:
数据段 字节数 说明
dpid 1 datapoint序号
type 1 对应开放平台上某datapoint具体的数据类型,通过如下“表示值”标识
类型 表示值 长度(字节) 说明
raw 0x00 N 对应于raw型datapoint(模组透传)
bool 0x01 1 value范围:0x00/0x01
value 0x02 4 对应int类型,大端表示
string 0x03 N 对应于具体字符串
enum 0x04 1 枚举类型,范围 0-255
bitmap 0x05 1/2/4 长度大于1字节时,大端表示
len 2 长度对应value的字节数
value 1/2/4/N hex表示,大于1字节采用大端传输
  • datapoint 命令/状态数据单元除 ”raw” 类型外,其他类型均属于 “obj” 型 datapoint

  • “状态数据”可含多个 datapoint “命令数据单元”

请求云端临时密码(带schedule列表)

  • 为将临时密码和其他密码作区分,App 设计上使用 7 位临时密码,门锁主板当检测到用户使用的是多组临时密码才去调用此接口去云端拉取相关数据,更新本地的密码数据和状态,这样可以最大程度节约功耗。

    注意:模组给门锁给的相关时间数据都是基于格林时间,请门锁本地通过获取格林时间的接口同步自己的时钟数据。

  • 密码每次服务端都是全量下发,门锁需要每次根据服务端返回的所有密码和状态进行更新。
  • 保留原生效周期设置,在生效周期基础上可以按照每周重复的方式 设置密码生效的计划。最多可以添加3个 schedule

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x14
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取当前生效临时密码:

55 aa 00 14 00 00 13

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x14
数据长度 2 0x0001+N(临时密码)
数据 1+N 数据长度为1+N字节:
Data[0]为是否获取密码成功标志,为0表示失败,后面不会带上相关密码和有效时间数据,数据内容长度为1,为1表示成功
Data[1] 密码组数(0 ~10)*当密码组数为0的时候表示面板没有创建密码。串口传输不会带上相关密码和有效时间数据**.*此密码组数为本包数据含有的密码数据
Data[2] 密码长度(后面每组的密码长度保持一致)
Data[3] bit7: 后续是否还有数据包。Bit6-bit0: 本包序号(从0开始) //第一组密码相关数据
Data[4]密码编号 (实际编号需要在密码编号的数据上加900)(1 ~ 50)
Data[5]密码有效次数 0:表示不限制次数密码-有效期内可以不限次数开门1:表示一次性密码-有效期内只能开一次门
Data[6]密码当前状态0:表示密码有效1:表示面板已经进行了删除操作此密码无效密码生效日期(格林时间):
Data[7]为年份, 0x00表示2000年
Data[8]为月份,从1开始到12结束
Data[9]为日期,从1开始到31结束
Data[10]为时钟,从0开始到23结束
Data[11]为分钟,从0开始到59结束
Data[12]为秒钟,从0开始到59结束密码截至日期(格林时间):
Data[13]为年份, 0x00表示2000年
Data[14]为月份,从1开始到12结束
Data[15]为日期,从1开始到31结束
Data[16]为时钟,从0开始到23结束
Data[17]为分钟,从0开始到59结束
Data[18]为秒钟,从0开始到59结束临时密码(具体字节数N=data[2])(密码数据传输字符的 ASCII 码)
Data[19+N] 为schedule 条数/第一条schedule数据
Data[20+N] 0:非全天有效,分时间段有效。1:全天有效。后面的起始时间和结束时间为无效数据。
Data[21+N] 开始时间(小时)
Data[22+N] 开始时间(分钟)
Data[23+N] 结束时间(小时)
Data[24+N] 结束时间(分钟)
Data[25+N] 周循环 Bit0:周日 Bit1:周一 Bit2:周二 Bit3:周三 Bit4:周四 Bit5:周五 Bit6:周六若此条schedule周日,周三循环,则为0x09/第二条schedule数据/…//第二组密码数据…
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

获取DP缓存命令

对于某些带设置性或控制功能的传感器,需要新增DP下发功能。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x15
数据长度 2 N
数据 dp_num(1byte) +dp_1(byte)+…+dp_n(1byte) 如果dp_num是0,则认为查询所有的dp
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取 dp115, dp114, dp113的缓存命令:

55 AA 00 15 00 04 03 73 72 71 71

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x15
数据长度 2 取决于“命令数据单元”类型以及个数
数据 result(1byte)+dp_num(1byte) +dp_1(byte)+…+dp_n(1byte) “命令数据单元”组, 返回有缓存命令的 dp数据。
result 为获取指令成功标志:
为0表示失败,后面不会带上相关dp数据,数据内容长度为1。
result为1表示成功
dp_num:若dp_num为0,则认为当前没有缓存命令。
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回 (dp115自动关门(布尔型,代表是否要执行自动关门)+dp114 延时门锁选择(枚举型,立即锁门或继续计时)+dp113(数值型,单位s),下列返回数据代表 延时 30s 关门)

55 AA 00 15 00 14 01 03 73 01 00 01 01 72 04 00 01 01 71 02 00 04 00 00 00 1E AF

离线动态密码

设备长时间不联网也可使用的动态密码。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x16
数据长度 2 N
数据 Year(1)+mon(1)+day(1)+hour(1)+min(1)+sec(1)+code_len(1)+code(n) 格林时间+密码长度+密码
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

例:离线密码:1849455172 格林时间:2021/01/11 08:18:42
55 AA 00 16 00 11 15 01 0B 08 12 2A 0A 01 08 04 09 04 05 05 01 07 02 C3

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x16
数据长度 2 N
数据 Result(1)+type(1)+decode_len(1)+decode(n) Result:
0 正确
非0 错误(无后续数据)
Type:
0 限时开门密码
1 单次开门密码
2 清除密码
decode_len:解密后数据长度
decode:解密数据
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

上报 MCU 的 SN 号

通过这个接口可将 MCU 的 SN 号上报至平台。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x17
数据长度 2 N
数据 sn_len(1) + sn(n) Sn长度(长度不得超过32byte)+SN
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x17
数据长度 2 1
数据 result result: 0 上报成功 非 0 上报失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组重置状态通知

设备重置状态 描述 状态值
状态1 模组本地重置 0x00
状态2 App 远程重置 0x01
状态3 App 恢复出厂重置 0x02

说明:重置状态的发送最多也会重发三次,重发间隔保持 1S。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x25
数据长度 2 0x0001
数据 1 重置状态:
0x00:模组本地重置
0x01:App远程重置
0x02:App恢复出厂重置
0x03:本地数据清除,但设备不离网
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x25
数据长度 2 0
数据 -
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

获取Wi-Fi状态

  • MCU可根据此条命令获取Wi-Fi状态。具体Wi-Fi状态见报告设备联网状态

  • 该协议仅支持保活门锁。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1A
数据长度 2 0x0000
数据 Data
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1A
数据长度 2 0x0002
数据 2 Data[0]指示Wi-Fi工作状态:
0x00:状态1
0x01:状态2
0x02:状态3
0x03:状态4
0x04:状态5
0x05:状态6
0xff: 无效状态(初始化未完成)
Data[1]指示设备激活状态:
0x00:未激活
0x01:已激活
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

获取 Unix 时间戳(带时区信息)

  • MCU 可以获取当前 Unix 时间戳,时区信息以及夏令时范围。

  • 该协议仅支持保活门锁。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1B
数据长度 2 0x0000
数据 Data
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1B
数据长度 2 N
数据 2 Data[0]:获取时间成功与否
1:成功
0:失败
Data[1]-Data[4]:Unix时间戳
Data[5]:获取时区信息是否成功
1表示成功
0表示失败
Data[6]:
0:表示东区
1:表示西区
Data[7]:表示时区
Data[8]:是否有夏令时
1:表示有夏令时
0:表示没有夏令时
Data[9]-Data[12]:进入夏令时时间戳(大端)
Data[13]-Data[16]:退出夏令时时间戳(大端)
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

密码进制服务

  • 密码进制主要指连续的密码数字按键范围,主要包含两个主要概念进制和起始值。

  • 进制表示所有密码数字的个数,目前支持 4-10。

  • 起始值表示数字开始的数值,目前仅支持 0 和 1。

    密码进制对应 密码按键数量 密码按键 从1/0开始 是否支持 动态密码 是否支持 离线密码 在线密码最 小密码长度 安全等级 在线密码 多语言配置
    4 可选 不支持 不支持 8 1/29W 支持8-12位密码
    5 可选 支持 不支持 8 1/39W 支持8-12位密码
    6 可选 支持 不支持 8 1/100W 支持8-12位密码
    7 可选 支持 支持 8 1/100W 支持8-11位密码
    8 可选 支持 支持 7 1/100W 支持7-11位密码
    9 可选 支持 支持 7 1/100W 支持7-10位密码
    10 不可选 支持 支持 6 1/100W 支持6-10位密码

    注意:如果进行了密码进制0x1C设置,即开启了密码进制服务,0x12、0x13、0x14三个命令将使用下面新的协议格式。

密码进制设置

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1C
数据长度 2 0x0002
数据 2 数据长度为2字节:
Data[0]为进制值
Data[1]为起始值
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

举例:

配置数字“12345”,分别配置进制为 5,起始值为 1;

配置数字“012345”,分别配置进制为 6,起始值为 0;

注意:密码进制0x1C设置,需要在获取信息查询产品信息0x01之后进行设置,并在密码操作前设置。

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x1C
数据长度 2 0x0001
数据 result result:
0 设置成功
非0 设置失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

动态密码校验

  • 协议中的时间数据用于运算当前的动态密码。动态密码运算时间都为当前的格林时间,设备需要给模组格林时间数据。

  • App 端可以设置一个设备当前的是否要加入管理员密码用于参与动态密码的混算结果,设备每次再请求校验动态密码的时候,都需要给模组当前门锁所有的管理员密码。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x12
数据长度 2 0x0006+0x01+N
数据 6 设备当前格林时间:
Data[0]为年份, 0x00表示2000年
Data[1]为月份,从1开始到12结束
Data[2]为日期,从1开始到31结束
Data[3]为时钟,从0开始到23结束
Data[4]为分钟,从0开始到59结束
Data[5]为秒钟,从0开始到59结束
- 1 密码长度n
- N 用户输入的密码数据:
Data[7]~Data[7+n]:数据传输使用ASCLL码
- 1 管理员密码组数(0~10)有多少组管理员密码后面带上相应组数数据
- N 第一组管理员密码包括长度(1个字节)+密码(密码部分由数字组成)数据传输使用ASCLL码
- N 第二组管理员密码部分包括长度(1个字节)+密码( 密码部分由数字组成)数据传输使用ASCLL码
-
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU发送 8 位动态密码带两组长度为6的管理员密码的数据包:

55 aa 00 12 00 1E 12 09 11 06 22 29 08 31 35 39 35 30 31 35 38 02 06 35 32 31 33 31 34 06 35 32 31 33 31 33 c3

动态密码为 10 位,15950158

第一组密码数据:521314

第二组密码数据:521313

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x12
数据长度 1 0x0001
数据 1 0x00 (密码核对通过)
0x01 (密码核对失败)//通信操作错误码
0x02 (设备未激活)
0x03 (数据长度错误)
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回密码校验失败:

55 aa 00 12 00 01 01 13

请求云端临时密码(支持多组)

说明:

  • 门锁主板当检测到用户使用的是多组临时密码才去调用此接口去云端拉取相关数据,更新本地的密码数据和状态,这样可以最大程度节约功耗。

    注意:模组给门锁给的相关时间数据都是基于格林时间,请门锁本地通过获取格林时间的接口同步自己的时钟数据。

  • 密码每次服务端都是全量下发,门锁需要每次根据服务端返回的所有密码和状态进行更新。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x13
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取当前生效临时密码:

55 aa 00 13 00 00 12

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x13
数据长度 2 0x0001+N(临时密码)
数据 1+N 数据长度为1+N字节:
Data[0]为是否获取密码成功标志,
为0表示失败,后面不会带上相关密码和有效时间数据,数据内容长度为1,
为1表示成功 Data[1] 密码组数(0~10)当密码组数为0的时候表示面板没有创建密码。串口传输不会带上相关密码和有效时间数据

//第一组密码相关数据
(长度+编号+有效次数+当前状态+生效日期+截至日期+密码内容)
Data[2] 密码长度
Data[3]密码编号 (实际编号需要在密码编号的数据上加900)(1~50)
Data[4]密码有效次数
0:表示不限制次数密码-有效期内可以不限次数开门
1:表示一次性密码-有效期内只能开一次门
Data[5]密码当前状态
0:表示密码有效
1:表示面板已经进行了删除操作此密码无效
密码生效日期(格林时间):
Data[6]为年份, 0x00表示2000年
Data[7]为月份,从1开始到12结束
Data[8]为日期,从1开始到31结束
Data[9]为时钟,从0开始到23结束
Data[10]为分钟,从0开始到59结束
Data[11]为秒钟,从0开始到59结束
密码截至日期(格林时间):
Data[12]为年份, 0x00表示2000年
Data[13]为月份,从1开始到12结束
Data[14]为日期,从1开始到31结束
Data[15]为时钟,从0开始到23结束
Data[16]为分钟,从0开始到59结束
Data[17]为秒钟,从0开始到59结束
临时密码(具体字节数N=data[2])(密码数据传输字符的 ASCII 码)

//第二组密码数据
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

请求云端临时密码(带schedule列表)

说明:

  • 门锁主板当检测到用户使用的是多组临时密码才去调用此接口去云端拉取相关数据,更新本地的密码数据和状态,这样可以最大程度节约功耗。

    注意:模组给门锁给的相关时间数据都是基于格林时间,请门锁本地通过获取格林时间的接口同步自己的时钟数据。

  • 密码每次服务端都是全量下发,门锁需要每次根据服务端返回的所有密码和状态进行更新。

  • 保留原生效周期设置,在生效周期基础上可以按照每周重复的方式添加密码生效的计划;最多可以添加3个 schedule

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x14
数据长度 2 0x0000
数据 0
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

门锁获取当前生效临时密码:

55 aa 00 14 00 00 13

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x14
数据长度 2 0x0001+N(临时密码)
数据 1+N 数据长度为1+N字节:
Data[0]为是否获取密码成功标志,
为0表示失败,后面不会带上相关密码和有效时间数据,数据内容长度为1,
为1表示成功Data[1] 密码组数(0~10)当密码组数为0的时候表示面板没有创建密码。串口传输不会带上相关密码和有效时间数据.此密码组数为本包数据含有的密码数据
Data[2] bit7: 后续是否还有数据包。Bit6-bit0: 本包序号(从0开始)

//第一组密码相关数据(长度+编号+有效次数+当前状态+生效日期+截至日期+密码内容+schedule条数+schedule数据)
Data[3] 密码长度
Data[4]密码编号 (实际编号需要在密码编号的数据上加900)(1~50)
Data[5]密码有效次数
0:表示不限制次数密码-有效期内可以不限次数开门
1:表示一次性密码-有效期内只能开一次门
Data[6]密码当前状态
0:表示密码有效
1:表示面板已经进行了删除操作此密码无效
密码生效日期(格林时间):
Data[7]为年份, 0x00表示2000年
Data[8]为月份,从1开始到12结束
Data[9]为日期,从1开始到31结束
Data[10]为时钟,从0开始到23结束
Data[11]为分钟,从0开始到59结束
Data[12]为秒钟,从0开始到59结束
密码截至日期(格林时间):
Data[13]为年份, 0x00表示2000年
Data[14]为月份,从1开始到12结束
Data[15]为日期,从1开始到31结束
Data[16]为时钟,从0开始到23结束
Data[17]为分钟,从0开始到59结束
Data[18]为秒钟,从0开始到59结束
临时密码(具体字节数N=data[2])
(密码数据传输字符的 ASCII 码)Data[19+N] 为schedule 条数
(第一条schedule数据)
Data[20+N]
0:非全天有效,分时间段有效。
1:全天有效。后面的起始时间和结束时间为无效数据。
Data[21+N] 开始时间(小时)
Data[22+N] 开始时间(分钟)
Data[23+N] 结束时间(小时)
Data[24+N] 结束时间(分钟)
Data[25+N] 周循环 Bit0:周日 Bit1:周一 Bit2:周二 Bit3:周三 Bit4:周四 Bit5:周五 Bit6:周六若此条schedule周日,周三循环,则为0x09
(第二条schedule数据)


//第二组密码数据
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组功能性测试

  • 本条命令多用于设备量产时的产品整机测试使用,产测指令需要在模组上电完成初始化流程以后(回复查询产品信息 的数据包)发送
  • 模组在收到该指令后,可根据协议内容进行指定的测试
    • 模组收到 0x00 扫描指定路由器后,开始扫描指定 SSID 的路由器,并返回扫描结果。
    • 模组收到 0x01 扫描指定路由器后,开始连接指定 SSID 的路由器,并返回结果。
    • 模组收到 0x02 命令后,进行 SPI 传图测试,,会在 5s 内等待接收 SPI 发送的 0x61 命令,若未收到,则返回失败,若收到61指令则返回成功。
  • 扫描指定的 SSID,返回的数据中表示扫描结果和信号强度百分比;
  • 原则上若扫描成功,才可选择连接指定的路由器;
  • 指定的 SSID 固定为:tuya_mdev_test,密码为:test1234,要求路由器为 2.4G 信号

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0xF0
数据长度 2 0x0002
数据 2 Data[0]产测功能点
0x00:扫描指定路由器
0x01:连接指定路由器
0x02:SPI传图测试
Data[1]子命令
0x00(默认值)
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

具体产测步骤及结果回复:

  • 扫描指定路由器
    • Data[0] = 0x00 时表示扫描成功
      Data[1]表示扫描到的路由器信号强度百分比(0-100)
    • Data[0] = 0x01 时表示扫描失败
      Data[1] = 0x00表示未扫描到指定SSID
      Data[1] = 0x01 表示模组未授权
  • 连接指定路由器
    • Data[0] = 0x00 时表示连接成功
      Data[1] = 0x00 默认为0x00
    • Data[0] = 0x01 时表示连接失败
      Data[1] = 0x00 默认为0x00 连接超时
      Data[1] = 0x01 其他原因失败
  • SPI传图测试
    • Data[0] = 0x00 时表示接收成功
      Data[1] = 0x00 默认为0x00
    • Data[0] = 0x01 时表示接收失败
      Data[1] = 0x00 表示超时未收到SPI数据
      Data[1] = 0x01 表示收到数据包长度错误

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0xF0
数据长度 2 0x0002
数据 2 Data[0]:产测结果
0x00:成功
0x01:失败
Data[1]信号强度/失败原因
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

自动升级

使用场景:
门锁Wi-Fi模组基线或固件功能有重大升级时,或者Wi-Fi模组有严重BUG或紧急问题修复时,需要覆盖到已出货产品,固件静默升级功能可以使得用户无感升级,提升用户体验。
说明:

  • 用户在涂鸦官网配置模组、MCU升级时,配置 Wi-Fi、MCU升级方式为自动保持设备更新
  • 上电云端会拉去是否有新固件更新,如果有则发送给模组,模组接收到有新固件则发送协议给MCU,MCU判断是否
    能够升级并回复。
  • 模组收到MCU回复命令,如果升级就则下发命令开始升级,升级成功发送成功命令。否则回复失败
    模组向MCU发送升级信息:
字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x21
数据长度 2 0x0002
数据 1 0x00 检测到固件更新(不可断电)
0x01 开始(不可断电)
0x02 成功(15S后断电)
0x03 失败 (断电)
1 固件类型
0x00 模组固件
0x01 MCU固件
校验和 1 从帧头开始按字节求和得出的结果对256求余

模组发送固件升级信息:

55 aa 00 21 00 02 00 00 22

注意:接受到模组向 MCU 发送的升级成功命令后 15s 后断电,因为模组升级成功后,会重新连接网络,检测固件版本是否升级成功,如果成功,App 端才会收到固件升级成功的通知,并退出(如果不需要看到 App 提示升级成功,可忽略,收到该命令即可断电)。

MCU返回升级信息:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x21
数据长度 2 0x0002
数据 1 0x00 继续升级(除请求升级之外,其他状态默认回复0)
0x01 电量不足拒绝升级
0x02 其它原因
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组升级状态返回:

55 aa 00 21 00 01 00 21

55 aa 00 0a 00 01 01 22

拓展功能协议

注意:此章节中,图片上传相关和拍照视频相关功能独立,请勿混淆。

  • 图片上传相关仅用于第三方猫眼传图方案(XR809平台)
  • 拍照视频相关仅用于一体化拍照视频方案(BL608方案)

图片上传相关

使用场景:主要应用于人脸识别锁的图片传输功能需求。上传图片后,可从 app 端查看开门者人脸信息。

说明:当 MCU 有图片上传时,需要先通知模组启动图片上传服务相关功能。

  • 当相同的事件有触发需要携带多张图片的时候,MCU 只触发一次即可。
  • MCU 上报 0x60 命令时,可以选择是否携带时间;如果不携带时间,则模组在回复 0x62 命令时,会将模组自己的时间回复给 MCU,如果携带时间,则模组在回复 0x62 命令时会将该时间回复给 MCU 。Mcu 在上报事件时,事件所携带的时间应与0x62返回的时间保持一致
  • 当模组返回图片上传失败后,MCU 应当停止图片传输。
  • 模组需要在收到 Wi-Fi 发送的 0x02、0x03、0x04 网络状态时,开始发送 0x60 图片上传请求。

图片上传流程图:

MCU 对接协议

事件状态通知

当有事件触发时,通过此指令通知模组,若需要携带图片信息,模组收到指令后开启图片传输相关功能服务。

  • 事件编码表 可参见附录1。
  • 当事件通知是携带图片的事件时,模组会定时 20s 等待 MCU 上传图片,若超过 20s 还未收到图片信息,则会退出图片接收状态,通过 0x62 指令返回失败给 MCU。
  • 每次有图片传输时,都需要先发送此命令通知模组,模组开启图片传输功能。
  • 单次事件通知只触发一张图片的传输,若需要传输多张图片,需要重复图片上传流程。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x60
数据长度 2 0x04
数据 2 事件信息编码:
0x0000:防撬告警
0x0001:远程开门请求
0x0002:指纹开门试错
0x0003:密码开门试错
0x0004:人脸开门试错
0x0005:掌纹开门试错
0x0006:指静脉开门试错
0x0007:指纹开门
………
- 1 是否携带图片信息:
0x00:不携带图片(后面的数据内容无效)
0x01:携带图片
- 1 上传图片张数(<=10):0x00:此字节内容无效
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

示例:55 AA 00 60 00 04 00 00 01 01 18

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x60
数据长度 2 1
数据 1 result:
0 信息接收成功
非0 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

示例:55 AA 00 60 00 01 00 93

图片上传

图片上传时支持 spi 和 uart 两种数据传输方式。

  • UART 传输时单包图片大小限制为 15K。

  • SPI 传输时单包图片大小限制为 30K。

  • 开启图片传输时,模组会开启超时接收定时器,一张图片数据每包之间超时等待间隔为 5s,若 5s 未收到下包内容,则会退出接收,通过 0x62 指令返回失败。

  • 若要重传则需要从 0x60 指令开始重新启动图片传输功能

  • SPI 传输时,模组做为从机,MCU 作为主机,模组仅用于接收 MCU 发送的图片数据,ACK 仍由串口通知返回 MCU。

    注意:若选择由 Wi-Fi 模组关联图片与事件,则该命令中上报的时间需要与 0x60、0x61 命令字中的时间保持一致。

MCU 发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x61
数据长度 2 N
数据 7 Data[0]为这条数据传输是否带本地时间标志位:
0表示这条数据不带门锁给的时间后面的时间模组认为数据无效不处理
1表示后面的时间数据有效,时间数据为设备所在的当地时间。
2表示后面的时间数据有效,时间数据为格林时间。
Data[1]为年份, 0x00表示2000年
Data[2]为月份,从1开始到12结束
Data[3]为日期,从1开始到31结束
Data[4]为时钟,从0开始到23结束
Data[5]为分钟,从0开始到59结束
Data[6]为秒钟,从0开始到59结束
- 2 图片ID号:图片ID号作为一张图片数据的归属标识
- 2 图片总包数:当前传输的中张图片一共分多少包传输
- 2 当前包序号(从0开始):当前数据是第几包图片数据
- N 图片数据
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x61
数据长度 2 1
数据 1 result:
0 信息接收成功
非0 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图片上传结果反馈

  • 用来反馈图片上传结果,当模组返回图片上传失败时,需要中止图片传输。

  • 当模组返回图片上传成功之后,MCU 上报事件记录的时候需要将模组返回的图片 ID 和时间一起上报。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x62
数据长度 2 9
数据 2 图片ID号:图片ID号作为一张图片数据的归属标识
- 6 当前图片上传的时间:
Data[1]为年份, 0x00表示2000年
Data[2]为月份,从1开始到12结束
Data[3]为日期,从1开始到31结束
Data[4]为时钟,从0开始到23结束
Data[5]为分钟,从0开始到59结束
Data[6]为秒钟,从0开始到59结束
- 1 Result:失败时,时间数据无效
0 图片上传成功
1 网络断开无法上传成功;
2 图片太大超出30k;
3 超时未收到MCU的图片信息;
4 其它原因失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x62
数据长度 2 1
数据 1 result:
0 无后续图片上传
非0 还有图片上传
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图片上传状态获取

用来反馈图片上传状态的,若模组反馈图片上传失败,需要停止图片传输。

  • 当模组返回当前状态的状态 0 :无图片上传时,事件 ID 和图片编码数据无效,

  • 模组返回的时间只支持本地时间。

  • 此命令通过串口发送获取到的为模组此刻的处理状态。spi 获取到的是前一次 spi 数据交互时刻的状态。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x63
数据长度 2 0x0000
数据 1
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组返回:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x63
数据长度 2 11
数据 图片上传相关数据 1 状态:
0:无图片传输触发
1:接收图片中;
2:图片上传中;
3:图片上传成功;
4:图片上传获取url失败;
5:图片数据上传云端失败;
6:图片接收超时失败;
7:图片大小超出限制失败;
2 事件信息编码:
0x0000:防撬告警
………
2 图片ID号:图片ID号作为一张图片数据的归属标识
时间数据(只提供本地时间) 6 当前图片上传的时间:
Data[1]为年份, 0x00表示2000年
Data[2]为月份,从1开始到12结束
Data[3]为日期,从1开始到31结束
Data[4]为时钟,从0开始到23结束
Data[5]为分钟,从0开始到59结束
Data[6]为秒钟,从0开始到59结束
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

拍照视频相关

  • 针对新的平台 Wi-Fi 模组上集成了拍照功能,简化了拍照流程;

图片上传流程图:

MCU 对接协议

触发抓拍命令

当有事件触发时,通过此指令通知模组,有事件触发抓拍,模组收到此指令后开启抓拍相关功能。

  • 事件编码表可参见附录1;

  • 当事件通知需要抓拍图片时,模组会抓拍并上传图片,若超时还未收到上传成功的应答,则会通过 0x62 指令返回失败给 MCU;

  • 每次事件触发抓拍时,都需要发送此命令通知模组,模组开启抓拍功能;

  • 可通过子命令决定抓拍方式;

  • 抓拍后需要上传对应的记录型事件,才能成功关联并读取到对应图片或视频。

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x64
数据长度 2 0x01+0x05+0x07
数据 1 子命令默认:0x00
2 事件信息编码:
0x0000:防撬告警
0x0001:远程开门请求;
0x0002:指纹开门试错;
0x0003:密码开门试错;
0x0004:人脸开门试错;
0x0005:掌纹开门试错;
0x0006:指静脉开门试错;
0x0007:指纹开门;
…………
1 是否抓拍图片:
0x00:不抓拍图片(后面的数据内容无效);
0x01:抓拍图片
1 抓拍类型:
0x00:单张抓拍
0x01:连续抓拍
0x02:智能抓拍
……
1 抓拍图片张数(<=16):0x00:此字节内容无效;
7 数据长度为7字节:
Data[0]为这条数据传输是否带本地时间标志位:
0表示这条数据不带门锁给的时间后面的时间模组认为数据无效不处理;(默认需要时间)
1表示后面的时间数据有效,时间数据为设备所在的当地时间。
2表示后面的时间数据有效,时间数据为格林时间。
Data[1]为年份, 0x00表示2000年
Data[2]为月份,从1开始到12结束
Data[3]为日期,从1开始到31结束
Data[4]为时钟,从0开始到23结束
Data[5]为分钟,从0开始到59结束
Data[6]为秒钟,从0开始到59结束
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x64
数据长度 2 1
数据 1 result:
0 信息接收成功
非0 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

示例:55 AA 00 64 00 01 00 64

触发结果通知

用来反馈触发抓拍或视频的相关结果

  • 当触发类型为图片时,通知结果为 0 代表图片上传成功;
    MCU 上报事件记录的时候需要将模组返回的图片 ID 和时间一起上报。
  • 当触发类型为视频时,通知结果为 0 代表视频流建立连接;
    通知结果为视频流播放结束时,数据中所带时间信息无效,此时 MCU 需自行判断当前触发类型,并做超时断电处理。

模组发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x62
数据长度 2 9
数据 2 图片ID号:图片ID号作为一张图片数据的归属标识。
6 当前图片上传的时间:
Data[1]为年份, 0x00表示2000年
Data[2]为月份,从1开始到12结束
Data[3]为日期,从1开始到31结束
Data[4]为时钟,从0开始到23结束
Data[5]为分钟,从0开始到59结束
Data[6]为秒钟,从0开始到59结束
1 Result:失败时,时间数据无效
0 上传成功/开始推流
1 网络异常;
2 大小超出限制;
3 抓拍超时;
4 其它原因失败
5 推流结束
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x62
数据长度 2 1
数据 1 result:
0 无后续图片上传
非0 还有图片上传
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图像参数配置

  • 为满足客户动态配置参数的需求,增加图像参数配置相关指令。发送该指令,可修改图像相关的分辨率、图像质量、视频帧率、及是否动态开启红外夜视功能。模组会记录该配置,下次启动时将使用该配置来初始化图像相关相关参数。
  • 发送该指令后,模组会自动重启。
  • 若未发送该配置,则模组会采用默认的图像参数来进行初始化。
  • 需在模组回复 PID 并完成初始化后发送。(模组发送 02 指令后)

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x65
数据长度 2 0x0004
数据 1 图像分辨率:
0x00:320 * 240
0x01:640 * 480;
1 图像压缩比:
25
50
1 视频帧率:
12
15
20
1 红外夜视功能:
0x00:关闭
0x01:开启
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x65
数据长度 2 1
数据 1 配置结果:
0x00:配置成功
0x01:配置失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图像寄存器配置

  • 为满足客户动态配置图像寄存器,调节图像效果的需求,增加图像寄存器的参数配置指令。
  • 发送该指令后,模组会自动重启。
  • 若未发送该配置,则模组会采用默认的图像寄存器来进行初始化。
  • 需在模组回复PID并完成初始化后发送。(模组发送02指令后)

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x66
数据长度 2 2N+1
数据 1 配置寄存器个数 N
2N Data[0]:寄存器地址
Data[1]:寄存器值

依次填写要配置的寄存器地址和值
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x66
数据长度 2 1
数据 1 配置结果:
0x00:配置成功
0x01:配置失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图片下载相关 (暂不支持)

图片下载通知

  • 通知模组当前有图片数据需要下载传输给 MCU;

MCU发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x65
数据长度 2 1
数据 1 单包图片下载的大小:
0x01:1024
0x02:2048
0x03:3072
0x04:4096
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

模组回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x65
数据长度 2 1
数据 1 result:
0 信息接受成功,启动数据下载服务成功
非0 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

图片下载数据传输

模组串口发送:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x66
数据长度 2 N
数据 2 图片 ID 号:图片 ID 号作为一张图片数据的归属标识
2 图片总包数:当前传输的中张图片一共分多少包传输
2 当前包序号(从 0 开始):当前数据是第几包图片数据
N 图片数据
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

MCU 回复:

字段 字节数 说明
帧头 2 0x55aa
版本 1 0x00
命令字 1 0x66
数据长度 2 1
数据 1 result:
0 信息接受成功
非0 失败
校验和 1 从帧头开始按字节求和得出的结果对 256 求余

附录一:图片上传事件编码表

事件状态 描述 状态值
状态1 防撬告警 0x0000
状态2 远程开门请求 0x0001
状态3 指纹开门试错 0x0002
状态4 密码开门试错 0x0003
状态5 卡片开门试错 0x0004
状态6 人脸开门试错 0x0005
状态7 掌纹开门试错 0x0006
状态8 指静脉开门试错 0x0007
状态9 指纹开门 0x0008
状态10 密码开门 0x0009
状态11 卡片开锁 0x000A
状态12 人脸开锁 0x000B
状态13 掌静脉开锁 0x000C
状态14 指静脉开锁 0x000D
状态15 临时密码解锁 0x000E
状态16 动态密码解锁 0x000F
状态17 远程解锁 0x0010
状态18 离线密码解锁上报 0x0011
状态19 门铃请求上报 0x0012
状态20 劫持警告 0x0013
状态21 低电报警 0x0014
状态22 钥匙插入报警 0x0015
状态23 高温报警 0x0016
状态24 门铃 + 远程开门 0x0017
状态25 有人停留(逗留) 0x0018
状态26 门锁被破坏 0x0019
状态27 特殊指纹开锁 0x001A
状态28 布放模式下开锁 0x001B

附录二:SPI配置信息表

当前默认参数:

参数名称 描述 状态值
时钟 时钟频率 6000000
时钟模式 - SPI_SCLK_Mode0
首字节电平 - SPI_TCTRL_FBS_MSB
Cs 片选信号 低电平
字节对齐 - 8位

协议版本

下表记录了 Wi-Fi 门锁设备的 MCU 对接协议相关修订说明。

版本 编写/修订说明 修订日期 备注
1.0.0 协议首版 2018.09.15 新增
1.0.1 增加支持多组临时密码的请求接口 2018.10.19 修改
1.0.2 1. 增加支持:多组临时密码接口返回面板0组密码时,增加返回字段
2. 增加组合开门方式的相关说明
2018.12.17 修改
1.0.3 增加获取DP缓存命令 2019.07.10 修改
1.0.4 在报告设备联网状态中增加低功耗状态 2019.07.13 修改
1.0.5 1. 增加离线动态密码
2. 增加上报MCU SN号
2019.09.09 修改
1.0.6 增加周期性临时密码(带schedule列表) 2019.10.10 修改
1.0.7 1.增加快速上报指令
2.增加ez和ap共存配网状态
3.查询产品信息增加配网方式字段
4.增加拍照锁相关功能
5.产品信息增加cap字段
6.增加模组重置状态通知
7.增加图片上传状态获取
2020.07.09 修改
1.0.8 增加支持运营商上报功能 20200713 修改
1.0.9 扩展图片上传相关的命令字适配单芯片拍照模组 20200721 修改
1.0.10 增加主动获取Wi-Fi状态、获取unix时间戳的协议 20200730 修改
1.0.11 1.修改图片上传逻辑,在收到模组回复的网络状态包时触发图片上传,而非仅收到状态包为0x04时。
2.修改图片时间的关联逻辑,改为由模组关联,MCU传图和事件上报同一时间
20200912 修改
1.0.12 增加修改debug等级的调试命令0xDB 20201014 修改
1.0.13 1.增加密码进制设置协议
2.新增新动态密码协议、多组云端临时密码协议
20210106 修改
1.0.14 0x64 中增加短视频及实时视频相关命令,修改抓拍类型的字段 20210125 修改
1.0.15 增加SPI产测相关指令 0xF0 20210224 修改
1.0.16 1.增加 0x65、0x66 两条配置图像参数的命令
2.取消快速上报类协议
20210226 修改
1.0.17 1.修改 64 命令中触发类型,取消短视频类型
2.增加 62 状态返回中停止推流的通知
20210327 修改
1.0.18 附录 1 增加 4 条状态 20210408 修改