btgatt_client_interface_t Struct Reference

#include <bt_gatt_client.h>

Data Fields

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(* get_included_service )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *start_incl_srvc_id)
 
bt_status_t(* get_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id)
 
bt_status_t(* get_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *start_descr_id)
 
bt_status_t(* read_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int auth_req)
 
bt_status_t(* write_characteristic )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int write_type, int len, int auth_req, char *p_value)
 
bt_status_t(* read_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int auth_req)
 
bt_status_t(* write_descriptor )(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int write_type, int len, int auth_req, char *p_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, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)
 
bt_status_t(* deregister_for_notification )(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)
 
bt_status_t(* read_remote_rssi )(int client_if, const bt_bdaddr_t *bd_addr)
 
bt_status_t(* scan_filter_param_setup )(int client_if, int action, int filt_index, int feat_seln, int list_logic_type, int filt_logic_type, int rssi_high_thres, int rssi_low_thres, int dely_mode, int found_timeout, int lost_timeout, int found_timeout_cnt)
 
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, int data_len, char *p_data, int mask_len, char *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, uint16_t manufacturer_len, char *manufacturer_data, uint16_t service_data_len, char *service_data, uint16_t service_uuid_len, char *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 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, int manufacturer_len, char *manufacturer_data, int service_data_len, char *service_data, int service_uuid_len, char *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)
 

Detailed Description

Represents the standard BT-GATT client interface.

Definition at line 245 of file bt_gatt_client.h.

Field Documentation

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

Definition at line 397 of file bt_gatt_client.h.

bt_status_t(* batchscan_dis_batch_scan)(int client_if)

Definition at line 405 of file bt_gatt_client.h.

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)

Definition at line 401 of file bt_gatt_client.h.

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

Definition at line 408 of file bt_gatt_client.h.

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

Configure the MTU for a given connection

Definition at line 370 of file bt_gatt_client.h.

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

Request a connection parameter update

Definition at line 373 of file bt_gatt_client.h.

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

Create a connection to a remote LE or dual-mode device

Definition at line 256 of file bt_gatt_client.h.

bt_status_t(* deregister_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)

Deregister a previous request for notifications/indications

Definition at line 331 of file bt_gatt_client.h.

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

Disconnect a remote device or cancel a pending connection

Definition at line 260 of file bt_gatt_client.h.

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

Execute a prepared write operation

Definition at line 320 of file bt_gatt_client.h.

bt_status_t(* get_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id)

Enumerate characteristics for a given service. Set start_char_id to NULL to get the first characteristic.

Definition at line 286 of file bt_gatt_client.h.

bt_status_t(* get_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *start_descr_id)

Enumerate descriptors for a given characteristic. Set start_descr_id to NULL to get the first descriptor.

Definition at line 293 of file bt_gatt_client.h.

int(* get_device_type)(const bt_bdaddr_t *bd_addr)

Determine the type of the remote device (LE, BR/EDR, Dual-mode)

Definition at line 360 of file bt_gatt_client.h.

bt_status_t(* get_included_service)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *start_incl_srvc_id)

Enumerate included services for a given service. Set start_incl_srvc_id to NULL to get the first included service.

Definition at line 279 of file bt_gatt_client.h.

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

Start or stop advertisements to listen for incoming connections

Definition at line 264 of file bt_gatt_client.h.

bt_status_t(* multi_adv_disable)(int client_if)

Definition at line 394 of file bt_gatt_client.h.

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)

Definition at line 380 of file bt_gatt_client.h.

bt_status_t(* multi_adv_set_inst_data)(int client_if, bool set_scan_rsp, bool include_name, bool incl_txpower, int appearance, int manufacturer_len, char *manufacturer_data, int service_data_len, char *service_data, int service_uuid_len, char *service_uuid)

Definition at line 388 of file bt_gatt_client.h.

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)

Definition at line 384 of file bt_gatt_client.h.

bt_status_t(* read_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int auth_req)

Read a characteristic on a remote device

Definition at line 298 of file bt_gatt_client.h.

bt_status_t(* read_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int auth_req)

Read the descriptor for a given characteristic

Definition at line 309 of file bt_gatt_client.h.

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

Request RSSI for a given remote device

Definition at line 336 of file bt_gatt_client.h.

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

Clear the attribute cache for a given device

Definition at line 267 of file bt_gatt_client.h.

bt_status_t(* register_client)(bt_uuid_t *uuid)

Registers a GATT client application with the stack

Definition at line 247 of file bt_gatt_client.h.

bt_status_t(* register_for_notification)(int client_if, const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id)

Register to receive notifications or indications for a given characteristic

Definition at line 326 of file bt_gatt_client.h.

bt_status_t(* scan)(bool start)

Start or stop LE device scanning

Definition at line 253 of file bt_gatt_client.h.

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, int data_len, char *p_data, int mask_len, char *p_mask)

Configure a scan filter condition

Definition at line 346 of file bt_gatt_client.h.

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

Clear all scan filter conditions for specific filter index

Definition at line 354 of file bt_gatt_client.h.

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

Enable / disable scan filter feature

Definition at line 357 of file bt_gatt_client.h.

bt_status_t(* scan_filter_param_setup)(int client_if, int action, int filt_index, int feat_seln, int list_logic_type, int filt_logic_type, int rssi_high_thres, int rssi_low_thres, int dely_mode, int found_timeout, int lost_timeout, int found_timeout_cnt)

Setup scan filter params

Definition at line 339 of file bt_gatt_client.h.

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

Enumerate all GATT services on a connected device. Optionally, the results can be filtered for a given UUID.

Definition at line 273 of file bt_gatt_client.h.

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, uint16_t manufacturer_len, char *manufacturer_data, uint16_t service_data_len, char *service_data, uint16_t service_uuid_len, char *service_uuid)

Set the advertising data or scan response data

Definition at line 363 of file bt_gatt_client.h.

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

Sets the LE scan interval and window in units of N*0.625 msec

Definition at line 377 of file bt_gatt_client.h.

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

Test mode interface

Definition at line 411 of file bt_gatt_client.h.

bt_status_t(* unregister_client)(int client_if)

Unregister a client application from the stack

Definition at line 250 of file bt_gatt_client.h.

bt_status_t(* write_characteristic)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, int write_type, int len, int auth_req, char *p_value)

Write a remote characteristic

Definition at line 303 of file bt_gatt_client.h.

bt_status_t(* write_descriptor)(int conn_id, btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id, btgatt_gatt_id_t *descr_id, int write_type, int len, int auth_req, char *p_value)

Write a remote descriptor for a given characteristic

Definition at line 314 of file bt_gatt_client.h.


The documentation for this struct was generated from the following file: