LE OOB records

Generation of NFC NDEF LE OOB records for NDEF messages. More...

Modules
	LE record for BLE pairing encoder configuration

Macros
#define	NFC_NDEF_LE_OOB_RECORD_DESC_DEF(NAME,PAYLOAD_ID,P_BLE_ADVDATA)
	Macro for generating a description of an NFC NDEF Bluetooth Carrier Configuration LE Record. More...
#define	NFC_NDEF_LE_OOB_RECORD_DESC(NAME)   NFC_NDEF_GENERIC_RECORD_DESC(NAME)
	Macro for accessing the NFC NDEF Bluetooth Carrier Configuration LE record descriptor instance that was created with NFC_NDEF_LE_OOB_RECORD_DESC_DEF.

Functions
ret_code_t	nfc_le_oob_payload_constructor (ble_advdata_t *p_ble_advdata, uint8_t *p_buff, uint32_t *p_len)
	Function for constructing the payload for a Bluetooth Carrier Configuration LE record. More...

Detailed Description

Generation of NFC NDEF LE OOB records for NDEF messages.

Macro Definition Documentation

#define NFC_NDEF_LE_OOB_RECORD_DESC_DEF	(		NAME,
			PAYLOAD_ID,
			P_BLE_ADVDATA
	)

Value:

uint8_t NAME##_ndef_le_oob_record_id = (PAYLOAD_ID); \
 uint8_t NAME##_ndef_le_oob_record_id_length = ((PAYLOAD_ID) != 0) ? 1 : 0; \
 NFC_NDEF_GENERIC_RECORD_DESC_DEF( NAME, \
 TNF_MEDIA_TYPE, \
 &NAME##_ndef_le_oob_record_id, \
 NAME##_ndef_le_oob_record_id_length, \
 (le_oob_rec_type_field), \
 sizeof(le_oob_rec_type_field), \
 nfc_le_oob_payload_constructor, \
 (P_BLE_ADVDATA)) \

Macro for generating a description of an NFC NDEF Bluetooth Carrier Configuration LE Record.

This macro declares and initializes an instance of an NFC NDEF record description for a Bluetooth Carrier Configuration LE record.

Note

The record descriptor is declared as automatic variable, which implies that the NDEF message encoding (see nfc_ble_simplified_le_oob_msg_encode) must be done in the same variable scope.

Parameters

[in]	NAME	Name for accessing record descriptor.
[in]	PAYLOAD_ID	NDEF record header Payload ID field (Limited to one byte). If 0, no ID is present in the record description.
[in]	P_BLE_ADVDATA	Pointer to the encoded BLE advertising data structure. This data is used to create the record payload.

Function Documentation

ret_code_t nfc_le_oob_payload_constructor	(	ble_advdata_t *	p_ble_advdata,
		uint8_t *	p_buff,
		uint32_t *	p_len
	)

Function for constructing the payload for a Bluetooth Carrier Configuration LE record.

This function encodes the record payload according to the BLE AD structure. It implements an API compatible with p_payload_constructor_t

Parameters

[in]	p_ble_advdata	Pointer to the description of the payload.
[out]	p_buff	Pointer to payload destination. If NULL, function will calculate the expected size of the record payload.
[in,out]	p_len	Size of available memory to write as input. Size of generated payload as output.

Return values

NRF_SUCCESS	If the record payload was encoded successfully.
Other	If the record payload encoding failed.