ST / X_NUCLEO_NFC01A1

Firmware library for the X-NUCLEO-NFC01A1 Dynamic NFC Tag board.

Dependencies:   M24SR

Dependents:   NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more

Fork of X_NUCLEO_NFC01A1 by ST Expansion SW Team

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

Files at this revision

API Documentation at this revision

Revision 1:15d4a123ef6b, committed 2015-12-03

Comitter:
giovannivisentini
Date:
Thu Dec 03 14:56:13 2015 +0000
Parent:
0:969a2be49f41
Child:
2:35b4626e5305
Commit message:
Add License

Changed in this revision

Type4NfcTagSTM24SR.cpp Show annotated file Show diff for this revision Revisions of this file
Type4NfcTagSTM24SR.h Show annotated file Show diff for this revision Revisions of this file
X_NUCLEO_NFC01A1.cpp Show annotated file Show diff for this revision Revisions of this file
X_NUCLEO_NFC01A1.h Show annotated file Show diff for this revision Revisions of this file
m24sr/m24sr_class.cpp Show annotated file Show diff for this revision Revisions of this file
m24sr/m24sr_class.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Type4NfcTagSTM24SR.cpp	Thu Dec 03 13:44:06 2015 +0000
+++ b/Type4NfcTagSTM24SR.cpp	Thu Dec 03 14:56:13 2015 +0000
@@ -1,9 +1,36 @@
-/*
- * Type4NfcTagSTM24SR.cpp
- *
- *  Created on: Nov 5, 2015
- *      Author: giovanni visentini
- */
+/**
+  ******************************************************************************
+  * @file       Type4NfcTagSTM24SR.cpp
+  * @date       05/11/2015
+  * @brief      wrapper class for use the NDefLib library for write/read ndef message
+  ******************************************************************************
+  *
+  * COPYRIGHT(c) 2015 STMicroelectronics
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of STMicroelectronics nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
 
 #include <Type4NfcTagSTM24SR.h>
 

--- a/Type4NfcTagSTM24SR.h	Thu Dec 03 13:44:06 2015 +0000
+++ b/Type4NfcTagSTM24SR.h	Thu Dec 03 14:56:13 2015 +0000
@@ -1,9 +1,36 @@
-/*
- * Type4NfcTagSTM24SR.h
- *
- *  Created on: Nov 5, 2015
- *      Author: giovanni visentini
- */
+/**
+  ******************************************************************************
+  * @file       Type4NfcTagSTM24SR.h
+  * @date       05/11/2015
+  * @brief      wrapper class for use the NDefLib library for write/read ndef message
+  ******************************************************************************
+  *
+  * COPYRIGHT(c) 2015 STMicroelectronics
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of STMicroelectronics nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
 
 #ifndef TYPE4NFCTAGSTM24SR_H_
 #define TYPE4NFCTAGSTM24SR_H_

--- a/X_NUCLEO_NFC01A1.cpp	Thu Dec 03 13:44:06 2015 +0000
+++ b/X_NUCLEO_NFC01A1.cpp	Thu Dec 03 14:56:13 2015 +0000
@@ -1,9 +1,37 @@
-/*
- * X_NUCLEO_NFC01A1.cpp
- *
- *  Created on: Nov 5, 2015
- *      Author: giovanni visentini
- */
+/**
+  ******************************************************************************
+  * @file       X_NUCLEO_NFC01A1.h
+  * @date       05/11/2015
+  * @brief      singleton class that controls all the electronics inside the 
+  * 			X_NUCLEO_NFC01A1 expansion board
+  ******************************************************************************
+  *
+  * COPYRIGHT(c) 2015 STMicroelectronics
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of STMicroelectronics nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
 
 #include <X_NUCLEO_NFC01A1.h>
 

--- a/X_NUCLEO_NFC01A1.h	Thu Dec 03 13:44:06 2015 +0000
+++ b/X_NUCLEO_NFC01A1.h	Thu Dec 03 14:56:13 2015 +0000
@@ -1,9 +1,37 @@
-/*
- * X_NUCLEO_NFC01A1.h
- *
- *  Created on: Nov 5, 2015
- *      Author: giovanni visentini
- */
+/**
+  ******************************************************************************
+  * @file       X_NUCLEO_NFC01A1.h
+  * @date       05/11/2015
+  * @brief      singleton class that controls all the electronics inside the 
+  * 			X_NUCLEO_NFC01A1 expansion board
+  ******************************************************************************
+  *
+  * COPYRIGHT(c) 2015 STMicroelectronics
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of STMicroelectronics nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
 
 #ifndef X_NUCLEO_NFC01A1_H_
 #define X_NUCLEO_NFC01A1_H_
@@ -43,7 +71,6 @@
 	 * @param led2Name pin for control the led1 status
 	 * @param led3Name pin for control the led1 status
 	 */
-	//TODO FIX all this the pin name?
 	X_NUCLEO_NFC01A1(I2C &devI2C) :
 			mM24SR(M24SR_ADDR, devI2C, GPO_PIN, RF_DISABLE_PIN), mNfcLed1(
 					LED1_PIN), mNfcLed2(LED2_PIN), mNfcLed3(LED3_PIN) {	}

--- a/m24sr/m24sr_class.cpp	Thu Dec 03 13:44:06 2015 +0000
+++ b/m24sr/m24sr_class.cpp	Thu Dec 03 14:56:13 2015 +0000
@@ -1,9 +1,7 @@
 /**
  ******************************************************************************
  * @file    m24sr_class.cpp
- * @author  MMY Application Team
- * @version V1.2.0
- * @date    20-October-2014
+ * @date    05/11/2015
  * @brief   This file provides a set of functions to interface with the M24SR
  *          device.
  ******************************************************************************

--- a/m24sr/m24sr_class.h	Thu Dec 03 13:44:06 2015 +0000
+++ b/m24sr/m24sr_class.h	Thu Dec 03 14:56:13 2015 +0000
@@ -1,15 +1,13 @@
 /**
  ******************************************************************************
  * @file    m24sr_class.h
- * @author  MMY Application Team
- * @version V1.2.0
- * @date    20-October-2014
+ * @date    05/11/2015
  * @brief   This file provides a set of functions to interface with the M24SR
  *          device.
  ******************************************************************************
  * @attention
  *
- * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
+ * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
  *
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met: