蓝牙设备端SDK用户编程说明
更新时间:2019-06-12 16:39:44
背景
Breeze协议提供基于蓝牙链路连接阿里云的安全通道和服务,并且提供蓝牙辅助配网功能(通过BLE链路获取AP的SSID和password)。基本SDK API在breeze_export.h中,蓝牙配网的接口API在breeze_awss_export.h中。
接口API
breeze_start
启动breeze SDK服务。用户使用此接口初始化和启动breeze服务。
参数
名称 | 类型 | 描述 |
---|---|---|
dev_conf | device_config | 初始化Breeze SDK的信息,包含设备信息,回调函数等。 |
返回值
0
成功, -1
失败。
breeze_end
停止breeze服务,用户调用此接口停止breeze服务。
参数
无。
返回值
0
成功, -1
失败。
breeze_post
推送设备端状态数据至移动端,使用BLE indicate方式。
参数
名称 | 类型 | 描述 |
---|---|---|
buffer | uint8_t* | 数据指针。 |
length | uint32_t | 数据长度,byte数。 |
Return
0
成功, 其他错误值 失败。
breeze_post_fast
和breeze_post
类似,推送设备端状态数据至移动端,区别在于使用BLE notify方式。
参数
名称 | 类型 | 描述 |
---|---|---|
buffer | uint8_t* | 数据指针。 |
length | uint32_t | 数据长度,byte数。 |
Return
0
成功, 其他错误值 失败。
breeze_post_ext
设备端上报带有cmd字段的数据至移动端。
参数
名称 | 类型 | 描述 |
---|---|---|
buffer | uint8_t* | 数据指针。 |
length | uint32_t | 数据长度,byte。 |
cmd | uint8_t | 推送给移动端的cmd类型。 |
返回值
0
成功, 其他错误值 失败。
breeze_append_adv_data
广播内容增加用户自定义数据。
参数
名称 | 类型 | 描述 |
---|---|---|
data | uint8_t* | 数据指针。 |
len | uint32_t | 数据长度,byte数。 |
返回值
无。
breeze_restart_advertising
SDK重启蓝牙广播。
参数
无。
返回值
无。
breeze_awss_init
该接口对蓝牙配网SDK进行初始化。在用户业务逻辑初始化阶段调用。
参数
名称 | 类型 | 描述 |
---|---|---|
cb | apinfo_ready_cb | 为设备完成WiFi信息(SSID、密码)获取后的回调函数,由用户定义/提供,并由SDK完成调用。 |
info | breeze_dev_info_t | 为设备信息,包括ProductID,Product Key,Product Secret,Device Name,Device Secret等字段,由用户提供。 |
返回值
无。
breeze_awss_end
停止蓝牙配网服务。
参数
无。
返回值
无。