开放 APP SDK

1 介绍

本文档描述了BroadLink智能家居APPSDK的工作场景,集成方案,主要功能和接口说明。

2 更新记录

版本号 更新内容 更新时间 作者
2.0 手册创建 2017/12/23 ZJJ
2.3 增加BLLetAsync库 2018/01/11 ZJJ
2.5 新增部分接口 2018/04/01 ZJJ
2.6 模块细化,拆分出 BLAccount和BLFamily 2018/05/21 ZJJ
2.7 模块细化,拆分出 BLIRCode 库 2018/08/10 ZJJ
2.8 统一服务APPService,远程控制采用HTTPS方式 2018/10/25 ZJJ
2.9 Fastcon 相关命令支持, 取消自动 addDevice 和 自动 Pair 功能 2019/01/07 ZJJ
2.10 接口调整,红外码库子设备功能 2019/04/15 ZJJ
2.11 接口调整,支持同时存在多个相同did 2019/05/15 JYQ
2.14 兼容多种其他设备协议 2020/03/15 ZJJ

具体参考 更新详情

3 接入集成

如果需要接入SDK,首先需要先申请 License,然后再将 SDK 加入到工程中,使用申请到的 License 完成初始化。

具体参考 APPSDK集成说明

4 使用流程

APPSDK 目前主要包含以下几个库:

BLLetCore 库

核心功能库,主要用于设备控制,设备配网和维护设备相关信息接口。

BLLetAccount 库

账号系统库,主要用于 Broadlink账户登录/注册,以及账号互通相关功能。

BLLetFamily 库

家庭系统库,主要提供家庭、家庭设备和房间管理接口。

BLSFamily 库

家庭系统库V2。

BLLetIRCode 库

红外码库,主要提供红外码查询、下载和解析接口。

BLProduct 库

产品库,主要提供产品信息查询,资源下载等接口。

BLWebSocket库

长连接库,主要提供与云端的长连接,比如场景、设备状态推送等。

各个模块之间的关系:

整体框图

具体参考 APPSDK 使用流程

5 示例代码

具体参考

AndroidDemo

iOSDemo

6 错误码表

具体参考 APPSDK错误码表

7 FAQ

具体参考 APPSDK FAQ