Renesas PTX1xxR IoT-Reader API (non-OS) Version 7.3.1
Renesas Software Stack for IoT-Reader Applications (non-OS)
Data Structures | Typedefs | Enumerations | Functions
ptxNDEF.h File Reference
#include <stdint.h>
#include "ptx_IOT_READER.h"
#include "ptxNDEF_T2TOP.h"
#include "ptxNDEF_T3TOP.h"
#include "ptxNDEF_T4TOP.h"
#include "ptxNDEF_T5TOP.h"
#include "ptxStatus.h"
Include dependency graph for ptxNDEF.h:

Go to the source code of this file.

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

SPDX-License-Identifier: BSD-3-Clause

Copyright (c) 2026, Renesas Electronics Corporation and/or its affiliates

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of Renesas nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project : PTX1K Module : Generic NDEF OPERATION API File : ptxNDEF.h

Description : Generic NDEF Operation API (IOT READER - Extension)