X-NUCLEO-NFC01A1 Dynamic NFC Tag Expansion Board Firmware Package

Introduction

This firmware package includes Components Device Drivers, Board Support Package and example applications for STMicroelectronics X-NUCLEO-NFC01A1 Dynamic NFC Tag Expansion Board based on M24SR.

Firmware Library

Class X_NUCLEO_NFC01A1 is intended to represent the Dynamic NFC Tag Expansion Board with the same name.
It provides an API to access to the M24SR component and to the three onboard LEDs.
It is intentionally implemented as a singleton because only one X_NUCLEO_NFC01A1 at a time might be deployed in a HW component stack.
The library also provides an implementation of the NDEF library API for M24SR, providing an simple way to read/write NDEF formatted messages from/to the M24SR dynamic NFC tag.

Example applications

1. Hello World
2. Asynchronous Hello World

Diff: m24sr/NDefNfcTagM24SR.h

Revision:: 8:5e637c71cbb3
Parent:: 7:19fc04b8fec6
Child:: 9:9f2e2e68d695
Child:: 11:a798ebea69fa

--- a/m24sr/NDefNfcTagM24SR.h	Mon Jan 11 12:37:28 2016 +0000
+++ b/m24sr/NDefNfcTagM24SR.h	Mon Jan 11 13:06:23 2016 +0000
@@ -42,14 +42,12 @@
 class M24SR;
 
 /**
- * implement the abstract method for use the NDefLib,
- * all method must be called after opening a session
- */
+ * implement the abstract method for use the NDefLib */
 class NDefNfcTagM24SR: public NDefLib::NDefNfcTag {
 
 public:
 	/**
-	 *
+	 * create the object
 	 * @param device device where write the Ndef tags
 	 */
 	NDefNfcTagM24SR(M24SR &device) :
@@ -57,7 +55,19 @@
 					0xFF) {
 	}
 
+	/**
+	 * open the communication with the nfc tag
+	 * \par when override this method call this implementation as last action for set the session opened
+	 * @param force force to open a communication
+	 * @return true if success
+	 */
 	virtual bool openSession(bool force = false);
+	
+	/**
+	 * close the communication with the nfc tag
+	 * \par when override this method call this implementation as last action for set the session closed
+	 * @return true if success
+	 */
 	virtual bool closeSession();
 
 	/**
@@ -71,7 +81,23 @@
 	
 
 protected:
+	
+	/**
+	 * write a sequence of byte in the NDEF file
+	 * @param buffer buffer to write
+	 * @param length number of byte to write
+	 * @param offset offset where start to write
+	 * @return true if success
+	 */
 	virtual bool writeByte(const uint8_t *buffer, const uint16_t length, uint16_t offset);
+	
+	/**
+	 * read a sequence of byte from the NDEF file
+	 * @param byteOffset offset were start read
+	 * @param byteLength number of byte to read
+	 * @param[out] buffer buffer where store the data read
+	 * @return true if success
+	 */
 	virtual bool readByte(const uint16_t byteOffset, const uint16_t byteLength,
 			uint8_t *buffer);