公寓锁功能实现说明

更新时间:2024-06-20 08:46:22下载pdf

配网

使用场景

初次配网或操作移除网络后的配网,模块自带功能,无DP。

实现流程

  • 配置子设备前,需要将网关先用App配上网,才能添加Zigbee子设备。具体配网步骤,请参考 如何在App添加Zigbee设备让设备联网

  • 正常完成配网后给模块上电上传数据,只需要给模块上电,等待模块返回已连接服务器的网络状态即可。

  • 流程参考如下:
    公寓锁功能实现说明
    使用协议:0x01 查询产品信息 ——0x02 查询模块网络状态 —— 0x03 配置Zigbee模块

门锁信息变更

使用场景

电量、门磁、内门(电子)反锁、方舌等均为门锁设置信息,变更时需要上报。

涉及DP

  • DP 26 剩余电量
  • DP 27 门磁状态上报
  • DP 28 内门(电子)反锁状态上报
  • DP 29 方舌状态上报
  • DP 30 门锁语言切换
  • DP 31 门锁音量
  • DP 32 获取门锁状态

DP说明

  • 剩余电量:显示当前剩余电量百分比,取值范围0~100

  • 门磁状态上报、内门(电子)反锁状态上报、方舌状态上报、门锁语言切换:枚举型

  • 门锁音量:枚举型,分为高、中、低、静音四种音量。

  • 获取门锁状态:用于App端单独或全部获取电量、门磁、内门(电子)反锁、方舌等门锁信息。

  • 电量上报逻辑,以下情况要求上报:

    • 设备首次配网/重新配网
    • 设备重启(更换电池)
    • 电量发生变化
    • 定期上报,如10天更新上报一次
      使用协议:0x05 MCU数据事物上报(主动)

开门日志功能

使用场景

App上可查看门锁的历史开门记录

涉及DP

  • DP 13 临时密码解锁
  • DP 14管理员解锁上报
  • DP 15管家解锁上报
  • DP 16 动态密码解锁上报
  • DP 17 离线密码解锁上报
  • DP 18 离线密码清空上报
  • DP 19卡解锁
  • DP 20 指纹解锁
  • DP 21 从门内侧打开门锁
  • DP 22 未知权限开门
  • DP 43 身份证解锁上报

DP说明

  • 临时密码解锁、卡解锁、指纹解锁、身份证解锁:DP 值用于区分人员(取值范围0~999),上报时面板显示对应人员解锁信息。

  • 动态密码解锁:DP 值无特殊含义(取值范围 0 ~ 999),只为与上面的数据格式保持统一,上报时面板只显示解锁方式,不做人员区别。

  • 管理员解锁上报、管家解锁上报动态密码解锁上报:管理员、管家有且仅有一位,编号分别为1、2。

  • 门被打开:门只要被打开就上报

实现流程

  • 基本思路:
    门锁被打开时,上报对应开门方式的DP点,如下表。开门日志显示的记录数据需要在没有网络的情况下,和实际发生的事件一致,因此推荐使用记录型状态上报。在断网时模块保存无法上报成功的数据,来当下次有数据上报的时候再重新上报,记录型数据携带时间为设备本地时间。

  • 实现流程:
    公寓锁功能实现说明

    使用协议:0x23 记录型状态上报

说明:相关的编号是由MCU生成的,尤其是临时密码的编号,MCU的编号跟临时密码的编号是独立的

告警记录

使用场景

门锁告警被触发时,App上能及时提示告警,且能查看告警记录

涉及DP

DP 23 告警

DP说明

告警:告警支持的内容包括 指纹试错报警、密码试错报警、卡试错报警、人脸试错报警、假锁(锁舌卡住)、高温报警、超时未关门、电子锁舌未弹出、防撬报警、钥匙插入、低电报警、电量耗尽报警、震动报警。

实现流程

  • 基本思路:

    触发告警时,MCU上报对应告警DP值。

    说明:用记录型状态上报,要采用设备端时间,且要注意时间的准确性。若设备时间比实际时间滞后,上报时App报警图标无闪烁提醒,点击进去可以查看到该条报警记录;若以服务端时间为准,设备断网后重新联网,这时显示记录时间和实际发生的事件不符合。

  • 告警:

  • 公寓锁功能实现说明

    使用协议:0x23 记录型状态上报

密码管理

使用场景

超级用户密码管理和租客密码管理。

涉及DP

  • DP 1 超级用户密码管理
  • DP 2 创建临时密码
  • DP 3 删除临时密码
  • DP 4 修改临时密码
  • DP 5 冻结临时密码
  • DP 6 解冻临时密码
  • DP 7 清除门锁临时密码
  • DP 24 本地密码变更上报

DP说明

  • 超级用户密码管理:用于App修改管理员密码,修改、复位、冻结、解冻管家密码操作。

  • 创建临时密码、删除临时密码、修改临时密码、冻结临时密码、解冻临时密码:用于App租客密码的创建、删除、修改、冻结、解冻操作。

  • 清除门锁临时密码:当 App 对门锁进行恢复出厂设置时,云端下发指令给门锁,门锁清除本地的临时密码;如果门锁本地进行恢复出厂设置,清除了本地的临时密码,需要上报该 DP 到云端,确保云端的临时密码记录和本地保持一致,如果本地恢复出厂设置时,上报该 DP 失败,需要在下次重新配网后上报。

  • 本地密码变更上报:用于本地管理员、管家、普通用户密码变更上报。

逻辑说明

  • 密码管理有三种用户角色:管理员、管家和普通用户。
  • 密码管理有七种操作方式:新增、修改、删除、冻结、解冻、复位、清空。
  • 上一级可新增、删除、冻结、解冻、清空(如果有)下一级。
  • 本级只可修改自己的密码。
  • 管理员密码只可修改。
  • 管家密码可修改(自己)、被冻结、被解冻、被复位;
  • 普通用户密码可被新增、修改、被删除、被冻结、被解冻、被清空。
  • 管家密码复位:复位到出厂值,如12345678。

状态说明

  • 普通授权,即临时密码,状态有:
  • 下发中:临时密码到达生效时间且服务端未接收到硬件反馈
  • 下发失败:服务端90s没有收到硬件反馈
  • 未生效:临时密码未到达生效时间
  • 授权成功:服务端接收到硬件反馈
  • 已冻结:App端冻结临时密码
  • 已失效:临时密码超过失效时间
  • 已删除:App端删除临时密码。下发失败会显示重试按钮,暂不加已删除状态

转换关系如下:

公寓锁功能实现说明

实现流程

公寓锁功能实现说明

密码同步

使用场景

用于服务端与硬件端密码同步。

涉及DP

  • DP 9 房客密码同步校验
  • DP 10 租客密码编号同步请求
  • DP 11 获取密码内容
  • DP 12 同步密码上报

DP说明

  • 房客密码同步校验:用于校验服务端和硬件端密码是否一致。由App端发起;重新入网,MCU需主动上报该DP;门锁MCU定时每7天自动上报。
  • 租客密码编号同步请求:如果DP 9 房客密码同步校验返回不一致,则由服务端发起同步请求。MCU返回密码编号和密码校验值列表,每次上报最多20条。
  • 获取密码内容:根据密码编号获取密码内容,实现本地和云端同步。
  • 同步密码上报:同步完成后,MCU主动上报。

离线密码

使用场景

在网络断开或网络环境较差情况下(即门锁断开网络连接的情况下)使用。

涉及DP

DP 8 离线密码T0时间下发

DP说明

离线密码T0时间下发:服务端下发基本时间到门锁MCU,用于离线密码加密功能。

离线密码使用规则

用户可选是否离线单次授权。

如果用户选择了离线单次授权,生效时间不可选择,失效时间为生效时间+6小时,且失效时间不可编辑。

如果用户未选择离线单次授权,生效失效时间均可编辑,密码有效时间内可以不限次数使用。

实现流程

公寓锁功能实现说明

使用协议:0x08 离线密码上报

动态密码**

使用场景

主人在App上生成动态密码,有效时间内访客在门锁上输入对应的动态密码即可开门。

涉及 DP**

DP 16 动态密码解锁上报

实现流程**

  • 基本思路:

    • 普通授权栏有动态密码选项。如果选择动态密码,则在租客面板授权成功状态下显示动态密码栏;如果未选择动态密码,则租客面板授权成功状态下不显示动态密码栏。
    • App上获取动态密码,设备端输入动态密码并上报(动态密码上报指令中的时间戳,必须使用格林时间而非本地时间),模块返回校验结果,设备根据回复结果控制门锁状态。动态密码5分钟内有效,超时重新获取。

      说明:App上获取动态密码,目前Zigbee公寓锁的公版面板没有加入管理员密码的混算,但嵌入式和服务器上已支持。

  • 实现流程:

    公寓锁功能实现说明
    使用协议:0x07 请求动态密码

短信通知

使用场景

该功能与离线密码和临时密码功能所对应,在需要离线密码或临时密码的场景下,通过涂鸦App(或OEM的App)在创建离线密码或临时密码的同时,可以给指定的手机号发送短信,短信内容中包含设备的名称,密码的内容,以及生效时间和结束时间。

短信支持中国大陆地区,以及其他国家或地区,在App创建密码的时候,可以选择国家/地区码。

涉及DP

DP33 短信通知

DP说明

  • 该 DP 是非必选 DP ,使用该功能需要付费。

  • 勾选该 DP 后,在增值服务 功能拓展服务 开通。

    公寓锁功能实现说明

    纯App功能,无需协议

恢复出厂设置

使用场景

用于将门锁恢复为出厂时的设置状态。

涉及DP

DP 25 恢复出厂设置

逻辑说明

App端恢复出厂设置

App触发恢复出厂设置后,云端清空全部授权,设备被移除。设备端的临时密码和离线密码可用。

设备重新配网后,云端建立延迟任务,下发DP25。门锁收到该DP后,设备端清空所有授权信息(普通授权、临时授权、卡和身份证授权),通知模块清空全部临时密码,且设备端的管理员和管家密码重置到出厂值。

设备端恢复出厂设置

设备端恢复出厂设置启动后,设备MCU端的房客密码、卡和身份证授权信息要全部清除,设备MCU要通知模块清除全部临时密码。

设备再次配网时,设备端要上报恢复出厂设置DP,通知云端清空全部授权信息。

逻辑说明

App端恢复出厂设置:

公寓锁功能实现说明

门锁端恢复出厂设置:

公寓锁功能实现说明

产测

使用场景

用于 PCBA 的模块产测,该产测仅测试 ZigBee 模块相关的 RF 和串口是否正常,需要锁端配合显示产测结果以确定模块是否正常,其他门锁功能产测需要客户自行完成。

产测时需要产测信标配合使用,信标由涂鸦提供,请联系涂鸦商务或项目经理申请。

逻辑说明

公寓锁功能实现说明

将产测信标信道设置为 11 信道并上电,将产品靠近信标,发送产测指令并等待模组返回结果(大于 60% 为合格),大约需要 3s。

注意:产测信标做了发送功率衰减,所以产测距离要在 1m 以内;该命令必须在未配网情况下才可以正常运行。

补充说明

告警设置

需要App弹窗提醒部分信息,开发者平台设置操作,可参考推送设备消息

模块信息

  • 推荐使用模块:目前仅支持TYZS5 UART唤醒
  • 模块规格书:请在产品的硬件开发-模块详情中查看下载
  • 支持波特率:仅支持115200
  • 调试模拟助手:请在硬件开发中下载涂鸦串口调试助手