btgatt_client_interface_t 结构体参考文档

btgatt_client_interface_t 结构体参考文档

#include < bt_gatt_client.h >

数据字段

bt_status_t (*  register_client )( bt_uuid_t *uuid)
 
bt_status_t (*  unregister_client )(int client_if)
 
bt_status_t (*  scan )(bool start)
 
bt_status_t (*  connect )(int client_if, const bt_bdaddr_t *bd_addr, bool is_direct, int transport)
 
bt_status_t (*  disconnect )(int client_if, const bt_bdaddr_t *bd_addr, int conn_id)
 
bt_status_t (*  listen )(int client_if, bool start)
 
bt_status_t (*  refresh )(int client_if, const bt_bdaddr_t *bd_addr)
 
bt_status_t (*  search_service )(int conn_id, bt_uuid_t *filter_uuid)
 
bt_status_t (*  read_characteristic )(int conn_id, uint16_t handle, int auth_req)
 
bt_status_t (*  write_characteristic )(int conn_id, uint16_t handle, int write_type, int auth_req, vector< uint8_t > value)
 
bt_status_t (*  read_descriptor )(int conn_id, uint16_t handle, int auth_req)
 
bt_status_t (*  write_descriptor )(int conn_id, uint16_t handle, int write_type, int auth_req, vector< uint8_t > value)
 
bt_status_t (*  execute_write )(int conn_id, int execute)
 
bt_status_t (*  register_for_notification )(int client_if, const bt_bdaddr_t *bd_addr, uint16_t handle)
 
bt_status_t (*  deregister_for_notification )(int client_if, const bt_bdaddr_t *bd_addr, uint16_t handle)
 
bt_status_t (*  read_remote_rssi )(int client_if, const bt_bdaddr_t *bd_addr)
 
bt_status_t (*  scan_filter_param_setup )( btgatt_filt_param_setup_t filt_param)
 
bt_status_t (*  scan_filter_add_remove )(int client_if, int action, int filt_type, int filt_index, int company_id, int company_id_mask, const bt_uuid_t *p_uuid, const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr, char addr_type, vector< uint8_t > data, vector< uint8_t > p_mask)
 
bt_status_t (*  scan_filter_clear )(int client_if, int filt_index)
 
bt_status_t (*  scan_filter_enable )(int client_if, bool enable)
 
int(*  get_device_type )(const bt_bdaddr_t *bd_addr)
 
bt_status_t (*  set_adv_data )(int client_if, bool set_scan_rsp, bool include_name, bool include_txpower, int min_interval, int max_interval, int appearance, vector< uint8_t > manufacturer_data, vector< uint8_t > service_data, vector< uint8_t > service_uuid)
 
bt_status_t (*  configure_mtu )(int conn_id, int mtu)
 
bt_status_t (*  conn_parameter_update )(const bt_bdaddr_t *bd_addr, int min_interval, int max_interval, int latency, int timeout)
 
bt_status_t (*  set_scan_parameters )(int client_if, int scan_interval, int scan_window)
 
bt_status_t (*  multi_adv_enable )(int client_if, int min_interval, int max_interval, int adv_type, int chnl_map, int tx_power, int timeout_s)
 
bt_status_t (*  multi_adv_update )(int client_if, int min_interval, int max_interval, int adv_type, int chnl_map, int tx_power, int timeout_s)
 
bt_status_t (*  multi_adv_set_inst_data )(int client_if, bool set_scan_rsp, bool include_name, bool incl_txpower, int appearance, vector< uint8_t > manufacturer_data, vector< uint8_t > service_data, vector< uint8_t > service_uuid)
 
bt_status_t (*  multi_adv_disable )(int client_if)
 
bt_status_t (*  batchscan_cfg_storage )(int client_if, int batch_scan_full_max, int batch_scan_trunc_max, int batch_scan_notify_threshold)
 
bt_status_t (*  batchscan_enb_batch_scan )(int client_if, int scan_mode, int scan_interval, int scan_window, int addr_type, int discard_rule)
 
bt_status_t (*  batchscan_dis_batch_scan )(int client_if)
 
bt_status_t (*  batchscan_read_reports )(int client_if, int scan_mode)
 
bt_status_t (*  test_command )(int command, btgatt_test_params_t *params)
 
bt_status_t (*  get_gatt_db )(int conn_id)
 

详细说明

表示标准 BT-GATT 客户端接口。

定义位于文件 bt_gatt_client.h 的 274 行

字段文档

bt_status_t (* batchscan_cfg_storage)(int client_if, int batch_scan_full_max, int batch_scan_trunc_max, int batch_scan_notify_threshold)

定义位于文件 bt_gatt_client.h 393 行

bt_status_t (* batchscan_dis_batch_scan)(int client_if)

定义位于文件 bt_gatt_client.h 401 行。

bt_status_t (* batchscan_enb_batch_scan)(int client_if, int scan_mode, int scan_interval, int scan_window, int addr_type, int discard_rule)

定义位于文件 bt_gatt_client.h 397 行。

bt_status_t (* batchscan_read_reports)(int client_if, int scan_mode)

定义位于文件 bt_gatt_client.h 404 行中。

bt_status_t (* configure_mtu)(int conn_id, int mtu)

为给定连接配置 MTU

定义位于文件 bt_gatt_client.h 的第 367 行

bt_status_t (* conn_parameter_update)(const bt_bdaddr_t *bd_addr, int min_interval, int max_interval, int latency, int timeout)

请求更新连接参数

定义位于文件 bt_gatt_client.h 的第 370 行 。 。

bt_status_t (* connect)(int client_if, const bt_bdaddr_t *bd_addr, bool is_direct, int transport)

创建与远程 LE 或双模式设备的连接

定义位于文件 bt_gatt_client.h 285 行

bt_status_t (* deregister_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, uint16_t handle)

取消注册之前的通知/指示请求

定义位于文件 bt_gatt_client.h 的第 332 行 。 。

bt_status_t (* disconnect)(int client_if, const bt_bdaddr_t *bd_addr, int conn_id)

断开远程设备的连接或取消待处理的连接

定义位于文件 bt_gatt_client.h 的 289 行。

bt_status_t (* execute_write)(int conn_id, int execute)

执行准备好的写入操作

定义位于文件 bt_gatt_client.h 的 第 322 行。

int(* get_device_type)(const bt_bdaddr_t *bd_addr)

确定远程设备的类型(LE、BR/EDR、双模式)

定义位于文件 bt_gatt_client.h 357 行。

bt_status_t (* get_gatt_db)(int conn_id)

获取 GATT 数据库内容

定义位于文件 bt_gatt_client.h 的第 410 行

bt_status_t (* listen)(int client_if, bool start)

启动或停止广告以监听传入连接

定义位于文件 bt_gatt_client.h 的第 293 行

bt_status_t (* multi_adv_disable)(int client_if)

定义位于文件 bt_gatt_client.h 的第 390 行

bt_status_t (* multi_adv_enable)(int client_if, int min_interval, int max_interval, int adv_type, int chnl_map, int tx_power, int timeout_s)

定义位于文件 bt_gatt_client.h 的第 377 行

bt_status_t (* multi_adv_set_inst_data)(int client_if, bool set_scan_rsp, bool include_name, bool incl_txpower, int appearance, vector< uint8_t > manufacturer_data, vector< uint8_t > service_data, vector< uint8_t > service_uuid)

定义位于文件 bt_gatt_client.h 的第 385 行

bt_status_t (* multi_adv_update)(int client_if, int min_interval, int max_interval, int adv_type, int chnl_map, int tx_power, int timeout_s)

定义位于文件 bt_gatt_client.h 的第 381 行 。 。

bt_status_t (* read_characteristic)(int conn_id, uint16_t handle, int auth_req)

读取远程设备上的特性

定义位于文件 bt_gatt_client.h 的第 305 行 。 。

bt_status_t (* read_descriptor)(int conn_id, uint16_t handle, int auth_req)

读取指定特性的描述符

定义位于文件 bt_gatt_client.h 314 行。

bt_status_t (* read_remote_rssi)(int client_if, const bt_bdaddr_t *bd_addr)

请求指定远程设备的 RSSI

定义位于文件 bt_gatt_client.h 336 行。

bt_status_t (* refresh)(int client_if, const bt_bdaddr_t *bd_addr)

清除指定设备的属性缓存

定义位于文件 bt_gatt_client.h 的第 296 行

bt_status_t (* register_client)( bt_uuid_t *uuid)

向堆栈注册 GATT 客户端应用

定义位于文件 bt_gatt_client.h 276 行

bt_status_t (* register_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, uint16_t handle)

注册接收特定特性的通知或指示

定义位于文件 bt_gatt_client.h 的第 328 行

bt_status_t (* scan)(bool start)

开始或停止 LE 设备扫描

定义位于文件 bt_gatt_client.h 282 行

bt_status_t (* scan_filter_add_remove)(int client_if, int action, int filt_type, int filt_index, int company_id, int company_id_mask, const bt_uuid_t *p_uuid, const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr, char addr_type, vector< uint8_t > data, vector< uint8_t > p_mask)

配置扫描过滤条件

定义位于文件 bt_gatt_client.h 的第 343 行

bt_status_t (* scan_filter_clear)(int client_if, int filt_index)

清除特定过滤器索引的所有扫描过滤条件

定义位于文件 bt_gatt_client.h 的第 351 行。

bt_status_t (* scan_filter_enable)(int client_if, bool enable)

启用 / 停用扫描过滤器功能

定义位于文件 bt_gatt_client.h 354 行

bt_status_t (* scan_filter_param_setup)( btgatt_filt_param_setup_t filt_param)

设置扫描过滤器参数

定义位于文件 bt_gatt_client.h 339 行

bt_status_t (* search_service)(int conn_id, bt_uuid_t *filter_uuid)

枚举已连接设备上的所有 GATT 服务。(可选)您可以按给定 UUID 过滤结果。

定义位于文件 bt_gatt_client.h 302 行。

bt_status_t (* set_adv_data)(int client_if, bool set_scan_rsp, bool include_name, bool include_txpower, int min_interval, int max_interval, int appearance, vector< uint8_t > manufacturer_data, vector< uint8_t > service_data, vector< uint8_t > service_uuid)

设置通告数据或扫描响应数据

定义位于文件 bt_gatt_client.h 360 行中。

bt_status_t (* set_scan_parameters)(int client_if, int scan_interval, int scan_window)

以 N*0.625 毫秒为单位设置 LE 扫描间隔和时段

定义位于文件 bt_gatt_client.h 374 行。

bt_status_t (* test_command)(int command, btgatt_test_params_t *params)

测试模式界面

定义位于文件 bt_gatt_client.h 407 行。

bt_status_t (* unregister_client)(int client_if)

从堆栈中取消注册客户端应用

定义位于文件 bt_gatt_client.h 279 行

bt_status_t (* write_characteristic)(int conn_id, uint16_t handle, int write_type, int auth_req, vector< uint8_t > value)

写入远程特征

定义位于文件 bt_gatt_client.h 的第 309 行

bt_status_t (* write_descriptor)(int conn_id, uint16_t handle, int write_type, int auth_req, vector< uint8_t > value)

为给定特征编写远程描述符

定义位于文件 bt_gatt_client.h 317 行


此结构体的文档是根据以下文件生成的: