NFCEEPROM Class Reference

The NFC EEPROM class represents a NFC target device connected using a wired link (I2C, SPI, etc). More...

#include <NFCEEPROM.h>

Inheritance diagram for NFCEEPROM:

Data Structures
struct	Delegate
	The NFCEEPROM delegate. More...

Public Member Functions
	NFCEEPROM (NFCEEPROMDriver *driver, events::EventQueue *queue, const Span< uint8_t > &ndef_buffer)
	Construct a NFCEEPROM instance.
nfc_err_t	initialize ()
	Initialize the NFC EEPROM.
void	set_delegate (Delegate *delegate)
	Set the delegate that will receive events generated by this EEPROM.
virtual void	write_ndef_message ()
	Write a NDEF message to the target.
virtual void	read_ndef_message ()
	Read a NDEF message from the target.
virtual void	erase_ndef_message ()
	Erase the NDEF message in the target.
virtual bool	is_ndef_supported () const
	Check if this instance actually supports NDEF content.

Protected Member Functions
void	parse_ndef_message (const ac_buffer_t &buffer)
	Parse a NDEF message.
void	build_ndef_message (ac_buffer_builder_t &buffer_builder)
	Build NDEF message.
ndef_msg_t *	ndef_message ()
	Retrieve underlying NDEF message instance.

Detailed Description

The NFC EEPROM class represents a NFC target device connected using a wired link (I2C, SPI, etc).

These EEPROMs essentially provide addressable memory that can be accessed using either a wired or NFC interface.

In NFC mode these most often conform to one of the NFC tag types defined by the NFC Forum, therefore encoding NDEF data in these EEPROMs will ensure that it is understandable by a NFC reader.

Definition at line 46 of file NFCEEPROM.h.

Constructor & Destructor Documentation

NFCEEPROM()

NFCEEPROM	(	NFCEEPROMDriver *	driver,
		events::EventQueue *	queue,
		const Span< uint8_t > &	ndef_buffer
	)

Construct a NFCEEPROM instance.

Parameters

[in]	driver	a pointer to a NFCEEPROMDriver instance
[in]	queue	a pointer to the events queue to use
[in]	ndef_buffer	a bytes array used to store NDEF messages

Member Function Documentation

initialize()

nfc_err_t initialize

(

)

Initialize the NFC EEPROM.

This method must be called before any other method call.

Returns

NFC_OK, or an error.

set_delegate()

void set_delegate

(

Delegate *

delegate

)

Set the delegate that will receive events generated by this EEPROM.

Parameters

[in]

delegate

the delegate instance to use

write_ndef_message()

virtual void write_ndef_message ( )

virtual

Write a NDEF message to the target.

on_ndef_message_written() will be called on completion.

Implements NFCTarget.

read_ndef_message()

virtual void read_ndef_message ( )

virtual

Read a NDEF message from the target.

on_ndef_message_read() will be called on completion.

Implements NFCTarget.

erase_ndef_message()

virtual void erase_ndef_message ( )

virtual

Erase the NDEF message in the target.

on_ndef_message_erased() will be called on completion.

Implements NFCTarget.

is_ndef_supported()

virtual bool is_ndef_supported ( ) const

virtualinherited

Check if this instance actually supports NDEF content.

Returns

whether NDEF content is supported

Reimplemented in Type4RemoteInitiator.

Definition at line 56 of file NFCNDEFCapable.h.

parse_ndef_message()

void parse_ndef_message ( const ac_buffer_t &  buffer )

protectedinherited

Parse a NDEF message.

Parameters

[in]

buffer

a buffer containing a NDEF message

build_ndef_message()

void build_ndef_message ( ac_buffer_builder_t &  buffer_builder )

protectedinherited

Build NDEF message.

Parameters

[in,out]

buffer_builder

a buffer builder in which to create the NDEF message. The backing buffer is guaranteed to be continuous.

ndef_message()

ndef_msg_t * ndef_message ( )

protectedinherited

Retrieve underlying NDEF message instance.

Returns

pointer to NDEF message instance