Tag Type T5T Operation API

Collaboration diagram for Tag Type T5T Operation API:

Data Structures
struct	ptxNDEF_T5TOP_InitParams
	T5T NDEF OP Initialization Parameters. More...
struct	ptxNDEF_T5TOP_CC
	T5T NDEF OP Capability Container Parameters. More...
struct	ptxNDEF_T5TOP
	T5T NDEF OP Component. More...

Typedefs
typedef struct ptxNDEF_T5TOP_InitParams	ptxNDEF_T5TOP_InitParams_t
	T5T NDEF OP Initialization Parameters.
typedef struct ptxNDEF_T5TOP_CC	ptxNDEF_T5TOP_CC_t
	T5T NDEF OP Capability Container Parameters.
typedef struct ptxNDEF_T5TOP	ptxNDEF_T5TOP_t
	T5T NDEF OP Component.

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpOpen (ptxNDEF_T5TOP_t *t5tOpComp, ptxNDEF_T5TOP_InitParams_t *initParams)
	Initialize / Open the T5T OP Component.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpFormatTag (ptxNDEF_T5TOP_t *t5tOpComp)
	Formats a Type 5 Tag to INITIALIZED state.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpCheckMessage (ptxNDEF_T5TOP_t *t5tOpComp)
	Checks if a NDEF-message is present on the given Tag (or not).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpReadMessage (ptxNDEF_T5TOP_t *t5tOpComp, uint8_t *msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpWriteMessage (ptxNDEF_T5TOP_t *t5tOpComp, uint8_t *msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpLockTag (ptxNDEF_T5TOP_t *t5tOpComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T5TOpClose (ptxNDEF_T5TOP_t *t5tOpComp)
	Unitialize / Close the T5T OP Component.

T5T Tag specific definitions
#define	PTX_T5T_DEFAULT_TIMEOUT_MS   (uint32_t)202
#define	PTX_T5T_SUPPORTED_VERSION   (uint8_t)0x10

Detailed Description

Macro Definition Documentation

PTX_T5T_DEFAULT_TIMEOUT_MS

#define PTX_T5T_DEFAULT_TIMEOUT_MS   (uint32_t)202

T5T default Timeout in ms

PTX_T5T_SUPPORTED_VERSION

#define PTX_T5T_SUPPORTED_VERSION   (uint8_t)0x10

T5T supported Version

Function Documentation

ptxNDEF_T5TOpCheckMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpCheckMessage

(

ptxNDEF_T5TOP_t *

t5tOpComp

)

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

Parameters

[in]

t5tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T5TOpClose()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpClose

(

ptxNDEF_T5TOP_t *

t5tOpComp

)

Unitialize / Close the T5T OP Component.

Parameters

[in]

t5tOpComp

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

Returns

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

ptxNDEF_T5TOpFormatTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpFormatTag

(

ptxNDEF_T5TOP_t *

t5tOpComp

)

Formats a Type 5 Tag to INITIALIZED state.

Parameters

[in]

t5tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T5TOpLockTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpLockTag

(

ptxNDEF_T5TOP_t *

t5tOpComp

)

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

Parameters

[in]

t5tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T5TOpOpen()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpOpen	(	ptxNDEF_T5TOP_t *	t5tOpComp,
		ptxNDEF_T5TOP_InitParams_t *	initParams )

Initialize / Open the T5T OP Component.

Parameters

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T5TOpReadMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpReadMessage	(	ptxNDEF_T5TOP_t *	t5tOpComp,
		uint8_t *	msgBuffer,
		uint32_t *	msgLen )

Reads a NDEF-message from a given Tag.

Parameters

[in]	t5tOpComp	Pointer to an initialized instance of the T5T-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_T5TOpWriteMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpWriteMessage	(	ptxNDEF_T5TOP_t *	t5tOpComp,
		uint8_t *	msgBuffer,
		uint32_t	msgLen )

Writes a NDEF-message onto a given Tag.

Parameters

[in]	t5tOpComp	Pointer to an initialized instance of the T5T-OP component.
[in]	msgBuffer	Pointer to buffer holding the NDEF-message to write (NULL -> empty NDEF-message is written).
[in]	msgLen	Size of NDEF-message (0 -> empty NDEF-message is written).

Returns

Status, indicating whether the operation was successful.