Tag Type T4T Operation API

Collaboration diagram for Tag Type T4T Operation API:

Data Structures
struct	ptxNDEF_T4TOP_InitParams
	T4T NDEF OP Initialization Parameters. More...
struct	ptxNDEF_T4TOP_CC
	T4T NDEF OP Capability Container Parameters. More...
struct	ptxNDEF_T4TOP_NLEN
	T4T NDEF file contents. More...
struct	ptxNDEF_T4TOP
	T4T NDEF OP Component. More...

Typedefs
typedef struct ptxNDEF_T4TOP_InitParams	ptxNDEF_T4TOP_InitParams_t
	T4T NDEF OP Initialization Parameters.
typedef struct ptxNDEF_T4TOP_CC	ptxNDEF_T4TOP_CC_t
	T4T NDEF OP Capability Container Parameters.
typedef struct ptxNDEF_T4TOP_NLEN	ptxNDEF_T4TOP_NLEN_t
	T4T NDEF file contents.
typedef struct ptxNDEF_T4TOP	ptxNDEF_T4TOP_t
	T4T NDEF OP Component.

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpOpen (ptxNDEF_T4TOP_t *t4tOpComp, ptxNDEF_T4TOP_InitParams_t *initParams)
	Initialize / Open the T4T OP Component.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpFormatTag (ptxNDEF_T4TOP_t *t4tOpComp)
	Formats a Type 4 Tag to INITIALIZED state.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpCheckMessage (ptxNDEF_T4TOP_t *t4tOpComp)
	Checks if a NDEF-message is present on the given Tag (or not).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpReadMessage (ptxNDEF_T4TOP_t *t4tOpComp, uint8_t *msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpWriteMessage (ptxNDEF_T4TOP_t *t4tOpComp, uint8_t *msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpLockTag (ptxNDEF_T4TOP_t *t4tOpComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T4TOpClose (ptxNDEF_T4TOP_t *t4tOpComp)
	Unitialize / Close the T4T OP Component.

T4T Tag specific definitions
#define	PTX_T4T_DEFAULT_TIMEOUT_MS   (uint32_t)50000
#define	PTX_T4T_MAXIMUM_NLEN_LENGTH   (uint8_t)4u
#define	PTX_T4T_CC_LEN   (uint8_t)2u
#define	PTX_T4T_FILEIDENTIFIER_LEN   (uint8_t)2u

Detailed Description

Macro Definition Documentation

PTX_T4T_CC_LEN

#define PTX_T4T_CC_LEN   (uint8_t)2u

CC length.

PTX_T4T_DEFAULT_TIMEOUT_MS

#define PTX_T4T_DEFAULT_TIMEOUT_MS   (uint32_t)50000

T4T default timeout in ms

PTX_T4T_FILEIDENTIFIER_LEN

#define PTX_T4T_FILEIDENTIFIER_LEN   (uint8_t)2u

File Identifier length.

PTX_T4T_MAXIMUM_NLEN_LENGTH

#define PTX_T4T_MAXIMUM_NLEN_LENGTH   (uint8_t)4u

Maximum NLEN length.

Function Documentation

ptxNDEF_T4TOpCheckMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpCheckMessage

(

ptxNDEF_T4TOP_t *

t4tOpComp

)

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

Parameters

[in]

t4tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T4TOpClose()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpClose

(

ptxNDEF_T4TOP_t *

t4tOpComp

)

Unitialize / Close the T4T OP Component.

Parameters

[in]

t4tOpComp

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

Returns

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

ptxNDEF_T4TOpFormatTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpFormatTag

(

ptxNDEF_T4TOP_t *

t4tOpComp

)

Formats a Type 4 Tag to INITIALIZED state.

Parameters

[in]

t4tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T4TOpLockTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpLockTag

(

ptxNDEF_T4TOP_t *

t4tOpComp

)

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

Parameters

[in]

t4tOpComp

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T4TOpOpen()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpOpen	(	ptxNDEF_T4TOP_t *	t4tOpComp,
		ptxNDEF_T4TOP_InitParams_t *	initParams )

Initialize / Open the T4T OP Component.

Parameters

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

Returns

Status, indicating whether the operation was successful.

ptxNDEF_T4TOpReadMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpReadMessage	(	ptxNDEF_T4TOP_t *	t4tOpComp,
		uint8_t *	msgBuffer,
		uint32_t *	msgLen )

Reads a NDEF-message from a given Tag.

Parameters

[in]	t4tOpComp	Pointer to an initialized instance of the T4T-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_T4TOpWriteMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpWriteMessage	(	ptxNDEF_T4TOP_t *	t4tOpComp,
		uint8_t *	msgBuffer,
		uint32_t	msgLen )

Writes a NDEF-message onto a given Tag.

Parameters

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