uFCoder 2.58
Loading...
Searching...
No Matches
NDEF related commands

Functions for reading and writing common NDEF messages and records into various NFC tags. Currently, only NFC Type 2 Tags are supported, while support for other NFC Tag types will be added in future upgrades. More...

Functions

UFR_STATUS DL_API read_ndef_record (uint8_t message_nr, uint8_t record_nr, VAR uint8_t *tnf, OUT uint8_t *type_record, VAR uint8_t *type_length, OUT uint8_t *id, VAR uint8_t *id_length, OUT uint8_t *payload, VAR uint32_t *payload_length)
 
UFR_STATUS DL_API write_ndef_record (uint8_t message_nr, IN uint8_t *tnf, IN uint8_t *type_record, IN uint8_t *type_length, IN uint8_t *id, IN uint8_t *id_length, IN uint8_t *payload, IN uint32_t *payload_length, VAR uint8_t *card_formated)
 
UFR_STATUS DL_API write_ndef_record_mirroring (uint8_t message_nr, IN uint8_t *tnf, IN uint8_t *type_record, IN uint8_t *type_length, IN uint8_t *id, IN uint8_t *id_length, IN uint8_t *payload, IN uint32_t *payload_length, VAR uint8_t *card_formated, int use_uid_ascii_mirror, int use_counter_ascii_mirror, uint32_t payload_mirroring_pos)
 
UFR_STATUS DL_API write_ndef_record_mirroring_tt (uint8_t message_nr, IN uint8_t *tnf, IN uint8_t *type_record, IN uint8_t *type_length, IN uint8_t *id, IN uint8_t *id_length, IN uint8_t *payload, IN uint32_t *payload_length, VAR uint8_t *card_formated, int use_uid_ascii_mirror, int use_counter_ascii_mirror, int use_tt_message_mirror, uint32_t payload_mirroring_pos)
 
UFR_STATUS DL_API get_ndef_record_count (VAR uint8_t *ndef_message_cnt, VAR uint8_t *ndef_record_cnt, OUT uint8_t *ndef_record_array, VAR uint8_t *empty_ndef_message_cnt)
 
UFR_STATUS DL_API erase_last_ndef_record (uint8_t message_nr)
 
UFR_STATUS DL_API erase_all_ndef_records (uint8_t message_nr)
 
UFR_STATUS DL_API ndef_card_initialization (void)
 
UFR_STATUS DL_API WriteNdefRecord_WiFi (uint8_t ndef_storage, IN const char *ssid, uint8_t auth_type, uint8_t encryption_type, IN const char *password)
 
UFR_STATUS DL_API WriteNdefRecord_BT (uint8_t ndef_storage, IN const char *bt_mac_address)
 
UFR_STATUS DL_API WriteNdefRecord_SMS (uint8_t ndef_storage, IN const char *phone_number, IN const char *message)
 
UFR_STATUS DL_API WriteNdefRecord_Bitcoin (uint8_t ndef_storage, IN const char *bitcoin_address, IN const char *amount, IN const char *message)
 
UFR_STATUS DL_API WriteNdefRecord_GeoLocation (uint8_t ndef_storage, IN const char *latitude, IN const char *longitude)
 
UFR_STATUS DL_API WriteNdefRecord_NaviDestination (uint8_t ndef_storage, IN const char *destination)
 
UFR_STATUS DL_API WriteNdefRecord_Email (uint8_t ndef_storage, IN const char *email_address, IN const char *subject, IN const char *message)
 
UFR_STATUS DL_API WriteNdefRecord_Address (uint8_t ndef_storage, IN const char *address)
 
UFR_STATUS DL_API WriteNdefRecord_AndroidApp (uint8_t ndef_storage, IN const char *package_name)
 
UFR_STATUS DL_API WriteNdefRecord_Text (uint8_t ndef_storage, IN const char *text)
 
UFR_STATUS DL_API WriteNdefRecord_StreetView (uint8_t ndef_storage, IN const char *latitude, IN const char *longitude)
 
UFR_STATUS DL_API WriteNdefRecord_Skype (uint8_t ndef_storage, IN const char *user_name, uint8_t action)
 
UFR_STATUS DL_API WriteNdefRecord_Whatsapp (uint8_t ndef_storage, IN const char *message)
 
UFR_STATUS DL_API WriteNdefRecord_Viber (uint8_t ndef_storage, IN const char *message)
 
UFR_STATUS DL_API WriteNdefRecord_Contact (uint8_t ndef_storage, IN const char *name, IN const char *company, IN const char *address, IN const char *phone, IN const char *email, IN const char *website)
 
UFR_STATUS DL_API WriteNdefRecord_Phone (uint8_t ndef_storage, IN const char *phone_number)
 
UFR_STATUS DL_API ReadNdefRecord_WiFi (OUT char *ssid, OUT char *auth_type, OUT char *encryption_type, OUT char *password)
 
UFR_STATUS DL_API ReadNdefRecord_Bitcoin (OUT char *bitcoin_address, OUT char *amount, OUT char *message)
 
UFR_STATUS DL_API ReadNdefRecord_GeoLocation (OUT char *latitude, OUT char *longitude)
 
UFR_STATUS DL_API ReadNdefRecord_NaviDestination (OUT char *destination)
 
UFR_STATUS DL_API ReadNdefRecord_Email (OUT char *email_address, OUT char *subject, OUT char *message)
 
UFR_STATUS DL_API ReadNdefRecord_Address (OUT char *address)
 
UFR_STATUS DL_API ReadNdefRecord_AndroidApp (OUT char *package_name)
 
UFR_STATUS DL_API ReadNdefRecord_Text (OUT char *text)
 
UFR_STATUS DL_API ReadNdefRecord_StreetView (OUT char *latitude, OUT char *longitude)
 
UFR_STATUS DL_API ReadNdefRecord_Skype (OUT char *user_name, OUT char *action)
 
UFR_STATUS DL_API ReadNdefRecord_Whatsapp (OUT char *message)
 
UFR_STATUS DL_API ReadNdefRecord_Viber (OUT char *message)
 
UFR_STATUS DL_API ReadNdefRecord_Contact (OUT char *vCard)
 
UFR_STATUS DL_API ReadNdefRecord_Phone (OUT char *phone_number)
 
UFR_STATUS DL_API ReadNdefRecord_SMS (OUT char *phone_number, OUT char *message)
 
UFR_STATUS DL_API ReadNdefRecord_BT (OUT char *bt_mac_address)
 
c_string DL_API ParseNdefMessage (IN uint8_t *type_record, uint8_t type_len, IN uint8_t *payload, uint32_t payload_len)
 

Detailed Description

Functions for reading and writing common NDEF messages and records into various NFC tags. Currently, only NFC Type 2 Tags are supported, while support for other NFC Tag types will be added in future upgrades.

Function Documentation

◆ read_ndef_record()

UFR_STATUS DL_API read_ndef_record ( uint8_t message_nr,
uint8_t record_nr,
VAR uint8_t * tnf,
OUT uint8_t * type_record,
VAR uint8_t * type_length,
OUT uint8_t * id,
VAR uint8_t * id_length,
OUT uint8_t * payload,
VAR uint32_t * payload_length )

Function returns TNF, type of record, ID and payload from the NDEF record. NDEF record shall be elected by the message ordinal and record ordinal in this message.

Parameters
message_nrNDEF message ordinal (starts from 1)
record_nrNDEF record ordinal (in message)
tnfpointer to the variable containing TNF of record
type_recordpointer to array containing type of record
type_lengthpointer to the variable containing length of type of record string
idpointer to array containing ID of record
id_lengthpointer to the variable containing length of ID of record string
payloadpointer to array containing payload of record
payload_lengthpointer to the variable containing length of payload
Returns
Operation status

◆ write_ndef_record()

UFR_STATUS DL_API write_ndef_record ( uint8_t message_nr,
IN uint8_t * tnf,
IN uint8_t * type_record,
IN uint8_t * type_length,
IN uint8_t * id,
IN uint8_t * id_length,
IN uint8_t * payload,
IN uint32_t * payload_length,
VAR uint8_t * card_formated )

Function adds a record to the end of message, if one or more records already exist in this message. If current message is empty, then this empty record will be replaced with the record. Parameters of function are: ordinal of message, TNF, type of record, ID, payload. Function also returns pointer to the variable which reported that the card formatted for NDEF using (card does not have a capability container, for example new Mifare Ultralight, or Mifare Classic card).

Parameters
message_nrNDEF message ordinal (starts from 1)
tnfpointer to variable containing TNF of record
type_recordpointer to array containing type of record
type_lengthpointer to the variable containing length of type of record string
idpointer to array containing ID of record
id_lengthpointer to the variable containing length of ID of record string
payloadpointer to array containing payload of record
payload_lengthpointer to the variable containing length of payload
card_formatedpointer to the variable which shows that the card formatted for NDEF using.
Returns
Operation status

◆ write_ndef_record_mirroring()

UFR_STATUS DL_API write_ndef_record_mirroring ( uint8_t message_nr,
IN uint8_t * tnf,
IN uint8_t * type_record,
IN uint8_t * type_length,
IN uint8_t * id,
IN uint8_t * id_length,
IN uint8_t * payload,
IN uint32_t * payload_length,
VAR uint8_t * card_formated,
int use_uid_ascii_mirror,
int use_counter_ascii_mirror,
uint32_t payload_mirroring_pos )

This function works the same as the write_ndef_record(), with the additional “UID and / or NFC counter mirror” features support. NTAG 21x family of devices offers these specific features. For details about “ASCII mirror” features refer to http://www.nxp.com/docs/en/data-sheet/NTAG213_215_216.pdf (in Rev. 3.2 from 2. June 2015, page 20) and http://www.nxp.com/docs/en/data-sheet/NTAG210_212.pdf (in Rev. 3.0 from 14. March 2013, page 16).

Parameters
message_nrNDEF message ordinal (starts from 1)
tnfpointer to variable containing TNF of record
type_recordpointer to array containing type of record
type_lengthpointer to the variable containing length of type of record string
idpointer to array containing ID of record
id_lengthpointer to the variable containing length of ID of record string
payloadpointer to array containing payload of record
payload_lengthpointer to the variable containing length of payload
card_formatedpointer to the variable which shows that the card formatted for NDEF using.
use_uid_ascii_mirrorif use_uid_ascii_mirror == 1 then “UID ASCII Mirror” feature is in use. if use_uid_ascii_mirror == 0 then “UID ASCII Mirror” feature is switched off.
use_counter_ascii_mirrorif use_counter_ascii_mirror == 1 then “NFC counter ASCII Mirror” feature is in use. if use_counter_ascii_mirror == 0 then “NFC counter ASCII Mirror” feature is switched off.
payload_mirroring_posDefines the starting position of the “ASCII Mirror” into the NDEF record payload.
Returns
Operation status

◆ write_ndef_record_mirroring_tt()

UFR_STATUS DL_API write_ndef_record_mirroring_tt ( uint8_t message_nr,
IN uint8_t * tnf,
IN uint8_t * type_record,
IN uint8_t * type_length,
IN uint8_t * id,
IN uint8_t * id_length,
IN uint8_t * payload,
IN uint32_t * payload_length,
VAR uint8_t * card_formated,
int use_uid_ascii_mirror,
int use_counter_ascii_mirror,
int use_tt_message_mirror,
uint32_t payload_mirroring_pos )

This function works the same as the write_ndef_record(), with the additional “UID and / or NFC counter mirror” features support. NTAG 21x family of devices offers these specific features. For details about “ASCII mirror” features refer to http://www.nxp.com/docs/en/data-sheet/NTAG213_215_216.pdf (in Rev. 3.2 from 2. June 2015, page 20) and http://www.nxp.com/docs/en/data-sheet/NTAG210_212.pdf (in Rev. 3.0 from 14. March 2013, page 16).

Parameters
message_nrNDEF message ordinal (starts from 1)
tnfpointer to variable containing TNF of record
type_recordpointer to array containing type of record
type_lengthpointer to the variable containing length of type of record string
idpointer to array containing ID of record
id_lengthpointer to the variable containing length of ID of record string
payloadpointer to array containing payload of record
payload_lengthpointer to the variable containing length of payload
card_formatedpointer to the variable which shows that the card formatted for NDEF using.
use_uid_ascii_mirrorif use_uid_ascii_mirror == 1 then “UID ASCII Mirror” feature is in use. if use_uid_ascii_mirror == 0 then “UID ASCII Mirror” feature is switched off.
use_counter_ascii_mirrorif use_counter_ascii_mirror == 1 then “NFC counter ASCII Mirror” feature is in use. if use_counter_ascii_mirror == 0 then “NFC counter ASCII Mirror” feature is switched off. payload_mirroring_pos Defines the starting position of the “ASCII Mirror” into the NDEF record payload.
use_tt_message_mirrorif use_tt_message_mirror == 1 then Tag tamper status mirroring is enabled
payload_mirroring_posDefines the starting position of the “ASCII Mirror” into the NDEF record payload.
Returns
Operation status

◆ get_ndef_record_count()

UFR_STATUS DL_API get_ndef_record_count ( VAR uint8_t * ndef_message_cnt,
VAR uint8_t * ndef_record_cnt,
OUT uint8_t * ndef_record_array,
VAR uint8_t * empty_ndef_message_cnt )

Function returns the number of NDEF messages that have been read from the card, and number of NDEF records, number of NDEF empty messages. Also, function returns array of bytes containing number of messages pairs. First byte of pair is message ordinal, and second byte is number of NDEF records in that message. Message ordinal starts from 1.

Parameters
ndef_message_cntpointer to the variable containing number of NDEF messages
ndef_record_cntpointer to the variable containing number of NDEF record
ndef_record_arraypointer to the array of bytes containing pairs (message ordinal - number of records)
empty_ndef_message_cntpointer to the variable containing number of empty messages
Returns
Operation status

◆ erase_last_ndef_record()

UFR_STATUS DL_API erase_last_ndef_record ( uint8_t message_nr)

Function deletes the last record of the selected message. If a message contains one record, then it will be written as an empty message.

Parameters
message_nrNDEF message ordinal (starts form 1)
Returns
Operation status

◆ erase_all_ndef_records()

UFR_STATUS DL_API erase_all_ndef_records ( uint8_t message_nr)

Function deletes all records of the message, then writes an empty message.

Parameters
message_nrNDEF message ordinal (starts form 1)
Returns
Operation status

◆ ndef_card_initialization()

UFR_STATUS DL_API ndef_card_initialization ( void )

Function prepares the card for NDEF using. Function writes Capability Container (CC) if necessary, and writes empty message. If the card is MIFARE CLASSIC or MIFARE PLUS, then the function writes MAD (MIFARE Application Directory), and default keys and access bits for NDEF using.

Returns
Operation status

◆ WriteNdefRecord_WiFi()

UFR_STATUS DL_API WriteNdefRecord_WiFi ( uint8_t ndef_storage,
IN const char * ssid,
uint8_t auth_type,
uint8_t encryption_type,
IN const char * password )

Store WiFi configuration as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
ssidPointer to the null-terminated string that should contain SSID name we want to connect to
auth_typeAuthentication type: 0 - OPEN 1 - WPA Personal 2 - WPA Enterprise 3 - WPA2 Enterprise 4 - WPA2 Personal
encryption_typeEncryption type: 0 - NONE 1 - WEP 2 - TKIP 3 - AES 4 - AES/TKIP
passwordPointer to the null-terminated string that should contain password of the SSID we want to connect to
Returns
Operation status

◆ WriteNdefRecord_BT()

UFR_STATUS DL_API WriteNdefRecord_BT ( uint8_t ndef_storage,
IN const char * bt_mac_address )

Store BT MAC address for pairing as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
bt_mac_addressPointer to the null-terminated string that should contain BT MAC address for pairing in hex format (12 characters)(e.g.: “AABBCCDDEEFF”)
Returns
Operation status

◆ WriteNdefRecord_SMS()

UFR_STATUS DL_API WriteNdefRecord_SMS ( uint8_t ndef_storage,
IN const char * phone_number,
IN const char * message )

Store phone number and message data as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
phone_numberPointer to char array containing phone number
messagePointer to the null-terminated string that should contain message data
Returns
Operation status

◆ WriteNdefRecord_Bitcoin()

UFR_STATUS DL_API WriteNdefRecord_Bitcoin ( uint8_t ndef_storage,
IN const char * bitcoin_address,
IN const char * amount,
IN const char * message )

Store bitcoin address, amount and donation message as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
bitcoin_addressPointer to the null-terminated string that should contain bitcoin address
amountPointer to the null-terminated string that should contain amount (e.g.: “1.0”)
messagePointer to the null-terminated string that should contain donation message
Returns
Operation status

◆ WriteNdefRecord_GeoLocation()

UFR_STATUS DL_API WriteNdefRecord_GeoLocation ( uint8_t ndef_storage,
IN const char * latitude,
IN const char * longitude )

Store latitude and longitude as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
latitudePointer to the null-terminated string that should contain latitude (e.g.: “44.6229337”)
longitudePointer to the null-terminated string that should contain longitude (e.g.: “21.1787368”)
Returns
Operation status

◆ WriteNdefRecord_NaviDestination()

UFR_STATUS DL_API WriteNdefRecord_NaviDestination ( uint8_t ndef_storage,
IN const char * destination )

Store wanted destination as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
destinationPointer to the null-terminated string that should contain city, street name or some other destination
Returns
Operation status

◆ WriteNdefRecord_Email()

UFR_STATUS DL_API WriteNdefRecord_Email ( uint8_t ndef_storage,
IN const char * email_address,
IN const char * subject,
IN const char * message )

Store email message as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
email_addressPointer to the null-terminated string that should contain recipient email address
subjectPointer to the null-terminated string that should contain subject
messagePointer to the null-terminated string that should contain message
Returns
Operation status

◆ WriteNdefRecord_Address()

UFR_STATUS DL_API WriteNdefRecord_Address ( uint8_t ndef_storage,
IN const char * address )

Store address (city, street name, etc) as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
addressPointer to the null-terminated string that should contain city name, street name, etc.
Returns
Operation status

◆ WriteNdefRecord_AndroidApp()

UFR_STATUS DL_API WriteNdefRecord_AndroidApp ( uint8_t ndef_storage,
IN const char * package_name )

Store android app package name as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
package_namePointer to the null-terminated string that should contain android app packagne name
Returns
Operation status

◆ WriteNdefRecord_Text()

UFR_STATUS DL_API WriteNdefRecord_Text ( uint8_t ndef_storage,
IN const char * text )

Store text as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
textPointer to the null-terminated string that should contain text
Returns
Operation status

◆ WriteNdefRecord_StreetView()

UFR_STATUS DL_API WriteNdefRecord_StreetView ( uint8_t ndef_storage,
IN const char * latitude,
IN const char * longitude )

Store latitude and longitude as NDEF message into reader or into card for Google StreetView.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
latitudePointer to the null-terminated string that should contain latitude (e.g.: “44.6229337”)
longitudePointer to the null-terminated string that should contain longitude (e.g.: “21.1787368”)
Returns
Operation status

◆ WriteNdefRecord_Skype()

UFR_STATUS DL_API WriteNdefRecord_Skype ( uint8_t ndef_storage,
IN const char * user_name,
uint8_t action )

Store skype username as NDEF message into reader or into card for call or chat.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
user_namepointer to the null-terminated string that should contain skype username
actionAction type: call - 0 chat - 1
Returns
Operation status

◆ WriteNdefRecord_Whatsapp()

UFR_STATUS DL_API WriteNdefRecord_Whatsapp ( uint8_t ndef_storage,
IN const char * message )

Store Whatsapp message as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
messagePointer to the null-terminated string that should contain Whatsapp message
Returns
Operation status

◆ WriteNdefRecord_Viber()

UFR_STATUS DL_API WriteNdefRecord_Viber ( uint8_t ndef_storage,
IN const char * message )

Store Viber message as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
messagePointer to the null-terminated string that should contain Viber message
Returns
Operation status

◆ WriteNdefRecord_Contact()

UFR_STATUS DL_API WriteNdefRecord_Contact ( uint8_t ndef_storage,
IN const char * name,
IN const char * company,
IN const char * address,
IN const char * phone,
IN const char * email,
IN const char * website )

Store phone contact as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
namepointer to the null-terminated string that should contain contact display name
companypointer to the null-terminated string that should contain contact company name
addressPointer to the null-terminated string that should contain contact residental address
phonepointer to the null-terminated string that should contain contact phone number
emailpointer to the null-terminated string that should contain contact email address
websitepointer to the null-terminated string that should contain contact website
Returns
Operation status

◆ WriteNdefRecord_Phone()

UFR_STATUS DL_API WriteNdefRecord_Phone ( uint8_t ndef_storage,
IN const char * phone_number )

Store phone_number as NDEF message into reader or into card.

Parameters
ndef_storageStore NDEF into: reader - 0, card - 1 From library 5.0.31 and firmware 5.0.33 2 - reader RAM
phone_numberPointer to char array containing phone number
Returns
Operation status

◆ ReadNdefRecord_WiFi()

UFR_STATUS DL_API ReadNdefRecord_WiFi ( OUT char * ssid,
OUT char * auth_type,
OUT char * encryption_type,
OUT char * password )

Reads NDEF WiFi configuration from card..

Parameters
ssidPointer to char array containing SSID name
auth_typePointer to char array containing authentication type
encryption_typePointer to char array containing encryption type
passwordPointer to char array containing password
Returns
Operation status

◆ ReadNdefRecord_Bitcoin()

UFR_STATUS DL_API ReadNdefRecord_Bitcoin ( OUT char * bitcoin_address,
OUT char * amount,
OUT char * message )

Reads NDEF bitcoin address, amount and donation message from card.

Parameters
bitcoin_addressPointer to char array containing bitcoin_address
amountPointer to char array containing bitcoin amount
messagePointer to char array containing donation message
Returns
Operation status

◆ ReadNdefRecord_GeoLocation()

UFR_STATUS DL_API ReadNdefRecord_GeoLocation ( OUT char * latitude,
OUT char * longitude )

Reads NDEF latitude and longitude from card.

Parameters
latitudePointer to char array containing latitude
longitudePointer to char array containing longitude
Returns
Operation status

◆ ReadNdefRecord_NaviDestination()

UFR_STATUS DL_API ReadNdefRecord_NaviDestination ( OUT char * destination)

Reads NDEF navigation destination from card.

Parameters
destinationPointer to char array containing destination
Returns
Operation status

◆ ReadNdefRecord_Email()

UFR_STATUS DL_API ReadNdefRecord_Email ( OUT char * email_address,
OUT char * subject,
OUT char * message )

Reads NDEF email address, subject and message from card.

Parameters
email_addressPointer to char array containing recipient email address
subjectPointer to char array containing subject
messagePointer to char array containing message
Returns
Operation status

◆ ReadNdefRecord_Address()

UFR_STATUS DL_API ReadNdefRecord_Address ( OUT char * address)

Reads NDEF address (city, street name,etc) from card.

Parameters
addressPointer to char array containing address
Returns
Operation status

◆ ReadNdefRecord_AndroidApp()

UFR_STATUS DL_API ReadNdefRecord_AndroidApp ( OUT char * package_name)

Reads android app package name stored as NDEF record

Parameters
package_namePointer to the null-terminated string that should contain android app package name
Returns
Operation status

◆ ReadNdefRecord_Text()

UFR_STATUS DL_API ReadNdefRecord_Text ( OUT char * text)

Reads NDEF text from card.

Parameters
textPointer to char array containing text
Returns
Operation status

◆ ReadNdefRecord_StreetView()

UFR_STATUS DL_API ReadNdefRecord_StreetView ( OUT char * latitude,
OUT char * longitude )

Reads NDEF latitude and longitude for Google StreetView from card.

Parameters
latitudePointer to char array containing latitude
longitudePointer to char array containing longitude
Returns
Operation status

◆ ReadNdefRecord_Skype()

UFR_STATUS DL_API ReadNdefRecord_Skype ( OUT char * user_name,
OUT char * action )

Reads NDEF skype username and action from card.

Parameters
user_namepointer to the null-terminated string that should contain skype username
actionPointer to char array containing Skype action (“call” or “chat”)
Returns
Operation status

◆ ReadNdefRecord_Whatsapp()

UFR_STATUS DL_API ReadNdefRecord_Whatsapp ( OUT char * message)

Reads NDEF Whatsapp message from card.

Parameters
messagePointer to char array containing Whatsapp message
Returns
Operation status

◆ ReadNdefRecord_Viber()

UFR_STATUS DL_API ReadNdefRecord_Viber ( OUT char * message)

Reads NDEF Viber message from card.

Parameters
messagePointer to char array containing Viber message
Returns
Operation status

◆ ReadNdefRecord_Contact()

UFR_STATUS DL_API ReadNdefRecord_Contact ( OUT char * vCard)

Reads NDEF phone contact from card.

Parameters
vCardPointer to char array containing phone contact data
Returns
Operation status

◆ ReadNdefRecord_Phone()

UFR_STATUS DL_API ReadNdefRecord_Phone ( OUT char * phone_number)

Reads NDEF phone number from card.

Parameters
phone_numberPointer to char array containing phone number
Returns
Operation status

◆ ReadNdefRecord_SMS()

UFR_STATUS DL_API ReadNdefRecord_SMS ( OUT char * phone_number,
OUT char * message )

Reads NDEF phone number and message from card.

Parameters
phone_numberPointer to char array containing phone number
messagePointer to char array containing message
Returns
Operation status

◆ ReadNdefRecord_BT()

UFR_STATUS DL_API ReadNdefRecord_BT ( OUT char * bt_mac_address)

Reads NDEF Bluetooth MAC address for pairing from card.

Parameters
bt_mac_addressPointer to char array containing Bluetooth MAC address
Returns
Operation status

◆ ParseNdefMessage()

c_string DL_API ParseNdefMessage ( IN uint8_t * type_record,
uint8_t type_len,
IN uint8_t * payload,
uint32_t payload_len )

Used to parse NDEF record into separate parameters

Parameters
type_recordpointer to the array containing record type
type_lenlength of the record type
payloadpointer to the array containing record payload
payload_lenlength of the record payload
Returns
Operation status