nRF51 SDK - S120 SoftDevice
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

Functions

uint32_t sd_ble_gap_address_set (ble_gap_addr_t const *p_addr)
 Set local Bluetooth address. More...
 
uint32_t sd_ble_gap_address_get (ble_gap_addr_t *p_addr)
 Get local Bluetooth address. 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)
 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 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_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)
 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 singnal strength. 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)
 Create a connection (GAP Link Establishment). More...
 
uint32_t sd_ble_gap_connect_cancel (void)
 Cancel a connection establishment. More...
 

Detailed Description

Function Documentation

uint32_t sd_ble_gap_address_get ( ble_gap_addr_t p_addr)

Get local Bluetooth address.

Parameters
[out]p_addrPointer to address structure to be filled in.
Return values
NRF_SUCCESSAddress successfully retrieved.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
uint32_t sd_ble_gap_address_set ( ble_gap_addr_t const *  p_addr)

Set local Bluetooth address.

Parameters
[in]p_addrPointer to address structure.
Return values
NRF_SUCCESSAddress successfully set.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
BLE_ERROR_GAP_INVALID_BLE_ADDRInvalid address.
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.

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.
: To clear the advertising data and set it to a 0-length packet, simply provide a valid pointer (p_data/p_sr_data) with its corresponding length (dlen/srdlen) set to 0.
: The call will fail if p_data and p_sr_data are both NULL since this would have no effect.
Parameters
[in]p_dataRaw data to be placed in advertising packet. If NULL, no changes are made to the current advertising packet data.
[in]dlenData 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_dataRaw data to be placed in scan response packet. If NULL, no changes are made to the current scan response packet data.
[in]srdlenData 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.
Return values
NRF_SUCCESSAdvertising data successfully updated or cleared.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_FLAGSInvalid combination of advertising flags supplied.
NRF_ERROR_INVALID_DATAInvalid data type(s) supplied, check the advertising data format specification.
NRF_ERROR_INVALID_LENGTHInvalid data length(s) supplied.
BLE_ERROR_GAP_UUID_LIST_MISMATCHInvalid UUID list supplied.
uint32_t sd_ble_gap_adv_start ( ble_gap_adv_params_t const *  p_adv_params)

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

Parameters
[in]p_adv_paramsPointer to advertising parameters structure.
Return values
NRF_SUCCESSThe BLE stack has started advertising.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied, check the accepted ranges and limits.
BLE_ERROR_GAP_INVALID_BLE_ADDRInvalid Bluetooth address supplied.
BLE_ERROR_GAP_DISCOVERABLE_WITH_WHITELISTDiscoverable mode and whitelist incompatible.
NRF_ERROR_BUSYThe stack is busy, process pending events and retry.
uint32_t sd_ble_gap_adv_stop ( void  )

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

Return values
NRF_SUCCESSThe BLE stack has stopped advertising.
NRF_ERROR_INVALID_STATEInvalid 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.

Parameters
[out]p_appearancePointer to appearance (16-bit) to be filled in, see Bluetooth Appearance values.
Return values
NRF_SUCCESSAppearance value retrieved successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
uint32_t sd_ble_gap_appearance_set ( uint16_t  appearance)

Set GAP Appearance value.

Parameters
[in]appearanceAppearance (16-bit), see Bluetooth Appearance values.
Return values
NRF_SUCCESSAppearance value set successfully.
NRF_ERROR_INVALID_PARAMInvalid 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.

Parameters
[in]conn_handleConnection handle.
[in]key_typeSee GAP Authentication Key Types.
[in]p_keyIf 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). If key type is BLE_GAP_AUTH_KEY_TYPE_OOB, then a 16-byte OOB key value in Little Endian format.

This function is only used to reply to a BLE_GAP_EVT_AUTH_KEY_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.
Return values
NRF_SUCCESSAuthentication key successfully set.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
uint32_t sd_ble_gap_authenticate ( uint16_t  conn_handle,
ble_gap_sec_params_t const *  p_sec_params 
)

Initiate GAP Authentication procedure.

Parameters
[in]conn_handleConnection handle.
[in]p_sec_paramsPointer to the ble_gap_sec_params_t structure with the security parameters to be used during the pairing procedure. In the peripheral role, only the timeout, bond and mitm fields of this structure are used.

In the central role, this function will send an SMP Pairing Request, otherwise in the peripheral role, an SMP Security Request will be sent.

Note
Calling this function may result in the following events depending on the outcome and parameters: BLE_GAP_EVT_SEC_PARAMS_REQUEST, BLE_GAP_EVT_SEC_INFO_REQUEST, BLE_GAP_EVT_AUTH_KEY_REQUEST, BLE_GAP_EVT_AUTH_STATUS.
Return values
NRF_SUCCESSSuccessfully initiated authentication procedure.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
NRF_ERROR_BUSYThe stack is busy, process pending events and retry.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
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 both to reply to a BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST or to start the procedure unrequested.

Parameters
[in]conn_handleConnection handle.
[in]p_conn_paramsPointer 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_SUCCESSThe Connection Update procedure has been started successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied, check parameter limits and constraints.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
NRF_ERROR_BUSYProcedure 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_HANDLEInvalid connection handle supplied.
NRF_ERROR_NO_MEMNot 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.

Parameters
[in]conn_handleConnection handle.
[out]p_conn_secPointer to a ble_gap_conn_sec_t structure to be filled in.
Return values
NRF_SUCCESSCurrent connection security successfully retrieved.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
BLE_ERROR_INVALID_CONN_HANDLEInvalid 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 
)

Create a connection (GAP Link Establishment).

Parameters
[in]p_peer_addrPointer to peer address. If the selective bit is set in ble_gap_scan_params_t, then this must be NULL.
[in]p_scan_paramsPointer to scan parameters structure.
[in]p_conn_paramsPointer to desired connection parameters.
Return values
NRF_SUCCESSSuccessfully initiated connection procedure.
NRF_ERROR_INVALID_ADDRInvalid parameter(s) pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_GAP_INVALID_BLE_ADDRInvalid Peer address.
NRF_ERROR_NO_MEMlimit of available connections reached.
NRF_ERROR_BUSYThe stack is busy, process pending events and retry.
uint32_t sd_ble_gap_connect_cancel ( void  )

Cancel a connection establishment.

Return values
NRF_SUCCESSSuccessfully cancelled an inprogress connection procedure.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
uint32_t sd_ble_gap_device_name_get ( uint8_t *  p_dev_name,
uint16_t *  p_len 
)

Get GAP device name.

Parameters
[out]p_dev_namePointer 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_lenLength of the buffer pointed by p_dev_name, complete device name length on output.
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.
Return values
NRF_SUCCESSGAP device name retrieved successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_DATA_SIZEInvalid 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.

Parameters
[in]p_write_permWrite permissions for the Device Name characteristic see ble_gap_conn_sec_mode_t.
[in]p_dev_namePointer to a UTF-8 encoded, non NULL-terminated string.
[in]lenLength 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_SUCCESSGAP device name and permissions set successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_DATA_SIZEInvalid data size(s) supplied.
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.

Parameters
[in]conn_handleConnection handle.
[in]hci_status_codeHCI status code, see Bluetooth status codes (accepted values are BTLE_REMOTE_USER_TERMINATED_CONNECTION and BTLE_CONN_INTERVAL_UNACCEPTABLE).
Return values
NRF_SUCCESSThe disconnection procedure has been started successfully.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
NRF_ERROR_INVALID_STATEInvalid 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.

Parameters
[in]conn_handleConnection handle.
[in]p_master_idPointer to a ble_gap_master_id_t master identification structure.
[in]p_enc_infoPointer to a ble_gap_enc_info_t encryption information structure.

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

Note
Calling this function may result in the following event depending on the outcome and parameters: BLE_GAP_EVT_CONN_SEC_UPDATE.
Return values
NRF_SUCCESSSuccessfully initiated authentication procedure.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
BLE_ERROR_INVALID_ROLEOperation is not supported in the Peripheral role.
NRF_ERROR_BUSYProcedure already in progress or not allowed at this time, wait for pending procedures to complete and retry.
uint32_t sd_ble_gap_ppcp_get ( ble_gap_conn_params_t p_conn_params)

Get GAP Peripheral Preferred Connection Parameters.

Parameters
[out]p_conn_paramsPointer to a ble_gap_conn_params_t structure where the parameters will be stored.
Return values
NRF_SUCCESSPeripheral Preferred Connection Parameters retrieved successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
uint32_t sd_ble_gap_ppcp_set ( ble_gap_conn_params_t const *  p_conn_params)

Set GAP Peripheral Preferred Connection Parameters.

Parameters
[in]p_conn_paramsPointer to a ble_gap_conn_params_t structure with the desired parameters.
Return values
NRF_SUCCESSPeripheral Preferred Connection Parameters set successfully.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
uint32_t sd_ble_gap_rssi_start ( uint16_t  conn_handle)

Start reporting the received signal strength to the application.

A new event is reported whenever the RSSI value changes, until sd_ble_gap_rssi_stop is called.

Parameters
[in]conn_handleConnection handle.
Return values
NRF_SUCCESSSuccessfully activated RSSI reporting.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
uint32_t sd_ble_gap_rssi_stop ( uint16_t  conn_handle)

Stop reporting the received singnal strength.

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.

Parameters
[in]conn_handleConnection handle.
Return values
NRF_SUCCESSSuccessfully deactivated RSSI reporting.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid 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).

Parameters
[in]p_scan_paramsPointer to scan parameters structure.
Return values
NRF_SUCCESSSuccessfully initiated scanning procedure.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_BUSYThe stack is busy, process pending events and retry.
NRF_ERROR_NOT_SUPPORTEDA selected feature is not supported (selective scanning).
uint32_t sd_ble_gap_scan_stop ( void  )

Stop scanning (GAP Discovery procedure, Observer Procedure).

Return values
NRF_SUCCESSSuccessfully stopped scanning procedure.
NRF_ERROR_INVALID_STATEInvalid 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.

Parameters
[in]conn_handleConnection handle.
[in]p_enc_infoPointer to a ble_gap_enc_info_t encryption information structure. May be NULL to signal none is available.
[in]p_id_infoPointer to a ble_gap_irk_t identity information structure. May be NULL to signal none is available.
[in]p_sign_infoPointer to a ble_gap_sign_info_t signing information structure. May be NULL to signal none is available.

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 implemented yet. p_sign_info must therefore be NULL.
Return values
NRF_SUCCESSSuccessfully accepted security information.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid 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.

Parameters
[in]conn_handleConnection handle.
[in]sec_statusSecurity status, see GAP Security status.
[in]p_sec_paramsPointer to a ble_gap_sec_params_t security parameters structure. As a central 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_keysetPointer to a ble_gap_sec_keyset_t security keyset structure. Any keys distributed as a result of the ongoing security procedure will be stored into the memory referenced inside this structure. Bluetooth addresses distributed by the local device constitute an exception, since those will have to be filled in by the user before calling this function. A NULL pointer will result in the keys not being stored at all.

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.
Return values
NRF_SUCCESSSuccessfully accepted security parameter from the application.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied.
uint32_t sd_ble_gap_tx_power_set ( int8_t  tx_power)

Set the radio's transmit power.

Parameters
[in]tx_powerRadio transmit power in dBm (accepted values are -40, -30, -20, -16, -12, -8, -4, 0, and 4 dBm).
Note
-40 dBm will not actually give -40 dBm, but will instead be remapped to -30 dBm.
Return values
NRF_SUCCESSSuccessfully changed the transmit power.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.