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@9:9f2e2e68d695, 2016-01-14 (annotated)

Committer:
giovannivisentini
Date:
Thu Jan 14 07:54:59 2016 +0000
Revision:
9:9f2e2e68d695
Parent:
7:19fc04b8fec6
Child:
19:0b65a5813059
update documentation 3

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