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 行。

這個結構體的說明文件是由下列檔案產生：