网关设备开发包

更新时间：2023-09-20 08:56:05下载pdf

网关设备开发包，是基于 TuyaOS 技术体系裁剪得到的适用于开发典型的网关产品的类型开发包，涵盖了设备配网、云端连接、设备控制、子设备接入、场景联动等核心能力，帮助您快速开发网关产品。

开发包特性

网关设备开发包适用于具备 Ethernet、Wi-Fi、4G、蓝牙等连接能力的设备开发网关产品，广泛应用于智能家居、智慧酒店、智慧地产、智慧公寓等领域，网关设备开发包的特性如下：

能力	说明
设备初始化	设备初始化是指调用一系列接口完成 TuyaOS 软件初始化，是开发其他功能的先决条件。
设备重置	设备重置是把设备恢复到配网前状态的操作。根据触发源不同，可以分为本地重置和 App 重置。根据重置后设备所处的状态，又可分为普通重置（解除绑定）和恢复出厂重置（解绑并清除数据）。
产测授权	产测授权是通过涂鸦生产工具把设备的授权信息写入到设备的不易失存储区，用于后续设备正常运行时的设备认证。

能力	说明
日志管理	TuyaOS 提供分级别的日志记录功能，您可以自由选择输出媒介（串口、文件、终端、网络等）。同时，还支持远程获取本地日志，方便排查问题。
本地访问	TuyaOS 提供简单的本地访问功能，可以获取设备列表和设备上报的数据，能够调用接口本地下发指令，主要用于实现网关本地化业务。

能力	说明
有线配网	设备连接路由器后，会定期在局域网内发送 UDP 广播包。手机连接到同一局域网，App 接收到广播包，并根据广播包内携带的信息，与设备协商交换密钥，然后将激活 Token 发送给设备。设备获取到激活 Token 后，使用授权信息和 Token，向云端进行设备认证、激活操作。
AP 配网	设备生成一个 Wi-Fi AP 热点，手机连接到此热点，App 与设备建立 TLS 加密通道，传输配网路由器的 SSID、密码以及激活 Token 给设备。设备获取到 SSID、密码后，切换到 Station 模式去连接路由器，并使用授权信息和 Token，向云端进行设备认证、激活的操作。
蓝牙配网	设备定期发送蓝牙广播，App 通过广播扫描发现此设备，进行蓝牙配对、秘钥交换、连接，传输配网路由器的 SSID、密码以及激活 Token。设备获取到 SSID、密码后，切换到 Station 模式去连接路由器，并使用授权信息和 Token，向云端进行设备认证、激活的操作。

能力	说明
子设备添加	子设备添加是指子设备通过网关绑定到云端的过程，也称设备激活。
子设备移除	子设备移除是指把子设备从网关上移除的操作。根据触发源不同，可以分为本地移除和 App 移除。本地移除是子设备主动离网，网关收到来自子设备的离网通知后通过调用解除绑定接口清除子设备的数据。App 移除是从 App 面板上移除子设备，网关收到来自 App 或云端的离网通知后剔除子设备。
子设备心跳	子设备心跳是维持设备在线和离线状态的手段。在一定周期内，如果应用没有刷新子设备心跳时间，TuyaOS 会触发回调通知应用主动查询子设备是否在线，收到子设备任何数据都应该刷新其心跳时间，以维持子设备在线状态。
子设备 DP 操作	子设备 DP 操作是指令下发和数据上报的操作，涂鸦 IoT 开发平台把设备功能抽象成数据点，也称 DP。指令下发时，TuyaOS 会触发回调通知应用处理，应用把 DP 数据转成具体协议下发给子设备。数据上报时，应用接收到子设备上报的数据，把它转成 DP 数据后调用上报接口推送给 TuyaOS。
子设备升级	子设备升级是在线更新子设备固件，TuyaOS 提供固件下载和完整性校验的功能。

能力	说明
Zigbee 子设备接入	网关硬件可以搭配涂鸦 Zigbee 模组，调用 Zigbee 服务接口运行 Zigbee 软件栈，则支持接入涂鸦生态的 Zigbee 子设备，降低子设备对接门槛，快速实现 Zigbee 网关产品。
蓝牙子设备接入	网关硬件可以搭配涂鸦蓝牙模组，调用蓝牙服务接口运行蓝牙软件栈，则支持接入涂鸦生态的低功耗蓝牙和蓝牙 Mesh 子设备，降低子设备对接门槛，快速实现蓝牙网关产品。

能力	说明
本地联动	本地联动属于自动化的一种，自动化的条件和动作所包含的设备均在同一网关下，则该自动化为本地联动。本地联动不依赖云端，即使网关没有网络，本地联动仍然能生效。
局域网联动	局域网联动也是自动化的一种，自动化的条件和动作所包含的设备在不同网关下，这些网关属于同一个家庭并且处于同一个局域网中，则满足局域网联动要求。网关间动态建立主从（Primary-Secondary）拓扑，局域网联动的规则由 Primary 网关接管，即使网关没有网络，局域网联动仍然生效。

能力	说明
主固件升级	主固件升级是在线更新网关的固件。
附属固件升级	附属固件升级是在线更新网关附属模组的固件，如网关产品携带 Zigbee、蓝牙等模组，可以通过这个方式来更新模组的固件。

能力	说明
无网施工	TuyaOS 提供无外网施工的功能，广泛应用于智慧地产领域。施工工程师在无外网条件下，部署好智能场景，待用户入住后权限交付给用户，用户只需要激活网关设备，立即能体验预先配置好的智能场景，减少繁琐的添加子设备和配置场景操作，增强用户体验。
安防能力	TuyaOS 提供安防能力，支持布防/撤防、环境报警等功能，可以快速开发安防网关产品。
故障分析	TuyaOS 提供 Core Dump 分析工具，当应用程序遇到错误宕机时，记录当前的栈信息，结合编译带符号链接表的应用程序，该工具可以追溯到异常的函数接口，通常用于排查线上产品异常问题。
故障替换	网关故障替换是指当网关硬件出现故障时，用一个全新的网关来替换它，故障网关的数据全部迁移到新的网关下，用户无需重新添加子设备和配置场景，增强用户体验。

在开发过程遇到问题，您可以登录 TuyaOS 开发者论坛网关中控开发版块进行沟通咨询。