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

Embed: (wiki syntax)

« Back to documentation index

XNucleoNFC01A1 Class Reference
Public Member Functions | Static Public Member Functions | Static Public Attributes

XNucleoNFC01A1 Class Reference

Singleton class that controls all the electronics inside the XNucleoNFC01A1 expansion board. More...

#include <XNucleoNFC01A1.h>

Public Member Functions

DigitalOut & get_led1 ()
DigitalOut & get_led2 ()
DigitalOut & get_led3 ()
M24SR & get_M24SR ()

Static Public Member Functions

static XNucleoNFC01A1 * instance (I2C &devI2C, M24SR::gpoEventCallback eventCallback=NULL, const PinName &gpoName=DEFAULT_GPO_PIN, const PinName &RFDisableName=DEFAULT_RF_DISABLE_PIN, const PinName &led1Name=DEFAULT_LED1_PIN, const PinName &led2Name=DEFAULT_LED2_PIN, const PinName &led3Name=DEFAULT_LED3_PIN)
 Create or return an instance of XNucleoNFC01A1.

Static Public Attributes

static const PinName DEFAULT_SDA_PIN = D14
 Default pin used for the M24SR SDA signal.
static const PinName DEFAULT_SDL_PIN = D15
 Default pin used for the M24SR SDL signal.
static const PinName DEFAULT_GPO_PIN = D12
 Default pin used for the M24SR GPO signal.
static const PinName DEFAULT_RF_DISABLE_PIN = D11
 Default pin used for M24SR RF_DISABLE signal.
static const PinName DEFAULT_LED1_PIN = D5
 Default pin to control the led 1.
static const PinName DEFAULT_LED2_PIN = D4
 Default pin to control the led 2.
static const PinName DEFAULT_LED3_PIN = D2
 Default pin to control the led 3.

Detailed Description

Singleton class that controls all the electronics inside the XNucleoNFC01A1 expansion board.

Definition at line 50 of file XNucleoNFC01A1.h.

Member Function Documentation

DigitalOut& get_led1 (  )
Returns:
board led1.

Definition at line 111 of file XNucleoNFC01A1.h.

DigitalOut& get_led2 (  )
Returns:
board led2.

Definition at line 118 of file XNucleoNFC01A1.h.

DigitalOut& get_led3 (  )
Returns:
board led3.

Definition at line 125 of file XNucleoNFC01A1.h.

M24SR& get_M24SR (  )
Returns:
NFC Chip.

Definition at line 132 of file XNucleoNFC01A1.h.

XNucleoNFC01A1 * instance ( I2C &  devI2C,
M24SR::gpoEventCallback  eventCallback = NULL,
const PinName &  gpoName = DEFAULT_GPO_PIN,
const PinName &  RFDisableName = DEFAULT_RF_DISABLE_PIN,
const PinName &  led1Name = DEFAULT_LED1_PIN,
const PinName &  led2Name = DEFAULT_LED2_PIN,
const PinName &  led3Name = DEFAULT_LED3_PIN 
) [static]

Create or return an instance of XNucleoNFC01A1.

Parameters:
devI2CI2C channel used to communicate with the board.
eventCallbackFunction that will be called when the gpo pin status change.
gpoNameName of the gpio pin of the M24SR chip.
RFDisableNamePin that controls the rf antenna status.
led1NamePin to control the led1 status.
led2NamePin to control the led1 status.
led3NamePin to control the led1 status.

Definition at line 52 of file XNucleoNFC01A1.cpp.

Field Documentation

const PinName DEFAULT_GPO_PIN = D12 [static]

Default pin used for the M24SR GPO signal.

Definition at line 84 of file XNucleoNFC01A1.h.

const PinName DEFAULT_LED1_PIN = D5 [static]

Default pin to control the led 1.

Definition at line 86 of file XNucleoNFC01A1.h.

const PinName DEFAULT_LED2_PIN = D4 [static]

Default pin to control the led 2.

Definition at line 87 of file XNucleoNFC01A1.h.

const PinName DEFAULT_LED3_PIN = D2 [static]

Default pin to control the led 3.

Definition at line 88 of file XNucleoNFC01A1.h.

const PinName DEFAULT_RF_DISABLE_PIN = D11 [static]

Default pin used for M24SR RF_DISABLE signal.

Definition at line 85 of file XNucleoNFC01A1.h.

const PinName DEFAULT_SDA_PIN = D14 [static]

Default pin used for the M24SR SDA signal.

Definition at line 82 of file XNucleoNFC01A1.h.

const PinName DEFAULT_SDL_PIN = D15 [static]

Default pin used for the M24SR SDL signal.

Definition at line 83 of file XNucleoNFC01A1.h.

Generated on Tue Jul 12 2022 14:09:53 by  doxygen 1.7.2