Fork for the GitHub

Embed: (wiki syntax)

« Back to documentation index

LibGeo_Public_Functions

LibGeo_Public_Functions
[LibNFC_FORUM]

This file is used to manage geolocation (stored or loaded in tag) More...

Functions

uint16_t NDEF_ReadGeo (sRecordInfo_t *pRecordStruct, sGeoInfo *pGeoStruct)
 This function read NDEF and retrieve Geo information if any.
uint16_t NDEF_WriteGeo (sGeoInfo *pGeoStruct, I2C *mi2cChannel)
 This function write the NDEF file with the geolocation data given in the structure.
void NDEF_PrepareGeoMessage (sGeoInfo *pGeoStruct, uint8_t *pNDEFMessage, uint16_t *size)
 This function write the NDEF file with the geolocation data given in the structure.

Detailed Description

This file is used to manage geolocation (stored or loaded in tag)


Function Documentation

void NDEF_PrepareGeoMessage ( sGeoInfo *  pGeoStruct,
uint8_t *  pNDEFMessage,
uint16_t *  size 
)

This function write the NDEF file with the geolocation data given in the structure.

Parameters:
pGeoStruct: pointer on structure that contain the geolocation information.
pNDEFMessage: pointer on the NDEF message.
size: to store the size of the NDEF message generated.

Definition at line 216 of file lib_NDEF_Geo.cpp.

uint16_t NDEF_ReadGeo ( sRecordInfo_t *  pRecordStruct,
sGeoInfo *  pGeoStruct 
)

This function read NDEF and retrieve Geo information if any.

Parameters:
pRecordStruct: Pointer on the record structure.
pGeoStruct: pointer on the structure to fill .
Return values:
NDEF_OK: Geolocation information from NDEF have been retrieved.
NDEF_ERROR: not able to read NDEF from tag.

Definition at line 149 of file lib_NDEF_Geo.cpp.

uint16_t NDEF_WriteGeo ( sGeoInfo *  pGeoStruct,
I2C *  mi2cChannel 
)

This function write the NDEF file with the geolocation data given in the structure.

Parameters:
pGeoStruct: pointer on structure that contain the geolocation information.
Return values:
NDEF_OK: the function is succesful.
NDEF_ERROR_MEMORY_INTERNAL: Cannot write to tag.
NDEF_ERROR_NOT_FORMATED: CCFile data not supported or not present.
NDEF_ERROR_MEMORY_TAG: Size not compatible with memory.
NDEF_ERROR_LOCKED: Tag locked, cannot be write.

Definition at line 199 of file lib_NDEF_Geo.cpp.