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: Interfaces/Nfc_class.h

Revision:: 7:19fc04b8fec6
Parent:: 6:96389fb79676
Child:: 8:5e637c71cbb3

--- a/Interfaces/Nfc_class.h	Tue Dec 22 15:34:24 2015 +0000
+++ b/Interfaces/Nfc_class.h	Mon Jan 11 12:37:28 2016 +0000
@@ -75,38 +75,38 @@
 	virtual NFC_StatusTypeDef GetSession(void) = 0;
 	/**
 	 * force to open an i2c connection , abort the RF connection
-	 * @return
+	 * @return NFC_SUCCESS if the session is acquired
 	 */
 	virtual NFC_StatusTypeDef KillSession(void) = 0;
 
 	/**
 	 * close an i2c connection
-	 * @return
+	 * @return NFC_SUCCESS if the session is release
 	 */
 	virtual NFC_StatusTypeDef Deselect(void) = 0;
 
 	/**
 	 * Select the application file
-	 * @return
+	 * @return NFC_SUCCESS if the application is selected
 	 */
 	virtual NFC_StatusTypeDef SelectApplication(void) = 0;
 
 	/**
 	 * select the CC file
-	 * @return
+	 * @return NFC_SUCCESS if the cc file is selected
 	 */
 	virtual NFC_StatusTypeDef SelectCCfile(void) = 0;
 
 	/**
 	 * select the ndef file
 	 * @param NDEFfileId file id to open
-	 * @return
+	 * @return NFC_SUCCESS if the file is selected
 	 */
 	virtual NFC_StatusTypeDef SelectNDEFfile(uint16_t NDEFfileId) = 0;
 
 	/**
 	 * select the system file
-	 * @return
+	 * @return NFC_SUCCESS if the system file is selected
 	 */
 	virtual NFC_StatusTypeDef SelectSystemfile(void) = 0;
 
@@ -115,7 +115,7 @@
 	 * @param Offset offset where start to read
 	 * @param NbByteToRead number of byte to read
 	 * @param[out] pBufferRead buffer where store the read data
-	 * @return
+	 * @return NFC_SUCCESS if no error happen
 	 */
 	virtual NFC_StatusTypeDef ReadBinary(uint16_t Offset, uint8_t NbByteToRead, uint8_t *pBufferRead) = 0;
 
@@ -124,7 +124,7 @@
 	 * @param Offset offset where start to write
 	 * @param NbByteToWrite number of byte to write
 	 * @param pDataToWrite buffer to write
-	 * @return
+	 * @return NFC_SUCCESS if no error happen
 	 */
 	virtual NFC_StatusTypeDef UpdateBinary(uint16_t Offset, uint8_t NbByteToWrite, uint8_t *pDataToWrite) = 0;
 
@@ -133,7 +133,7 @@
 	 * @param uPwdId password type
 	 * @param NbPwdByte password size ( must be 0x10)
 	 * @param pPwd password buffer
-	 * @return
+	 * @return NFC_SUCCESS if no error happen, and you have the permission to write/read
 	 */
 	virtual NFC_StatusTypeDef Verify(PasswordType_t uPwdId, uint8_t NbPwdByte,const uint8_t *pPwd) = 0;
 
@@ -146,12 +146,57 @@
 	virtual NFC_StatusTypeDef ChangeReferenceData(PasswordType_t uPwdId,const uint8_t *pPwd) = 0;
 	virtual NFC_StatusTypeDef EnableVerificationRequirement(PasswordType_t uReadOrWrite) = 0;
 	virtual NFC_StatusTypeDef DisableVerificationRequirement(PasswordType_t uReadOrWrite) = 0;
+	
+	/**
+	 * as {@link Nfc#ReadBinary} but it doesn't give error if you read more byte than the ones 
+	 * that are available
+	 * @param Offset offset where start to read
+	 * @param NbByteToRead number of byte to read
+	 * @param[out] pBufferRead buffer where store the read data
+	 * @return NFC_SUCCESS if no error happen
+	 */
 	virtual NFC_StatusTypeDef STReadBinary(uint16_t Offset, uint8_t NbByteToRead, uint8_t *pBufferRead) = 0;
+	
+	/**
+	 * set the tag as read/write only and write it in the eeprom
+	 * @param  uReadOrWrite ReadPwd if you need a write only, WritePwd if you need a read only
+	 * @return NFC_SUCCESS if no error happen
+	 */
 	virtual NFC_StatusTypeDef EnablePermanentState(PasswordType_t uReadOrWrite) = 0;
+	/**
+	 * unset the tag as read/write only and write it in the eeprom
+	 * @param  uReadOrWrite ReadPwd if you need a write only, WritePwd if you need a read only
+	 * @return NFC_SUCCESS if no error happen
+	 * @par you must be in i2csuper user state for call this function
+	 */
 	virtual NFC_StatusTypeDef DisablePermanentState(PasswordType_t uReadOrWrite) = 0;
+	
+	/**
+	 * set the gpo output pin
+	 * @param uSetOrReset new pin status
+ 	 * @return NFC_SUCCESS if no error happen
+	 */
 	virtual NFC_StatusTypeDef StateControl(uint8_t uSetOrReset) = 0;
+	
+	/**
+	 * @brief  This function configure GPO purpose for I2C session
+	 * @param	GPO_I2Cconfig: GPO configuration to set
+ 	 * @return NFC_SUCCESS if no error happen
+	 */
 	virtual NFC_StatusTypeDef ManageI2CGPO(uint8_t GPO_I2Cconfig) = 0;
+	
+	/**
+ 	* @brief  This function configure GPO purpose for RF session
+ 	* @param	GPO_RFconfig: GPO configuration to set
+  	* @return NFC_SUCCESS if no error happen
+ 	*/
 	virtual NFC_StatusTypeDef ManageRFGPO(uint8_t GPO_RFconfig) = 0;
+	
+	/**
+	 * @brief  This function enable or disable RF communication
+	 * @param	OnOffChoice: GPO configuration to set
+  	 * @return NFC_SUCCESS if no error happen
+	 */
 	virtual NFC_StatusTypeDef RFConfig(uint8_t OnOffChoice) = 0;
 
 	virtual ~Nfc(){};