Renesas PTX1xxR IoT-Reader API (non-OS) Version 7.3.1
Renesas Software Stack for IoT-Reader Applications (non-OS)
ptxNDEF.h
Go to the documentation of this file.
1
49#ifndef APIS_PTX_NDEF_H_
50#define APIS_PTX_NDEF_H_
51
52/*
53 * ####################################################################################################################
54 * INCLUDES
55 * ####################################################################################################################
56 */
57
58#include <stdint.h>
59#include "ptx_IOT_READER.h"
60#include "ptxNDEF_T2TOP.h"
61#include "ptxNDEF_T3TOP.h"
62#include "ptxNDEF_T4TOP.h"
63#include "ptxNDEF_T5TOP.h"
64#include "ptxStatus.h"
65
66#ifdef __cplusplus
67extern "C" {
68#endif
69
70/*
71 * ####################################################################################################################
72 * DEFINES / TYPES
73 * ####################################################################################################################
74 */
75
76/*
77 * ####################################################################################################################
78 * TYPES
79 * ####################################################################################################################
80 */
85
95
111
127
128/*
129 * ####################################################################################################################
130 * API FUNCTIONS
131 * ####################################################################################################################
132 */
133
143
152
161
171ptxStatus_t ptxNDEF_ReadMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t *msgLen);
172
182ptxStatus_t ptxNDEF_WriteMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t msgLen);
183
192
201
202#ifdef __cplusplus
203}
204#endif
205
208#endif /* Guard */
209
ptxStatus_t ptxNDEF_FormatTag(ptxNDEF_t *ndefComp)
Formats a given Tag to INITIALIZED state.
ptxStatus_t ptxNDEF_ReadMessage(ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t *msgLen)
Reads a NDEF-message from a given Tag.
ptxStatus_t ptxNDEF_Close(ptxNDEF_t *ndefComp)
Unitialize / Close the NDEF OP Component.
ptxStatus_t ptxNDEF_WriteMessage(ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t msgLen)
Writes a NDEF-message onto a given Tag.
enum ptxNDEF_T5T_Modes ptxNDEF_T5T_Modes_t
T5T communication mode.
ptxStatus_t ptxNDEF_Open(ptxNDEF_t *ndefComp, ptxNDEF_InitParams_t *initParams)
Initialize / Open the NDEF OP Component.
ptxNDEF_T5T_Modes
T5T communication mode.
Definition ptxNDEF.h:90
struct ptxNDEF_InitParams ptxNDEF_InitParams_t
NDEF OP Initialization Parameters.
struct ptxNDEF ptxNDEF_t
Generic NDEF OP Component.
ptxStatus_t ptxNDEF_LockTag(ptxNDEF_t *ndefComp)
Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
ptxStatus_t ptxNDEF_CheckMessage(ptxNDEF_t *ndefComp)
Checks if a NDEF-message is present on the given Tag (or not).
@ ptxNDEF_T5T_Mode_None
Definition ptxNDEF.h:91
@ ptxNDEF_T5T_Mode_Selected
Definition ptxNDEF.h:93
@ ptxNDEF_T5T_Mode_Addressed
Definition ptxNDEF.h:92
uint16_t ptxStatus_t
Status Type.
Definition ptxStatus.h:70
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
Card Registry structure.
Definition ptx_IOT_READER.h:676
NDEF OP Initialization Parameters.
Definition ptxNDEF.h:100
uint8_t * RxBuffer
Definition ptxNDEF.h:104
uint32_t RxBufferSize
Definition ptxNDEF.h:105
void * IotRd
Definition ptxNDEF.h:101
ptxNDEF_T5T_Modes_t T5TMode
Definition ptxNDEF.h:109
uint32_t WorkBufferSize
Definition ptxNDEF.h:107
uint8_t * TxBuffer
Definition ptxNDEF.h:102
uint8_t * WorkBuffer
Definition ptxNDEF.h:106
uint32_t TxBufferSize
Definition ptxNDEF.h:103
T2T NDEF OP Component.
Definition ptxNDEF_T2TOP.h:210
T3T NDEF OP Component.
Definition ptxNDEF_T3TOP.h:127
T4T NDEF OP Component.
Definition ptxNDEF_T4TOP.h:132
T5T NDEF OP Component.
Definition ptxNDEF_T5TOP.h:123
Generic NDEF OP Component.
Definition ptxNDEF.h:116
ptxNDEF_T5TOP_t T5TOP
Definition ptxNDEF.h:124
ptxNDEF_T2TOP_t T2TOP
Definition ptxNDEF.h:121
ptxNDEF_T3TOP_t T3TOP
Definition ptxNDEF.h:122
struct ptxIoTRd_CardRegistry * CardRegistry
Definition ptxNDEF.h:120
ptxStatus_Comps_t CompId
Definition ptxNDEF.h:118
ptxNDEF_T4TOP_t T4TOP
Definition ptxNDEF.h:123