Functions

Get local Bluetooth identity address.

Note

This will always return the identity address irrespective of the privacy settings, i.e. the address type will always be either BLE_GAP_ADDR_TYPE_PUBLIC or BLE_GAP_ADDR_TYPE_RANDOM_STATIC .

Parameters

[out]

p_addr

Pointer to address structure to be filled in.

Return values

NRF_SUCCESS	Address successfully retrieved.
NRF_ERROR_INVALID_ADDR	Invalid or NULL pointer supplied.

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.

Note

The identity address cannot be changed while advertising, scanning or creating a connection.

This address will be distributed to the peer during bonding. If the address changes, the address stored in the peer device will not be valid and the ability to reconnect using the old address will be lost.

By default the SoftDevice will set an address of type BLE_GAP_ADDR_TYPE_RANDOM_STATIC upon being enabled. The address is a random number populated during the IC manufacturing process and remains unchanged for the lifetime of each IC.

Relevant Message Sequence Charts

Advertising

Parameters

[in]

p_addr

Pointer to address structure.

Return values

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.

Configure an advertising set. Set, clear or update advertising and scan response data.

Note

The format of the advertising data will be checked by this call to ensure interoperability. Limitations imposed by this API call to the data provided include having a flags data type in the scan response data and duplicating the local name in the advertising data and scan response data.

In order to update advertising data while advertising, new advertising buffers must be provided.

Relevant Message Sequence Charts

Advertising

Whitelist Sharing

Parameters

[in,out]	p_adv_handle	Provide a pointer to a handle containing BLE_GAP_ADV_SET_HANDLE_NOT_SET to configure a new advertising set. On success, a new handle is then returned through the pointer. Provide a pointer to an existing advertising handle to configure an existing advertising set.
[in]	p_adv_data	Advertising data. If set to NULL, no advertising data will be used. See ble_gap_adv_data_t .
[in]	p_adv_params	Advertising parameters. When this function is used to update advertising data while advertising, this parameter must be NULL. See ble_gap_adv_params_t .

Return values

NRF_SUCCESS	Advertising set successfully configured.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied: Invalid advertising data configuration specified. See ble_gap_adv_data_t . Invalid configuration of p_adv_params. See ble_gap_adv_params_t . Use of whitelist requested but whitelist has not been set, see sd_ble_gap_whitelist_set .
BLE_ERROR_GAP_INVALID_BLE_ADDR	ble_gap_adv_params_t::p_peer_addr is invalid.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation. It is invalid to provide non-NULL advertising set parameters while advertising. It is invalid to provide the same data buffers while advertising. To update advertising data, provide new advertising buffers.
BLE_ERROR_GAP_DISCOVERABLE_WITH_WHITELIST	Discoverable mode and whitelist incompatible.
BLE_ERROR_INVALID_ADV_HANDLE	The provided advertising handle was not found. Use BLE_GAP_ADV_SET_HANDLE_NOT_SET to configure a new advertising handle.
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 given in Bluetooth Specification Version 5.0, Volume 3, Part C, Chapter 11.
NRF_ERROR_INVALID_LENGTH	Invalid data length(s) supplied.
NRF_ERROR_NOT_SUPPORTED	Unsupported data length or advertising parameter configuration.
NRF_ERROR_NO_MEM	Not enough memory to configure a new advertising handle. Update an existing advertising handle instead.
BLE_ERROR_GAP_UUID_LIST_MISMATCH	Invalid UUID list supplied.

Start advertising (GAP Discoverable, Connectable modes, Broadcast Procedure).

Note

Only one advertiser may be active at any time.

Events generated

BLE_GAP_EVT_CONNECTED	Generated after connection has been established through connectable advertising.
BLE_GAP_EVT_ADV_SET_TERMINATED	Advertising set has terminated.
BLE_GAP_EVT_SCAN_REQ_REPORT	A scan request was received.

Relevant Message Sequence Charts

Advertising

Peripheral Connection Establishment with Private Peer

Directed Advertising

Whitelist Sharing

Parameters

[in]	adv_handle	Advertising handle to advertise on, received from sd_ble_gap_adv_set_configure .
[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. For non-connectable advertising, this is ignored.

Return values

NRF_SUCCESS	The BLE stack has started advertising.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation. adv_handle is not configured or already advertising.
NRF_ERROR_CONN_COUNT	The limit of available connections has been reached; connectable advertiser cannot be started.
BLE_ERROR_INVALID_ADV_HANDLE	Advertising handle not found. Configure a new adveriting handle with sd_ble_gap_adv_set_configure .
NRF_ERROR_NOT_FOUND	conn_cfg_tag not found.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied: Invalid configuration of p_adv_params. See ble_gap_adv_params_t . Use of whitelist requested but whitelist has not been set, see sd_ble_gap_whitelist_set .
NRF_ERROR_RESOURCES	Either: adv_handle is configured with connectable advertising, but the event_length parameter associated with conn_cfg_tag is too small to be able to establish a connection on the selected advertising phys. Use sd_ble_cfg_set to increase the event length. Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral, Broadcaster or Observer) and try again. p_adv_params is configured with connectable advertising, but the event_length parameter associated with conn_cfg_tag is too small to be able to establish a connection on the selected advertising phys. Use sd_ble_cfg_set to increase the event length.

Stop advertising (GAP Discoverable, Connectable modes, Broadcast Procedure).

Relevant Message Sequence Charts

Advertising

Whitelist Sharing

Parameters

[in]

adv_handle

The advertising handle that should stop advertising.

Return values

NRF_SUCCESS	The BLE stack has stopped advertising.
BLE_ERROR_INVALID_ADV_HANDLE	Invalid advertising handle.
NRF_ERROR_INVALID_STATE	The advertising handle is not advertising.

Get GAP Appearance value.

Parameters

[out]

p_appearance

Pointer to appearance (16-bit) to be filled in, see Bluetooth Appearance values .

Return values

NRF_SUCCESS	Appearance value retrieved successfully.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.

Set GAP Appearance value.

Parameters

[in]

appearance

Appearance (16-bit), see Bluetooth Appearance values .

Return values

NRF_SUCCESS	Appearance value set successfully.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.

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 .

Note

If the call returns an error code, the request is still pending, and the reply call may be repeated with corrected parameters.

Events generated

This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate .

Relevant Message Sequence Charts

Bonding: Passkey Entry, User Inputs on Peripheral or OOB

Bonding: Numeric Comparison

Bonding: Passkey Entry, User Inputs on Peripheral

Bonding: Passkey Entry, User Inputs on Central or OOB

Bonding: Numeric Comparison

Bonding: Passkey Entry: User Inputs on Central

Parameters

[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.

Return values

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.

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.

Events generated

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

Relevant Message Sequence Charts

Peripheral Security Request

Security Request Reception

Central Encryption and Authentication mutual exclusion

Pairing: Just Works

Bonding: Just Works

Bonding: Passkey Entry, Central displays

Bonding: Passkey Entry, User Inputs on Central or OOB

Pairing: Just Works

Bonding: Numeric Comparison

Bonding: Passkey Entry: Central Displays

Bonding: Passkey Entry: User Inputs on Central

Bonding: Out of Band

Parameters

[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.

Return values

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_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.

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.

Events generated

BLE_GAP_EVT_CONN_PARAM_UPDATE

Result of the connection parameter update procedure.

Relevant Message Sequence Charts

Peripheral Connection Parameter Update

Central Encryption and Authentication mutual exclusion

Central Connection Parameter Update on multiple links

Central Control Procedure Serialization on multiple links

Central Connection Parameter Update

Parameters

[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

Return values

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, 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.

Get the current connection security.

Parameters

[in]	conn_handle	Connection handle.
[out]	p_conn_sec	Pointer to a ble_gap_conn_sec_t structure to be filled in.

Return values

NRF_SUCCESS	Current connection security successfully retrieved.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.

Create a connection (GAP Link Establishment).

Note

If a scanning procedure is currently in progress it will be automatically stopped when calling this function. The scanning procedure will be stopped even if the function returns an error.

Relevant Message Sequence Charts

Whitelist Sharing

Central Connection Establishment with Private Peer

Central Connection Establishment and Termination

Parameters

[in]	p_peer_addr	Pointer to peer identity address. If ble_gap_scan_params_t::filter_policy is set to use whitelist, then p_peer_addr is ignored.
[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.

Return values

NRF_SUCCESS	Successfully initiated connection procedure.
NRF_ERROR_INVALID_ADDR	Invalid parameter(s) pointer supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied. Invalid parameter(s) in p_scan_params or p_conn_params. Use of whitelist requested but whitelist has not been set, see sd_ble_gap_whitelist_set . Peer address was not present in the device identity list, see sd_ble_gap_device_identities_set .
NRF_ERROR_NOT_FOUND	conn_cfg_tag not found.
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_RESOURCES	Either: Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral or Observer) and try again. The event_length parameter associated with conn_cfg_tag is too small to be able to establish a connection on the selected ble_gap_scan_params_t::scan_phys . Use sd_ble_cfg_set to increase the event length.

Cancel a connection establishment.

Relevant Message Sequence Charts

Central Connection Establishment and Termination

Return values

NRF_SUCCESS	Successfully canceled an ongoing connection procedure.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation.

Initiate or respond to a Data Length Update Procedure.

Note

If the application uses BLE_GAP_DATA_LENGTH_AUTO for one or more members of p_dl_params, the SoftDevice will choose the highest value supported in current configuration and connection parameters.

Parameters

[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 or does not support the requested Data Length Update parameters. Ignored if NULL.

Relevant Message Sequence Charts

Data Length Update Procedure

Return values

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. Inspect p_dl_limitation to see which parameter is not supported.
NRF_ERROR_RESOURCES	The connection event length configured for this link is not sufficient for the requested parameters. Use sd_ble_cfg_set with BLE_CONN_CFG_GAP to increase the connection event length. Inspect p_dl_limitation to 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.

Set device identity list.

Note

Only one device identity list can be used at a time and the list is shared between the BLE roles. The device identity list cannot be set if a BLE role is using the list.

Parameters

[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 .

Relevant Message Sequence Charts

Private Advertising

Private Scanning

Scan Private Devices

Directed Advertising

Peripheral Connection Establishment with Private Peer

Central Connection Establishment with Private Peer

Return values

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.

Get GAP device name.

Note

If the device name is longer than the size of the supplied buffer, p_len will return the complete device name length, and not the number of bytes actually returned in p_dev_name. The application may use this information to allocate a suitable buffer size.

Parameters

[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.

Return values

NRF_SUCCESS	GAP device name retrieved successfully.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_DATA_SIZE	Invalid data size(s) supplied.

Set GAP device name.

Note

If the device name is located in application flash memory (see ble_gap_cfg_device_name_t ), it cannot be changed. Then NRF_ERROR_FORBIDDEN will be returned.

Parameters

[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 ).

Return values

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.

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.

Events generated

BLE_GAP_EVT_DISCONNECTED

Generated when disconnection procedure is complete.

Relevant Message Sequence Charts

Peripheral Connection Establishment and Termination

Parameters

[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 ).

Return values

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).

Initiate GAP Encryption procedure.

In the central role, this function will initiate the encryption procedure using the encryption information provided.

Events generated

BLE_GAP_EVT_CONN_SEC_UPDATE

The connection security has been updated.

Relevant Message Sequence Charts

Central Encryption and Authentication mutual exclusion

Encryption Establishment using stored keys

Central Control Procedure Serialization on multiple links

Security Request Reception

Parameters

[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.

Return values

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.

Notify the peer of a local keypress.

Relevant Message Sequence Charts

Bonding: Passkey Entry, User Inputs on Peripheral

Bonding: Passkey Entry: User Inputs on Central

Parameters

[in]	conn_handle	Connection handle.
[in]	kp_not	See GAP Keypress Notification Types .

Return values

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.

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 .

Note

If the call returns an error code, the request is still pending, and the reply call may be repeated with corrected parameters.

Events generated

This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate .

Relevant Message Sequence Charts

Pairing: Just Works

Bonding: Numeric Comparison

Bonding: Passkey Entry, Peripheral Displays

Bonding: Passkey Entry, User Inputs on Peripheral

Bonding: Out of Band

Pairing: Just Works

Bonding: Numeric Comparison

Bonding: Passkey Entry: Central Displays

Bonding: Passkey Entry: User Inputs on Central

Bonding: Out of Band

Parameters

[in]	conn_handle	Connection handle.
[in]	p_dhkey	LE Secure Connections DHKey.

Return values

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.

Generate a set of OOB data to send to a peer out of band.

Note

The ble_gap_addr_t included in the OOB data returned will be the currently active one (or, if a connection has already been established, the one used during connection setup). The application may manually overwrite it with an updated value.

Relevant Message Sequence Charts

Bonding: Out of Band

Bonding: Out of Band

Parameters

[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.

Return values

NRF_SUCCESS	OOB data successfully generated.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.

Provide the OOB data sent/received out of band.

Note

An authentication procedure with OOB selected as an algorithm must be in progress when calling this function.

A BLE_GAP_EVT_LESC_DHKEY_REQUEST event with the oobd_req set to 1 must have been received prior to calling this function.

Events generated

This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate .

Relevant Message Sequence Charts

Bonding: Out of Band

Bonding: Out of Band

Parameters

[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.

Return values

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.

Initiate or respond to a PHY Update Procedure.

This function is used to initiate or respond to a PHY Update Procedure. It will always generate a BLE_GAP_EVT_PHY_UPDATE event if successfully executed. If this function is used to initiate a PHY Update procedure and the only option provided in ble_gap_phys_t::tx_phys and ble_gap_phys_t::rx_phys is the currently active PHYs in the respective directions, the SoftDevice will generate a BLE_GAP_EVT_PHY_UPDATE with the current PHYs set and will not initiate the procedure in the Link Layer.

If ble_gap_phys_t::tx_phys or ble_gap_phys_t::rx_phys is BLE_GAP_PHY_AUTO , then the stack will select PHYs based on the peer's PHY preferences and the local link configuration. The PHY Update procedure will for this case result in a PHY combination that respects the time constraints configured with sd_ble_cfg_set and the current link layer data length.

When acting as a central, the SoftDevice will select the fastest common PHY in each direction.

If the peer does not support the PHY Update Procedure, then the resulting BLE_GAP_EVT_PHY_UPDATE event will have a status set to BLE_HCI_UNSUPPORTED_REMOTE_FEATURE .

If the PHY procedure was rejected by the peer due to a procedure collision, the status will be BLE_HCI_STATUS_CODE_LMP_ERROR_TRANSACTION_COLLISION or BLE_HCI_DIFFERENT_TRANSACTION_COLLISION . If the peer responds to the PHY Update procedure with invalid parameters, the status will be BLE_HCI_STATUS_CODE_INVALID_LMP_PARAMETERS . If the PHY procedure was rejected by the peer for a different reason, the status will contain the reason as specified by the peer.

Note

BLE_GAP_PHY_CODED is only supported as an experimental feature in this SoftDevice. When this function is used to reply to a PHY Update, depending on the peers preferences, BLE_GAP_PHY_AUTO might result in the PHY to be changed to BLE_GAP_PHY_CODED .

Events generated

BLE_GAP_EVT_PHY_UPDATE

Result of the PHY Update Procedure.

Relevant Message Sequence Charts

Central PHY Update

Peripheral PHY Update

Parameters

[in]	conn_handle	Connection handle to indicate the connection for which the PHY Update is requested.
[in]	p_gap_phys	Pointer to PHY structure.

Return values

NRF_SUCCESS	Successfully requested a PHY Update.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation.
NRF_ERROR_RESOURCES	The connection event length configured for this link is not sufficient for the combination of ble_gap_phys_t::tx_phys , ble_gap_phys_t::rx_phys , and ble_gap_data_length_params_t . The connection event length is configured with BLE_CONN_CFG_GAP using sd_ble_cfg_set .
NRF_ERROR_BUSY	Procedure is already in progress or not allowed at this time. Process pending events and wait for the pending procedure to complete and retry.

Get GAP Peripheral Preferred Connection Parameters.

Parameters

[out]

p_conn_params

Pointer to a ble_gap_conn_params_t structure where the parameters will be stored.

Return values

NRF_SUCCESS	Peripheral Preferred Connection Parameters retrieved successfully.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.

Set GAP Peripheral Preferred Connection Parameters.

Parameters

[in]

p_conn_params

Pointer to a ble_gap_conn_params_t structure with the desired parameters.

Return values

NRF_SUCCESS	Peripheral Preferred Connection Parameters set successfully.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.

Get privacy settings.

Note

ble_gap_privacy_params_t::p_device_irk must be initialized to NULL or a valid address before this function is called. If it is initialized to a valid address, the address pointed to will contain the current device IRK on return.

Parameters

[in,out]

p_privacy_params

Privacy settings.

Return values

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.

Set privacy settings.

Note

Privacy settings cannot be changed while advertising, scanning or creating a connection.

Parameters

[in]

p_privacy_params

Privacy settings.

Relevant Message Sequence Charts

Private Advertising

Private Scanning

Directed Advertising

Return values

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.

Start the Quality of Service (QoS) channel survey module.

The channel survey module provides measurements of the energy levels on the Bluetooth Low Energy channels. When the module is enabled, BLE_GAP_EVT_QOS_CHANNEL_SURVEY_REPORT events will periodically report the measured energy levels for each channel.

Note

The measurements are scheduled with lower priority than other Bluetooth Low Energy roles, Radio Timeslot API events and Flash API events.

The channel survey module will attempt to do measurements so that the average interval between measurements will be interval_us. However due to the channel survey module having the lowest priority of all roles and modules, this may not be possible. In that case fewer than expected channel survey reports may be given.

In order to use the channel survey module, ble_gap_cfg_role_count_t::qos_channel_survey_role_available must be set. This is done using sd_ble_cfg_set .

Parameters

[in]

interval_us

Requested average interval for the measurements and reports. See Quality of Service (QoS) Channel survey interval defines for valid ranges. If set to BLE_GAP_QOS_CHANNEL_SURVEY_INTERVAL_CONTINUOUS , the channel survey role will be scheduled at every available opportunity.

Return values

NRF_SUCCESS	The module is successfully started.
NRF_ERROR_INVALID_PARAM	Invalid parameter supplied. interval_us is out of the allowed range.
NRF_ERROR_INVALID_STATE	Trying to start the module when already running.
NRF_ERROR_RESOURCES	The channel survey module is not available to the application. Set ble_gap_cfg_role_count_t::qos_channel_survey_role_available using sd_ble_cfg_set .

Stop the Quality of Service (QoS) channel survey module.

Return values

NRF_SUCCESS	The module is successfully stopped.
NRF_ERROR_INVALID_STATE	Trying to stop the module when it is not running.

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.

Note

ERRATA-153 requires the rssi sample to be compensated based on a temperature measurement.

Relevant Message Sequence Charts

RSSI get sample

Parameters

[in]	conn_handle	Connection handle.
[out]	p_rssi	Pointer to the location where the RSSI measurement shall be stored.
[out]	p_ch_index	Pointer to the location where Channel Index for the RSSI measurement shall be stored.

Return values

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.

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.

Events generated

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.

Relevant Message Sequence Charts

RSSI get sample

RSSI for connections with event filter

Parameters

[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.

Return values

NRF_SUCCESS	Successfully activated RSSI reporting.
NRF_ERROR_INVALID_STATE	RSSI reporting is already ongoing.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.

Stop reporting the received signal strength.

Note

An RSSI change detected before the call but not yet received by the application may be reported after sd_ble_gap_rssi_stop has been called.

Relevant Message Sequence Charts

RSSI get sample

RSSI for connections with event filter

Parameters

[in]

conn_handle

Connection handle.

Return values

NRF_SUCCESS	Successfully deactivated RSSI reporting.
NRF_ERROR_INVALID_STATE	RSSI reporting is not ongoing.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.

Start or continue scanning (GAP Discovery procedure, Observer Procedure).

Note

A call to this function will require the application to keep the memory pointed by p_adv_report_buffer alive until the buffer is released. The buffer is released when the scanner is stopped or when this function is called with another buffer.

The scanner will automatically stop in the following cases:

• sd_ble_gap_scan_stop is called.
• sd_ble_gap_connect is called.
• A BLE_GAP_EVT_TIMEOUT with source set to BLE_GAP_TIMEOUT_SRC_SCAN is received.
• When a BLE_GAP_EVT_ADV_REPORT event is received and ble_gap_adv_report_type_t::status is not set to BLE_GAP_ADV_DATA_STATUS_INCOMPLETE_MORE_DATA . In this case scanning is only paused to let the application access received data. The application must call this function to continue scanning, or call sd_ble_gap_scan_stop to stop scanning.

If a BLE_GAP_EVT_ADV_REPORT event is received with ble_gap_adv_report_type_t::status set to BLE_GAP_ADV_DATA_STATUS_INCOMPLETE_MORE_DATA , the scanner will continue scanning, and the application will receive more reports from this advertising event. The following reports will include the old and new received data. The application can stop the scanner from receiving more packets from this advertising event by calling this function. This might be useful when receiving data from extended advertising events where ble_gap_evt_adv_report_t::aux_pointer is large.

Events generated

BLE_GAP_EVT_ADV_REPORT	An advertising or scan response packet has been received.
BLE_GAP_EVT_TIMEOUT	Scanner has timed out.

Relevant Message Sequence Charts

Scanning

Whitelist Sharing

Parameters

[in]	p_scan_params	Pointer to scan parameters structure. When this function is used to continue scanning, this parameter must be NULL.
[in]	p_adv_report_buffer	Pointer to buffer used to store incoming advertising data. The memory pointed to should be kept alive until the scanning is stopped. See GAP Minimum scanner buffer size for minimum and maximum buffer size. If the scanner receives advertising data larger than can be stored in the buffer, a BLE_GAP_EVT_ADV_REPORT will be raised with ble_gap_adv_report_type_t::status set to BLE_GAP_ADV_DATA_STATUS_INCOMPLETE_TRUNCATED .

Return values

NRF_SUCCESS	Successfully initiated scanning procedure.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation. Either: Scanning is already ongoing and p_scan_params was not NULL Scanning is not running and p_scan_params was NULL. The scanner has timed out when this function is called to continue scanning.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied. See ble_gap_scan_params_t .
NRF_ERROR_NOT_SUPPORTED	Unsupported parameters supplied. See ble_gap_scan_params_t .
NRF_ERROR_INVALID_LENGTH	The provided buffer length is invalid. See BLE_GAP_SCAN_BUFFER_MIN .
NRF_ERROR_RESOURCES	Not enough BLE role slots available. Stop one or more currently active roles (Central, Peripheral or Broadcaster) and try again

Stop scanning (GAP Discovery procedure, Observer Procedure).

Note

The buffer provided in sd_ble_gap_scan_start is released.

Relevant Message Sequence Charts

Scanning

Whitelist Sharing

Return values

NRF_SUCCESS	Successfully stopped scanning procedure.
NRF_ERROR_INVALID_STATE	Invalid state to perform operation. Not in the scanning state.

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 .

Note

If the call returns an error code, the request is still pending, and the reply call may be repeated with corrected parameters.

Data signing is not yet supported, and p_sign_info must therefore be NULL.

Relevant Message Sequence Charts

Peripheral Encryption Establishment using stored keys

Parameters

[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.

Return values

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.

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 .

Note

If the call returns an error code, the request is still pending, and the reply call may be repeated with corrected parameters.

Events generated

This function is used during authentication procedures, see the list of events in the documentation of sd_ble_gap_authenticate .

Relevant Message Sequence Charts

Pairing: Just Works

Bonding: Just Works

Bonding: Passkey Entry, Peripheral displays

Bonding: Passkey Entry, User Inputs on Peripheral or OOB

Bonding: Passkey Entry with static passkey

Pairing failure: Confirm failed

Pairing: Just Works

Bonding: Numeric Comparison

Bonding: Passkey Entry, Peripheral Displays

Bonding: Passkey Entry, User Inputs on Peripheral

Bonding: Out of Band

GAP Failed Pairing: Keysize too small

Pairing failure: Pairing aborted by the application

Pairing failure: Pairing failed from central

Pairing failure: Timeout

Pairing: Just Works

Bonding: Just Works

Bonding: Passkey Entry, Central displays

Bonding: Passkey Entry, User Inputs on Central or OOB

Pairing: Just Works

Bonding: Numeric Comparison

Bonding: Passkey Entry: Central Displays

Bonding: Passkey Entry: User Inputs on Central

Bonding: Out of Band

Parameters

[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.

Return values

NRF_SUCCESS	Successfully accepted security parameter from the application.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	The stack is busy, process pending events and retry.
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.

Set the radio's transmit power.

Parameters

[in]	role	The role to set the transmit power for, see BLE_GAP_TX_POWER_ROLES for possible roles.
[in]	handle	The handle parameter is interpreted depending on role: If role is BLE_GAP_TX_POWER_ROLE_CONN , this value is the specific connection handle. If role is BLE_GAP_TX_POWER_ROLE_ADV , the advertising set identified with the advertising handle, will use the specified transmit power, and include it in the advertising packet headers if ble_gap_adv_properties_t::include_tx_power set. For all other roles handle is ignored.
[in]	tx_power	Radio transmit power in dBm (see note for accepted values).

Note

Supported tx_power values: -40dBm, -20dBm, -16dBm, -12dBm, -8dBm, -4dBm, 0dBm, +2dBm, +3dBm, +4dBm, +5dBm, +6dBm, +7dBm and +8dBm.

The initiator will have the same transmit power as the scanner.

When a connection is created it will inherit the transmit power from the initiator or advertiser leading to the connection.

Return values

NRF_SUCCESS	Successfully changed the transmit power.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
BLE_ERROR_INVALID_ADV_HANDLE	Advertising handle not found.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle supplied.

Set the active whitelist in the SoftDevice.

Note

Only one whitelist can be used at a time and the whitelist is shared between the BLE roles. The whitelist cannot be set if a BLE role is using the whitelist.

If an address is resolved using the information in the device identity list, then the whitelist filter policy applies to the peer identity address and not the resolvable address sent on air.

Relevant Message Sequence Charts

Whitelist Sharing

Scan Private Devices

Parameters

[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 .

Return values

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.