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

X_NUCLEO_NFC01A1.h@7:19fc04b8fec6, 2016-01-11 (annotated)

Committer:
giovannivisentini
Date:
Mon Jan 11 12:37:28 2016 +0000
Revision:
7:19fc04b8fec6
Parent:
6:96389fb79676
Child:
9:9f2e2e68d695
update docs

Who changed what in which revision?

UserRevisionLine numberNew contents of line
giovannivisentini 1:15d4a123ef6b 1 /**
giovannivisentini 1:15d4a123ef6b 2 ******************************************************************************
giovannivisentini 1:15d4a123ef6b 3 * @file X_NUCLEO_NFC01A1.h
giovannivisentini 6:96389fb79676 4 * @author ST Central Labs
giovannivisentini 6:96389fb79676 5 * @date 05 Nov 2015
giovannivisentini 1:15d4a123ef6b 6 * @brief singleton class that controls all the electronics inside the
giovannivisentini 1:15d4a123ef6b 7 * X_NUCLEO_NFC01A1 expansion board
giovannivisentini 1:15d4a123ef6b 8 ******************************************************************************
giovannivisentini 1:15d4a123ef6b 9 *
giovannivisentini 1:15d4a123ef6b 10 * COPYRIGHT(c) 2015 STMicroelectronics
giovannivisentini 1:15d4a123ef6b 11 *
giovannivisentini 1:15d4a123ef6b 12 * Redistribution and use in source and binary forms, with or without modification,
giovannivisentini 1:15d4a123ef6b 13 * are permitted provided that the following conditions are met:
giovannivisentini 1:15d4a123ef6b 14 * 1. Redistributions of source code must retain the above copyright notice,
giovannivisentini 1:15d4a123ef6b 15 * this list of conditions and the following disclaimer.
giovannivisentini 1:15d4a123ef6b 16 * 2. Redistributions in binary form must reproduce the above copyright notice,
giovannivisentini 1:15d4a123ef6b 17 * this list of conditions and the following disclaimer in the documentation
giovannivisentini 1:15d4a123ef6b 18 * and/or other materials provided with the distribution.
giovannivisentini 1:15d4a123ef6b 19 * 3. Neither the name of STMicroelectronics nor the names of its contributors
giovannivisentini 1:15d4a123ef6b 20 * may be used to endorse or promote products derived from this software
giovannivisentini 1:15d4a123ef6b 21 * without specific prior written permission.
giovannivisentini 1:15d4a123ef6b 22 *
giovannivisentini 1:15d4a123ef6b 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
giovannivisentini 1:15d4a123ef6b 24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
giovannivisentini 1:15d4a123ef6b 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
giovannivisentini 1:15d4a123ef6b 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
giovannivisentini 1:15d4a123ef6b 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
giovannivisentini 1:15d4a123ef6b 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
giovannivisentini 1:15d4a123ef6b 29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
giovannivisentini 1:15d4a123ef6b 30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
giovannivisentini 1:15d4a123ef6b 31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
giovannivisentini 1:15d4a123ef6b 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
giovannivisentini 1:15d4a123ef6b 33 *
giovannivisentini 1:15d4a123ef6b 34 ******************************************************************************
giovannivisentini 1:15d4a123ef6b 35 */
giovannivisentini 0:969a2be49f41 36
giovannivisentini 0:969a2be49f41 37 #ifndef X_NUCLEO_NFC01A1_H_
giovannivisentini 0:969a2be49f41 38 #define X_NUCLEO_NFC01A1_H_
giovannivisentini 0:969a2be49f41 39 #include <stdint.h>
giovannivisentini 0:969a2be49f41 40
giovannivisentini 0:969a2be49f41 41 #include "mbed.h"
giovannivisentini 0:969a2be49f41 42
giovannivisentini 0:969a2be49f41 43 #include "m24sr/m24sr_class.h"
giovannivisentini 0:969a2be49f41 44
giovannivisentini 0:969a2be49f41 45 /**
giovannivisentini 0:969a2be49f41 46 * singleton class that controls all the electronics inside the X_NUCLEO_NFC01A1 expansion board
giovannivisentini 0:969a2be49f41 47 */
giovannivisentini 0:969a2be49f41 48 class X_NUCLEO_NFC01A1 {
giovannivisentini 0:969a2be49f41 49
giovannivisentini 0:969a2be49f41 50 private:
giovannivisentini 0:969a2be49f41 51 /**
giovannivisentini 0:969a2be49f41 52 * ponter to the singleton instance, NULL if we did't build one
giovannivisentini 0:969a2be49f41 53 */
giovannivisentini 0:969a2be49f41 54 static X_NUCLEO_NFC01A1 *mInstance;
giovannivisentini 0:969a2be49f41 55 /**
giovannivisentini 0:969a2be49f41 56 * i2c address of the m24sr chip
giovannivisentini 0:969a2be49f41 57 */
giovannivisentini 0:969a2be49f41 58 static const uint8_t M24SR_ADDR;
giovannivisentini 0:969a2be49f41 59
giovannivisentini 0:969a2be49f41 60 /**
giovannivisentini 0:969a2be49f41 61 * constructor
giovannivisentini 0:969a2be49f41 62 * @param devI2C i2c channel used for communicate with the board
giovannivisentini 0:969a2be49f41 63 * @param gpoName pin of the gpio pin of the M24SR chip
giovannivisentini 0:969a2be49f41 64 * @param RFDisableName pin for disable the rf antenna
giovannivisentini 0:969a2be49f41 65 * @param led1Name pin for control the led1 status
giovannivisentini 0:969a2be49f41 66 * @param led2Name pin for control the led1 status
giovannivisentini 0:969a2be49f41 67 * @param led3Name pin for control the led1 status
giovannivisentini 0:969a2be49f41 68 */
giovannivisentini 3:fa914de381ae 69 X_NUCLEO_NFC01A1(I2C &devI2C, const PinName &gpoName,
giovannivisentini 3:fa914de381ae 70 const PinName &RFDisableName, const PinName &led1Name,
giovannivisentini 3:fa914de381ae 71 const PinName &led2Name, const PinName &led3Name):
giovannivisentini 3:fa914de381ae 72 mM24SR(M24SR_ADDR,devI2C,gpoName,RFDisableName),
giovannivisentini 3:fa914de381ae 73 mNfcLed1(led1Name),mNfcLed2(led2Name),mNfcLed3(led3Name){}
giovannivisentini 0:969a2be49f41 74
giovannivisentini 0:969a2be49f41 75 public:
giovannivisentini 7:19fc04b8fec6 76 static const PinName DEFAULT_SDA_PIN; //!< default pin used for the M24SR SDA signal
giovannivisentini 7:19fc04b8fec6 77 static const PinName DEFAULT_SDL_PIN; //!< default pin used for the M24SR SDL signal
giovannivisentini 7:19fc04b8fec6 78 static const PinName DEFAULT_GPO_PIN; //!< default pin used for the M24SR GPO signal
giovannivisentini 7:19fc04b8fec6 79 static const PinName DEFAULT_RF_DISABLE_PIN; //!< default pin used for M24SR RF_DISABLE signal
giovannivisentini 7:19fc04b8fec6 80 static const PinName DEFAULT_LED1_PIN; //!< default pin for controll the led 1
giovannivisentini 7:19fc04b8fec6 81 static const PinName DEFAULT_LED2_PIN; //!< default pin for controll the led 2
giovannivisentini 7:19fc04b8fec6 82 static const PinName DEFAULT_LED3_PIN; //!< default pin for controll the led 3
giovannivisentini 0:969a2be49f41 83
giovannivisentini 7:19fc04b8fec6 84 /**
giovannivisentini 7:19fc04b8fec6 85 * create or return an instance of X_NUCLEO_NFC01A1
giovannivisentini 7:19fc04b8fec6 86 * @param devI2C i2c channel used for communicate with the board
giovannivisentini 7:19fc04b8fec6 87 * @param gpoName pin of the gpio pin of the M24SR chip
giovannivisentini 7:19fc04b8fec6 88 * @param RFDisableName pin for disable the rf antenna
giovannivisentini 7:19fc04b8fec6 89 * @param led1Name pin for control the led1 status
giovannivisentini 7:19fc04b8fec6 90 * @param led2Name pin for control the led1 status
giovannivisentini 7:19fc04b8fec6 91 * @param led3Name pin for control the led1 status
giovannivisentini 7:19fc04b8fec6 92 */
giovannivisentini 3:fa914de381ae 93 static X_NUCLEO_NFC01A1* Instance(I2C &devI2C,
giovannivisentini 3:fa914de381ae 94 const PinName &gpoName = DEFAULT_GPO_PIN,
giovannivisentini 3:fa914de381ae 95 const PinName &RFDisableName = DEFAULT_RF_DISABLE_PIN,
giovannivisentini 3:fa914de381ae 96 const PinName &led1Name = DEFAULT_LED1_PIN,
giovannivisentini 3:fa914de381ae 97 const PinName &led2Name = DEFAULT_LED2_PIN,
giovannivisentini 3:fa914de381ae 98 const PinName &led3Name = DEFAULT_LED3_PIN);
giovannivisentini 0:969a2be49f41 99
giovannivisentini 0:969a2be49f41 100 /**
giovannivisentini 0:969a2be49f41 101 * @return board led1
giovannivisentini 0:969a2be49f41 102 */
giovannivisentini 0:969a2be49f41 103 DigitalOut& getLed1() {
giovannivisentini 0:969a2be49f41 104 return mNfcLed1;
giovannivisentini 0:969a2be49f41 105 }
giovannivisentini 0:969a2be49f41 106
giovannivisentini 0:969a2be49f41 107 /**
giovannivisentini 0:969a2be49f41 108 * @return board led2
giovannivisentini 0:969a2be49f41 109 */
giovannivisentini 0:969a2be49f41 110 DigitalOut& getLed2() {
giovannivisentini 0:969a2be49f41 111 return mNfcLed2;
giovannivisentini 0:969a2be49f41 112 }
giovannivisentini 0:969a2be49f41 113
giovannivisentini 0:969a2be49f41 114 /**
giovannivisentini 0:969a2be49f41 115 * @return board led3
giovannivisentini 0:969a2be49f41 116 */
giovannivisentini 0:969a2be49f41 117 DigitalOut& getLed3() {
giovannivisentini 0:969a2be49f41 118 return mNfcLed3;
giovannivisentini 0:969a2be49f41 119 }
giovannivisentini 0:969a2be49f41 120
giovannivisentini 0:969a2be49f41 121 /**
giovannivisentini 0:969a2be49f41 122 * @return NFC Chip
giovannivisentini 0:969a2be49f41 123 */
giovannivisentini 0:969a2be49f41 124 M24SR& getM24SR() {
giovannivisentini 0:969a2be49f41 125 return mM24SR;
giovannivisentini 0:969a2be49f41 126 }
giovannivisentini 0:969a2be49f41 127
giovannivisentini 0:969a2be49f41 128 virtual ~X_NUCLEO_NFC01A1() {
giovannivisentini 0:969a2be49f41 129 }
giovannivisentini 0:969a2be49f41 130
giovannivisentini 0:969a2be49f41 131 private:
giovannivisentini 0:969a2be49f41 132
giovannivisentini 0:969a2be49f41 133 M24SR mM24SR;
giovannivisentini 0:969a2be49f41 134 DigitalOut mNfcLed1;
giovannivisentini 0:969a2be49f41 135 DigitalOut mNfcLed2;
giovannivisentini 0:969a2be49f41 136 DigitalOut mNfcLed3;
giovannivisentini 0:969a2be49f41 137
giovannivisentini 0:969a2be49f41 138 };
giovannivisentini 0:969a2be49f41 139
giovannivisentini 0:969a2be49f41 140 #endif /* X_NUCLEO_NFC01A1_H_ */