URI records

nRF5 SDK v13.0.0

Generation of NFC NDEF URI record descriptions. More...

Enumerations

enum nfc_uri_id_t {
NFC_URI_NONE = 0x00,
NFC_URI_HTTP_WWW = 0x01,
NFC_URI_HTTPS_WWW = 0x02,
NFC_URI_HTTP = 0x03,
NFC_URI_HTTPS = 0x04,
NFC_URI_TEL = 0x05,
NFC_URI_MAILTO = 0x06,
NFC_URI_FTP_ANONYMOUS = 0x07,
NFC_URI_FTP_FTP = 0x08,
NFC_URI_FTPS = 0x09,
NFC_URI_SFTP = 0x0A,
NFC_URI_SMB = 0x0B,
NFC_URI_NFS = 0x0C,
NFC_URI_FTP = 0x0D,
NFC_URI_DAV = 0x0E,
NFC_URI_NEWS = 0x0F,
NFC_URI_TELNET = 0x10,
NFC_URI_IMAP = 0x11,
NFC_URI_RTSP = 0x12,
NFC_URI_URN = 0x13,
NFC_URI_POP = 0x14,
NFC_URI_SIP = 0x15,
NFC_URI_SIPS = 0x16,
NFC_URI_TFTP = 0x17,
NFC_URI_BTSPP = 0x18,
NFC_URI_BTL2CAP = 0x19,
NFC_URI_BTGOEP = 0x1A,
NFC_URI_TCPOBEX = 0x1B,
NFC_URI_IRDAOBEX = 0x1C,
NFC_URI_FILE = 0x1D,
NFC_URI_URN_EPC_ID = 0x1E,
NFC_URI_URN_EPC_TAG = 0x1F,
NFC_URI_URN_EPC_PAT = 0x20,
NFC_URI_URN_EPC_RAW = 0x21,
NFC_URI_URN_EPC = 0x22,
NFC_URI_URN_NFC = 0x23,
NFC_URI_RFU = 0xFF
}
URI identifier codes according to "URI Record Type Definition" (denotation "NFCForum-TS-RTD_URI_1.0" published on 2006-07-24) chapter 3.2.2. More...

Functions

nfc_ndef_record_desc_t * nfc_uri_rec_declare ( nfc_uri_id_t uri_id_code, uint8_t const *const p_uri_data, uint8_t uri_data_len)
Function for generating a description of a URI record. More...

Detailed Description

Generation of NFC NDEF URI record descriptions.

Enumeration Type Documentation

URI identifier codes according to "URI Record Type Definition" (denotation "NFCForum-TS-RTD_URI_1.0" published on 2006-07-24) chapter 3.2.2.

Enumerator
NFC_URI_NONE

No prepending is done.

NFC_URI_HTTP_WWW

"http://www."

NFC_URI_HTTPS_WWW

"https://www."

NFC_URI_HTTP

"http:"

NFC_URI_HTTPS

"https:"

NFC_URI_TEL

"tel:"

NFC_URI_MAILTO

"mailto:"

NFC_URI_FTP_ANONYMOUS

"ftp://anonymous:anonymous@"

NFC_URI_FTP_FTP

"ftp://ftp."

NFC_URI_FTPS

"ftps://"

NFC_URI_SFTP

"sftp://"

NFC_URI_SMB

"smb://"

NFC_URI_NFS

"nfs://"

NFC_URI_FTP

"ftp://"

NFC_URI_DAV

"dav://"

NFC_URI_NEWS

"news:"

NFC_URI_TELNET

"telnet://"

NFC_URI_IMAP

"imap:"

NFC_URI_RTSP

"rtsp://"

NFC_URI_URN

"urn:"

NFC_URI_POP

"pop:"

NFC_URI_SIP

"sip:"

NFC_URI_SIPS

"sips:"

NFC_URI_TFTP

"tftp:"

NFC_URI_BTSPP

"btspp://"

NFC_URI_BTL2CAP

"btl2cap://"

NFC_URI_BTGOEP

"btgoep://"

NFC_URI_TCPOBEX

"tcpobex://"

NFC_URI_IRDAOBEX

"irdaobex://"

NFC_URI_FILE

"file://"

NFC_URI_URN_EPC_ID

"urn:epc:id:"

NFC_URI_URN_EPC_TAG

"urn:epc:tag:"

NFC_URI_URN_EPC_PAT

"urn:epc:pat:"

NFC_URI_URN_EPC_RAW

"urn:epc:raw:"

NFC_URI_URN_EPC

"urn:epc:"

NFC_URI_URN_NFC

"urn:nfc:"

NFC_URI_RFU

No prepending is done. Reserved for future use.

Function Documentation

nfc_ndef_record_desc_t * nfc_uri_rec_declare ( nfc_uri_id_t uri_id_code ,
uint8_t const *const p_uri_data ,
uint8_t uri_data_len
)

Function for generating a description of a URI record.

This function declares and initializes a static instance of an NFC NDEF record description of a URI record.

Note
The record payload data ( uri_id_code , p_uri_data , and uri_data_len ) should be declared as static. If it is declared as automatic, the NDEF message encoding (see nfc_uri_msg_encode ) must be done in the same variable scope.
Parameters
[in] uri_id_code URI identifier code that defines the protocol field of the URI.
[in] p_uri_data Pointer to the URI string. The string should not contain the protocol field if the protocol was specified in uri_id_code .
[in] uri_data_len Length of the URI string.
Returns
Pointer to the description of the record.