Renesas PTX1xxR IoT-Reader API (non-OS) Version 7.3.1
Renesas Software Stack for IoT-Reader Applications (non-OS)
Data Structures | Macros | Typedefs | Enumerations | Functions
ptx_IOT_READER.h File Reference
#include "ptxStatus.h"
#include "ptxHce.h"
#include "ptxNSC.h"
#include <stddef.h>
Include dependency graph for ptx_IOT_READER.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ptxIoTRd_ChipConfig
 Chip RF- and System-Configuration Identifiers. More...
 
struct  ptxIoTRd_ComInterface_Params
 Parameters for Communication/Host Interface Initialization. More...
 
struct  ptxIoTRd_TempSense_Params
 Parameters for Temperature Sensor Initialization. More...
 
struct  ptxIoTRd_ProtILimiterSettings
 External Protection Limiter Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
struct  ptxIoTRd_ProtISensorSettings
 External Current Sensor Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
union  ptxIoTRd_ProtSettings
 External Protection Settings (WLC only, to be ignored for stand-alone IoT-operation). More...
 
struct  ptxIoTRd_Protection_Params
 External Protection Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
struct  ptxIoTRd_InitPars
 Parameters for IoTRd Initialization. More...
 
struct  ptxIoTRd_BitRates
 Available higher bitrate identifiers. More...
 
struct  ptxIoTRd_HBRConfig_Int
 Available higher bitrates in Rx- and Tx-direction. More...
 
struct  ptxIoTRd_HBRConfig
 Higher bitrate configuration. More...
 
struct  ptxIoTRd_DiscConfigTypeFPollCmdParams
 Custom Type-F Polling Command Parameters. More...
 
struct  ptxIoTRd_DiscConfig
 Configuration for RF-Discovery Loop. More...
 
struct  ptxIoTRd_CardAParams
 RF-Technology Type-A Card Parameters. More...
 
struct  ptxIoTRd_CardBParams
 RF-Technolgy Type-B Card Parameters. More...
 
struct  ptxIoTRd_CardFParams
 RF-Technolgy Type-F Card Parameters. More...
 
struct  ptxIoTRd_CardVParams
 RF-Technolgy Type-V Card Parameters. More...
 
struct  ptxIoTRd_CardExtensionParams
 RF-Technolgy Extension Card Parameters (Prototype/RFU) More...
 
union  ptxIoTRd_CardTechParams
 General Card RF-Technology specific Parameters. More...
 
struct  ptxIoTRd_SupportedRFProt
 Card Supported RF-Protocols. More...
 
struct  ptxIoTRd_CardParams
 General Card Parameters (=> Card Registry Entry) More...
 
struct  ptxIoTRd_CardRegistry
 Card Registry structure. More...
 
struct  ptxIoTRd_RfMsg
 Rf Message Registry structure. More...
 
struct  ptxIoTRd_Extension
 Extension Prototype (RFU): Extension Component Structure. More...
 
struct  ptxIoTRd
 IOT Reader Main Structure (Context). More...
 

Macros

#define PTX_IOTRD_MAX_SUPPORTED_DEVICES   (uint8_t)50
 
#define PTX_IOTRD_MAX_SUPPORTED_RF_PROTOCOLS   (uint8_t)4
 
#define PTX_IOTRD_TECH_A_SENSRES_MAX_SIZE   (uint8_t)2
 
#define PTX_IOTRD_TECH_A_NFCID1_MAX_SIZE   (uint8_t)10
 
#define PTX_IOTRD_TECH_B_SENSB_MAX_SIZE   (uint8_t)13
 
#define PTX_IOTRD_TECH_F_SENSF_MAX_SIZE   (uint8_t)20
 
#define PTX_IOTRD_TECH_V_UID_MAX_SIZE   (uint8_t)8
 
#define PTX_IOTRD_TECH_EXT_PARAM_MAX_SIZE   (uint8_t)32
 
#define PTX_IOTRD_PROT_ISO_DEP_ATS_MAX_SIZE   (uint8_t)21
 
#define PTX_IOTRD_PROT_ISO_DEP_ATTRIB_RES_MAX_SIZE   (uint8_t)16
 
#define PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE   (uint8_t)65
 
#define PTX_IOTRD_HIGH_LEVEL_PROT_MAX_SIZE   PTX_IOTRD_PROT_NFC_DEP_ATR_RES_MAX_SIZE
 
#define PTX_IOTRD_RF_BAILOUT_TECH_A   (uint8_t)1
 
#define PTX_IOTRD_RF_BAILOUT_TECH_B   (uint8_t)2
 
#define PTX_IOTRD_RF_BAILOUT_TECH_F   (uint8_t)4
 
#define PTX_IOTRD_MAX_RF_CONFIG_TLVS   (10u)
 
RF-Discovery status values. Returned by ptxIoTRd_Get_Status_Info(Discover).
#define RF_DISCOVER_STATUS_NO_CARD   (uint8_t)0
 
#define RF_DISCOVER_STATUS_CARD_ACTIVE   (uint8_t)1
 
#define RF_DISCOVER_STATUS_DISCOVER_RUNNING   (uint8_t)2
 
#define RF_DISCOVER_STATUS_DISCOVER_DONE   (uint8_t)3
 
#define RF_DISCOVER_STATUS_LISTEN_A   (uint8_t)4
 
#define RF_DISCOVER_STATUS_DISCOVER_UNDEFINED   (uint8_t)0xFF
 
LPCD mechanism state (used for WLC-Stacks, alternatively available via \ref ptxIoTRd_Get_Status_Info).
#define RF_LPCD_STATUS_NO_DEVICE   (uint8_t)0
 
#define RF_LPCD_STATUS_DEVICE_FOUND   (uint8_t)1
 
Length of the Rf Message Buffer.
#define PTX_IOTRD_RF_MSG_MAX_SIZE   (512U)
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE   (uint8_t)0
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER   (uint8_t)1
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP   (uint8_t)2
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_SLEEP_NON_BLOCKING   (uint8_t)3
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_NO_RF_RESET   (uint8_t)4
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_IDLE_PROTOCOL   (uint8_t)5
 
#define PTX_IOTRD_RF_DEACTIVATION_TYPE_DISCOVER_PROTOCOL   (uint8_t)6
 
#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_ONGOING   (uint8_t)0
 
#define PTX_IOTRD_RF_DEACTIVATION_SLEEP_DONE   (uint8_t)1
 
Generic Defines (independent of Product Type)
#define PTX_SYSTEM_STATUS_OK   (uint8_t)0
 
#define PTX_SYSTEM_STATUS_ERR_OVERCURRENT   (uint8_t)1
 
#define PTX_SYSTEM_STATUS_ERR_TEMPERATURE   (uint8_t)2
 
Defines of possible RF error codes.
#define PTX_RF_ERROR_NTF_CODE_NO_ERROR   (uint8_t)0x00
 
#define PTX_RF_ERROR_NTF_CODE_UNKNOWN_ERROR   (uint8_t)0xFF
 
#define PTX_RF_ERROR_NTF_CODE_WARNING_PA_OVERCURRENT_LIMIT   (uint8_t)0x09
 
#define PTX_RF_ERROR_NTF_CODE_ERR_EMV_COLL   (uint8_t)0x11
 
#define PTX_RF_ERROR_NTF_CODE_ERR_TIMEOUT   (uint8_t)0x12
 
#define PTX_RF_ERROR_NTF_CODE_ERR_TRANSMISSION   (uint8_t)0x13
 
#define PTX_RF_ERROR_NTF_CODE_ERR_PROTOCOL   (uint8_t)0x14
 
Hardware Product-IDs
#define PTX_HW_PRODUCT_ID_PTX100X   (uint8_t)0x00
 
#define PTX_HW_PRODUCT_ID_PTX105X   (uint8_t)0x01
 
#define PTX_HW_PRODUCT_ID_PTX130X   (uint8_t)0x02
 
Platform-dependent I2C speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)
#define PTX_IOTRD_HOST_SPEED_I2C_100000   (100000UL)
 
#define PTX_IOTRD_HOST_SPEED_I2C_400000   (400000UL)
 
#define PTX_IOTRD_HOST_SPEED_I2C_1000000   (1000000UL)
 
#define PTX_IOTRD_HOST_SPEED_I2C_3400000   (3400000UL)
 
#define PTX_IOTRD_HOST_SPEED_I2C_MAX   PTX_IOTRD_HOST_SPEED_I2C_3400000
 
Platform-dependent UART speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)
#define PTX_IOTRD_HOST_SPEED_UART_9600   (9600UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_14400   (14400UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_19200   (19200UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_28800   (28800UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_38400   (38400UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_57600   (57600UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_115200   (115200UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_230400   (230400UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_460800   (460800UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_921600   (921600UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_1843200   (1843200UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_3000000   (3000000UL)
 
#define PTX_IOTRD_HOST_SPEED_UART_MAX   PTX_IOTRD_HOST_SPEED_UART_3000000
 
Platform-dependent SPI speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)
#define PTX_IOTRD_HOST_SPEED_SPI_1M   (1000000UL)
 
#define PTX_IOTRD_HOST_SPEED_SPI_5M   (5000000UL)
 
#define PTX_IOTRD_HOST_SPEED_SPI_10M   (10000000UL)
 
#define PTX_IOTRD_HOST_SPEED_SPI_MAX   PTX_IOTRD_HOST_SPEED_SPI_10M
 
API Extension Definitions
#define PTX_IOTRD_MAX_EXTENSIONS   (1u)
 

Typedefs

typedef enum ptxIoTRd_RevisionType ptxIoTRd_RevisionType_t
 NSC Revision-Info Types.
 
typedef enum ptxIoTRd_ChipConfigID ptxIoTRd_ChipConfigID_t
 Chip RF- and System-Configuration Identifiers.
 
typedef enum ptxIoTRd_SysInfoType ptxIoTRd_SysInfoType_t
 NSC System-Info Types.
 
typedef struct ptxIoTRd_ChipConfig ptxIoTRd_ChipConfig_t
 Chip RF- and System-Configuration Identifiers.
 
typedef struct ptxIoTRd_ComInterface_Params ptxIoTRd_ComInterface_Params_t
 Parameters for Communication/Host Interface Initialization.
 
typedef struct ptxIoTRd_TempSense_Params ptxIoTRd_TempSense_Params_t
 Parameters for Temperature Sensor Initialization.
 
typedef enum ptxIoTRd_ProtSupply ptxIoTRd_ProtSupply_t
 External Protection Circuitry Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef enum ptxIoTRd_ProtAttenuation ptxIoTRd_ProtAttenuation_t
 External Protection Attenuation Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef enum ptxIoTRd_ProtType ptxIoTRd_ProtType_t
 External Protection Type Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef struct ptxIoTRd_ProtILimiterSettings ptxIoTRd_ProtILimiterSettings_t
 External Protection Limiter Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef struct ptxIoTRd_ProtISensorSettings ptxIoTRd_ProtISensorSettings_t
 External Current Sensor Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef union ptxIoTRd_ProtSettings ptxIoTRd_ProtSettings_t
 External Protection Settings (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef struct ptxIoTRd_Protection_Params ptxIoTRd_Protection_Params_t
 External Protection Parameters (WLC only, to be ignored for stand-alone IoT-operation).
 
typedef struct ptxIoTRd_InitPars ptxIoTRd_InitPars_t
 Parameters for IoTRd Initialization.
 
typedef struct ptxIoTRd_BitRates ptxIoTRd_BitRates_t
 Available higher bitrate identifiers.
 
typedef struct ptxIoTRd_HBRConfig_Int ptxIoTRd_HBRConfig_Int_t
 Available higher bitrates in Rx- and Tx-direction.
 
typedef struct ptxIoTRd_HBRConfig ptxIoTRd_HBRConfig_t
 Higher bitrate configuration.
 
typedef enum ptxIoTRd_CardRFTechType ptxIoTRd_CardRFTechType_t
 Card RF-Technology Type.
 
typedef enum ptxIoTRd_CardProtocol ptxIoTRd_CardProtocol_t
 Card RF-Protocol Type.
 
typedef struct ptxIoTRd_DiscConfigTypeFPollCmdParams ptxIoTRd_DiscConfigTypeFPollCmdParams_t
 Custom Type-F Polling Command Parameters.
 
typedef struct ptxIoTRd_DiscConfig ptxIoTRd_DiscConfig_t
 Configuration for RF-Discovery Loop.
 
typedef struct ptxIoTRd_CardAParams ptxIoTRd_CardAParams_t
 RF-Technology Type-A Card Parameters.
 
typedef struct ptxIoTRd_CardBParams ptxIoTRd_CardBParams_t
 RF-Technolgy Type-B Card Parameters.
 
typedef struct ptxIoTRd_CardFParams ptxIoTRd_CardFParams_t
 RF-Technolgy Type-F Card Parameters.
 
typedef struct ptxIoTRd_CardVParams ptxIoTRd_CardVParams_t
 RF-Technolgy Type-V Card Parameters.
 
typedef struct ptxIoTRd_CardExtensionParams ptxIoTRd_CardExtensionParams_t
 RF-Technolgy Extension Card Parameters (Prototype/RFU)
 
typedef union ptxIoTRd_CardTechParams ptxIoTRd_CardTechParams_t
 General Card RF-Technology specific Parameters.
 
typedef enum ptxIoTRd_StatusType ptxIoTRd_StatusType_t
 Generic Status / State Identifier.
 
typedef struct ptxIoTRd_SupportedRFProt ptxIoTRd_SupportedRFProt_t
 Card Supported RF-Protocols.
 
typedef struct ptxIoTRd_CardParams ptxIoTRd_CardParams_t
 General Card Parameters (=> Card Registry Entry)
 
typedef struct ptxIoTRd_CardRegistry ptxIoTRd_CardRegistry_t
 Card Registry structure.
 
typedef enum ptxIoTRd_RfMsgState ptxIoTRd_RfMsgState_t
 Rf Message State.
 
typedef enum ptxIoTRd_CheckPresType ptxIoTRd_CheckPresType_t
 Type of Check Presence Mechanism.
 
typedef enum ptxIoTRd_RSSI_Mode ptxIoTRd_RSSI_Mode_t
 RSSI Mode.
 
typedef struct ptxIoTRd_RfMsg ptxIoTRd_RfMsg_t
 Rf Message Registry structure.
 
typedef ptxStatus_t(* pExtProcessNTF_t) (void *extCtx, void *iotRdComp, void *nscEvent)
 Extension Prototype (RFU): Handler for NTF Processing at API-level.
 
typedef ptxStatus_t(* pExtActivateCMD_t) (void *extCtx, void *iotRdComp, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol)
 Extension Prototype (RFU): Handler for Activate-/Select-Command Processing at API-level.
 
typedef struct ptxIoTRd_Extension ptxIoTRd_Extension_t
 Extension Prototype (RFU): Extension Component Structure.
 
typedef struct ptxIoTRd ptxIoTRd_t
 IOT Reader Main Structure (Context).
 

Enumerations

enum  ptxIoTRd_RevisionType {
  RevInfo_C_Stack , RevInfo_Local_Changes , RevInfo_DFY_Code , RevInfo_DFY_Toolchain ,
  RevInfo_ChipID , RevInfo_ProductID
}
 NSC Revision-Info Types.
 
enum  ptxIoTRd_ChipConfigID {
  RF_Wavebank_0 , RF_Wavebank_1 , RF_Wavebank_2 , RF_Wavebank_3 ,
  RF_Wavebank_4 , RF_Wavebank_5 , RF_Wavebank_6 , RF_Wavebank_7 ,
  RF_Wavebank_8 , RF_Wavebank_9 , RF_Wavebank_10 , RF_Wavebank_11 ,
  RF_Wavebank_12 , RF_Wavebank_13 , RF_Wavebank_14 , RF_Wavebank_15 ,
  RF_Wavebank_16 , RF_Wavebank_17 , RF_Wavebank_18 , RF_Wavebank_19 ,
  RF_Misc , RF_PollA106 , RF_PollA212 , RF_PollA424 ,
  RF_PollA848 , RF_PollB106 , RF_PollB212 , RF_PollB424 ,
  RF_PollB848 , RF_PollF212 , RF_PollF424 , RF_PollV ,
  RF_Listen , RF_LAST_RF_CONFIG_ENTRY , SYS_ThermalThreshold = 100 , SYS_OvercurrentThreshold ,
  SYS_ConClockSrc , SYS_ConVarLBS , SYS_ConNHost , SYS_ConNHosCE
}
 Chip RF- and System-Configuration Identifiers.
 
enum  ptxIoTRd_SysInfoType { SysInfo_VDPA_Calibration_Result }
 NSC System-Info Types.
 
enum  ptxIoTRd_ProtSupply { SupplyPad_GPIO5 = 0x00 , SupplyPad_ATEST3 = 0x40 }
 External Protection Circuitry Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
enum  ptxIoTRd_ProtAttenuation { Attenuation_Off = 0x00 , Attenuation_03 = 0x10 , Attenuation_09 = 0x30 }
 External Protection Attenuation Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
enum  ptxIoTRd_ProtType { ProtType_None = 0x00 , ProtType_CurrentSensor = 0x01 , ProtType_CurrentLimiter = 0x02 }
 External Protection Type Parameters (WLC only, to be ignored for stand-alone IoT-operation). More...
 
enum  ptxIoTRd_CardRFTechType {
  Tech_TypeA = 0 , Tech_TypeB = 1 , Tech_TypeF = 2 , Tech_TypeV = 6 ,
  Tech_TypeExtension = 10
}
 Card RF-Technology Type.
 
enum  ptxIoTRd_CardProtocol {
  Prot_Undefined = 0 , Prot_T2T = 2 , Prot_T3T = 3 , Prot_ISODEP = 4 ,
  Prot_NFCDEP = 5 , Prot_T5T = 6 , Prot_Extension = 10
}
 Card RF-Protocol Type.
 
enum  ptxIoTRd_StatusType {
  StatusType_System , StatusType_Discover , StatusType_DeactivateSleep , StatusType_LastRFError ,
  StatusType_LPCDNtfCounter , StatusType_Lpcd
}
 Generic Status / State Identifier.
 
enum  ptxIoTRd_RfMsgState {
  RfMsg_NotReceived , RfMsg_RfMsg_Rcv , RfMsg_RfMsg_Chained_Rcv , RfMsg_RfError ,
  RfMsg_RfErrorTimeOut , RfMsg_CtrlAck , RfMsg_CtrlAttCmd , RfMsg_RfClt
}
 Rf Message State.
 
enum  ptxIoTRd_CheckPresType { PresCheck_A , PresCheck_B }
 Type of Check Presence Mechanism. More...
 
enum  ptxIoTRd_RSSI_Mode { RSSI_Mode_Enabled , RSSI_Mode_Disabled }
 RSSI Mode. More...
 

Functions

ptxStatus_t ptxIoTRd_InitNSC (ptxIoTRd_t *iotRd, ptxIoTRd_ComInterface_Params_t *initParams)
 Initializes the NSC component.
 
ptxStatus_t ptxIoTRd_Init (ptxIoTRd_t *iotRd, ptxIoTRd_InitPars_t *initParams)
 Initialize the IoT Reader Component and the PTX1K.
 
ptxStatus_t ptxIoTRd_Initiate_Discovery (ptxIoTRd_t *iotRd, ptxIoTRd_DiscConfig_t *discConfig)
 Initiate RF-Discovery according to NFC-Forum.
 
ptxStatus_t ptxIoTRd_Update_ChipConfig (ptxIoTRd_t *iotRd, uint8_t nrConfigs, ptxIoTRd_ChipConfig_t *configParams)
 Updates the RF- and System-Configuration parameters of the NFC hardware.
 
ptxStatus_t ptxIoTRd_ConfigHBR (ptxIoTRd_t *iotRd, ptxIoTRd_HBRConfig_t *configParams)
 Configures HBR.
 
ptxStatus_t ptxIoTRd_Get_Revision_Info (ptxIoTRd_t *iotRd, ptxIoTRd_RevisionType_t revisionType, uint32_t *revisionInfo)
 Get various revisions of system (C-Stack, DFY-Code/-Toolchain, Chip-ID, Local changes, Product-ID etc.).
 
ptxStatus_t ptxIoTRd_Get_Card_Registry (ptxIoTRd_t *iotRd, ptxIoTRd_CardRegistry_t **cardRegistry)
 Access the internal card registry.
 
ptxStatus_t ptxIoTRd_Activate_Card (ptxIoTRd_t *iotRd, ptxIoTRd_CardParams_t *cardParams, ptxIoTRd_CardProtocol_t protocol)
 Activates a specific card.
 
ptxStatus_t ptxIoTRd_Data_Exchange (ptxIoTRd_t *iotRd, uint8_t *tx, uint32_t txLength, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
 Exchange data with an already activated card.
 
ptxStatus_t ptxIoTRd_Bits_Exchange_Mode (ptxIoTRd_t *iotRd, uint8_t enable)
 Enable or disable Bits Exchange Option.
 
ptxStatus_t ptxIoTRd_Bits_Exchange (ptxIoTRd_t *iotRd, uint8_t *tx, uint8_t *txPar, size_t txLength, uint8_t *rx, uint8_t *rxPar, size_t *rxLength, size_t *numTotBits, uint32_t msTimeout)
 Exchanges Type-A RF-technology aligned raw RF bit-streams in state "DATA EXCHANGE" based on Cards / Tags supporting the T2T protocol.
 
ptxStatus_t ptxIoTRd_RF_PresenceCheck (ptxIoTRd_t *iotRd, ptxIoTRd_CheckPresType_t presCheckType)
 Check the presence of an activated Card.
 
ptxStatus_t ptxIoTRd_T5T_IsolatedEoF (ptxIoTRd_t *iotRd, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
 This function sends EoF command to a T5T activated card and waits for an answer.
 
ptxStatus_t ptxIoTRd_T3T_SENSFRequest (ptxIoTRd_t *iotRd, uint16_t systemCode, uint8_t requestCode, uint8_t tsn, uint8_t *rx, uint32_t *rxLength, uint32_t msAppTimeout)
 This function sends EoF command to a T3T activated card and waits for an answer.
 
ptxStatus_t ptxIoTRd_Reader_Deactivation (ptxIoTRd_t *iotRd, uint8_t deactivationType)
 Perform generic Reader deactivation.
 
ptxStatus_t ptxIoTRd_Set_Power_Mode (ptxIoTRd_t *iotRd, uint8_t newPowerMode)
 Set reader power mode.
 
ptxStatus_t ptxIoTRd_Get_System_Info (ptxIoTRd_t *iotRd, ptxIoTRd_SysInfoType_t infoType, uint8_t *infoBuffer, uint8_t *infoBufferLength)
 Get System-internal Information.
 
ptxStatus_t ptxIoTRd_SWReset (ptxIoTRd_t *iotRd)
 SW Reset.
 
ptxStatus_t ptxIoTRd_Deinit (ptxIoTRd_t *iotRd)
 Close the IoT Reader Component.
 
ptxStatus_t ptxIoTRd_Get_Status_Info (ptxIoTRd_t *iotRd, ptxIoTRd_StatusType_t statusType, uint8_t *statusInfo)
 Get various status- and state-information.
 
ptxStatus_t ptxIoTRd_TempSensor_Calibration (ptxIoTRd_t *iotRd, uint8_t Tambient, uint8_t *Tshutdown)
 Perform PTX1K integrated temperature sensor calibration and calculate calibrated temperature shutdown temperature. The outcome of this process is the calibrated temperature shutdown temperature value, returned in Tshutdown parameter. This value is used in every further call to ptxIoTRd_Init_NSC().
 
ptxStatus_t ptxIoTRd_Set_RSSI_Mode (ptxIoTRd_t *iotRd, ptxIoTRd_RSSI_Mode_t rssiMode, uint8_t *rssiRefreshPeriodInt)
 This function puts the system / stack into RSSI-mode or deactivates the RSSI-mode.
 
ptxStatus_t ptxIoTRd_Get_RSSI_Value (ptxIoTRd_t *iotRd, uint16_t *rssiValue)
 This function reads the current RSSI-value.
 
ptxStatus_t ptxIoTRd_Register_Extension (ptxIoTRd_t *iotRd, uint8_t extensionID, ptxIoTRd_Extension_t *extension)
 Register an IoT-Extension (Prototype/RFU).
 
ptxStatus_t ptxIoTRd_DeRegister_Extension (ptxIoTRd_t *iotRd, uint8_t extensionID)
 De-Register an IoT-Extension (Prototype/RFU).
 

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 : IOT_READER File : ptx_IOT_READER.h

Description : API for IOT READER

Generated by doxygen 1.10.0