nRF5 SDK v17.1.0
Modules | Functions
Advertising and Scan Response Data Encoder for NFC OOB pairing

Function for encoding data in the Advertising and Scan Response Data format, which can be used to create payload of NFC message intended for initiating the Out-of-Band pairing. More...

Modules

 AD data for OOB pairing encoder configuration
 

Functions

ret_code_t nfc_ble_oob_adv_data_encode (ble_advdata_t const *const p_advdata, uint8_t *const p_encoded_data, uint16_t *const p_len)
 Function for encoding data in the Advertising and Scan Response data format, which is used for NFC OOB pairing. More...
 
void nfc_tk_value_payload_encode (ble_advdata_tk_value_t *p_tk_value, uint8_t *p_tk_payload_data)
 Function for encoding payload field of Security Manager TK Value AD Type. More...
 

Detailed Description

Function for encoding data in the Advertising and Scan Response Data format, which can be used to create payload of NFC message intended for initiating the Out-of-Band pairing.

Function Documentation

ret_code_t nfc_ble_oob_adv_data_encode ( ble_advdata_t const *const  p_advdata,
uint8_t *const  p_encoded_data,
uint16_t *const  p_len 
)

Function for encoding data in the Advertising and Scan Response data format, which is used for NFC OOB pairing.

This function encodes data into the Advertising and Scan Response data format (AD structures). Encoding is based on the selections in the supplied structures. This function uses ble_advdata_encode to encode regular data and adds additional AD Structures which are specific for NFC OOB pairing: Security Manager TK Value, LESC OOB values, OOB Flags, and LE Role.

Parameters
[in]p_advdataPointer to the structure for specifying the content of encoded data.
[out]p_encoded_dataPointer to the buffer where encoded data will be returned.
[in,out]p_lenin: Size of p_encoded_data buffer. out: Length of encoded data.
Return values
NRF_SUCCESSIf the operation was successful.
NRF_ERROR_INVALID_PARAMIf the operation failed because a wrong parameter was provided in p_advdata.
NRF_ERROR_DATA_SIZEIf the operation failed because not all the requested data could fit into the provided buffer or some encoded AD structure is too long and its length cannot be encoded with one octet.
void nfc_tk_value_payload_encode ( ble_advdata_tk_value_t p_tk_value,
uint8_t *  p_tk_payload_data 
)

Function for encoding payload field of Security Manager TK Value AD Type.

Parameters
[in]p_tk_valueSecurity Manager TK Value AD Type payload.
[out]p_tk_payload_dataPointer to the buffer where TK payload data will be stored.

Documentation feedback | Developer Zone | Subscribe | Updated