Official interfaces for ST components.

Dependents:   X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more

Fork of ST_INTERFACES by Davide Aliprandi

Embed: (wiki syntax)

« Back to documentation index

Nfc Class Reference

Nfc Class Reference

An abstract class for Nfc components. More...

#include <Nfc.h>

Inherits Component.

Public Member Functions

virtual int read_binary (uint16_t offset, uint8_t nb_bytes_to_read, uint8_t *p_buffer_read)=0
 Read data from the tag.
virtual int update_binary (uint16_t offset, uint8_t nb_bytes_to_write, uint8_t *p_buffer_write)=0
 Write data to the tag.
virtual ~Nfc ()
 Destructor.
virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.

Detailed Description

An abstract class for Nfc components.

Definition at line 63 of file Nfc.h.


Constructor & Destructor Documentation

virtual ~Nfc (  ) [virtual]

Destructor.

Definition at line 87 of file Nfc.h.


Member Function Documentation

virtual int init ( void *  init ) [pure virtual, inherited]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.
virtual int read_binary ( uint16_t  offset,
uint8_t  nb_bytes_to_read,
uint8_t *  p_buffer_read 
) [pure virtual]

Read data from the tag.

Parameters:
offsetRead offset.
nb_bytes_to_readNumber of bytes to read.
[out]p_buffer_readBuffer to store the read data into.
Returns:
NFC_SUCCESS if no errors
virtual int read_id ( uint8_t *  id ) [pure virtual, inherited]

Getting the ID of the component.

Parameters:
[out]idpointer to an allocated variable to store the ID into.
Return values:
0in case of success, an error code otherwise.
virtual int update_binary ( uint16_t  offset,
uint8_t  nb_bytes_to_write,
uint8_t *  p_buffer_write 
) [pure virtual]

Write data to the tag.

Parameters:
offsetWrite offset.
nb_bytes_to_writeNumber of bytes to write.
p_buffer_writeBuffer to write.
Returns:
NFC_SUCCESS if no errors