RFID API Documentation  1.0
Reference guide for RFID API
Configuration

Functions

RFID_STATUS WINAPI RFID_GetAntennaConfig (RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT16 *pReceiveSensitivityIndex, UINT16 *pTransmitPowerIndex, UINT16 *pTransmitFrequencyIndex)
 This function gets the antenna configuration from the reader. More...
 
RFID_STATUS WINAPI RFID_SetAntennaConfig (RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT16 receiveSensitivityIndex, UINT16 transmitPowerIndex, UINT16 transmitFrequencyIndex)
 This function sets Antenna Configuration at the Reader. More...
 
RFID_STATUS WINAPI RFID_SetAntennaRfConfig (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPANTENNA_RF_CONFIG lpAntennaRfConfig)
 This function sets Antenna RF Configuration at the Reader. More...
 
RFID_STATUS WINAPI RFID_GetAntennaRfConfig (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPANTENNA_RF_CONFIG lpAntennaRfConfig)
 This function gets Antenna Configuration at the Reader. More...
 
RFID_STATUS WINAPI RFID_GetPhysicalAntennaProperties (RFID_HANDLE32 readerHandle, UINT16 antennaID, BOOLEAN *pStatus, UINT32 *pAntennaGain)
 This function gets the physical properties of an Antenna from the Reader. More...
 
RFID_STATUS WINAPI RFID_GetSingulationControl (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPSINGULATION_CONTROL lpSingulationControl)
 This function provides interface to the get the Singulation control. More...
 
RFID_STATUS WINAPI RFID_SetSingulationControl (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPSINGULATION_CONTROL lpSingulationControl)
 This function provides interface to set the Singulation control. More...
 
RFID_STATUS WINAPI RFID_ResetConfigToFactoryDefaults (RFID_HANDLE32 readerHandle)
 This function resets the reader configuration to factory defaults. More...
 
RFID_STATUS WINAPI RFID_SaveLlrpConfig (RFID_HANDLE32 readerHandle, LPVOID rsvd)
 This function saves the LLRP configuirations. More...
 
RFID_STATUS WINAPI RFID_GetSaveLlrpConfigStatus (RFID_HANDLE32 readerHandle, BOOLEAN *pSaveStatus)
 This function returns the LLRP configuirations status(Saved or Not) More...
 
RFID_STATUS WINAPI RFID_SetGPOState (RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN gpoState)
 This function performs the write to a general purpose output port. More...
 
RFID_STATUS WINAPI RFID_GetGPOState (RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN *pGPOState)
 This function gets the current state of the specified GPO port. More...
 
RFID_STATUS WINAPI RFID_GetGPIState (RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN *pGPIEnable, GPI_PORT_STATE *pState)
 This function gets current configuration and state of a single GPI Port. More...
 
RFID_STATUS WINAPI RFID_EnableGPIPort (RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN gpiEnable)
 This function enables a single GPI Pin as specified. More...
 
RFID_STATUS WINAPI RFID_GetRFMode (RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT32 *pRfModeTableIndex, UINT32 *pTari)
 This function gets the current RFMode from the Reader. More...
 
RFID_STATUS WINAPI RFID_SetRFMode (RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT32 rfModeTableIndex, UINT32 tari)
 This function sets the C1G2 RF Mode and the Tari value to use for the inventory operation. More...
 
RFID_STATUS WINAPI RFID_GetRadioPowerState (RFID_HANDLE32 readerHandle, BOOLEAN *pPowerState)
 This function gets the power state of the RFID Radio Module. More...
 
RFID_STATUS WINAPI RFID_SetRadioPowerState (RFID_HANDLE32 readerHandle, BOOLEAN powerState)
 This function sets the power state of the RFID Radio Module. More...
 
RFID_STATUS WINAPI RFID_GetDutyCycle (RFID_HANDLE32 readerHandle, UINT16 *pDutyCycleIndex, LPVOID rsvd)
 This function gets the duty cycle of the RFID Radio Module. More...
 
RFID_STATUS WINAPI RFID_SetDutyCycle (RFID_HANDLE32 readerHandle, UINT16 dutyCycleIndex, LPVOID rsvd)
 This function sets the duty cycle of the RFID Radio Module. More...
 
RFID_STATUS WINAPI RFID_GetRadioTransmitDelay (RFID_HANDLE32 readerHandle, RADIO_TRANSMIT_DELAY_TYPE *pType, UINT8 *pTime)
 This function gets the transmit delay of the RFID Radio Module. More...
 
RFID_STATUS WINAPI RFID_SetRadioTransmitDelay (RFID_HANDLE32 readerHandle, RADIO_TRANSMIT_DELAY_TYPE type, UINT8 time)
 This function sets the transmit delay of the RFID Radio Module. More...
 

Detailed Description

Function Documentation

◆ RFID_GetAntennaConfig()

RFID_STATUS WINAPI RFID_GetAntennaConfig ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
UINT16 pReceiveSensitivityIndex,
UINT16 pTransmitPowerIndex,
UINT16 pTransmitFrequencyIndex 
)

This function gets the antenna configuration from the reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; cannot be zero.
[out]pReceiveSensitivityIndex
Pointer to ReceiveSensitivityIndex. The value is the zero-based index into the ReceiveSensitivityTable.
[out]pTransmitPowerIndex
Pointer to TransmitPowerIndex. The value is the zero-based index into the TransmitPowerTable.
[out]pTransmitFrequencyIndex
Pointer to Frequency-hop table or Channel Index. In frequency-hopping regulatory regions, this is the Frequency hop table ID. In case of Fixed Frequency, this is the one-based channel index in the FixedFrequencyTable.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
None
See also
RFID_SetAntennaConfig, RFID_GetPhysicalAntennaProperties
Remarks
Example:
RFID_HANDLE32 readerHandle;
READER_CAPS readerCaps;
UINT16 antennaId = 4;
UINT16 receiveSensitivityIndex, transmitPowerIndex, transmitFrequencyIndex;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
// Get the Reader Capability
rfidStatus = RFID_GetReaderCaps(readerHandle, &readerCaps);
// Get Antenna Configuration for Antenna Id
rfidStatus = RFID_GetAntennaConfig(readerHandle, antennaId,
&receiveSensitivityIndex, &transmitPowerIndex, &transmitFrequencyIndex);
printf("\n Config of Antenna: %d: rxIndex-%d, txIndex-%d, txFqIndex-%d",
antennaId, receiveSensitivityIndex, transmitPowerIndex, transmitFrequencyIndex);
// Set highest transmit power
transmitPowerIndex = readerCaps.transmitPowerLevelTable.numValues -1;
// Set Antenna Config for Antenna Id - 1
rfidStatus = RFID_SetAntennaConfig(readerHandle, 1,
receiveSensitivityIndex, transmitPowerIndex, transmitFrequencyIndex);
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_SetAntennaConfig()

RFID_STATUS WINAPI RFID_SetAntennaConfig ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
UINT16  receiveSensitivityIndex,
UINT16  transmitPowerIndex,
UINT16  transmitFrequencyIndex 
)

This function sets Antenna Configuration at the Reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; If zero, configuration will be applied on all Antennas.
[in]receiveSensitivityIndex
Receive Sensitivity Index; The value is the zero-based index into the receiveSensitivtyTable in READER_CAPS.
[in]transmitPowerIndex
Transmit Power Index; The value is the zero-based index into the transmitPowerLevelTable in READER_CAPS.
[in]transmitFrequencyIndex
Pointer to Frequency-hop table or Channel Index; In Frequency-hopping regulatory regions, this is the Frequency hop table ID. In case of Fixed Frequency, this is the one-based channel index in the FixedFrequencyTable.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
RFID_GetReaderCaps can be invoked to get the receiveSensitivtyTable, transmitPowerLevelTable and fixedFreqInfo/freqHopInfo as part of the READER_CAPS.
See also
RFID_GetAntennaConfig, RFID_GetPhysicalAntennaProperties, RFID_GetReaderCaps
Remarks
Example: See

◆ RFID_SetAntennaRfConfig()

RFID_STATUS WINAPI RFID_SetAntennaRfConfig ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
LPANTENNA_RF_CONFIG  lpAntennaRfConfig 
)

This function sets Antenna RF Configuration at the Reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; If zero, configuration will be applied on all Antennas.
[in]lpAntennaRfConfigContains the RF related configuration of the Antenna
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
See also
RFID_SetAntennaConfig, RFID_GetPhysicalAntennaProperties, RFID_GetReaderCaps
Remarks
Example: See

◆ RFID_GetAntennaRfConfig()

RFID_STATUS WINAPI RFID_GetAntennaRfConfig ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
LPANTENNA_RF_CONFIG  lpAntennaRfConfig 
)

This function gets Antenna Configuration at the Reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; If zero, configuration will be applied on all Antennas.
[in]lpAntennaRfConfigContains the RF related configuration of the Antenna
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
See also
RFID_GetAntennaConfig, RFID_GetPhysicalAntennaProperties, RFID_GetReaderCaps
Remarks
Example: See
RFID_HANDLE32 readerHandle;
READER_CAPS readerCaps;
UINT16 antennaId = 4;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
// Get the Reader Capability
rfidStatus = RFID_GetReaderCaps(readerHandle, &readerCaps);
// Get Antenna Configuration for Antenna Id
ANTENNA_RF_CONFIG AntennaRFConfig;
rfidStatus = RFID_GetAntennaRfConfig(readerHandle, 1, &AntennaRFConfig);
printf("\n RF Config of Antenna: %d: transmitPowerIndex-%d, receiveSensitivityIndex-%d, transmitFrequencyIndex-%d \
rfModeTableIndex-%d, tari-%d, transmitPort-%d,receivePort-%d, stopTriggerType-%d, stopTriggerValue-%d",
antennaId, AntennaRFConfig.transmitPowerIndex, AntennaRFConfig.receiveSensitivityIndex, AntennaRFConfig.transmitFrequencyIndex,
AntennaRFConfig.rfModeTableIndex,AntennaRFConfig.tari,AntennaRFConfig.transmitPort,AntennaRFConfig.receivePort,
AntennaRFConfig.antennaStopTrigger.stopTriggerValue = 3000;
rfidStatus = RFID_SetAntennaRfConfig(readerHandle, 1, &AntennaRFConfig);
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_GetPhysicalAntennaProperties()

RFID_STATUS WINAPI RFID_GetPhysicalAntennaProperties ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
BOOLEAN pStatus,
UINT32 pAntennaGain 
)

This function gets the physical properties of an Antenna from the Reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; cannot be zero.
[out]pStatus
Pointer to the connectivity status of the antenna.
[out]pAntennaGain
Pointer to the antenna gain.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
None
See also
RFID_GetAntennaConfig
Remarks
Example:
RFID_HANDLE32 readerHandle;
UINT16 antennaId = 4;
UINT32 antennaGain = 0;
BOOLEAN antennaConnected = FALSE;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
rfidStatus = RFID_GetPhysicalAntennaProperties(readerHandle, antennaId,
&antennaConnected, &antennaGain);
printf("\n Phy.Properties of Antenna: %d: %s, gain-%d",
antennaId,
antennaConnected? "TRUE" : "FALSE", antennaGain);
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_GetSingulationControl()

RFID_STATUS WINAPI RFID_GetSingulationControl ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
LPSINGULATION_CONTROL  lpSingulationControl 
)

This function provides interface to the get the Singulation control.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; cannot be zero.
[out]lpSingulationControl
Pointer to SINGULATION_CONTROL
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
See also
RFID_PerformInventory, RFID_StopInventory, RFID_AddPreFilter, RFID_DeletePreFilter, RFID_SetSingulationControl
Remarks
Example:
RFID_HANDLE32 readerHandle;
UINT16 antennaId = 1;
SINGULATION_CONTROL singulationControl;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
// Get Singulation Control of an Antenna
rfidStatus = RFID_GetSingulationControl(readerHandle, antennaId, &singulationControl);
printf("\n Tag population setting of AntennaId - %d is %d",
antennaId, singulationControl.tagPopulation);
// Change the Tag population settings for all Antenna
singulationControl.tagPopulation = 100;
rfidStatus = RFID_SetSingulationControl(readerHandle, 0, &singulationControl);
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_SetSingulationControl()

RFID_STATUS WINAPI RFID_SetSingulationControl ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
LPSINGULATION_CONTROL  lpSingulationControl 
)

This function provides interface to set the Singulation control.

Parameters
[in]readerHandle
Handle to the RFID device
[in]antennaID
Antenna ID; If zero, configuration will be applied on all Antennas.
[in]lpSingulationControl
Pointer to SINGULATION_CONTROL
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
The singulation control settings provided through this API reside in the API layer and will be sent to the reader only during Inventory and Access operations performed through the API; hence it does not override the reader defaults. However, when the user calls RFID_ResetConfigToFactoryDefaults the API fetches the defaults from the reader and overrides the user-settings. The Reader Defaults can be known through RFID_GetSingulationControl.
See also
RFID_PerformInventory, RFID_StopInventory, RFID_AddPreFilter, RFID_DeletePreFilter, RFID_GetSingulationControl, RFID_ResetConfigToFactoryDefaults
Remarks
Example: See

◆ RFID_ResetConfigToFactoryDefaults()

RFID_STATUS WINAPI RFID_ResetConfigToFactoryDefaults ( RFID_HANDLE32  readerHandle)

This function resets the reader configuration to factory defaults.

Parameters
[in]readerHandle
Handle to the RFID device
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
Remarks
Once reset to factory defaults, all the settings will be lost. i.e. the registered notifications, Singulation Controls and Pre-Filters. The application shall redo the settings after calling this function.
See also
None
Remarks
Example:
RFID_HANDLE32 readerHandle;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
// Reset to factory defaults
rfidStatus = RFID_ResetConfigToFactoryDefaults(readerHandle);
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_SaveLlrpConfig()

RFID_STATUS WINAPI RFID_SaveLlrpConfig ( RFID_HANDLE32  readerHandle,
LPVOID  rsvd 
)

This function saves the LLRP configuirations.

Parameters
[in]readerHandle
Handle to the RFID device
[in]rsvd
Reserved for future use
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
Remarks
See also
None
Remarks
Example:
RFID_HANDLE32 readerHandle;

◆ RFID_GetSaveLlrpConfigStatus()

RFID_STATUS WINAPI RFID_GetSaveLlrpConfigStatus ( RFID_HANDLE32  readerHandle,
BOOLEAN pSaveStatus 
)

This function returns the LLRP configuirations status(Saved or Not)

Parameters
[in]readerHandle
Handle to the RFID device
[in]pSaveStatus
variable to get status
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
Remarks
See also
None
Remarks
Example:
RFID_HANDLE32 readerHandle;

◆ RFID_SetGPOState()

RFID_STATUS WINAPI RFID_SetGPOState ( RFID_HANDLE32  readerHandle,
UINT32  portNumber,
BOOLEAN  gpoState 
)

This function performs the write to a general purpose output port.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]portNumber
Port Number of the GPI Port.
[in]gpoState
Carries value to set true/false to the specified port.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
None
See also
RFID_GetGPOState, RFID_EnableGPIPort, RFID_GetGPIState
Remarks
Example: See

◆ RFID_GetGPOState()

RFID_STATUS WINAPI RFID_GetGPOState ( RFID_HANDLE32  readerHandle,
UINT32  portNumber,
BOOLEAN pGPOState 
)

This function gets the current state of the specified GPO port.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]portNumber
Port Number of the GPO Port.
[out]pGPOState
Pointer to current state of the specified GPO port.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter out of Range
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
None
See also
RFID_SetGPOState, RFID_EnableGPIPort, RFID_GetGPIState
Remarks
Example: See

◆ RFID_GetGPIState()

RFID_STATUS WINAPI RFID_GetGPIState ( RFID_HANDLE32  readerHandle,
UINT32  portNumber,
BOOLEAN pGPIEnable,
GPI_PORT_STATE pState 
)

This function gets current configuration and state of a single GPI Port.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]portNumber
Port Number of the GPI Port.
[out]pGPIEnable
Pointer to current configuration of the specified GPI Port: Enabled/Disabled.
[out]pState
Pointer to current state of the specified specified GPI port, of type GPI_PORT_STATE.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter out of Range
  • RFID_CONFIG_GET_FAILED Failed to set the configuration
Remarks
None
See also
RFID_EnableGPIPort, RFID_GetGPOState, RFID_SetGPOState
Remarks
Example:
RFID_HANDLE32 readerHandle;
BOOLEAN gpiEnabled;
GPI_PORT_STATE gpiState;
UINT32 portNumber = 1;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
RFID_GetGPIState(readerHandle, portNumber, &gpiEnabled, &gpiState);
if(FALSE == gpiEnabled)
{
rfidStatus = RFID_EnableGPIPort(readerHandle, portNumber, TRUE);
}
printf("\n GPI port %d is %s: state - %s", portNumber,
gpiEnabled? "Enabled" : "Disabled",
GPI_PORT_STATE_LOW == gpiState? "Low" :
GPI_PORT_STATE_HIGH == gpiState? "High" : "Unknown");
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_EnableGPIPort()

RFID_STATUS WINAPI RFID_EnableGPIPort ( RFID_HANDLE32  readerHandle,
UINT32  portNumber,
BOOLEAN  gpiEnable 
)

This function enables a single GPI Pin as specified.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]portNumber
Port Number of the GPI Port.
[in]gpiEnable
Whether the port is to be enabled or disabled.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
None
See also
RFID_GetGPIState, RFID_GetGPOState, RFID_SetGPOState
Remarks
Example: See

◆ RFID_GetRFMode()

RFID_STATUS WINAPI RFID_GetRFMode ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
UINT32 pRfModeTableIndex,
UINT32 pTari 
)

This function gets the current RFMode from the Reader.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; cannot be zero.
[out]pRfModeTableIndex
Pointer to RfModeTableIndex which is an index to the RF_MODE_TABLE_ENTRY in UHF_RF_MODE_TABLE present in RF_MODES of READER_CAPS.
[out]pTari
Pointer to current Tari value.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
See also
RFID_SetRFMode
Remarks
Example:
RFID_HANDLE32 readerHandle;
READER_CAPS readerCaps;
UINT16 antennaId = 4;
UINT32 rfModeTableIndex, tari, minTari, maxTari;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("169.254.2.1"), 0, 0, NULL))
{
// Get the Reader Capability
rfidStatus = RFID_GetReaderCaps(readerHandle, &readerCaps);
// Get RF Mode
rfidStatus = RFID_GetRFMode(readerHandle, antennaId, &rfModeTableIndex, &tari);
RF_MODES* pTable = &readerCaps.rfModes;
if (pTable->numTables > 0)
{
for(int nIndex = 0; nIndex < pTable->pUHFTables[0].numEntries; nIndex++)
{
if(rfModeTableIndex == nIndex)
printf("\n ***********Current RF Mode Table*********");
else
printf("\n ******************************************");
printf("\n RF Mode Table %d: Mode Identifier %d", nIndex, pTable->pUHFTables[0].pTablesEntries[nIndex].modeIdentifer);
printf("\n BDR Value: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].bdrValue);
printf("\n DR: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].divideRatio);
printf("\n Modulation: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].modulation);
printf("\n PIE Value: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].pieValue);
printf("\n Min TARI: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].minTariValue);
printf("\n Max TARI: %d", pTable->pUHFTables[0].pTablesEntries[nIndex].maxTariValue);
}
if (pTable->pUHFTables[0].numEntries > 0)
{
rfModeTableIndex = pTable->pUHFTables[0].numEntries - 1;
minTari = pTable->pUHFTables[0].pTablesEntries[0].minTariValue;
maxTari = pTable->pUHFTables[0].pTablesEntries[0].maxTariValue;
if (minTari == maxTari)
{
tari = 0;
}
else
tari = (UINT32)((minTari + maxTari) / 2);
}
//Set RF Mode
rfidStatus = RFID_SetRFMode(readerHandle, antennaId, rfModeTableIndex, tari);
}
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_SetRFMode()

RFID_STATUS WINAPI RFID_SetRFMode ( RFID_HANDLE32  readerHandle,
UINT16  antennaID,
UINT32  rfModeTableIndex,
UINT32  tari 
)

This function sets the C1G2 RF Mode and the Tari value to use for the inventory operation.

Parameters
[in]readerHandle
Handle to the RFID device.
[in]antennaID
Antenna ID; If zero, configuration will be applied on all Antennas.
[in]rfModeTableIndex
Index to the desired RF_MODE_TABLE_ENTRY in UHF_RF_MODE_TABLE present in RF_MODES of READER_CAPS.
[in]tari
Value of Tari to use for this mode specified in nsec. This is specified if the mode selected has a Tari range. If the selected mode has a range, and the Tari is set to zero, the Reader implementation picks up any Tari value within the range. If the selected mode has a range, and the specified Tari is out of that range and is not set to zero, the function fails.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Invalid handle is provided
  • RFID_API_PARAM_ERROR Invalid parameter given
  • RFID_API_PARAM_OUT_OF_RANGE Parameter is out of Range
  • RFID_CONFIG_SET_FAILED Failed to set the configuration
Remarks
The rfModeTableIndex should be a valid modeIdentifer as defined by the Reader Capabilities and reported by RFID_GetRFMode as a list of RF_MODES(s)
See also
RFID_GetRFMode
Remarks
Example: See

◆ RFID_GetRadioPowerState()

RFID_STATUS WINAPI RFID_GetRadioPowerState ( RFID_HANDLE32  readerHandle,
BOOLEAN pPowerState 
)

This function gets the power state of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[out]pPowerState
Current power state whether turned ON/OFF.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
This function is used to get the Power state of the RFID Radio Module in the Hand held device.
See also
RFID_SetRadioPowerState
Remarks
Example:

◆ RFID_SetRadioPowerState()

RFID_STATUS WINAPI RFID_SetRadioPowerState ( RFID_HANDLE32  readerHandle,
BOOLEAN  powerState 
)

This function sets the power state of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[in]powerState
Current power state whether turned ON/OFF.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
This function is used to turn ON/OFF the RFID Radio Module to save the power during idle stage in the Hand held device.
See also
RFID_GetRadioPowerState
Remarks
Example:

◆ RFID_GetDutyCycle()

RFID_STATUS WINAPI RFID_GetDutyCycle ( RFID_HANDLE32  readerHandle,
UINT16 pDutyCycleIndex,
LPVOID  rsvd 
)

This function gets the duty cycle of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[in]pDutyCycleIndex
Pointer to current index to pDutyCycleValueList of DUTY_CYCLE_TABLE.
[in]rsvd
Reserved for future use.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
  • RFID_CONFIG_GET_FAILED Failed to get the configuration
Remarks
See also
RFID_SetDutyCycle
Remarks
Example:

◆ RFID_SetDutyCycle()

RFID_STATUS WINAPI RFID_SetDutyCycle ( RFID_HANDLE32  readerHandle,
UINT16  dutyCycleIndex,
LPVOID  rsvd 
)

This function sets the duty cycle of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[in]dutyCycleIndex
Zero-based index to the supported Duty cycles as reported in pDutyCycleValueList of DUTY_CYCLE_TABLE.
[in]rsvd
Reserved for future use.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
See also
RFID_GetDutyCycle
Remarks
Example:
RFID_HANDLE32 readerHandle;
READER_CAPS readerCaps;
UINT16 dutyCycleIndex = 0;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, NULL, 0, 0, NULL))
{
// Get the Reader Capability
rfidStatus = RFID_GetReaderCaps(readerHandle, &readerCaps);
if(readerCaps.lpDutyCycleTable != NULL)
{
for(int nIndex = 0; nIndex < readerCaps.lpDutyCycleTable->numValues; nIndex++)
{
printf("%d", readerCaps.lpDutyCycleTable->pDutyCycleValueList[nIndex]);
}
rfidStatus = RFID_GetDutyCycle(readerHandle, &dutyCycleIndex, NULL);
dutyCycleIndex = readerCaps.lpDutyCycleTable->numValues - 1;
rfidStatus = RFID_SetDutyCycle(readerHandle, dutyCycleIndex, NULL);
}
else
{
printf("DutyCycle not supported");
}
rfidStatus = RFID_Disconnect(readerHandle);
}

◆ RFID_GetRadioTransmitDelay()

RFID_STATUS WINAPI RFID_GetRadioTransmitDelay ( RFID_HANDLE32  readerHandle,
RADIO_TRANSMIT_DELAY_TYPE pType,
UINT8 pTime 
)

This function gets the transmit delay of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[out]pType
Current type of radio transmit delay.
[out]pTime
Current time of radio transmit delay.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
This function is used to get the transmit delay of the RFID Radio Module in the Hand held device.
See also
RFID_SetRadioTransmitDelay
Remarks
Example:

◆ RFID_SetRadioTransmitDelay()

RFID_STATUS WINAPI RFID_SetRadioTransmitDelay ( RFID_HANDLE32  readerHandle,
RADIO_TRANSMIT_DELAY_TYPE  type,
UINT8  time 
)

This function sets the transmit delay of the RFID Radio Module.

Parameters
[in]readerHandle
Handle returned by RFID_Connect.
[in]type
type of radio transmit delay.
[in]time
time of radio transmit delay.
Returns
If the function succeeds the return value is RFID_API_SUCCESS. If the function fails the return value is one of the following:
  • RFID_API_INVALID_HANDLE Handle provided is invalid
  • RFID_READER_FUNCTION_UNSUPPORTED Unsupported on host-based readers like XR and FX
Remarks
This function is used to configure radio transmit delay
See also
RFID_GetRadioTransmitDelay
Remarks
Example:
RFID_SetAntennaRfConfig
RFID_STATUS WINAPI RFID_SetAntennaRfConfig(RFID_HANDLE32 readerHandle, UINT16 antennaID, LPANTENNA_RF_CONFIG lpAntennaRfConfig)
This function sets Antenna RF Configuration at the Reader.
Definition: rfidapi.cpp:1320
RFID_GetReaderCaps
#define RFID_GetReaderCaps
Definition: rfidapi.h:88
DUTY_CYCLE_TABLE::numValues
UINT16 numValues
Number of elements in the array pDutyCycleValueList.
Definition: rfidapiStructs.h:382
RFID_GetSingulationControl
RFID_STATUS WINAPI RFID_GetSingulationControl(RFID_HANDLE32 readerHandle, UINT16 antennaID, LPSINGULATION_CONTROL lpSingulationControl)
This function provides interface to the get the Singulation control.
Definition: rfidapi.cpp:1582
RFID_ResetConfigToFactoryDefaults
RFID_STATUS WINAPI RFID_ResetConfigToFactoryDefaults(RFID_HANDLE32 readerHandle)
This function resets the reader configuration to factory defaults.
Definition: rfidapi.cpp:1736
ANTENNA_RF_CONFIG
Contains Antenna RF configuration.
Definition: rfidapiStructs.h:1316
READER_CAPSW::transmitPowerLevelTable
TRANSMIT_POWER_LEVEL_TABLE transmitPowerLevelTable
Transmit Power Level Table .
Definition: rfidapiStructs.h:568
BOOLEAN
BYTE BOOLEAN
Definition: rfidapiTypes.h:48
READER_CAPSW::lpDutyCycleTable
LPDUTY_CYCLE_TABLE lpDutyCycleTable
List of DutyCycle percentages supported by the reader.
Definition: rfidapiStructs.h:584
READER_CAPSW
Provides information on Reader Capabilities as reported by the Reader.
Definition: rfidapiStructs.h:531
RF_MODE_TABLE_ENTRY::maxTariValue
UINT32 maxTariValue
Definition: rfidapiStructs.h:315
ANTENNA_RF_CONFIG::transmitPort
UINT16 transmitPort
Transmit port of the Antenna.
Definition: rfidapiStructs.h:1323
RF_MODE_TABLE_ENTRY::bdrValue
UINT32 bdrValue
Definition: rfidapiStructs.h:310
ANTENNA_RF_CONFIG::receivePort
UINT16 receivePort
Receive port of the Antenna.
Definition: rfidapiStructs.h:1324
ANTENNA_RF_CONFIG::rfModeTableIndex
UINT32 rfModeTableIndex
Index to the RF_MODE_TABLE_ENTRY in UHF_RF_MODE_TABLE present in RF_MODES of READER_CAPS.
Definition: rfidapiStructs.h:1321
ANTENNA_RF_CONFIG::transmitPowerIndex
UINT16 transmitPowerIndex
The value is the zero-based index into the TransmitPowerTable.
Definition: rfidapiStructs.h:1318
GPI_PORT_STATE
GPI_PORT_STATE
GPI_PORT_STATE specifies the state of a GPI port.
Definition: rfidapiConstants.h:165
RFID_SetDutyCycle
RFID_STATUS WINAPI RFID_SetDutyCycle(RFID_HANDLE32 readerHandle, UINT16 dutyCycleIndex, LPVOID rsvd)
This function sets the duty cycle of the RFID Radio Module.
Definition: rfidapi.cpp:2537
RFID_GetAntennaConfig
RFID_STATUS WINAPI RFID_GetAntennaConfig(RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT16 *pReceiveSensitivityIndex, UINT16 *pTransmitPowerIndex, UINT16 *pTransmitFrequencyIndex)
This function gets the antenna configuration from the reader.
Definition: rfidapi.cpp:1160
RFID_SetSingulationControl
RFID_STATUS WINAPI RFID_SetSingulationControl(RFID_HANDLE32 readerHandle, UINT16 antennaID, LPSINGULATION_CONTROL lpSingulationControl)
This function provides interface to set the Singulation control.
Definition: rfidapi.cpp:1654
RFID_GetDutyCycle
RFID_STATUS WINAPI RFID_GetDutyCycle(RFID_HANDLE32 readerHandle, UINT16 *pDutyCycleIndex, LPVOID rsvd)
This function gets the duty cycle of the RFID Radio Module.
Definition: rfidapi.cpp:2466
RF_MODE_TABLE_ENTRY::modeIdentifer
UINT32 modeIdentifer
Reader defined identifier as index to this RF_MODES.
Definition: rfidapiStructs.h:308
RFID_Disconnect
RFID_STATUS WINAPI RFID_Disconnect(RFID_HANDLE32 readerHandle)
This function closes connection to the Reader.
Definition: rfidapi.cpp:1061
ANTENNA_RF_CONFIG::tari
UINT32 tari
Tari value.
Definition: rfidapiStructs.h:1322
TRANSMIT_POWER_LEVEL_TABLE::numValues
UINT16 numValues
Number of elements in the array pPowerValueList.
Definition: rfidapiStructs.h:356
RFID_SetRFMode
RFID_STATUS WINAPI RFID_SetRFMode(RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT32 rfModeTableIndex, UINT32 tari)
This function sets the C1G2 RF Mode and the Tari value to use for the inventory operation.
Definition: rfidapi.cpp:2298
FALSE
#define FALSE
Definition: rfidapiTypes.h:55
RFID_HANDLE32
void * RFID_HANDLE32
Definition: rfidapiTypes.h:76
SINGULATION_CONTROL
Singulation Control parameters.
Definition: rfidapiStructs.h:277
ANTENNA_STOP_TRIGGER::stopTriggerType
ANTENNA_STOP_TRIGGER_TYPE stopTriggerType
Antenna stop trigger of type ANTENNA_STOP_TRIGGER_TYPE.
Definition: rfidapiStructs.h:1305
ANTENNA_RF_CONFIG::receiveSensitivityIndex
UINT16 receiveSensitivityIndex
The value is the zero-based index into the ReceiveSensitivityTable.
Definition: rfidapiStructs.h:1319
RFID_GetGPIState
RFID_STATUS WINAPI RFID_GetGPIState(RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN *pGPIEnable, GPI_PORT_STATE *pState)
This function gets current configuration and state of a single GPI Port.
Definition: rfidapi.cpp:2040
RF_MODES::numTables
UINT16 numTables
Number of RF Modes supported by the Reader.
Definition: rfidapiStructs.h:344
DUTY_CYCLE_TABLE::pDutyCycleValueList
UINT16 * pDutyCycleValueList
Array of Duty Cycle values.
Definition: rfidapiStructs.h:384
SINGULATION_CONTROL::tagPopulation
UINT16 tagPopulation
An estimate of the tag population in view of the RF field of the antenna.
Definition: rfidapiStructs.h:279
GPI_PORT_STATE_LOW
@ GPI_PORT_STATE_LOW
GPI state is low.
Definition: rfidapiConstants.h:166
RFID_EnableGPIPort
RFID_STATUS WINAPI RFID_EnableGPIPort(RFID_HANDLE32 readerHandle, UINT32 portNumber, BOOLEAN gpiEnable)
This function enables a single GPI Pin as specified.
Definition: rfidapi.cpp:2111
RFID_GetPhysicalAntennaProperties
RFID_STATUS WINAPI RFID_GetPhysicalAntennaProperties(RFID_HANDLE32 readerHandle, UINT16 antennaID, BOOLEAN *pStatus, UINT32 *pAntennaGain)
This function gets the physical properties of an Antenna from the Reader.
Definition: rfidapi.cpp:1492
RFID_API_SUCCESS
@ RFID_API_SUCCESS
Definition: rfidapiErrors.h:27
UINT32
unsigned int UINT32
Definition: rfidapiTypes.h:30
TRUE
#define TRUE
Definition: rfidapiTypes.h:58
RF_MODE_TABLE_ENTRY::minTariValue
UINT32 minTariValue
Definition: rfidapiStructs.h:314
RFID_Connect
#define RFID_Connect
Definition: rfidapi.h:51
UHF_RF_MODE_TABLE::numEntries
UINT16 numEntries
Number of entries in pTablesEntries.
Definition: rfidapiStructs.h:332
RF_MODE_TABLE_ENTRY::modulation
MODULATION modulation
Definition: rfidapiStructs.h:311
RF_MODES
Contains information on RF Modes supported by the Reader.
Definition: rfidapiStructs.h:343
UINT16
unsigned short UINT16
Definition: rfidapiTypes.h:28
RFID_STATUS
RFID_STATUS
Definition: rfidapiErrors.h:26
RFID_PerformInventory
RFID_STATUS WINAPI RFID_PerformInventory(RFID_HANDLE32 readerHandle, LPPOST_FILTER lpPostFilter, LPANTENNA_INFO lpAntennaInfo, LPTRIGGER_INFO lpTriggerInfo, LPVOID rsvd)
This function performs the inventory operation.
Definition: rfidapi.cpp:4156
RFID_SetAntennaConfig
RFID_STATUS WINAPI RFID_SetAntennaConfig(RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT16 receiveSensitivityIndex, UINT16 transmitPowerIndex, UINT16 transmitFrequencyIndex)
This function sets Antenna Configuration at the Reader.
Definition: rfidapi.cpp:1256
ANTENNA_RF_CONFIG::antennaStopTrigger
ANTENNA_STOP_TRIGGER antennaStopTrigger
Antenna stop trigger configuration.
Definition: rfidapiStructs.h:1325
ANTENNA_RF_CONFIG::transmitFrequencyIndex
UINT16 transmitFrequencyIndex
In frequency-hopping regulatory regions, this is the Frequency hop table ID.
Definition: rfidapiStructs.h:1320
RF_MODES::pUHFTables
UHF_RF_MODE_TABLE * pUHFTables
Pointer to the RF Mode tables.
Definition: rfidapiStructs.h:345
ANTENNA_STOP_TRIGGER_TYPE_DURATION_SECS
@ ANTENNA_STOP_TRIGGER_TYPE_DURATION_SECS
Stop after a specified Second duration.
Definition: rfidapiConstants.h:735
GPI_PORT_STATE_HIGH
@ GPI_PORT_STATE_HIGH
GPI state is high.
Definition: rfidapiConstants.h:167
RF_MODE_TABLE_ENTRY::divideRatio
DIVIDE_RATIO divideRatio
Definition: rfidapiStructs.h:309
RFID_GetRFMode
RFID_STATUS WINAPI RFID_GetRFMode(RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT32 *pRfModeTableIndex, UINT32 *pTari)
This function gets the current RFMode from the Reader.
Definition: rfidapi.cpp:2216
ANTENNA_STOP_TRIGGER::stopTriggerValue
UINT16 stopTriggerValue
Stop Trigger Value.
Definition: rfidapiStructs.h:1306
RFID_GetAntennaRfConfig
RFID_STATUS WINAPI RFID_GetAntennaRfConfig(RFID_HANDLE32 readerHandle, UINT16 antennaID, LPANTENNA_RF_CONFIG lpAntennaRfConfig)
This function gets Antenna Configuration at the Reader.
Definition: rfidapi.cpp:1412
UHF_RF_MODE_TABLE::pTablesEntries
RF_MODE_TABLE_ENTRY * pTablesEntries
Pointer to RF MODE Table entries.
Definition: rfidapiStructs.h:333
RF_MODE_TABLE_ENTRY::pieValue
UINT32 pieValue
Definition: rfidapiStructs.h:313
READER_CAPSW::rfModes
RF_MODES rfModes
List of RF Mode tables supported by the Reader.
Definition: rfidapiStructs.h:561