Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more
Fork of
NDefLib
by 
ST Expansion SW Team
NDEF NFC library
This library provides an abstract API to create NDEF formatted messages and records and to read/write them from/to a Type4 NFC Tag.
Implementations
At the moment, the NDEF API is implemented by X_NUCLEO_NFC01A1 and X_NUCLEO_NFC02A1 Dynamic NFC Tag libraries respectively driving the X-NUCLEO-NFC01A1 and X-NUCLEO-NFC02A1 boards.
Revision 15:01fc5a4b8366, committed 2016-02-01
- Comitter:
- giovannivisentini
- Date:
- Mon Feb 01 15:33:11 2016 +0000
- Parent:
- 14:ba0c186ae6d6
- Child:
- 16:030e7ffdf512
- Commit message:
- rename setCallback and update docs
Changed in this revision
| Message.h | Show annotated file Show diff for this revision Revisions of this file |
| NDefNfcTag.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/Message.h Thu Jan 28 14:01:07 2016 +0000
+++ b/Message.h Mon Feb 01 15:33:11 2016 +0000
@@ -71,7 +71,7 @@
* @param index Record index.
* @return a Record object if present, otherwise NULL
*/
- Record* operator[](const uint32_t index){
+ Record* operator[](const uint32_t index)const{
if (index >= mRecords.size())
return NULL;
return mRecords[index];
--- a/NDefNfcTag.h Thu Jan 28 14:01:07 2016 +0000
+++ b/NDefNfcTag.h Mon Feb 01 15:33:11 2016 +0000
@@ -1,6 +1,6 @@
/**
******************************************************************************
- * @file Type4NfcTag.h
+ * @file NDefNfcTag.h
* @author ST / Central Labs
* @version V1.0.0
* @date 21 Jan 2016
@@ -46,7 +46,7 @@
/**
* Abstract class used to write/read NDef messages to/from a nfc tag.
* This class is made for handle also asynchronous communication with the nfc component.
- * All the function in this class will return immediately, when the operation end a proper callback function will
+ * All the function in this class will return immediately, when a command end a proper callback function will
* be called.
*/
class NDefNfcTag {
@@ -123,7 +123,7 @@
* Set the callback.
* @param c object contains the callback.
*/
- void setCallBack(Callback *c){
+ void setCallback(Callback *c){
mCallBack=c;
}//setCallBack
@@ -248,11 +248,11 @@
Callback mDefaultCallBack;
/**
- * function that the user will call when a write end, it will invoke onMessageWrite
- * @param internalState object that invoke the write operation
- * @param status true if the operation had success
- * @param buffer buffer wrote
- * @param length number of byte wrote
+ * Function that the user will call when a write end, it will invoke onMessageWrite
+ * @param internalState Object that invoke the write operation.
+ * @param status True if the operation had success.
+ * @param buffer Buffer wrote.
+ * @param length Number of byte wrote.
* @return true if the write had success
*/
static bool onWriteMessageCallback(CallbackStatus_t *internalState,
@@ -265,12 +265,12 @@
}
/**
- * function that the use will call after a read operation.
+ * Function that the use will call after a read operation.
* in this case we read the message length, this function will read all the message
- * @param internalState object that invoke the write operation
- * @param status true if the operation had success
- * @param buffer buffer read
- * @param length number of byte read
+ * @param internalState Object that invoke the write operation.
+ * @param status true If the operation had success.
+ * @param buffer Buffer read.
+ * @param length Number of byte read.
* @return true if the read had success
*/
static bool onReadMessageLength(CallbackStatus_t *internalState,
@@ -299,11 +299,11 @@
/**
- * function that the user will call when it read all the message
- * @param internalState object that invoke the write operation
- * @param status true if the operation had success
- * @param buffer buffer read
- * @param length number of byte read
+ * Function that the user will call when it read all the message
+ * @param internalState Object that invoke the write operation.
+ * @param status True if the operation had success.
+ * @param buffer Buffer read.
+ * @param length Number of byte read.
* @return true if the read had success
*/
static bool onReadMessageCallback(CallbackStatus_t *internalState,