Generic NDEF Operation API

Collaboration diagram for Generic NDEF Operation API:

Data Structures
struct	ptxNDEF_InitParams
	NDEF OP Initialization Parameters. More...
struct	ptxNDEF
	Generic NDEF OP Component. More...

Typedefs
typedef enum ptxNDEF_T5T_Modes	ptxNDEF_T5T_Modes_t
	T5T communication mode.
typedef struct ptxNDEF_InitParams	ptxNDEF_InitParams_t
	NDEF OP Initialization Parameters.
typedef struct ptxNDEF	ptxNDEF_t
	Generic NDEF OP Component.

Enumerations
enum	ptxNDEF_T5T_Modes { ptxNDEF_T5T_Mode_None , ptxNDEF_T5T_Mode_Addressed , ptxNDEF_T5T_Mode_Selected }
	T5T communication mode. More...

Functions
ptxStatus_t	ptxNDEF_Open (ptxNDEF_t *ndefComp, ptxNDEF_InitParams_t *initParams)
	Initialize / Open the NDEF OP Component.
ptxStatus_t	ptxNDEF_FormatTag (ptxNDEF_t *ndefComp)
	Formats a given Tag to INITIALIZED state.
ptxStatus_t	ptxNDEF_CheckMessage (ptxNDEF_t *ndefComp)
	Checks if a NDEF-message is present on the given Tag (or not).
ptxStatus_t	ptxNDEF_ReadMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.
ptxStatus_t	ptxNDEF_WriteMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.
ptxStatus_t	ptxNDEF_LockTag (ptxNDEF_t *ndefComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
ptxStatus_t	ptxNDEF_Close (ptxNDEF_t *ndefComp)
	Unitialize / Close the NDEF OP Component.

Detailed Description

Enumeration Type Documentation

ptxNDEF_T5T_Modes

enum ptxNDEF_T5T_Modes

T5T communication mode.

Enumerator
ptxNDEF_T5T_Mode_None	ptxNDEF_T5T_Mode_None
ptxNDEF_T5T_Mode_Addressed	ptxNDEF_T5T_Mode_Addressed
ptxNDEF_T5T_Mode_Selected	ptxNDEF_T5T_Mode_Selected

Function Documentation

ptxNDEF_CheckMessage()

ptxStatus_t ptxNDEF_CheckMessage

(

ptxNDEF_t *

ndefComp

)

Checks if a NDEF-message is present on the given Tag (or not).

Parameters

[in]

ndefComp

Pointer to an initialized instance of the NDEF-OP component.

Returns

Status, indicating whether the operation was successful.

ptxNDEF_Close()

ptxStatus_t ptxNDEF_Close

(

ptxNDEF_t *

ndefComp

)

Unitialize / Close the NDEF OP Component.

Parameters

[in]

ndefComp

Pointer to an initialized instance of the NDEF-OP component.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNDEF_FormatTag()

ptxStatus_t ptxNDEF_FormatTag

(

ptxNDEF_t *

ndefComp

)

Formats a given Tag to INITIALIZED state.

Parameters

[in]

ndefComp

Pointer to an initialized instance of the NDEF-OP component.

Returns

Status, indicating whether the operation was successful.

ptxNDEF_LockTag()

ptxStatus_t ptxNDEF_LockTag

(

ptxNDEF_t *

ndefComp

)

Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).

Parameters

[in]

ndefComp

Pointer to an initialized instance of the NDEF-OP component.

Returns

Status, indicating whether the operation was successful.

ptxNDEF_Open()

ptxStatus_t ptxNDEF_Open	(	ptxNDEF_t *	ndefComp,
		ptxNDEF_InitParams_t *	initParams )

Initialize / Open the NDEF OP Component.

Parameters

[in]	ndefComp	Pointer to an allocated instance of the NDEF-OP component.
[in]	initParams	Pointer to initialization parameters.

Returns

Status, indicating whether the operation was successful.

ptxNDEF_ReadMessage()

ptxStatus_t ptxNDEF_ReadMessage	(	ptxNDEF_t *	ndefComp,
		uint8_t *	msgBuffer,
		uint32_t *	msgLen )

Reads a NDEF-message from a given Tag.

Parameters

[in]	ndefComp	Pointer to an initialized instance of the NDEF-OP component.
[in]	msgBuffer	Pointer to buffer holding the read NDEF-message.
[in,out]	msgLen	Size of the buffer (in), Length of the read NDEF-message (out).

Returns

Status, indicating whether the operation was successful.

ptxNDEF_WriteMessage()

ptxStatus_t ptxNDEF_WriteMessage	(	ptxNDEF_t *	ndefComp,
		uint8_t *	msgBuffer,
		uint32_t	msgLen )

Writes a NDEF-message onto a given Tag.

Parameters

[in]	ndefComp	Pointer to an initialized instance of the NDEF-OP component.
[in]	msgBuffer	Pointer to buffer holding the NDEF-message to write.
[in]	msgLen	Size of NDEF-message.

Returns

Status, indicating whether the operation was successful.