蓝牙门锁方案（新芯片模组） 技术对接说明

前言

此文档描述对涂鸦蓝牙门锁方案的技术对接说明，包含技术方案说明和软硬件整个产品生命周期的对接说明（从需求、研发、生产到售后）。

了解涂鸦

如果客户对涂鸦不了解，可以通过链接学习了解涂鸦。

一、方案说明

蓝牙门锁包括但不限于以下功能：
普通的指密卡开门、临时/离线密码开门、蓝牙电子钥匙开门、音箱开门、各种门锁状态上报、可连接蓝牙网关远程控制、布防撤防、自动/手动落锁、密码位数多样化、配件管理等，具体详见下面的方案资料。

方案详细介绍：
蓝牙门锁方案介绍链接
蓝牙挂锁方案介绍链接

二、对接需求

蓝牙硬件对接分成两种对接模式，分别是串口对接和SDK二次开发对接。软件对接则分为云云对接、APP SDK对接和面板SDK对接。

2.1 硬件对接

2.1.1 串口对接

串口对接是指客户MCU与蓝牙模组（芯片）之间基于串口协议进行对接，
系统框图：

2.1.2 SDK二次开发对接

SDK二次开发对接是指客户使用蓝牙模组（芯片）基于涂鸦提供的SDK二次开发对接，
系统框图：

2.1.3 客户端及控制面板

● 公版APP或小程序
如果客户只做硬件对接，不做软件对接，则可以使用涂鸦的公版APP或者公版小程序。可以通过自助文档的2.1.2章节链接学习使用。
● OEM APP或小程序
如果客户需要有自己公司的元素露出实现个性化差异化，则可以使用涂鸦的OEM APP或者OEM小程序。可以通过自助文档的2.1.3章节链接学习使用。
● 控制面板
客户如果对APP或小程序控制面板没有特殊需求，则可以使用涂鸦公版控制面板即可，如果有差异化需求则通过下述的“软件对接”进行对接。

2.2 软件对接

如果客户不使用涂鸦公版或OEM的APP和小程序，则可以进行软件对接。软件对接主要包括云云对接，APP SDK对接，面板SDK对接及微信小程序对接，详见自助文档的2.3章节链接学习了解。

三、硬件选型

如果客户进行的是硬件对接，则针对上述不同的对接方案可以有不同的硬件模块（芯片）的选型。

3.1 串口对接

模块对接：BT3L；客户无需烧录代码
芯片对接：BK3431q（需开白名单）；客户需要烧录涂鸦提供的透传代码并且写入授权码。

3.2 SDK二次开发

● 模块对接：BT3L；因为管脚资源少一般不推荐客户基于该模组进行二次开发；
● 芯片对接：PHY6222，BK3431q，FR8018HA（需开白名单）；SDK的二次开发客户都需要烧录自己的程序以及涂鸦提供的授权码方可连入涂鸦云。

具体模块和芯片选型对比链接：门锁相关模组&芯片选型。
说明：
1、 链接中包含功耗数据
2、 包含芯片对比说明
3、 具体原理图和数据手册详见下面网盘链接。

四、合作模式

在商务合作上也分为以下两种情况。

4.1 芯片对接

客户如果采购涂鸦的芯片有两种烧录授权的方式：
● 芯片+授权码一起采购然后自行进行烧录授权。
● 将固件和授权码一起给涂鸦进行烧录，最后客户拿到带固件和授权的芯片直接贴片使用。

4.2 模组对接

如果采购涂鸦的蓝牙模组则不需要自己进行烧录授权。

五、产品创建

产品创建就是PID创建，PID是Product ID的缩写，即产品ID。开发者在涂鸦IoT平台上创建的每一个产品都拥有一个唯一的产品编号，这就是PID。PID绑定着所有跟这个产品相关的信，如产品功能点、App控制面板、出货、用户账号、使用频次等。涂鸦IOT平台简介链接

5.1 IOT创建方案

PID的IOT平台创建路径：

5.2 选择DP

根据以下链接选择DP点：
dp映射表链接（在“BLE公版门锁（PRO）”页面进行dp选择）
特别说明：若后面选择蓝牙模组对接，创建时选择DP后，后期客户仍然可以进行DP的删减，模块固件是全功能固件，所以更换DP后模块固件不变，客户只要重新配网即可生效新DP功能。

5.3 选择设备面板

选择设备面板如下：

5.4 选择硬件开发

硬件开发也根据对接方式分为串口对接和SDK二次开发两种。

5.4.1 串口对接

● BT3L串口对接
按照如下截图选择“涂鸦标准模组MCU SDK开发”，选择BT3L模块，选择对应的透传固件“keytkt4f”和对应的版本。
● BK3431q串口对接（需开通白名单）

1. 按照如下截图选择“MCU SDK”对接，将PID发给涂鸦项目经理进行后台固件绑定，对应的透传固件为“keyktpaa”。
   

2. 调试时向涂鸦项目经理内部申请授权码，芯片样品的购买请在上述界面右下角点击“立即购买”。

5.4.2 SDK二次开发对接

目前BK3431q/PHY6222/FR8018HA支持SDK二次开发。
5.4.2.1 对接方式选择
当选择SDK二次开发时，对接方式选择“TuyaOS”，购买芯片需要涂鸦商务开通白名单，芯片平台选择“BK3431q 或 FR8018HA 或 PHY6222”，如下图所示：

5.4.2.2 新增自定义固件
因为是基于涂鸦SDK做二次开发，客户需要新增自定义固件，“固件标识名”和代码中的固件标识名需要保持一致，如下截图


经过创建生成固件key：keyvvshq

5.4.2.3 新增固件版本
新增固件版本则是要求上传对应版本的生产文件。
注意：生产文件的名称需要和固件标识名和版本号保持一致，否则后续授权可能会无法通过。
● 新增：

● 上传：

● 上架成功：

5.5 虚拟调试

5.5.1 设备调试

用于模拟真实硬件设备。可以像真实设备一样接收手机客户端下发的指令，也可以模拟真实设备上报数据。即使您的硬件设备未完成开发，也可完成 APP 界面调试。

六、硬件设计

6.1 原理图设计

对于不同的对接方式有不同的原理图设计。

6.1.1 串口对接

6.1.1.1 BT3L模组方案

BT3L模组方案设计参考链接：BT3L参考设计电路（唤醒IO管脚设计请勿参考链接，需参考以下内容）
因为需要进行低功耗控制，所以需要有两个控制引脚完成该低功耗功能：
● 模组 TL_B5： MCU唤醒模组控制脚，高电平有效。
● 模组 TL_D2 ：模组唤醒MCU控制脚，高电平有效。

6.1.1.2 BK3431q芯片方案
BK3431q核心系统方案设计参考链接：BK3431Q方案设计参考链接
MCU对接的BK芯片串口：P00\P01
因为需要进行低功耗控制，所以需要有两个控制引脚完成该低功耗功能：
MCU唤醒芯片控制引脚： P03引脚
芯片唤醒MCU控制引脚： P10引脚
补充：
1、 BK3431q目前只有32pin的型号

6.1.2 SDK二次开发

6.1.2.1 FR8018HA芯片方案

FR8018HA数据手册、最小系统及涂鸦开发版原理图等相关资料需要走涂鸦内部申请才可释放，请客户联系涂鸦商务人员申请。

6.1.2.2 PHY6222芯片方案

客户可以根据以下的数据手册及开发板原理图进行硬件开发。
芯片数据手册：
芯片数据手册链接
开发板原理图：
开发板原理图
6.1.2.3 BK3431q芯片方案
BK3431Q核心系统方案设计参考链接：BK3431Q方案设计参考链接
其他管脚设计客户自行根据外设决定。

6.2 PCB设计

6.2.1 串口对接

6.2.1.1 BT3L模组方案

BT3L模组PCB设计参考链接（如下截图所示）：BT3L参考设计电路

● 模块封装
模块封装下载地址

6.2.2 SDK二次开发

6.2.2.1 BK3431q芯片方案
PCB设计阶段需要考虑射频性能，下面提供客户PCB设计相关的资料链接。
注意：模块外围结构，必须是塑胶，不可全金属包围，否则会极大影响天线信号输出

● PCB天线
PCB天线资料包
● 晶振推荐
BK3431Q晶振选型：其他晶振会造成时钟严重不准，BK原厂推荐型号（低ESR）：ETST003279600E
ETST003279600E规格书下载地址：
链接：下载链接 提取码：82m7
注意：模块外围结构，必须是塑胶，不可全金属包围，否则会极大影响天线信号输出

6.3 样品申请

客户可以在IoT平台进行芯片或模块的样品申请。
在“硬件开发”界面进行下单购买（bk31341q和FR8018需要开白名单才能显示）

七、软件设计

7.2 程序开发

按照“5.1 产品创建”流程完成PID创建以后，便可进行嵌入式程序的开发。程序开发也和对接方式一样分为如下两种。

7.2.1 串口对接

7.2.1.1 串口对接辅助文档

串口对接程序开发请参考如下开发辅助文档链接：
辅助文档链接

7.2.1.2 串口透传固件

如果使用BK3431q对接，则BK透传固件请向涂鸦项目经理申请。

7.2.1.3 上位机调试

客户前期没有完成硬件设计的情况下可以拿蓝牙涂鸦模块使用涂鸦的上位机工具进行协议交互的模拟调试（上位机模拟MCU或模拟模组/芯片）。如下截图下载调试助手和调试文件进行模拟调试。

上位机使用截图如下，导入相应的“功能点调试文件”进行调试配网+功能等。

7.2.2 SDK二次开发对接

下载SDK进行二次开发
SDK开发者可以直接从涂鸦IoT平台下载SDK进行二次开发。

7.2.2.1 SDK二次开发辅助文档

SDK二次开发对接程序请参考如下开发辅助文档链接：
SDK辅助文档链接

7.2.2.2 激活码申请及调试

开始阶段客户可以申请免费的授权码授权快速接入涂鸦平台，进而进行产品的研发调试。
授权码概念：授权码是涂鸦统一为设备颁发的安全加密证书，是智能设备连接涂鸦云获得云服务能力的凭证，每台设备都具有唯一的授权码。
● 领取免费激活码

● 选择对应的授权码形式：
目前正常情况下支持“生产凭证”或“生产凭证-仅授权”两种授权码模式。
 生产凭证： 授权码中包含固件和授权信息（授权过程会校验固件信息，更利于管理授权码的使用范围）；
生产凭证-仅授权：授权码中仅包含授权信息，不含固件（授权过程不校验固件信息）；

● 授权码调试
SDK程序中需要做如下截图的修改才能授权成功。

7.2.2.3 上位机调试

7.2.2.4 开发板申请

● 独立授权研发调试
点击领取免费激活码（右上角），交付形式选择”生产凭证-仅授权“。

独立授权的调试工具使用说明，仅用于开发前期的样品授权使用：

1. 授权的串口为 PA0（RX）和PA1（TX）。
2. 授权小工具的下载链接。
3. 工具通过串口与芯片连接，通讯方式选择为COM，波特率为9600，SN不需要输入。
4. 账号和密码为PMS账号，申请链接：链接 。请留意注册时留下的邮箱，一般1～2天审核完成。注册时的类型需要选择“公司”，不是“个人开发者”，否则软件不能正常使用。
5. Token输入领取的免费激活码。
6. 点击独立授权，在运行信息提示”开始授权 10%“时，对芯片进行复位。
7. 独立授权完成。
   

7.3 程序烧录

6222的烧录授权：
说明链接

7.2.1 串口对接

● BT3L模组
BT3L模块对接无需烧录代码，模块自带固件和授权码，客户可以直接使用连接云端。

7.2.2 SDK二次开发对接

FR8018HA客户可以使用原厂提供2种烧录方式：J-Link烧录或者串口烧录。具体的使用方法链接：烧录说明链接，请看1.6章节。
串口烧录上位机下载链接。

7.4 产品配置

当程序开发完成后可以在平台进行一些如下的产品配置，丰富产品智能化维度。每个功能可以点击旁边的“操作说明”进行学习操作。

八、测试发布

请根据自助文档的2.2章节完成产品的测试发布。

九、下单提货生产

9.1 下单条件说明

请查看自助文档的2.6章节的下单条件说明。

9.2 下单&提货

下单提货和对接方式相关也分为两种模式。

9.2.1 串口对接

9.2.1.1 PHY6222芯片方案

a. 在硬件开发方式里选择“涂鸦标准模组MCU SDK开发”

b. 联系涂鸦商务开通芯片+授权码的下单白名单，完成下单付款后会看到如下图的订单状态（图片示例是PHY6222，实际订单以实际的芯片为准）：

c. 点击b步骤里的“发起提货”，提货时选择“生产凭证”的交付形式。

9.2.1.2 BT3L模组方案

客户在硬件开发方式里选择“涂鸦标准模组MCU SDK开发”。

在生产研发采购里完成采购下单。

9.2.2 SDK二次开发对接

9.2.2.1 BK3431q/FR8018HA/PHY6222芯片方案

此种对接需要涂鸦商务开通芯片+授权码的下单白名单。在硬件开发方式里选择“自研模组SDK开发”，授权码提货时，选择“生产凭证-仅授权”的交付形式。

9.3 产品生产

在试产或量产时，客户从IOT平台进行下单提货流程，后续产品的生产可以参照以下链接进行，涂鸦项目经理和工艺人员将会辅助客户进行生产。
使用涂鸦完整产测能力参考以下链接：
[涂鸦蓝牙门锁（新芯片）产测平台说明]https://docs.qq.com/doc/DTmJtdUVVUHl5Q1BH
仅仅使用涂鸦独立授权功能参考以下链接：
[涂鸦蓝牙门锁 - 仅独立授权量产说明]https://docs.qq.com/doc/DTktXa2dnRFVOVERo

十、售后支持

请查看[自助文档的2.4章节]https://docs.qq.com/doc/DTkRpTGJkSUlZRkVv了解售后支持服务。

十一、FAQ

11.1 基础通用FAQ

请查看自助文档的4.2章节查看了解门锁相关的常见问题。

11.2 本方案特定FAQ

FAQ汇总
Q1：FR8018HA可以支持将语音提示放到芯片内部的FLASH吗？可以的话怎么烧录？
A1：语音可以放到FLASH中，可以跟代码一起烧录，不需要分开烧录；后期可以集成在APP里，由用户自己在APP里选择不同的音效，通过OTA的方式烧录进去。