tkl_bluetooth | 蓝牙驱动

API 描述

tkl_ble_stack_init

OPERATE_RET tkl_ble_stack_init(uint8_t role);

功能描述:

初始化 ble 协议栈
参数：

输入/输出参数名描述
[in] role ble 角色配置

名字定义备注
TKL_BLE_ROLE_SERVER BLE 服务器
TKL_BLE_ROLE_CLIENT BLE 客户端
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	role	ble 角色配置

名字	定义	备注
TKL_BLE_ROLE_SERVER	BLE 服务器
TKL_BLE_ROLE_CLIENT	BLE 客户端

tkl_ble_stack_deinit

OPERATE_RET tkl_ble_stack_deinit(uint8_t role);

功能描述:

去初始化 ble 协议栈
参数：

输入/输出参数名描述
[in] role ble 角色，如下所示

名字定义备注
TKL_BLE_ROLE_SERVER BLE 服务器
TKL_BLE_ROLE_CLIENT BLE 客户端
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	role	ble 角色，如下所示

名字	定义	备注
TKL_BLE_ROLE_SERVER	BLE 服务器
TKL_BLE_ROLE_CLIENT	BLE 客户端

tkl_ble_gap_callback_register

OPERATE_RET tkl_ble_gap_callback_register(const TKL_BLE_GAP_EVT_FUNC_CB gap_evt);

功能描述:

注册 gap 回调函数

参数：

输入/输出	参数名	描述
[in]	gap_evt	注册 gap 回调函数，如下定义

typedef void(*TKL_BLE_GAP_EVT_FUNC_CB)(TKL_BLE_GAP_PARAMS_EVT_T *p_event);

TKL_BLE_GAP_PARAMS_EVT_T

typedef struct {
      TKL_BLE_GAP_EVT_TYPE_E          type;           /**< Gap Event */
      uint16_t                        conn_handle;    /**< Connection Handle */
      int                           result;         /**< Will Refer to HOST STACK Error Code */

      union {
          TKL_BLE_GAP_CONNECT_EVT_T       connect;        /**< Receive connect callback, This value can be used with TKL_BLE_EVT_PERIPHERAL_CONNECT and TKL_BLE_EVT_CENTRAL_CONNECT_DISCOVERY*/
          TKL_BLE_GAP_DISCONNECT_EVT_T    disconnect;     /**< Receive disconnect callback*/
          TKL_BLE_GAP_ADV_REPORT_T        adv_report;     /**< Receive Adv and Respond report*/
          TKL_BLE_GAP_CONN_PARAMS_T       conn_param;     /**< We will update connect parameters.This value can be used with TKL_BLE_EVT_CONN_PARAM_REQ and TKL_BLE_EVT_CONN_PARAM_UPDATE*/
          char                          link_rssi;      /**< Peer device RSSI value */
      }gap_event;

  } TKL_BLE_GAP_PARAMS_EVT_T;

返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gatt_callback_register

OPERATE_RET tkl_ble_gatt_callback_register(const TKL_BLE_GATT_EVT_FUNC_CB gatt_evt);

功能描述:

注册GATT回调函数

参数：

输入/输出	参数名	描述
[in]	gatt_evt	GATT 回调函数

typedef void(*TKL_BLE_GATT_EVT_FUNC_CB)(TKL_BLE_GATT_PARAMS_EVT_T *p_event);

TKL_BLE_GATT_PARAMS_EVT_T

gatt事件定义如下:

typedef struct {
    TKL_BLE_GATT_EVT_TYPE_E             type;           /**< Gatt Event */
    uint16_t                            conn_handle;    /**< Connection Handle */
    int                               result;         /**< Will Refer to HOST STACK Error Code */

    union {
        uint16_t                        exchange_mtu;   /**< This value can be used with TKL_BLE_GATT_EVT_MTU_REQUEST and TKL_BLE_GATT_EVT_MTU_RSP*/
        TKL_BLE_GATT_SVC_DISC_TYPE_T    svc_disc;       /**< Discovery All Service */
        TKL_BLE_GATT_CHAR_DISC_TYPE_T   char_disc;      /**< Discovery Specific Characteristic */
        TKL_BLE_GATT_DESC_DISC_TYPE_T   desc_disc;      /**< Discovery Specific Descriptors*/
        TKL_BLE_NOTIFY_RESULT_EVT_T     notify_result;  /**< This value can be used with TKL_BLE_GATT_EVT_NOTIFY_TX*/
        TKL_BLE_DATA_REPORT_T           write_report;   /**< This value can be used with TKL_BLE_GATT_EVT_WRITE_REQ*/
        TKL_BLE_DATA_REPORT_T           data_report;    /**< This value can be used with TKL_BLE_GATT_EVT_NOTIFY_INDICATE_RX*/
        TKL_BLE_DATA_REPORT_T           data_read;      /**< After we do read attr in central mode, we will get the callback*/
        TKL_BLE_SUBSCRBE_EVT_T          subscribe;      /**< ccc callback event, used with TKL_BLE_GATT_EVT_SUBSCRIBE*/
        TKL_BLE_READ_CHAR_EVT_T         char_read;      /**< read char event, used with TKL_BLE_GATT_EVT_READ_CHAR_VALUE*/
    } gatt_event;
} TKL_BLE_GATT_PARAMS_EVT_T;

返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gap_addr_set

OPERATE_RET tkl_ble_gap_addr_set(TKL_BLE_GAP_ADDR_T const *p_peer_addr);

功能描述:

设置Ble mac地址
参数：

输入/输出参数名描述
[in] p_peer_addr mac 地址，可选 public/random
返回值:
- OPRT_OK : 成功
- Others ：失败
备注

一般模组经过生产已带有 mac 地址，无需配置。

输入/输出	参数名	描述
[in]	p_peer_addr	mac 地址，可选 public/random

tkl_ble_gap_address_get

OPERATE_RET tkl_ble_gap_address_get(TKL_BLE_GAP_ADDR_T *p_peer_addr);

功能描述:

读取Ble设备mac地址
参数：

输入/输出参数名描述
[out] p_peer_addr 设备mac地址
返回值:
- OPRT_OK : 成功
- Others ：失败
备注

很少使用

输入/输出	参数名	描述
[out]	p_peer_addr	设备mac地址

tkl_ble_gap_adv_start

OPERATE_RET tkl_ble_gap_adv_start(TKL_BLE_GAP_ADV_PARAMS_T const *p_adv_params);

功能描述:

开启ble广播

参数：

输入/输出	参数名	描述
[in]	p_adv_params	广播参数，如下所示

TKL_BLE_GAP_ADV_PARAMS_T

typedef struct {
    uint8_t                 adv_type;                   /**< Adv Type. Refer to TKL_BLE_GAP_ADV_TYPE_CONN_SCANNABLE_UNDIRECTED etc.*/
    TKL_BLE_GAP_ADDR_T      direct_addr;                /**< For Directed Advertising, you can fill in direct address */

    uint16_t                adv_interval_min;           /**< Range: 0x0020 to 0x4000  Time = N * 0.625 msec Time Range: 20 ms to 10.24 sec */
    uint16_t                adv_interval_max;           /**< Range: 0x0020 to 0x4000  Time = N * 0.625 msec Time Range: 20 ms to 10.24 sec */
    uint8_t                 adv_channel_map;            /**< Advertising Channel Map, 0x01 = adv channel index 37,  0x02 = adv channel index 38,
                                                                0x04 = adv channel index 39. Default Value: 0x07*/
} TKL_BLE_GAP_ADV_PARAMS_T;

返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gap_adv_stop

OPERATE_RET tkl_ble_gap_adv_stop(void);

功能描述:

关闭ble广播
参数：

无
返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gap_adv_rsp_data_set

OPERATE_RET tkl_ble_gap_adv_rsp_data_set(TKL_BLE_DATA_T const *p_adv, TKL_BLE_DATA_T const *p_scan_rsp);

功能描述:

设置广播数据
参数：

输入/输出参数名描述
[in] p_adv 广播数据
[in] p_scan_rsp 扫描响应数据
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	p_adv	广播数据
[in]	p_scan_rsp	扫描响应数据

tkl_ble_gap_adv_rsp_data_update

OPERATE_RET tkl_ble_gap_adv_rsp_data_update(TKL_BLE_DATA_T const *p_adv, TKL_BLE_DATA_T const *p_scan_rsp);

功能描述:

更新广播数据
参数：

输入/输出参数名描述
[in] p_adv 广播数据
[in] p_scan_rsp 扫描响应数据
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	p_adv	广播数据
[in]	p_scan_rsp	扫描响应数据

tkl_ble_gap_scan_start

OPERATE_RET tkl_ble_gap_scan_start(TKL_BLE_GAP_SCAN_PARAMS_T const *p_scan_params)

功能描述:

打开扫描

参数：

输入/输出	参数名	描述
[in]	p_scan_params	扫描参数，如下所示

TKL_BLE_GAP_SCAN_PARAMS_T

typedef struct {
    uint8_t                 extended;                   /**< If 1, the scanner will accept extended advertising packets.
                                                            If set to 0, the scanner will not receive advertising packets
                                                            on secondary advertising channels, and will not be able
                                                            to receive long advertising PDUs. */
    uint8_t                 active : 1;                 /**< [Tuya Need]!!!! If 1, perform active scanning by sending scan requests.
                                                            This parameter is ignored when used with @ref tkl_ble_gap_connect. */
    uint8_t                 scan_phys;                  /**< Refer to @TKL_BLE_GAP_PHY_1MBPS. TKL_BLE_GAP_PHY_2MBPS*/
    uint16_t                interval;                   /**< Scan interval in 625 us units. */
    uint16_t                window;                     /**< Scan window in 625 us units. */
    uint16_t                timeout;                    /**< Scan timeout in 10 ms units. */
    uint8_t                 scan_channel_map;           /**< Scan Channel Index, refer to @TKL_BLE_GAP_ADV_PARAMS_T*/
} TKL_BLE_GAP_SCAN_PARAMS_T;

返回值:
- OPRT_OK : 成功
- Others ：失败
备注

tkl_ble_gap_scan_start 在开启遥控器或支持 central 模式时使用。

tkl_ble_gap_scan_stop

OPERATE_RET tkl_ble_gap_scan_stop(void)

功能描述:

关闭蓝牙扫描
参数：

无

返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gap_connect

OPERATE_RET tkl_ble_gap_connect(TKL_BLE_GAP_ADDR_T const *p_peer_addr, TKL_BLE_GAP_SCAN_PARAMS_T const *p_scan_params, TKL_BLE_GAP_CONN_PARAMS_T const *p_conn_params)

功能描述:

作为client时，发起连接。
参数：

输入/输出参数名描述
[in] p_peer_addr 对端地址
[in] p_scan_params 扫描参数
[in] p_conn_params 连接参数
返回值:
- OPRT_OK : 成功
- Others ：失败
说明

只有作为 central 需要适配。

输入/输出	参数名	描述
[in]	p_peer_addr	对端地址
[in]	p_scan_params	扫描参数
[in]	p_conn_params	连接参数

tkl_ble_gap_disconnect

OPERATE_RET tkl_ble_gap_disconnect(uint16_t conn_handle, uint8_t hci_reason);

功能描述:

断开ble连接
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] p_conn_params 断连原因，非异常情况下，主动断连使用 0x13。
返回值:
- OPRT_OK : 成功
- Others ：失败
备注

client 和 server 均会用到

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	p_conn_params	断连原因，非异常情况下，主动断连使用 0x13。

tkl_ble_gap_conn_param_update

OPERATE_RET tkl_ble_gap_conn_param_update(uint16_t conn_handle, TKL_BLE_GAP_CONN_PARAMS_T const *p_conn_params);

功能描述:

gap 连接参数更新
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] p_conn_params 连接参数
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	p_conn_params	连接参数

tkl_ble_gatts_service_add

OPERATE_RET tkl_ble_gatts_service_add(TKL_BLE_GATTS_PARAMS_T *p_service);

功能描述:

gatt 添加服务，server 使用。

参数：

输入/输出	参数名	描述
[in/out]	p_service	GATT 服务

TKL_BLE_GATTS_PARAMS_T

typedef struct {
    uint8_t                     svc_num;                /**< If we only use service(0xFD50), the svc_num will be set into 1 */
    TKL_BLE_SERVICE_PARAMS_T    *p_service;
} TKL_BLE_GATTS_PARAMS_T;

TKL_BLE_SERVICE_PARAMS_T

handle 下发时默认 0xFF，添加完服务之后会更新对应的 handle 值。

typedef struct {
    uint16_t                    handle;                 /**< After init the service, we will get the svc-handle */

    TKL_BLE_UUID_T              svc_uuid;               /**< Service UUID */
    TKL_BLE_SERVICE_TYPE_E      type;                   /**< Service Type */

    uint8_t                     char_num;               /**< Number of characteristic */
    TKL_BLE_CHAR_PARAMS_T       *p_char;                /**< Pointer of characteristic */
} TKL_BLE_SERVICE_PARAMS_T;

返回值:
- OPRT_OK : 成功
- Others ：失败

tkl_ble_gatts_value_set

OPERATE_RET tkl_ble_gatts_value_set(uint16_t conn_handle, uint16_t char_handle, uint8_t *p_data, uint16_t length);

功能描述:

gatt 更新属性值，如配置 read 特征值，可以使用该函数更新
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] char_handle 特征值 handle
[in] p_data 数据
[in] length 数据长度
返回值:

OPRT_OK : 成功 Others ：失败

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	char_handle	特征值 handle
[in]	p_data	数据
[in]	length	数据长度

tkl_ble_gatts_value_get

OPERATE_RET tkl_ble_gatts_value_get(uint16_t conn_handle, uint16_t char_handle, uint8_t *p_data, uint16_t length);

功能描述:

GATT读取属性值，暂未用到
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] char_handle 特征值 handle
[out] p_data 读取数据
[in] length 读取长度
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	char_handle	特征值 handle
[out]	p_data	读取数据
[in]	length	读取长度

tkl_ble_gatts_value_notify

OPERATE_RET tkl_ble_gatts_value_notify(uint16_t conn_handle, uint16_t char_handle, uint8_t *p_data, uint16_t length);

功能描述:

服务器发送通知数据。
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] char_handle 特征值 handle
[in] p_data 通知的数据
[in] length 通知的数据长度
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	char_handle	特征值 handle
[in]	p_data	通知的数据
[in]	length	通知的数据长度

tkl_ble_gatts_value_indicate

OPERATE_RET tkl_ble_gatts_value_indicate(uint16_t conn_handle, uint16_t char_handle, uint8_t *p_data, uint16_t length);

功能描述:

服务器发送指示数据。
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] char_handle 特征值 handle
[in] p_data 指示的数据
[in] length 指示的数据长度
返回值:
- OPRT_OK : 成功
- Others ：失败

输入/输出	参数名	描述
[in]	conn_handle	连接 handle
[in]	char_handle	特征值 handle
[in]	p_data	指示的数据
[in]	length	指示的数据长度

tkl_ble_gatts_exchange_mtu_reply

OPERATE_RET tkl_ble_gatts_exchange_mtu_reply(uint16_t conn_handle, uint16_t server_rx_mtu);

功能描述:

服务器配置 MTU，即通过向客户端发送交换 MTU 响应，回复客户端 MTU 交换的请求
参数：

输入/输出参数名描述
[in] conn_handle 连接 handle
[in] server_rx_mtu server侧接收 mtu 大小
返回值:
- OPRT_OK : 成功
- Others ：失败

API 描述

tkl_ble_stack_init​

tkl_ble_stack_deinit​

tkl_ble_gap_callback_register​

tkl_ble_gatt_callback_register​

tkl_ble_gap_addr_set​

tkl_ble_gap_address_get​

tkl_ble_gap_adv_start​

tkl_ble_gap_adv_stop​

tkl_ble_gap_adv_rsp_data_set​

tkl_ble_gap_adv_rsp_data_update​

tkl_ble_gap_scan_start​

tkl_ble_gap_scan_stop​

tkl_ble_gap_connect​

tkl_ble_gap_disconnect​

tkl_ble_gap_conn_param_update​

tkl_ble_gatts_service_add​

tkl_ble_gatts_value_set​

tkl_ble_gatts_value_get​

tkl_ble_gatts_value_notify​

tkl_ble_gatts_value_indicate​

tkl_ble_gatts_exchange_mtu_reply​