Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Structures

Detailed Description

Data Structures

struct  st_ble_evt_data_t
 st_ble_evt_data_t is the type of the data notified in a GAP Event. More...
 
struct  st_ble_dev_addr_t
 st_ble_dev_addr_t is the type of bluetooth device address(BD_ADDR). More...
 
struct  st_ble_gap_ext_adv_param_t
 Advertising parameters. More...
 
struct  st_ble_gap_adv_data_t
 Advertising data/scan response data/periodic advertising data. More...
 
struct  st_ble_gap_perd_adv_param_t
 Periodic advertising parameter. More...
 
struct  st_ble_gap_scan_phy_param_t
 Scan parameters per scan PHY. More...
 
struct  st_ble_gap_ext_scan_param_t
 Scan parameters. More...
 
struct  st_ble_gap_scan_on_t
 Parameters configured when scanning starts. More...
 
struct  st_ble_gap_conn_param_t
 Connection parameters included in connection interval, slave latency, supervision timeout, ce length. More...
 
struct  st_ble_gap_conn_phy_param_t
 Connection parameters per PHY. More...
 
struct  st_ble_gap_create_conn_param_t
 Connection parameters used in R_BLE_GAP_CreateConn(). More...
 
struct  st_ble_gap_rslv_list_key_set_t
 IRK of a remote device and IRK type of local device used in R_BLE_GAP_ConfRslvList(). More...
 
struct  st_ble_gap_set_phy_param_t
 PHY configuration parameters used in R_BLE_GAP_SetPhy(). More...
 
struct  st_ble_gap_set_def_phy_param_t
 PHY preferences which allows a remote device to set used in R_BLE_GAP_SetDefPhy(). More...
 
struct  st_ble_gap_auth_info_t
 Pairing parameters required from a remote device or information about keys distributed from a remote device. More...
 
struct  st_ble_gap_key_dist_t
 Keys distributed from a remote device. More...
 
struct  st_ble_gap_key_ex_param_t
 This structure includes the distributed keys and negotiated LTK size. More...
 
struct  st_ble_gap_pairing_param_t
 Pairing parameters used in R_BLE_GAP_SetPairingParams(). More...
 
struct  st_ble_gap_oob_data_t
 Oob data received from the remote device. This is used in R_BLE_GAP_SetRemOobData(). More...
 
struct  st_ble_gap_ver_num_t
 Version number of host stack. More...
 
struct  st_ble_gap_loc_ver_info_t
 Version number of Controller. More...
 
struct  st_ble_gap_loc_dev_info_evt_t
 Version information of local device. More...
 
struct  st_ble_gap_hw_err_evt_t
 Hardware error that is notified from Controller. More...
 
struct  st_ble_gap_cmd_err_evt_t
 HCI Command error. More...
 
struct  st_ble_gap_adv_rept_t
 Advertising Report. More...
 
struct  st_ble_gap_ext_adv_rept_t
 Extended Advertising Report. More...
 
struct  st_ble_gap_perd_adv_rept_t
 Periodic Advertising Report. More...
 
struct  st_ble_gap_adv_rept_evt_t
 Advertising report. More...
 
struct  st_ble_gap_adv_set_evt_t
 Advertising handle. More...
 
struct  st_ble_gap_adv_off_evt_t
 Information about the advertising set which stops advertising. More...
 
struct  st_ble_gap_adv_data_evt_t
 This structure notifies that advertising data has been set to Controller by R_BLE_GAP_SetAdvSresData(). More...
 
struct  st_ble_gap_rem_adv_set_evt_t
 This structure notifies that an advertising set has been removed. More...
 
struct  st_ble_gap_conn_evt_t
 This structure notifies that a link has been established. More...
 
struct  st_ble_gap_disconn_evt_t
 This structure notifies that a link has been disconnected. More...
 
struct  st_ble_gap_rd_ch_map_evt_t
 This structure notifies that Channel Map has been acquired by R_BLE_GAP_ReadChMap(). More...
 
struct  st_ble_gap_rd_rssi_evt_t
 This structure notifies that RSSI has been acquired by R_BLE_GAP_ReadRssi(). More...
 
struct  st_ble_gap_dev_info_evt_t
 This structure notifies that information about remote device has been acquired by R_BLE_GAP_GetRemDevInfo(). More...
 
struct  st_ble_gap_conn_upd_evt_t
 This structure notifies that connection parameters has been updated. More...
 
struct  st_ble_gap_conn_upd_req_evt_t
 This structure notifies that a request for connection parameters update has been received. More...
 
struct  st_ble_gap_conn_hdl_evt_t
 This structure notifies that a GAP Event that includes only connection handle has occurred. More...
 
struct  st_ble_gap_data_len_chg_evt_t
 This structure notifies that the packet data length has been updated. More...
 
struct  st_ble_gap_rd_rpa_evt_t
 This structure notifies that the local resolvable private address has been acquired by R_BLE_GAP_ReadRpa(). More...
 
struct  st_ble_gap_phy_upd_evt_t
 This structure notifies that PHY for a connection has been updated. More...
 
struct  st_ble_gap_phy_rd_evt_t
 This structure notifies that the PHY settings has been acquired by R_BLE_GAP_ReadPhy(). More...
 
struct  st_ble_gap_scan_req_recv_evt_t
 This structure notifies that a Scan Request packet has been received from a Scanner. More...
 
struct  st_ble_gap_sync_est_evt_t
 This structure notifies that a Periodic sync has been established. More...
 
struct  st_ble_gap_sync_hdl_evt_t
 This structure notifies that a GAP Event that includes only sync handle has occurred. More...
 
struct  st_ble_gap_white_list_conf_evt_t
 This structure notifies that White List has been configured. More...
 
struct  st_ble_gap_rslv_list_conf_evt_t
 This structure notifies that Resolving List has been configured. More...
 
struct  st_ble_gap_perd_list_conf_evt_t
 This structure notifies that Periodic Advertiser List has been configured. More...
 
struct  st_ble_gap_set_priv_mode_evt_t
 This structure notifies that Privacy Mode has been configured. More...
 
struct  st_ble_gap_pairing_req_evt_t
 This structure notifies that a pairing request from a remote device has been received. More...
 
struct  st_ble_gap_passkey_display_evt_t
 This structure notifies that a request for Passkey display in pairing has been received. More...
 
struct  st_ble_gap_num_comp_evt_t
 This structure notifies that a request for Numeric Comparison in pairing has been received. More...
 
struct  st_ble_gap_key_press_ntf_evt_t
 This structure notifies that the remote device has input a key in Passkey Entry. More...
 
struct  st_ble_gap_pairing_info_evt_t
 This structure notifies that the pairing has completed. More...
 
struct  st_ble_gap_enc_chg_evt_t
 This structure notifies that the encryption status of a link has been changed. More...
 
struct  st_ble_gap_peer_key_info_evt_t
 This structure notifies that the remote device has distributed the keys. More...
 
struct  st_ble_gap_ltk_req_evt_t
 This structure notifies that a LTK request from a remote device has been received. More...
 
struct  st_ble_gap_ltk_rsp_evt_t
 This structure notifies that local device has replied to the LTK request from the remote device. More...
 
struct  st_ble_gap_sc_oob_data_evt_t
 This structure notifies that OOB data for Secure Connections has been generated by R_BLE_GAP_CreateScOobData(). More...
 
struct  st_ble_gap_bond_info_t
 Bonding information used in R_BLE_GAP_SetBondInfo(). More...
 

Typedefs

typedef void(* ble_gap_app_cb_t) (uint16_t event_type, ble_status_t event_result, st_ble_evt_data_t *p_event_data)
 ble_gap_app_cb_t is the GAP Event callback function type. More...
 
typedef void(* ble_gap_del_bond_cb_t) (st_ble_dev_addr_t *p_addr)
 ble_gap_del_bond_cb_t is the type of the callback function for delete bonding information stored in non-volatile area.
This type is used in R_BLE_GAP_DeleteBondInfo(). More...
 
typedef st_ble_gap_ext_adv_param_t st_ble_gap_adv_param_t
 Advertising parameters. More...
 
typedef st_ble_gap_ext_scan_param_t st_ble_gap_scan_param_t
 Scan parameters. More...
 

Typedef Documentation

◆ ble_gap_app_cb_t

ble_gap_app_cb_t

ble_gap_app_cb_t is the GAP Event callback function type.

Parameters
[in]event_typeThe type of GAP Event.
[in]event_resultThe result of API call which generates the GAP Event.
[in]p_event_dataData notified in the GAP Event.
Returns
none

◆ ble_gap_del_bond_cb_t

ble_gap_del_bond_cb_t

ble_gap_del_bond_cb_t is the type of the callback function for delete bonding information stored in non-volatile area.
This type is used in R_BLE_GAP_DeleteBondInfo().

Parameters
[in]p_addrThe parameter returns the address of the remote device whose keys are deleted by R_BLE_GAP_DeleteBondInfo().
If R_BLE_GAP_DeleteBondInfo() deletes the keys of all remote devices, the parameter returns NULL.
Returns
none

◆ st_ble_gap_adv_param_t

◆ st_ble_gap_scan_param_t