X_NUCLEO_NFC02A1 library for M24LR

Dependencies:   ST_INTERFACES

Dependents:   HelloWorld_NFC02A1_mbedOS HelloWorld_NFC02A1laatste HelloWorld_NFC02A1

Fork of X_NUCLEO_NFC02A1 by ST Expansion SW Team

Embed: (wiki syntax)

« Back to documentation index

NDefNfcTagM24LR Class Reference

NDefNfcTagM24LR Class Reference

Helper class to use the NDefLib. More...

#include <NDefNfcTagM24LR.h>

Public Member Functions

 NDefNfcTagM24LR (Nfc &device)
virtual bool open_session (bool force=false)
 This functions opens a session.
virtual bool close_session ()
 This functions closes a session.
virtual ~NDefNfcTagM24LR ()
 Close the open session.

Protected Member Functions

virtual bool writeByte (const uint8_t *buffer, uint16_t length, uint16_t offset, byteOperationCallback_t callback, CallbackStatus_t *callbackStatus)
 This functions writes bytes.
virtual bool readByte (const uint16_t byteOffset, const uint16_t byteLength, uint8_t *buffer, byteOperationCallback_t callback, CallbackStatus_t *callbackStatus)
 This functions reads bytes.

Detailed Description

Helper class to use the NDefLib.

Definition at line 60 of file NDefNfcTagM24LR.h.


Constructor & Destructor Documentation

NDefNfcTagM24LR ( Nfc &  device )
Parameters:
devicedevice to use

Definition at line 68 of file NDefNfcTagM24LR.h.

virtual ~NDefNfcTagM24LR (  ) [virtual]

Close the open session.

Definition at line 84 of file NDefNfcTagM24LR.h.


Member Function Documentation

bool close_session (  ) [virtual]

This functions closes a session.

Parameters:
None.
Return values:
true.

Definition at line 434 of file NDefNfcTagM24LR.cpp.

bool open_session ( bool  force = false ) [virtual]

This functions opens a session.

Parameters:
force: force the opening.
Return values:
true.

Definition at line 411 of file NDefNfcTagM24LR.cpp.

bool readByte ( const uint16_t  byteOffset,
const uint16_t  length,
uint8_t *  buffer,
byteOperationCallback_t  callback,
CallbackStatus_t *  callbackStatus 
) [protected, virtual]

This functions reads bytes.

Parameters:
byteOffset: the offset of the buffer in bytes.
length,:the length of the buffer in bytes.
buffer: the buffer containing data.
callback: a function to call after reading data.
callbackStatus: the status of the callback.
Return values:
trueif read, false otherwise.

Definition at line 467 of file NDefNfcTagM24LR.cpp.

bool writeByte ( const uint8_t *  buffer,
uint16_t  length,
uint16_t  offset,
byteOperationCallback_t  callback,
CallbackStatus_t *  callbackStatus 
) [protected, virtual]

This functions writes bytes.

Parameters:
byffer: the buffer containing data.
length,:the length of the buffer in bytes.
offset,:the offset of the buffer in bytes.
Return values:
trueif written, false otherwise.

Definition at line 446 of file NDefNfcTagM24LR.cpp.