ST Americas mbed Team / lib_NFC_NDEF

Dependents:   Nucleo_NFC_Example I2C_NFC_Master Print_Entire_Nucleo_NFC01A1_Memory

Fork of lib_NDEF by Enrico Gregoratto

Embed: (wiki syntax)

« Back to documentation index

LibTT4_Public_Functions

LibTT4_Public_Functions
[LibNFC_FORUM]

This file is used to access tag type 4. More...

Functions

uint16_t TT4_Init (void)
 This fonction initialize Tag Type 4.
uint16_t TT4_ReadNDEF (uint8_t *pNDEF)
 This fonction read NDEF file.
uint16_t TT4_WriteNDEF (uint8_t *pNDEF)
 This fonction write NDEF file.
uint16_t TT4_ReadURI (sURI_Info *pURI)
 This fonction read NDEF file if NDEF is identified as URI.
uint16_t TT4_WriteURI (sURI_Info *pURI)
 This fonction write NDEF file from data given in the URI structure.
uint16_t TT4_ReadSMS (sSMSInfo *pSMS)
 This fonction read NDEF file if NDEF is identified as SMS.
uint16_t TT4_WriteSMS (sSMSInfo *pSMS)
 This fonction write NDEF file from data given in the SMS structure.
uint16_t TT4_ReadEmail (sEmailInfo *pEmailStruct)
 This fonction read NDEF file if NDEF is identified as eMail.
uint16_t TT4_WriteEmail (sEmailInfo *pEmailStruct)
 This fonction write NDEF file from data given in the eMail structure.
uint16_t TT4_ReadVcard (sVcardInfo *pVcard)
 This fonction read NDEF file if NDEF is identified as Vcard.
uint16_t TT4_WriteVcard (sVcardInfo *pVcard)
 This fonction write NDEF file from data given in the Vcard structure.
uint16_t TT4_ReadGeo (sGeoInfo *pGeo)
 This fonction read NDEF file if NDEF is identified as geolocation information.
uint16_t TT4_WriteGeo (sGeoInfo *pGeo)
 This fonction write NDEF file from data given in the geo structure.
uint16_t TT4_ReadMyApp (sMyAppInfo *pMyAppStruct)
 This fonction read NDEF file if NDEF is identified as expected private application.
uint16_t TT4_WriteMyApp (sMyAppInfo *pMyAppStruct)
 This fonction write NDEF file from data given in the structure.
uint16_t TT4_AddAAR (sAARInfo *pAAR)
 This fonction add AAR (Android Application Record) in the tag.

Detailed Description

This file is used to access tag type 4.


Function Documentation

uint16_t TT4_AddAAR ( sAARInfo *  pAAR )

This fonction add AAR (Android Application Record) in the tag.

Parameters:
pAAR: pointer on structure that contain AAR information
Return values:
SUCCESS: AAR added
ERROR: Not able to add AAR

Definition at line 455 of file lib_TagType4.c.

uint16_t TT4_Init ( void   )

This fonction initialize Tag Type 4.

Parameters:
None
Return values:
SUCCESS: Initialization done

Definition at line 80 of file lib_TagType4.c.

uint16_t TT4_ReadEmail ( sEmailInfo *  pEmailStruct )

This fonction read NDEF file if NDEF is identified as eMail.

Parameters:
pEmailStruct: pointer on eMail structure to fill with read data
Return values:
SUCCESS: eMail structure has been updated
ERROR: Not able to fill eMail structure

Definition at line 256 of file lib_TagType4.c.

uint16_t TT4_ReadGeo ( sGeoInfo *  pGeo )

This fonction read NDEF file if NDEF is identified as geolocation information.

Parameters:
pGeo: pointer on geo structure to fill with read data
Return values:
SUCCESS: geo structure has been updated
ERROR: Not able to fill geo structure

Definition at line 356 of file lib_TagType4.c.

uint16_t TT4_ReadMyApp ( sMyAppInfo *  pMyAppStruct )

This fonction read NDEF file if NDEF is identified as expected private application.

Parameters:
pMyAppStruct: pointer on structure to fill with read data
Return values:
SUCCESS: structure has been updated
ERROR: Not able to fill structure

Definition at line 405 of file lib_TagType4.c.

uint16_t TT4_ReadNDEF ( uint8_t *  pNDEF )

This fonction read NDEF file.

Parameters:
pNDEF: pointer on buffer to fill with NDEF data
Return values:
SUCCESS: NDEF file data have been retrieve
ERROR: Not able to get NDEF file data

Definition at line 113 of file lib_TagType4.c.

uint16_t TT4_ReadSMS ( sSMSInfo *  pSMS )

This fonction read NDEF file if NDEF is identified as SMS.

Parameters:
pSMS: pointer on SMS structure to fill with read data
Return values:
SUCCESS: SMS structure has been updated
ERROR: Not able to fill MS structure

Definition at line 207 of file lib_TagType4.c.

uint16_t TT4_ReadURI ( sURI_Info *  pURI )

This fonction read NDEF file if NDEF is identified as URI.

Parameters:
pURI: pointer on URI structure to fill with read data
Return values:
SUCCESS: URI structure has been updated
ERROR: Not able to fill URI structure

Definition at line 157 of file lib_TagType4.c.

uint16_t TT4_ReadVcard ( sVcardInfo *  pVcard )

This fonction read NDEF file if NDEF is identified as Vcard.

Parameters:
pVcard: pointer on Vcard structure to fill with read data
Return values:
SUCCESS: Vcard structure has been updated
ERROR: Not able to fill Vcard structure

Definition at line 306 of file lib_TagType4.c.

uint16_t TT4_WriteEmail ( sEmailInfo *  pEmailStruct )

This fonction write NDEF file from data given in the eMail structure.

Parameters:
pEmailStruct: pointer on eMail structure to prepare NDEF
Return values:
SUCCESS: NDEF eMail stored
ERROR: Not able to store NDEF eMail

Definition at line 284 of file lib_TagType4.c.

uint16_t TT4_WriteGeo ( sGeoInfo *  pGeo )

This fonction write NDEF file from data given in the geo structure.

Parameters:
pGeo: pointer on geo structure to prepare NDEF
Return values:
SUCCESS: NDEF geo stored
ERROR: Not able to store NDEF geo

Definition at line 383 of file lib_TagType4.c.

uint16_t TT4_WriteMyApp ( sMyAppInfo *  pMyAppStruct )

This fonction write NDEF file from data given in the structure.

Parameters:
pMyAppStruct: pointer on structure to prepare NDEF
Return values:
SUCCESS: NDEF stored
ERROR: Not able to store NDEF

Definition at line 433 of file lib_TagType4.c.

uint16_t TT4_WriteNDEF ( uint8_t *  pNDEF )

This fonction write NDEF file.

Parameters:
pNDEF: pointer on buffer that contain the NDEF data
Return values:
SUCCESS: NDEF file data have been stored
ERROR: Not able to store NDEF file

Definition at line 135 of file lib_TagType4.c.

uint16_t TT4_WriteSMS ( sSMSInfo *  pSMS )

This fonction write NDEF file from data given in the SMS structure.

Parameters:
pSMS: pointer on SMS structure to prepare NDEF
Return values:
SUCCESS: NDEF SMS stored
ERROR: Not able to store NDEF SMS

Definition at line 234 of file lib_TagType4.c.

uint16_t TT4_WriteURI ( sURI_Info *  pURI )

This fonction write NDEF file from data given in the URI structure.

Parameters:
pURI: pointer on URI structure to prepare NDEF
Return values:
SUCCESS: NDEF URI stored
ERROR: Not able to store NDEF URI

Definition at line 185 of file lib_TagType4.c.

uint16_t TT4_WriteVcard ( sVcardInfo *  pVcard )

This fonction write NDEF file from data given in the Vcard structure.

Parameters:
pVcard: pointer on Vcard structure to prepare NDEF
Return values:
SUCCESS: NDEF Vcard stored
ERROR: Not able to store NDEF Vcard

Definition at line 334 of file lib_TagType4.c.