Tag Type T3T Operation API

Collaboration diagram for Tag Type T3T Operation API:

Data Structures
struct	ptxNDEF_T3TOP_InitParams
	T3T NDEF OP Initialization Parameters. More...
struct	ptxNDEF_T3TOP_CC
	T3T NDEF OP Capability Container Parameters. More...
struct	ptxNDEF_T3TOP
	T3T NDEF OP Component. More...

Typedefs
typedef struct ptxNDEF_T3TOP_InitParams	ptxNDEF_T3TOP_InitParams_t
	T3T NDEF OP Initialization Parameters.
typedef struct ptxNDEF_T3TOP_CC	ptxNDEF_T3TOP_CC_t
	T3T NDEF OP Capability Container Parameters.
typedef struct ptxNDEF_T3TOP	ptxNDEF_T3TOP_t
	T3T NDEF OP Component.

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpOpen (ptxNDEF_T3TOP_t *t3tOpComp, ptxNDEF_T3TOP_InitParams_t *initParams)
	Initialize / Open the T3T OP Component.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpFormatTag (ptxNDEF_T3TOP_t *t3tOpComp)
	Formats a Type 3 Tag to INITIALIZED state.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpCheckMessage (ptxNDEF_T3TOP_t *t3tOpComp)
	Checks if a NDEF-message is present on the given Tag (or not).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpReadMessage (ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpWriteMessage (ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpLockTag (ptxNDEF_T3TOP_t *t3tOpComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T3TOpClose (ptxNDEF_T3TOP_t *t3tOpComp)
	Unitialize / Close the T3T OP Component.

T3T Tag specific size definitions and limits.
#define	PTX_T3T_BLOCK_SIZE   (uint8_t)16u
#define	PTX_T3T_RFU_SIZE   (uint8_t)4u
#define	PTX_T3T_DEFAULT_TIMEOUT_MS   (uint32_t)500
#define	PTX_T3T_SUPPORTED_VERSION   (uint8_t)0x10

Detailed Description

Macro Definition Documentation

PTX_T3T_BLOCK_SIZE

#define PTX_T3T_BLOCK_SIZE   (uint8_t)16u

T3T block size.

PTX_T3T_DEFAULT_TIMEOUT_MS

#define PTX_T3T_DEFAULT_TIMEOUT_MS   (uint32_t)500

T3T Tag specific default timeout.

PTX_T3T_RFU_SIZE

#define PTX_T3T_RFU_SIZE   (uint8_t)4u

Number of RFU bytes in Attribute Information Block.

PTX_T3T_SUPPORTED_VERSION

#define PTX_T3T_SUPPORTED_VERSION   (uint8_t)0x10

T3T Tag specific supported version.

Function Documentation

ptxNDEF_T3TOpCheckMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpCheckMessage

(

ptxNDEF_T3TOP_t *

t3tOpComp

)

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

Parameters

[in]

t3tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T3TOpClose()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpClose

(

ptxNDEF_T3TOP_t *

t3tOpComp

)

Unitialize / Close the T3T OP Component.

Parameters

[in]

t3tOpComp

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

Returns

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

ptxNDEF_T3TOpFormatTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpFormatTag

(

ptxNDEF_T3TOP_t *

t3tOpComp

)

Formats a Type 3 Tag to INITIALIZED state.

Parameters

[in]

t3tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T3TOpLockTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpLockTag

(

ptxNDEF_T3TOP_t *

t3tOpComp

)

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

Parameters

[in]

t3tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T3TOpOpen()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpOpen	(	ptxNDEF_T3TOP_t *	t3tOpComp,
		ptxNDEF_T3TOP_InitParams_t *	initParams )

Initialize / Open the T3T OP Component.

Parameters

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T3TOpReadMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpReadMessage	(	ptxNDEF_T3TOP_t *	t3tOpComp,
		uint8_t *	msgBuffer,
		uint32_t *	msgLen )

Reads a NDEF-message from a given Tag.

Parameters

[in]	t3tOpComp	Pointer to an initialized instance of the T3T-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_T3TOpWriteMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpWriteMessage	(	ptxNDEF_T3TOP_t *	t3tOpComp,
		uint8_t *	msgBuffer,
		uint32_t	msgLen )

Writes a NDEF-message onto a given Tag.

Parameters

[in]	t3tOpComp	Pointer to an initialized instance of the T3T-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.