Functions | |
uint32_t | sd_ble_gap_addr_set (ble_gap_addr_t const *p_addr) |
Set the local Bluetooth identity address. More... | |
uint32_t | sd_ble_gap_addr_get (ble_gap_addr_t *p_addr) |
Get local Bluetooth identity address. More... | |
uint32_t | sd_ble_gap_whitelist_set (ble_gap_addr_t const *const *pp_wl_addrs, uint8_t len) |
Set the active whitelist in the SoftDevice. More... | |
uint32_t | sd_ble_gap_device_identities_set (ble_gap_id_key_t const *const *pp_id_keys, ble_gap_irk_t const *const *pp_local_irks, uint8_t len) |
Set device identity list. More... | |
uint32_t | sd_ble_gap_privacy_set (ble_gap_privacy_params_t const *p_privacy_params) |
Set privacy settings. More... | |
uint32_t | sd_ble_gap_privacy_get (ble_gap_privacy_params_t *p_privacy_params) |
Get privacy settings. More... | |
uint32_t | sd_ble_gap_adv_data_set (uint8_t const *p_data, uint8_t dlen, uint8_t const *p_sr_data, uint8_t srdlen) |
Set, clear or update advertising and scan response data. More... | |
uint32_t | sd_ble_gap_adv_start (ble_gap_adv_params_t const *p_adv_params, uint8_t conn_cfg_tag) |
Start advertising (GAP Discoverable, Connectable modes, Broadcast Procedure). More... | |
uint32_t | sd_ble_gap_adv_stop (void) |
Stop advertising (GAP Discoverable, Connectable modes, Broadcast Procedure). More... | |
uint32_t | sd_ble_gap_conn_param_update (uint16_t conn_handle, ble_gap_conn_params_t const *p_conn_params) |
Update connection parameters. More... | |
uint32_t | sd_ble_gap_disconnect (uint16_t conn_handle, uint8_t hci_status_code) |
Disconnect (GAP Link Termination). More... | |
uint32_t | sd_ble_gap_tx_power_set (int8_t tx_power) |
Set the radio's transmit power. More... | |
uint32_t | sd_ble_gap_appearance_set (uint16_t appearance) |
Set GAP Appearance value. More... | |
uint32_t | sd_ble_gap_appearance_get (uint16_t *p_appearance) |
Get GAP Appearance value. More... | |
uint32_t | sd_ble_gap_ppcp_set (ble_gap_conn_params_t const *p_conn_params) |
Set GAP Peripheral Preferred Connection Parameters. More... | |
uint32_t | sd_ble_gap_ppcp_get (ble_gap_conn_params_t *p_conn_params) |
Get GAP Peripheral Preferred Connection Parameters. More... | |
uint32_t | sd_ble_gap_device_name_set (ble_gap_conn_sec_mode_t const *p_write_perm, uint8_t const *p_dev_name, uint16_t len) |
Set GAP device name. More... | |
uint32_t | sd_ble_gap_device_name_get (uint8_t *p_dev_name, uint16_t *p_len) |
Get GAP device name. More... | |
uint32_t | sd_ble_gap_authenticate (uint16_t conn_handle, ble_gap_sec_params_t const *p_sec_params) |
Initiate the GAP Authentication procedure. More... | |
uint32_t | sd_ble_gap_sec_params_reply (uint16_t conn_handle, uint8_t sec_status, ble_gap_sec_params_t const *p_sec_params, ble_gap_sec_keyset_t const *p_sec_keyset) |
Reply with GAP security parameters. More... | |
uint32_t | sd_ble_gap_auth_key_reply (uint16_t conn_handle, uint8_t key_type, uint8_t const *p_key) |
Reply with an authentication key. More... | |
uint32_t | sd_ble_gap_lesc_dhkey_reply (uint16_t conn_handle, ble_gap_lesc_dhkey_t const *p_dhkey) |
Reply with an LE Secure connections DHKey. More... | |
uint32_t | sd_ble_gap_keypress_notify (uint16_t conn_handle, uint8_t kp_not) |
Notify the peer of a local keypress. More... | |
uint32_t | sd_ble_gap_lesc_oob_data_get (uint16_t conn_handle, ble_gap_lesc_p256_pk_t const *p_pk_own, ble_gap_lesc_oob_data_t *p_oobd_own) |
Generate a set of OOB data to send to a peer out of band. More... | |
uint32_t | sd_ble_gap_lesc_oob_data_set (uint16_t conn_handle, ble_gap_lesc_oob_data_t const *p_oobd_own, ble_gap_lesc_oob_data_t const *p_oobd_peer) |
Provide the OOB data sent/received out of band. More... | |
uint32_t | sd_ble_gap_encrypt (uint16_t conn_handle, ble_gap_master_id_t const *p_master_id, ble_gap_enc_info_t const *p_enc_info) |
Initiate GAP Encryption procedure. More... | |
uint32_t | sd_ble_gap_sec_info_reply (uint16_t conn_handle, ble_gap_enc_info_t const *p_enc_info, ble_gap_irk_t const *p_id_info, ble_gap_sign_info_t const *p_sign_info) |
Reply with GAP security information. More... | |
uint32_t | sd_ble_gap_conn_sec_get (uint16_t conn_handle, ble_gap_conn_sec_t *p_conn_sec) |
Get the current connection security. More... | |
uint32_t | sd_ble_gap_rssi_start (uint16_t conn_handle, uint8_t threshold_dbm, uint8_t skip_count) |
Start reporting the received signal strength to the application. More... | |
uint32_t | sd_ble_gap_rssi_stop (uint16_t conn_handle) |
Stop reporting the received signal strength. More... | |
uint32_t | sd_ble_gap_rssi_get (uint16_t conn_handle, int8_t *p_rssi) |
Get the received signal strength for the last connection event. More... | |
uint32_t | sd_ble_gap_scan_start (ble_gap_scan_params_t const *p_scan_params) |
Start scanning (GAP Discovery procedure, Observer Procedure). More... | |
uint32_t | sd_ble_gap_scan_stop (void) |
Stop scanning (GAP Discovery procedure, Observer Procedure). More... | |
uint32_t | sd_ble_gap_connect (ble_gap_addr_t const *p_peer_addr, ble_gap_scan_params_t const *p_scan_params, ble_gap_conn_params_t const *p_conn_params, uint8_t conn_cfg_tag) |
Create a connection (GAP Link Establishment). More... | |
uint32_t | sd_ble_gap_connect_cancel (void) |
Cancel a connection establishment. More... | |
uint32_t | sd_ble_gap_data_length_update (uint16_t conn_handle, ble_gap_data_length_params_t const *p_dl_params, ble_gap_data_length_limitation_t *p_dl_limitation) |
Initiate or respond to a Data Length Update Procedure. More... | |
uint32_t sd_ble_gap_addr_get | ( | ble_gap_addr_t * | p_addr | ) |
Get local Bluetooth identity address.
[out] | p_addr | Pointer to address structure to be filled in. |
NRF_SUCCESS | Address successfully retrieved. |
NRF_ERROR_INVALID_ADDR | Invalid or NULL pointer supplied. |
uint32_t sd_ble_gap_addr_set | ( | ble_gap_addr_t const * | p_addr | ) |
Set the local Bluetooth identity address.
The local Bluetooth identity address is the address that identifies this device to other peers. The address type must be either @ref BLE_GAP_ADDR_TYPE_PUBLIC or @ref BLE_GAP_ADDR_TYPE_RANDOM_STATIC.
Advertising |
[in] | p_addr | Pointer to address structure. |
NRF_SUCCESS | Address successfully set. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid address. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. |
NRF_ERROR_INVALID_STATE | The identity address cannot be changed while advertising, scanning or creating a connection. |
uint32_t sd_ble_gap_adv_data_set | ( | uint8_t const * | p_data, |
uint8_t | dlen, | ||
uint8_t const * | p_sr_data, | ||
uint8_t | srdlen | ||
) |
Set, clear or update advertising and scan response data.
Advertising |
Whitelist Sharing |
[in] | p_data | Raw data to be placed in advertising packet. If NULL, no changes are made to the current advertising packet data. |
[in] | dlen | Data length for p_data. Max size: BLE_GAP_ADV_MAX_SIZE octets. Should be 0 if p_data is NULL, can be 0 if p_data is not NULL. |
[in] | p_sr_data | Raw data to be placed in scan response packet. If NULL, no changes are made to the current scan response packet data. |
[in] | srdlen | Data length for p_sr_data. Max size: BLE_GAP_ADV_MAX_SIZE octets. Should be 0 if p_sr_data is NULL, can be 0 if p_data is not NULL. |
NRF_SUCCESS | Advertising data successfully updated or cleared. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, both p_data and p_sr_data cannot be NULL. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_FLAGS | Invalid combination of advertising flags supplied. |
NRF_ERROR_INVALID_DATA | Invalid data type(s) supplied, check the advertising data format specification. |
NRF_ERROR_INVALID_LENGTH | Invalid data length(s) supplied. |
NRF_ERROR_NOT_SUPPORTED | Unsupported data type. |
BLE_ERROR_GAP_UUID_LIST_MISMATCH | Invalid UUID list supplied. |
uint32_t sd_ble_gap_adv_start | ( | ble_gap_adv_params_t const * | p_adv_params, |
uint8_t | conn_cfg_tag | ||
) |
Start advertising (GAP Discoverable, Connectable modes, Broadcast Procedure).
BLE_GAP_EVT_CONNECTED | Generated after connection has been established through connectable advertising. |
BLE_GAP_EVT_TIMEOUT | Advertisement has timed out. |
Advertising |
Peripheral Connection Establishment with Private Peer |
Directed Advertising |
Whitelist Sharing |
[in] | p_adv_params | Pointer to advertising parameters structure. |
[in] | conn_cfg_tag | Tag identifying a configuration set by sd_ble_cfg_set or BLE_CONN_CFG_TAG_DEFAULT to use the default connection configuration. |
NRF_SUCCESS | The BLE stack has started advertising. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_CONN_COUNT | The limit of available connections has been reached; connectable advertiser cannot be started. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, check the accepted ranges and limits. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid Bluetooth address supplied. |
BLE_ERROR_GAP_DISCOVERABLE_WITH_WHITELIST | Discoverable mode and whitelist incompatible. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. |
NRF_ERROR_RESOURCES | Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral or Observer) and try again |
uint32_t sd_ble_gap_adv_stop | ( | void | ) |
Stop advertising (GAP Discoverable, Connectable modes, Broadcast Procedure).
Advertising |
Whitelist Sharing |
NRF_SUCCESS | The BLE stack has stopped advertising. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation (most probably not in advertising state). |
uint32_t sd_ble_gap_appearance_get | ( | uint16_t * | p_appearance | ) |
Get GAP Appearance value.
[out] | p_appearance | Pointer to appearance (16-bit) to be filled in, see Bluetooth Appearance values. |
NRF_SUCCESS | Appearance value retrieved successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
uint32_t sd_ble_gap_appearance_set | ( | uint16_t | appearance | ) |
Set GAP Appearance value.
[in] | appearance | Appearance (16-bit), see Bluetooth Appearance values. |
NRF_SUCCESS | Appearance value set successfully. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
uint32_t sd_ble_gap_auth_key_reply | ( | uint16_t | conn_handle, |
uint8_t | key_type, | ||
uint8_t const * | p_key | ||
) |
Reply with an authentication key.
This function is only used to reply to a BLE_GAP_EVT_AUTH_KEY_REQUEST or a BLE_GAP_EVT_PASSKEY_DISPLAY, calling it at other times will result in an NRF_ERROR_INVALID_STATE.
This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate. |
[in] | conn_handle | Connection handle. |
[in] | key_type | See GAP Authentication Key Types. |
[in] | p_key | If key type is BLE_GAP_AUTH_KEY_TYPE_NONE, then NULL. If key type is BLE_GAP_AUTH_KEY_TYPE_PASSKEY, then a 6-byte ASCII string (digit 0..9 only, no NULL termination) or NULL when confirming LE Secure Connections Numeric Comparison. If key type is BLE_GAP_AUTH_KEY_TYPE_OOB, then a 16-byte OOB key value in little-endian format. |
NRF_SUCCESS | Authentication key successfully set. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_authenticate | ( | uint16_t | conn_handle, |
ble_gap_sec_params_t const * | p_sec_params | ||
) |
Initiate the GAP Authentication procedure.
In the central role, this function will send an SMP Pairing Request (or an SMP Pairing Failed if rejected), otherwise in the peripheral role, an SMP Security Request will be sent.
Depending on the security parameters set and the packet exchanges with the peer, the following events may be generated: | |
BLE_GAP_EVT_SEC_PARAMS_REQUEST | |
BLE_GAP_EVT_SEC_INFO_REQUEST | |
BLE_GAP_EVT_PASSKEY_DISPLAY | |
BLE_GAP_EVT_KEY_PRESSED | |
BLE_GAP_EVT_AUTH_KEY_REQUEST | |
BLE_GAP_EVT_LESC_DHKEY_REQUEST | |
BLE_GAP_EVT_CONN_SEC_UPDATE | |
BLE_GAP_EVT_AUTH_STATUS | |
BLE_GAP_EVT_TIMEOUT |
[in] | conn_handle | Connection handle. |
[in] | p_sec_params | Pointer to the ble_gap_sec_params_t structure with the security parameters to be used during the pairing or bonding procedure. In the peripheral role, only the bond, mitm, lesc and keypress fields of this structure are used. In the central role, this pointer may be NULL to reject a Security Request. |
NRF_SUCCESS | Successfully initiated authentication procedure. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. |
NRF_ERROR_NO_MEM | The maximum number of authentication procedures that can run in parallel for the given role is reached. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_NOT_SUPPORTED | Setting of sign or link fields in ble_gap_sec_kdist_t not supported. |
NRF_ERROR_TIMEOUT | A SMP timeout has occurred, and further SMP operations on this link is prohibited. |
uint32_t sd_ble_gap_conn_param_update | ( | uint16_t | conn_handle, |
ble_gap_conn_params_t const * | p_conn_params | ||
) |
Update connection parameters.
In the central role this will initiate a Link Layer connection parameter update procedure, otherwise in the peripheral role, this will send the corresponding L2CAP request and wait for the central to perform the procedure. In both cases, and regardless of success or failure, the application will be informed of the result with a BLE_GAP_EVT_CONN_PARAM_UPDATE event.
This function can be used as a central both to reply to a BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST or to start the procedure unrequested.
BLE_GAP_EVT_CONN_PARAM_UPDATE | Result of the connection parameter update procedure. |
[in] | conn_handle | Connection handle. |
[in] | p_conn_params | Pointer to desired connection parameters. If NULL is provided on a peripheral role, the parameters in the PPCP characteristic of the GAP service will be used instead. If NULL is provided on a central role and in response to a BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST, the peripheral request will be rejected |
NRF_SUCCESS | The Connection Update procedure has been started successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied, check parameter limits and constraints. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_BUSY | Procedure already in progress or not allowed at this time, process pending events and wait for pending procedures to complete and retry. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_NO_MEM | Not enough memory to complete operation. |
uint32_t sd_ble_gap_conn_sec_get | ( | uint16_t | conn_handle, |
ble_gap_conn_sec_t * | p_conn_sec | ||
) |
Get the current connection security.
[in] | conn_handle | Connection handle. |
[out] | p_conn_sec | Pointer to a ble_gap_conn_sec_t structure to be filled in. |
NRF_SUCCESS | Current connection security successfully retrieved. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_connect | ( | ble_gap_addr_t const * | p_peer_addr, |
ble_gap_scan_params_t const * | p_scan_params, | ||
ble_gap_conn_params_t const * | p_conn_params, | ||
uint8_t | conn_cfg_tag | ||
) |
Create a connection (GAP Link Establishment).
Whitelist Sharing |
Central Connection Establishment with Private Peer |
Central Connection Establishment and Termination |
[in] | p_peer_addr | Pointer to peer address. If the use_whitelist bit is set in ble_gap_scan_params_t, then this is ignored. If ble_gap_addr_t::addr_id_peer is set then p_peer_addr must be present in the device identity list see sd_ble_gap_device_identities_set. |
[in] | p_scan_params | Pointer to scan parameters structure. |
[in] | p_conn_params | Pointer to desired connection parameters. |
[in] | conn_cfg_tag | Tag identifying a configuration set by sd_ble_cfg_set or BLE_CONN_CFG_TAG_DEFAULT to use the default connection configuration. |
NRF_SUCCESS | Successfully initiated connection procedure. |
NRF_ERROR_INVALID_ADDR | Invalid parameter(s) pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied.
|
NRF_ERROR_INVALID_STATE | The SoftDevice is in an invalid state to perform this operation. This may be due to an existing locally initiated connect procedure, which must complete before initiating again. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid Peer address. |
NRF_ERROR_CONN_COUNT | The limit of available connections has been reached. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. If another connection is being established wait for the corresponding BLE_GAP_EVT_CONNECTED event before calling again. |
NRF_ERROR_RESOURCES | Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral or Broadcaster) and try again |
uint32_t sd_ble_gap_connect_cancel | ( | void | ) |
Cancel a connection establishment.
Central Connection Establishment and Termination |
NRF_SUCCESS | Successfully canceled an ongoing connection procedure. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
uint32_t sd_ble_gap_data_length_update | ( | uint16_t | conn_handle, |
ble_gap_data_length_params_t const * | p_dl_params, | ||
ble_gap_data_length_limitation_t * | p_dl_limitation | ||
) |
Initiate or respond to a Data Length Update Procedure.
[in] | conn_handle | Connection handle. |
[in] | p_dl_params | Pointer to local parameters to be used in Data Length Update Procedure. Set any member to BLE_GAP_DATA_LENGTH_AUTO to let the SoftDevice automatically decide the value for that member. Set to NULL to use automatic values for all members. |
[out] | p_dl_limitation | Pointer to limitation to be written when local device does not have enough resources to accommodate the requested Data Length Update parameters. Ignored if NULL. |
Data Length Update Procedure |
NRF_SUCCESS | Successfully set Data Length Extension initiation/response parameters. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle parameter supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_INVALID_PARAM | Invalid parameters supplied. |
NRF_ERROR_NOT_SUPPORTED | The requested parameters are not supported by the SoftDevice. |
NRF_ERROR_RESOURCES | The requested parameters can not be accommodated. Inspect p_dl_limitation so see where the limitation is. |
NRF_ERROR_BUSY | Peer has already initiated a Data Length Update Procedure. Process the pending BLE_GAP_EVT_DATA_LENGTH_UPDATE_REQUEST event to respond. |
uint32_t sd_ble_gap_device_identities_set | ( | ble_gap_id_key_t const *const * | pp_id_keys, |
ble_gap_irk_t const *const * | pp_local_irks, | ||
uint8_t | len | ||
) |
Set device identity list.
[in] | pp_id_keys | Pointer to an array of peer identity addresses and peer IRKs, if NULL the device identity list will be cleared. |
[in] | pp_local_irks | Pointer to an array of local IRKs. Each entry in the array maps to the entry in pp_id_keys at the same index. To fill in the list with the currently set device IRK for all peers, set to NULL. |
[in] | len | Length of the device identity list, maximum BLE_GAP_DEVICE_IDENTITIES_MAX_COUNT. |
Private Advertising |
Private Scanning |
Scan Private Devices |
Directed Advertising |
Peripheral Connection Establishment with Private Peer |
Central Connection Establishment with Private Peer |
NRF_SUCCESS | The device identity list successfully set/cleared. |
NRF_ERROR_INVALID_ADDR | The device identity list (or one of its entries) provided is invalid. This code may be returned if the local IRK list also has an invalid entry. |
BLE_ERROR_GAP_DEVICE_IDENTITIES_IN_USE | The device identity list is in use and cannot be set or cleared. |
BLE_ERROR_GAP_DEVICE_IDENTITIES_DUPLICATE | The device identity list contains multiple entries with the same identity address. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid address type is supplied. |
NRF_ERROR_DATA_SIZE | The given device identity list size invalid (zero or too large); this can only return when pp_id_keys is not NULL. |
uint32_t sd_ble_gap_device_name_get | ( | uint8_t * | p_dev_name, |
uint16_t * | p_len | ||
) |
Get GAP device name.
[out] | p_dev_name | Pointer to an empty buffer where the UTF-8 non NULL-terminated string will be placed. Set to NULL to obtain the complete device name length. |
[in,out] | p_len | Length of the buffer pointed by p_dev_name, complete device name length on output. |
NRF_SUCCESS | GAP device name retrieved successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied. |
uint32_t sd_ble_gap_device_name_set | ( | ble_gap_conn_sec_mode_t const * | p_write_perm, |
uint8_t const * | p_dev_name, | ||
uint16_t | len | ||
) |
Set GAP device name.
[in] | p_write_perm | Write permissions for the Device Name characteristic, see ble_gap_conn_sec_mode_t. |
[in] | p_dev_name | Pointer to a UTF-8 encoded, non NULL-terminated string. |
[in] | len | Length of the UTF-8, non NULL-terminated string pointed to by p_dev_name in octets (must be smaller or equal than BLE_GAP_DEVNAME_MAX_LEN). |
NRF_SUCCESS | GAP device name and permissions set successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_DATA_SIZE | Invalid data size(s) supplied. |
NRF_ERROR_FORBIDDEN | Device name is not writable. |
uint32_t sd_ble_gap_disconnect | ( | uint16_t | conn_handle, |
uint8_t | hci_status_code | ||
) |
Disconnect (GAP Link Termination).
This call initiates the disconnection procedure, and its completion will be communicated to the application with a BLE_GAP_EVT_DISCONNECTED event.
BLE_GAP_EVT_DISCONNECTED | Generated when disconnection procedure is complete. |
Peripheral Connection Establishment and Termination |
[in] | conn_handle | Connection handle. |
[in] | hci_status_code | HCI status code, see Bluetooth status codes (accepted values are BLE_HCI_REMOTE_USER_TERMINATED_CONNECTION and BLE_HCI_CONN_INTERVAL_UNACCEPTABLE). |
NRF_SUCCESS | The disconnection procedure has been started successfully. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation (disconnection is already in progress). |
uint32_t sd_ble_gap_encrypt | ( | uint16_t | conn_handle, |
ble_gap_master_id_t const * | p_master_id, | ||
ble_gap_enc_info_t const * | p_enc_info | ||
) |
Initiate GAP Encryption procedure.
In the central role, this function will initiate the encryption procedure using the encryption information provided.
BLE_GAP_EVT_CONN_SEC_UPDATE | The connection security has been updated. |
Central Encryption and Authentication mutual exclusion |
Encryption Establishment using stored keys |
Central Control Procedure Serialization on multiple links |
Security Request Reception |
[in] | conn_handle | Connection handle. |
[in] | p_master_id | Pointer to a ble_gap_master_id_t master identification structure. |
[in] | p_enc_info | Pointer to a ble_gap_enc_info_t encryption information structure. |
NRF_SUCCESS | Successfully initiated authentication procedure. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
BLE_ERROR_INVALID_ROLE | Operation is not supported in the Peripheral role. |
NRF_ERROR_BUSY | Procedure already in progress or not allowed at this time, wait for pending procedures to complete and retry. |
uint32_t sd_ble_gap_keypress_notify | ( | uint16_t | conn_handle, |
uint8_t | kp_not | ||
) |
Notify the peer of a local keypress.
This function can only be used when an authentication procedure using LE Secure Connection is in progress. Calling it at other times will result in an NRF_ERROR_INVALID_STATE.
Bonding: Passkey Entry, User Inputs on Peripheral |
Bonding: Passkey Entry: User Inputs on Central |
[in] | conn_handle | Connection handle. |
[in] | kp_not | See GAP Keypress Notification Types. |
NRF_SUCCESS | Keypress notification successfully queued for transmission. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. Either not entering a passkey or keypresses have not been enabled by both peers. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_BUSY | The BLE stack is busy. Retry at later time. |
uint32_t sd_ble_gap_lesc_dhkey_reply | ( | uint16_t | conn_handle, |
ble_gap_lesc_dhkey_t const * | p_dhkey | ||
) |
Reply with an LE Secure connections DHKey.
This function is only used to reply to a BLE_GAP_EVT_LESC_DHKEY_REQUEST, calling it at other times will result in an NRF_ERROR_INVALID_STATE.
This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate. |
[in] | conn_handle | Connection handle. |
[in] | p_dhkey | LE Secure Connections DHKey. |
NRF_SUCCESS | DHKey successfully set. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_lesc_oob_data_get | ( | uint16_t | conn_handle, |
ble_gap_lesc_p256_pk_t const * | p_pk_own, | ||
ble_gap_lesc_oob_data_t * | p_oobd_own | ||
) |
Generate a set of OOB data to send to a peer out of band.
Bonding: Out of Band |
Bonding: Out of Band |
[in] | conn_handle | Connection handle. Can be BLE_CONN_HANDLE_INVALID if a BLE connection has not been established yet. |
[in] | p_pk_own | LE Secure Connections local P-256 Public Key. |
[out] | p_oobd_own | The OOB data to be sent out of band to a peer. |
NRF_SUCCESS | OOB data successfully generated. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_lesc_oob_data_set | ( | uint16_t | conn_handle, |
ble_gap_lesc_oob_data_t const * | p_oobd_own, | ||
ble_gap_lesc_oob_data_t const * | p_oobd_peer | ||
) |
Provide the OOB data sent/received out of band.
This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate. |
Bonding: Out of Band |
Bonding: Out of Band |
[in] | conn_handle | Connection handle. |
[in] | p_oobd_own | The OOB data sent out of band to a peer or NULL if the peer has not received OOB data. Must correspond to ble_gap_sec_params_t::oob flag in BLE_GAP_EVT_SEC_PARAMS_REQUEST. |
[in] | p_oobd_peer | The OOB data received out of band from a peer or NULL if none received. Must correspond to ble_gap_sec_params_t::oob flag in sd_ble_gap_authenticate in the central role or sd_ble_gap_sec_params_reply in the peripheral role. |
NRF_SUCCESS | OOB data accepted. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_ppcp_get | ( | ble_gap_conn_params_t * | p_conn_params | ) |
Get GAP Peripheral Preferred Connection Parameters.
[out] | p_conn_params | Pointer to a ble_gap_conn_params_t structure where the parameters will be stored. |
NRF_SUCCESS | Peripheral Preferred Connection Parameters retrieved successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
uint32_t sd_ble_gap_ppcp_set | ( | ble_gap_conn_params_t const * | p_conn_params | ) |
Set GAP Peripheral Preferred Connection Parameters.
[in] | p_conn_params | Pointer to a ble_gap_conn_params_t structure with the desired parameters. |
NRF_SUCCESS | Peripheral Preferred Connection Parameters set successfully. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
uint32_t sd_ble_gap_privacy_get | ( | ble_gap_privacy_params_t * | p_privacy_params | ) |
Get privacy settings.
[in] | p_privacy_params | Privacy settings. |
NRF_SUCCESS | Privacy settings read. |
NRF_ERROR_INVALID_ADDR | The pointer given for returning the privacy settings may be NULL or invalid. Otherwise, the p_device_irk pointer in privacy parameter is an invalid pointer. |
uint32_t sd_ble_gap_privacy_set | ( | ble_gap_privacy_params_t const * | p_privacy_params | ) |
Set privacy settings.
[in] | p_privacy_params | Privacy settings. |
Private Advertising |
Private Scanning |
Directed Advertising |
NRF_SUCCESS | Set successfully. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid address type is supplied. |
NRF_ERROR_INVALID_ADDR | The pointer to privacy settings is NULL or invalid. Otherwise, the p_device_irk pointer in privacy parameter is an invalid pointer. |
NRF_ERROR_INVALID_PARAM | Out of range parameters are provided. |
NRF_ERROR_INVALID_STATE | Privacy settings cannot be changed while advertising, scanning or creating a connection. |
uint32_t sd_ble_gap_rssi_get | ( | uint16_t | conn_handle, |
int8_t * | p_rssi | ||
) |
Get the received signal strength for the last connection event.
@ref sd_ble_gap_rssi_start must be called to start reporting RSSI before using this function. @ref NRF_ERROR_NOT_FOUND will be returned until RSSI was sampled for the first time after calling @ref sd_ble_gap_rssi_start.
RSSI get sample |
[in] | conn_handle | Connection handle. |
[out] | p_rssi | Pointer to the location where the RSSI measurement shall be stored. |
NRF_SUCCESS | Successfully read the RSSI. |
NRF_ERROR_NOT_FOUND | No sample is available. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_INVALID_STATE | RSSI reporting is not ongoing, or disconnection in progress. |
uint32_t sd_ble_gap_rssi_start | ( | uint16_t | conn_handle, |
uint8_t | threshold_dbm, | ||
uint8_t | skip_count | ||
) |
Start reporting the received signal strength to the application.
A new event is reported whenever the RSSI value changes, until @ref sd_ble_gap_rssi_stop is called.
BLE_GAP_EVT_RSSI_CHANGED | New RSSI data available. How often the event is generated is dependent on the settings of the threshold_dbm and skip_count input parameters. |
RSSI get sample |
RSSI for connections with event filter |
[in] | conn_handle | Connection handle. |
[in] | threshold_dbm | Minimum change in dBm before triggering the BLE_GAP_EVT_RSSI_CHANGED event. Events are disabled if threshold_dbm equals BLE_GAP_RSSI_THRESHOLD_INVALID. |
[in] | skip_count | Number of RSSI samples with a change of threshold_dbm or more before sending a new BLE_GAP_EVT_RSSI_CHANGED event. |
NRF_SUCCESS | Successfully activated RSSI reporting. |
NRF_ERROR_INVALID_STATE | Disconnection in progress. Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_rssi_stop | ( | uint16_t | conn_handle | ) |
Stop reporting the received signal strength.
RSSI get sample |
RSSI for connections with event filter |
[in] | conn_handle | Connection handle. |
NRF_SUCCESS | Successfully deactivated RSSI reporting. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_scan_start | ( | ble_gap_scan_params_t const * | p_scan_params | ) |
Start scanning (GAP Discovery procedure, Observer Procedure).
BLE_GAP_EVT_ADV_REPORT | An advertising or scan response packet has been received. |
BLE_GAP_EVT_TIMEOUT | Scanner has timed out. |
Scanning |
Whitelist Sharing |
[in] | p_scan_params | Pointer to scan parameters structure. |
NRF_SUCCESS | Successfully initiated scanning procedure. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_BUSY | The stack is busy, process pending events and retry. |
NRF_ERROR_RESOURCES | Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral or Broadcaster) and try again |
uint32_t sd_ble_gap_scan_stop | ( | void | ) |
Stop scanning (GAP Discovery procedure, Observer Procedure).
Scanning |
Whitelist Sharing |
NRF_SUCCESS | Successfully stopped scanning procedure. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation (most probably not in scanning state). |
uint32_t sd_ble_gap_sec_info_reply | ( | uint16_t | conn_handle, |
ble_gap_enc_info_t const * | p_enc_info, | ||
ble_gap_irk_t const * | p_id_info, | ||
ble_gap_sign_info_t const * | p_sign_info | ||
) |
Reply with GAP security information.
This function is only used to reply to a BLE_GAP_EVT_SEC_INFO_REQUEST, calling it at other times will result in NRF_ERROR_INVALID_STATE.
Peripheral Encryption Establishment using stored keys |
[in] | conn_handle | Connection handle. |
[in] | p_enc_info | Pointer to a ble_gap_enc_info_t encryption information structure. May be NULL to signal none is available. |
[in] | p_id_info | Pointer to a ble_gap_irk_t identity information structure. May be NULL to signal none is available. |
[in] | p_sign_info | Pointer to a ble_gap_sign_info_t signing information structure. May be NULL to signal none is available. |
NRF_SUCCESS | Successfully accepted security information. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
uint32_t sd_ble_gap_sec_params_reply | ( | uint16_t | conn_handle, |
uint8_t | sec_status, | ||
ble_gap_sec_params_t const * | p_sec_params, | ||
ble_gap_sec_keyset_t const * | p_sec_keyset | ||
) |
Reply with GAP security parameters.
This function is only used to reply to a BLE_GAP_EVT_SEC_PARAMS_REQUEST, calling it at other times will result in an NRF_ERROR_INVALID_STATE.
This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate. |
[in] | conn_handle | Connection handle. |
[in] | sec_status | Security status, see GAP Security status. |
[in] | p_sec_params | Pointer to a ble_gap_sec_params_t security parameters structure. In the central role this must be set to NULL, as the parameters have already been provided during a previous call to sd_ble_gap_authenticate. |
[in,out] | p_sec_keyset | Pointer to a ble_gap_sec_keyset_t security keyset structure. Any keys generated and/or distributed as a result of the ongoing security procedure will be stored into the memory referenced by the pointers inside this structure. The keys will be stored and available to the application upon reception of a BLE_GAP_EVT_AUTH_STATUS event. Note that the SoftDevice expects the application to provide memory for storing the peer's keys. So it must be ensured that the relevant pointers inside this structure are not NULL. The pointers to the local key can, however, be NULL, in which case, the local key data will not be available to the application upon reception of the BLE_GAP_EVT_AUTH_STATUS event. |
NRF_SUCCESS | Successfully accepted security parameter from the application. |
NRF_ERROR_INVALID_ADDR | Invalid pointer supplied. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
NRF_ERROR_INVALID_STATE | Invalid state to perform operation. |
BLE_ERROR_INVALID_CONN_HANDLE | Invalid connection handle supplied. |
NRF_ERROR_NOT_SUPPORTED | Setting of sign or link fields in ble_gap_sec_kdist_t not supported. |
uint32_t sd_ble_gap_tx_power_set | ( | int8_t | tx_power | ) |
Set the radio's transmit power.
[in] | tx_power | Radio transmit power in dBm (accepted values are -40, -30, -20, -16, -12, -8, -4, 0, 3, and 4 dBm). |
NRF_SUCCESS | Successfully changed the transmit power. |
NRF_ERROR_INVALID_PARAM | Invalid parameter(s) supplied. |
uint32_t sd_ble_gap_whitelist_set | ( | ble_gap_addr_t const *const * | pp_wl_addrs, |
uint8_t | len | ||
) |
Set the active whitelist in the SoftDevice.
Whitelist Sharing |
Scan Private Devices |
[in] | pp_wl_addrs | Pointer to a whitelist of peer addresses, if NULL the whitelist will be cleared. |
[in] | len | Length of the whitelist, maximum BLE_GAP_WHITELIST_ADDR_MAX_COUNT. |
NRF_SUCCESS | The whitelist is successfully set/cleared. |
NRF_ERROR_INVALID_ADDR | The whitelist (or one of its entries) provided is invalid. |
BLE_ERROR_GAP_WHITELIST_IN_USE | The whitelist is in use by a BLE role and cannot be set or cleared. |
BLE_ERROR_GAP_INVALID_BLE_ADDR | Invalid address type is supplied. |
NRF_ERROR_DATA_SIZE | The given whitelist size is invalid (zero or too large); this can only return when pp_wl_addrs is not NULL. |