 |
RFID API Documentation
1.0
Reference guide for RFID API
|
|
RFID API Documentation
1.0
Reference guide for RFID API
|
Enumerated Types More...
Go to the source code of this file.
Macros | |
| #define | NUM_LOCK_DATA_FIELDS 5 |
| This indicates the number of data fields that can be used for Lock operation. More... | |
Enumerated Types
| #define NUM_LOCK_DATA_FIELDS 5 |
This indicates the number of data fields that can be used for Lock operation.
The fields are as in LOCK_DATA_FIELD
| enum RFID_VERSION |
RFID_VERSION is a member of CONNECTION_INFO.
| enum RFID_EVENT_TYPE |
RFID_EVENT_TYPE is a parameter for RFID_RegisterEventNotification.
| Enumerator | |
|---|---|
| GPI_EVENT | A GPI event (state change from high to low, or low to high) has occurred on a GPI port. When this event is signaled, RFID_GetEventData can be called to know the GPI port and the event that has occurred. The Dll can store a maximum of 2000 GPI_EVENT_DATA, which if not retrieved using RFID_GetEventData, results in dropping of events in FIFO manner. |
| TAG_DATA_EVENT | tag data event and tag read event are same. |
| TAG_READ_EVENT | Applications can register for this event to get Tag Reports from the Reader. When the event corresponding to this is signaled, it implies that Tag(s) are available for the Application to read and the application can call RFID_GetReadTag till all Tags are fetched from the Dll's Queue. The Dll can store a maximum of 4096 TAG_DATA by default, which if not retrieved using RFID_GetEventData,results in dropping of further events. The maximum Tag Storage count can be altered using the function RFID_SetTagStorageSettings. Inorder to get Tag reports indicating result of Access-operations, applications can set the value in RFID_SetTagStorageSettings. |
| BUFFER_FULL_WARNING_EVENT | When the internal buffers are 90% full, this event will be signaled. |
| ANTENNA_EVENT | A particular Antenna has been Connected or Disconnected. When this event is signaled, RFID_GetEventData can be called to know the Antenna and the Connection Status that has occurred. The Dll can store a maximum of 2000 ANTENNA_EVENT_DATA, which if not retrieved using RFID_GetEventData, results in dropping of events in FIFO manner. |
| INVENTORY_START_EVENT | Inventory Operation has started. In case of periodic trigger this event will be triggered for each period. |
| INVENTORY_STOP_EVENT | Inventory Operation has stopped. In case of periodic trigger this event will be triggered for each period. |
| ACCESS_START_EVENT | Access Operation has started. |
| ACCESS_STOP_EVENT | Access Operation has stopped. |
| DISCONNECTION_EVENT | Event notifying disconnection from the Reader. When this event is signaled, RFID_GetEventData can be called to know the reason for the disconnection. The Application can call RFID_Reconnect periodically to attempt reconnection or call RFID_Disconnect to cleanup and exit. |
| BUFFER_FULL_EVENT | When the internal buffers are 100% full, this event will be signaled and tags are discarded in FIFO manner. |
| NXP_EAS_ALARM_EVENT | This Event is generated when Reader finds a(NXP)tag with it's EAS System bit |
| READER_EXCEPTION_EVENT | Event notifying that an exception has occurred in the Reader. When this event is signaled, RFID_GetEventData can be called to know the reason for the exception. The Application can continue to use the connection if the reader renders is usable. |
| HANDHELD_TRIGGER_EVENT | A Handheld Gun/Button event Pull/Release has occurred. When this event is signaled, RFID_GetEventData can be called to know which event that has occurred. The Dll can store a maximum of 2000 HANDHELD_TRIGGER_EVENT_DATA, which if not retrieved using RFID_GetEventData, results in dropping of events in FIFO manner. |
| DEBUG_INFO_EVENT | This Event is generated when Reader sends a debug information. |
| TEMPERATURE_ALARM_EVENT | When the reader's operating temperature reaches Threshold level, this event will be generated. RFID_GetEventData can be called to get the event details like source name (PA/Ambient), current Temperature and alarm Level (Low, High or Critical).> |
| RF_SURVEY_DATA_READ_EVENT | Applications can register for this event to get RF Survey Reports from the Reader. When the event corresponding to this is signaled, it implies that RF Survey data are available for the Application to read and the application can call RFID_GetRFSurvey or rfid_GetRfSurveyData till all RF Survey data are fetched from the Dll's Queue.The Dll can store a maximum of 4096 RF_SURVEY_DATA by default, which if not retrieved using RFID_GetEventData, results in dropping of further events. The maximum RF SURVEY Storage count can be altered using the function RFID_SetRFSurveyStorageSettings. Inorder to get RFSurvey reports indicating result of Access-operations, applications can set the value in RFID_SetRFSurveyStorageSettings. |
| RF_SURVEY_START_EVENT | RF Survey Operation has started. In case of periodic trigger this event will be triggered for each period. |
| RF_SURVEY_STOP_EVENT | RF Survey Operation has stopped. In case of periodic trigger this event will be triggered for each period. |
| AUTONOMOUS_EVENT | Autonomous Events, RFID_GetEventData() to ask LLRP reader to dump unreported event. if enable moving tag, RFID_GetEventData() to ask LLRP reader to dump stationary tag |
DISCONNECTION_EVENT_TYPE specifies the event indicating the reason for Disconnection.
| enum ANTENNA_EVENT_TYPE |
| enum GPI_PORT_STATE |
| enum READER_ID_TYPE |
FORWARD_LINK_MODULATION indicates the type of forward link modulation.
It is a member of RF_MODE_TABLE_ENTRY.
| Enumerator | |
|---|---|
| FORWARD_LINK_MODULATION_PR_ASK | |
| FORWARD_LINK_MODULATION_SSB_ASK | |
| FORWARD_LINK_MODULATION_DSB_ASK | |
| enum MODULATION |
MODULATION indicates the type of modulation.
It is a member of RF_MODE_TABLE_ENTRY.
| Enumerator | |
|---|---|
| MV_FM0 | |
| MV_2 | |
| MV_4 | |
| MV_8 | |
| enum DIVIDE_RATIO |
DIVIDE_RATIO indicates the Divide Ratio.
It is a member of RF_MODE_TABLE_ENTRY.
| Enumerator | |
|---|---|
| DR_8 | |
| DR_64_3 | |
SPECTRAL_MASK_INDICATOR indicates the Spectral mask characteristics of the mode.
It is a member of RF_MODE_TABLE_ENTRY.
| Enumerator | |
|---|---|
| SMI_UNKNOWN | |
| SMI_SI | |
| SMI_MI | |
| SMI_DI | |
| enum MEMORY_BANK |
MEMORY_BANK specifies the four memory banks as supported by Class 1 Gen 2 Specification.
| enum START_TRIGGER_TYPE |
START_TRIGGER_TYPE indicates type of start trigger.
| Enumerator | |
|---|---|
| START_TRIGGER_TYPE_IMMEDIATE | Start immediately when RFID_PerformInventory or RFID_PerformAccessSequence is called. |
| START_TRIGGER_TYPE_PERIODIC | Start periodically as per START_TRIGGER_PERIODIC. |
| START_TRIGGER_TYPE_GPI | Start based on GPI Trigger set by GPI_TRIGGER. |
| START_TRIGGER_TYPE_HANDHELD | Start based on Handheld Gun/Button Trigger set by HANDHELD_TRIGGER. |
| enum STOP_TRIGGER_TYPE |
STOP_TRIGGER_TYPE indicates the type of stop trigger.
| enum TRUNCATE_ACTION |
| enum SESSION |
SESSION specifies the 4 sessions as supported by Class 1 Gen 2 Specification.
| enum INVENTORY_STATE |
INVENTORY_STATE specifies the two inventory-States as supported by Class 1 Gen 2 Specification.
| Enumerator | |
|---|---|
| INVENTORY_STATE_A | Indicates to select tags in State A for the session specified in SINGULATION_CONTROL. |
| INVENTORY_STATE_B | Indicates to select tags in State B for the session specified in SINGULATION_CONTROL. |
| INVENTORY_STATE_AB_FLIP | Indicates to select tags in State A or B and then flip them for the session specified in SINGULATION_CONTROL. |
| enum FILTER_ACTION |
| enum SL_FLAG |
| enum TARGET |
TARGET specifies the Target Parameter for PreFilter (C1G2 Select) as supported by Class 1 Gen 2 Specification.
| enum STATE_UNAWARE_ACTION |
STATE_UNAWARE_ACTION specifies the state unware Action Parameter for PreFilter (C1G2 Select).
| enum STATE_AWARE_ACTION |
STATE_AWARE_ACTION specifies the state aware action Parameter for PreFilter (C1G2 Select).
| enum LOCK_PRIVILEGE |
LOCK_PRIVILEGE specifies the privilege Parameter for RFID_Lock.
| Enumerator | |
|---|---|
| LOCK_PRIVILEGE_NONE | This is the default Value for privilege field in LOCK_ACCESS_PARAMS. This value indicates that when user is calling RFID_Lock, he |
| LOCK_PRIVILEGE_READ_WRITE | Lock Privilege: Read-Write. |
| LOCK_PRIVILEGE_PERMA_LOCK | Lock Privilege: Permanent Lock. |
| LOCK_PRIVILEGE_PERMA_UNLOCK | Lock Privilege: Permanent unlock. |
| LOCK_PRIVILEGE_UNLOCK | Lock Privilege: Unlock. |
| enum LOCK_DATA_FIELD |
LOCK_DATA_FIELD specifies the data field on which lock operation is to performed using RFID_Lock.
RECOMMISSION_OPERATION_CODE specifies the operation Parameter for RFID_Recommission.
Note: Options 3 and 7 are subject to change as functionality is not finalized.
| enum ANTENNA_MODE |
ACCESS_OPERATION_CODE specifies the Operation Code for Operation Sequence.
| enum TAG_FIELD |
TAG_FIELD specifies the fields to be enabled in TAG_DATA.
| enum RFSURVEY_FIELD |
RFSURVEY_FIELD specifies the fields to be enabled in RF_SURVEY_DATA.
| enum TAG_EVENT |
TAG_EVENT specifies the event pertaining to a Tag reported via TAG_DATA.
| enum READER_TYPE |
| enum MATCH_PATTERN |
MATCH_PATTERN specifies whether the criteria of filtering tags matching patterns A and B.
It is a member of POST_FILTER and ACCESS_FILTER.
| enum MATCH_RANGE |
MATCH_RANGE specifies the Selection for match range.
It is a member of RSSI_RANGE_FILTER and TIME_RANGE_FILTER.
| enum TRACE_LEVEL |
TRACE_LEVEL specifies the trace-level setting for RFID_SetTraceLevel.
| enum READER_ID_LENGTH |
| enum SERVICE_ID |
| enum HEALTH_STATUS |
| enum USB_OPERATION_MODE |
| enum POWER_SOURCE_TYPE |
| enum LED_COLOR |
| enum OPERATION_QUALIFIER |
OPERATION_QUALIFIER indicates the operation to be performed on the corresponding antenna.
| enum TEMPERATURE_SOURCE |
| enum ALARM_LEVEL |
| enum BATTERY_STATUS |
1.8.18