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

Committer:
giovannivisentini
Date:
2015-12-03
Revision:
0:969a2be49f41
Child:
1:15d4a123ef6b

File content as of revision 0:969a2be49f41:

/*
 * X_NUCLEO_NFC01A1.h
 *
 *  Created on: Nov 5, 2015
 *      Author: giovanni visentini
 */

#ifndef X_NUCLEO_NFC01A1_H_
#define X_NUCLEO_NFC01A1_H_
#include <stdint.h>

#include "mbed.h"

#include "m24sr/m24sr_class.h"

/**
 * singleton class that controls all the electronics inside the X_NUCLEO_NFC01A1 expansion board
 */
class X_NUCLEO_NFC01A1 {

private:
	/**
	 * ponter to the singleton instance, NULL if we did't build one
	 */
	static X_NUCLEO_NFC01A1 *mInstance;
	/**
	 * i2c address of the m24sr chip
	 */
	static const uint8_t M24SR_ADDR;

	static const PinName GPO_PIN;
	static const PinName RF_DISABLE_PIN;
	static const PinName LED1_PIN;
	static const PinName LED2_PIN;
	static const PinName LED3_PIN;

	/**
	 * constructor
	 * @param devI2C i2c channel used for communicate with the board
	 * @param gpoName pin of the gpio pin of the M24SR chip
	 * @param RFDisableName pin for disable the rf antenna
	 * @param led1Name pin for control the led1 status
	 * @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) {	}

public:
	const static PinName DEFAULT_SDA_PIN;
	const static PinName DEFAULT_SDL_PIN;

	static X_NUCLEO_NFC01A1* Instance(I2C &devI2C);

	/**
	 * @return board led1
	 */
	DigitalOut& getLed1() {
		return mNfcLed1;
	}

	/**
	 * @return board led2
	 */
	DigitalOut& getLed2() {
		return mNfcLed2;
	}

	/**
	 * @return board led3
	 */
	DigitalOut& getLed3() {
		return mNfcLed3;
	}

	/**
	 * @return NFC Chip
	 */
	M24SR& getM24SR() {
		return mM24SR;
	}

	virtual ~X_NUCLEO_NFC01A1() {
	}

private:

	M24SR mM24SR;
	DigitalOut mNfcLed1;
	DigitalOut mNfcLed2;
	DigitalOut mNfcLed3;

};

#endif /* X_NUCLEO_NFC01A1_H_ */