Fork for the GitHub

Embed: (wiki syntax)

« Back to documentation index

LibSMS_Public_Functions

LibSMS_Public_Functions
[LibNFC_FORUM]

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

Functions

uint16_t NDEF_ReadSMS (sRecordInfo_t *pRecordStruct, sSMSInfo *pSMSStruct)
 This function read NDEF and retrieve SMS information if any.
uint16_t NDEF_WriteSMS (sSMSInfo *pSMSStruct, I2C *mi2cChannel)
 This function write the NDEF file with the SMS data given in the structure.
void NDEF_PrepareSMSMessage (sSMSInfo *pSMSStruct, uint8_t *pNDEFMessage, uint16_t *size)
 This function write the NDEF file with the SMS data given in the structure.

Detailed Description

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


Function Documentation

void NDEF_PrepareSMSMessage ( sSMSInfo *  pSMSStruct,
uint8_t *  pNDEFMessage,
uint16_t *  size 
)

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

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

Definition at line 223 of file lib_NDEF_SMS.cpp.

uint16_t NDEF_ReadSMS ( sRecordInfo_t *  pRecordStruct,
sSMSInfo *  pSMSStruct 
)

This function read NDEF and retrieve SMS information if any.

Parameters:
pRecordStruct: Pointer on the record structure.
pSMSStruct: pointer on the structure to fill.
Return values:
NDEF_OK: SMS information from NDEF have been retrieve.
NDEF_ERROR: Not able to retrieve SMS information.

Definition at line 155 of file lib_NDEF_SMS.cpp.

uint16_t NDEF_WriteSMS ( sSMSInfo *  pSMSStruct,
I2C *  mi2cChannel 
)

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

Parameters:
pSMSStruct: pointer on structure that contain the SMS information.
Return values:
NDEF_OK: NDEF file data written in the tag.
NDEF_ERROR: not able to store NDEF in tag.
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 206 of file lib_NDEF_SMS.cpp.