Breeze-用户编程接口说明.md

背景

Breeze协议提供基于蓝牙链路连接阿里云的安全通道和服务，并且提供蓝牙辅助配网功能(通过BLE链路获取SSID和password，此部分请参阅蓝牙辅助WiFi配网开发说明)，除此之外还提供OTA升级功能。 Breeze SDK提供清晰简洁的API接口供上层使用。

接口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数。

返回值

无。