![]() |
RFID API Documentation
1.0
Reference guide for RFID API
|
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... | |
| 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.
| [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. |
| RFID_STATUS WINAPI RFID_SetAntennaConfig | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| UINT16 | receiveSensitivityIndex, | ||
| UINT16 | transmitPowerIndex, | ||
| UINT16 | transmitFrequencyIndex | ||
| ) |
This function sets Antenna Configuration at the Reader.
| [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. |
| RFID_STATUS WINAPI RFID_SetAntennaRfConfig | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| LPANTENNA_RF_CONFIG | lpAntennaRfConfig | ||
| ) |
This function sets Antenna RF Configuration at the Reader.
| [in] | readerHandle | Handle to the RFID device. |
| [in] | antennaID | Antenna ID; If zero, configuration will be applied on all Antennas. |
| [in] | lpAntennaRfConfig | Contains the RF related configuration of the Antenna |
| RFID_STATUS WINAPI RFID_GetAntennaRfConfig | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| LPANTENNA_RF_CONFIG | lpAntennaRfConfig | ||
| ) |
This function gets Antenna Configuration at the Reader.
| [in] | readerHandle | Handle to the RFID device. |
| [in] | antennaID | Antenna ID; If zero, configuration will be applied on all Antennas. |
| [in] | lpAntennaRfConfig | Contains the RF related configuration of the Antenna |
| 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.
| [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. |
| RFID_STATUS WINAPI RFID_GetSingulationControl | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| LPSINGULATION_CONTROL | lpSingulationControl | ||
| ) |
This function provides interface to the get the Singulation control.
| [in] | readerHandle | Handle to the RFID device. |
| [in] | antennaID | Antenna ID; cannot be zero. |
| [out] | lpSingulationControl | Pointer to SINGULATION_CONTROL |
| RFID_STATUS WINAPI RFID_SetSingulationControl | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| LPSINGULATION_CONTROL | lpSingulationControl | ||
| ) |
This function provides interface to set the Singulation control.
| [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 |
| RFID_STATUS WINAPI RFID_ResetConfigToFactoryDefaults | ( | RFID_HANDLE32 | readerHandle | ) |
This function resets the reader configuration to factory defaults.
| [in] | readerHandle | Handle to the RFID device |
| RFID_STATUS WINAPI RFID_SaveLlrpConfig | ( | RFID_HANDLE32 | readerHandle, |
| LPVOID | rsvd | ||
| ) |
This function saves the LLRP configuirations.
| [in] | readerHandle | Handle to the RFID device |
| [in] | rsvd | Reserved for future use |
| RFID_STATUS WINAPI RFID_GetSaveLlrpConfigStatus | ( | RFID_HANDLE32 | readerHandle, |
| BOOLEAN * | pSaveStatus | ||
| ) |
This function returns the LLRP configuirations status(Saved or Not)
| [in] | readerHandle | Handle to the RFID device |
| [in] | pSaveStatus | variable to get status |
| RFID_STATUS WINAPI RFID_SetGPOState | ( | RFID_HANDLE32 | readerHandle, |
| UINT32 | portNumber, | ||
| BOOLEAN | gpoState | ||
| ) |
This function performs the write to a general purpose output port.
| [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. |
| RFID_STATUS WINAPI RFID_GetGPOState | ( | RFID_HANDLE32 | readerHandle, |
| UINT32 | portNumber, | ||
| BOOLEAN * | pGPOState | ||
| ) |
This function gets the current state of the specified GPO port.
| [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. |
| 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.
| [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. |
| RFID_STATUS WINAPI RFID_EnableGPIPort | ( | RFID_HANDLE32 | readerHandle, |
| UINT32 | portNumber, | ||
| BOOLEAN | gpiEnable | ||
| ) |
This function enables a single GPI Pin as specified.
| [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. |
| RFID_STATUS WINAPI RFID_GetRFMode | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | antennaID, | ||
| UINT32 * | pRfModeTableIndex, | ||
| UINT32 * | pTari | ||
| ) |
This function gets the current RFMode from the Reader.
| [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. |
| 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.
| [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. |
| RFID_STATUS WINAPI RFID_GetRadioPowerState | ( | RFID_HANDLE32 | readerHandle, |
| BOOLEAN * | pPowerState | ||
| ) |
This function gets the power state of the RFID Radio Module.
| [in] | readerHandle | Handle returned by RFID_Connect. |
| [out] | pPowerState | Current power state whether turned ON/OFF. |
| RFID_STATUS WINAPI RFID_SetRadioPowerState | ( | RFID_HANDLE32 | readerHandle, |
| BOOLEAN | powerState | ||
| ) |
This function sets the power state of the RFID Radio Module.
| [in] | readerHandle | Handle returned by RFID_Connect. |
| [in] | powerState | Current power state whether turned ON/OFF. |
| RFID_STATUS WINAPI RFID_GetDutyCycle | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 * | pDutyCycleIndex, | ||
| LPVOID | rsvd | ||
| ) |
This function gets the duty cycle of the RFID Radio Module.
| [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. |
| RFID_STATUS WINAPI RFID_SetDutyCycle | ( | RFID_HANDLE32 | readerHandle, |
| UINT16 | dutyCycleIndex, | ||
| LPVOID | rsvd | ||
| ) |
This function sets the duty cycle of the RFID Radio Module.
| [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. |
| 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.
| [in] | readerHandle | Handle returned by RFID_Connect. |
| [out] | pType | Current type of radio transmit delay. |
| [out] | pTime | Current time of radio transmit delay. |
| 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.
| [in] | readerHandle | Handle returned by RFID_Connect. |
| [in] | type | type of radio transmit delay. |
| [in] | time | time of radio transmit delay. |