Generation of NFC NDEF messages for the NFC tag.
More...
Generation of NFC NDEF messages for the NFC tag.
#define NFC_NDEF_MSG_DEF |
( |
|
NAME, |
|
|
|
MAX_RECORD_CNT |
|
) |
| |
Value:
{ \
.
pp_record = NAME##_nfc_ndef_p_record_desc_array, \
.record_count = 0, \
.max_record_count = MAX_RECORD_CNT \
}
Macro for creating and initializing an NFC NDEF message descriptor.
This macro creates and initializes a static instance of type nfc_ndef_msg_desc_t and a static array of pointers to record descriptors (nfc_ndef_record_desc_t) used by the message.
Use the macro NFC_NDEF_MSG to access the NDEF message descriptor instance.
- Parameters
-
[in] | NAME | Name of the related instance. |
[in] | MAX_RECORD_CNT | Maximal count of records in the message. |
#define NFC_NDEF_NESTED_NDEF_MSG_RECORD_DEF |
( |
|
NAME, |
|
|
|
TNF, |
|
|
|
P_ID, |
|
|
|
ID_LEN, |
|
|
|
P_TYPE, |
|
|
|
TYPE_LEN, |
|
|
|
P_NESTED_MESSAGE |
|
) |
| |
Value:
{ \
\
.id_length = ID_LEN, \
.p_id = P_ID, \
\
.type_length = TYPE_LEN, \
.p_type = P_TYPE, \
\
.p_payload_descriptor = (void*) (P_NESTED_MESSAGE) \
}
Macro for creating and initializing an NFC NDEF record descriptor with an encapsulated NDEF message.
This macro creates and initializes a static instance of type nfc_ndef_record_desc_t that contains an encapsulated NDEF message as payload. nfc_ndef_msg_encode is used as payload constructor to encode the message. The encoded message is then used as payload for the record.
Use the macro NFC_NDEF_NESTED_NDEF_MSG_RECORD to access the NDEF record descriptor instance.
- Parameters
-
[in] | NAME | Name of the created record descriptor instance. |
[in] | TNF | Type Name Format (TNF) value for the record. |
[in] | P_ID | Pointer to the ID string. |
[in] | ID_LEN | Length of the ID string. |
[in] | P_TYPE | Pointer to the type string. |
[in] | TYPE_LEN | Length of the type string. |
[in] | P_NESTED_MESSAGE | Pointer to the message descriptor to encapsulate as the record's payload. |
Function for clearing an NDEF message.
This function clears an NDEF message descriptor, thus empties the NDEF message.
- Parameters
-
[in,out] | p_msg | Pointer to the message descriptor. |
Function for encoding an NDEF message.
This function encodes an NDEF message according to the provided message descriptor.
- Note
- The way of encoding an NDEF message may vary depending on tag's platform, which can be chosen with NFC_NDEF_MSG_TAG_TYPE in
sdk_config.h
.
- Parameters
-
[in] | p_ndef_msg_desc | Pointer to the message descriptor. |
[out] | p_msg_buffer | Pointer to the message destination. If NULL, function will calculate the expected size of the message. |
[in,out] | p_msg_len | Size of the available memory for the message as input. Size of the generated message as output. |
- Returns
- Return value from nfc_ndef_record_encode.
Function for adding a record to an NDEF message.
- Parameters
-
[in] | p_record | Pointer to the record descriptor. |
[in,out] | p_msg | Pointer to the message descriptor. |
- Return values
-
NRF_SUCCESS | If the record was added successfully. |
NRF_ERROR_NO_MEM | If the message already contains the maximum number of records and the operation is not allowed. |