Inventory

Functions
RFID_STATUS WINAPI	RFID_AddPreFilter (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPPRE_FILTER lpPreFilter, UINT32 *pFilterIndex)
	This function provides interface to the select command, which the reader applies to sort a particular tag population. More...
RFID_STATUS WINAPI	RFID_DeletePreFilter (RFID_HANDLE32 readerHandle, UINT16 antennaID, UINT32 filterIndex)
	This function removes one/all filters from the filter list, which the reader applies to sort a particular tag population. More...
RFID_STATUS WINAPI	RFID_NXPBrandCheck (RFID_HANDLE32 readerHandle, LPPOST_FILTER lpPostFilter, LPANTENNA_INFO lpAntennaInfo, LPTRIGGER_INFO lpTriggerInfo, UINT16 brandID)
	This function performs the inventory operation. More...
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. More...
RFID_STATUS WINAPI	RFID_StartRFSurvey (RFID_HANDLE32 readerHandle, UINT16 antennaID, LPRFSURVEY_STOP_TRIGGER lpRfSurveyStopTriggerInfo, UINT32 startFrequency, UINT32 endFrequency, LPVOID rsvd)
	This function performs the rf survey operation. More...
RFID_STATUS WINAPI	RFID_GetRFSurvey (RFID_HANDLE32 readerHandle, LPRFSURVEY_DATA lpRFSurveyData)
	This function returns a RFSurvey data if available. More...
RFID_STATUS WINAPI	RFID_PerformZoneInventory (RFID_HANDLE32 readerHandle, LPPOST_FILTER lpPostFilter, LPANTENNA_INFO lpAntennaInfo, LPTRIGGER_INFO lpTriggerInfo, LPZONE_SEQUENCE lpZoneSequence, LPVOID rsvd)
	This function performs the inventory operation on Zone List. More...
RFID_STATUS WINAPI	RFID_AddZoneW (RFID_HANDLE32 readerHandle, UINT16 zoneId, LPZONE_CONFIGW zoneConfig, LPVOID rsvd)
	This function Adds the Zone and sets configuration for Antennas in the Zone. More...
RFID_STATUS WINAPI	RFID_AddZoneA (RFID_HANDLE32 readerHandle, UINT16 zoneId, LPZONE_CONFIGA zoneConfig, LPVOID rsvd)
RFID_STATUS WINAPI	RFID_DeleteZone (RFID_HANDLE32 readerHandle, UINT32 zoneId, LPVOID rsvd)
	This function deletes zone based on provided zoneid. More...
RFID_STATUS WINAPI	RFID_NXPStopBrandCheck (RFID_HANDLE32 readerHandle)
	This function stops the inventory operation. More...
RFID_STATUS WINAPI	RFID_StopInventory (RFID_HANDLE32 readerHandle)
	This function stops the inventory operation. More...
RFID_STATUS WINAPI	RFID_StopRFSurvey (RFID_HANDLE32 readerHandle)
	This function stops the rf survey operation. More...

Detailed Description

Function Documentation

RFID_AddPreFilter()

RFID_STATUS WINAPI RFID_AddPreFilter	(	RFID_HANDLE32	readerHandle,
		UINT16	antennaID,
		LPPRE_FILTER	lpPreFilter,
		UINT32 *	pFilterIndex
	)

This function provides interface to the select command, which the reader applies to sort a particular tag population.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	antennaID	0 for all Antenna or the specific antennaID.
[in]	lpPreFilter	Pointer to PRE_FILTER.
[out]	pFilterIndex	Pointer to the Index to the pre-filter created if the API succeeds.

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_FILTER_MAX_FILTERS_EXCEEDED Reached limit for maximum number of filters that can be added

Remarks

The API returns a valid pFilterIndex if the API is successful. The filters set using this API will be applied for the next Inventory and Access operation. If the filters are not set or if the set filters are removed using RFID_DeletePreFilter, the reader will operate on factory defaults. The filters will not be persistant across application restarts. So the application will have to set the desired filters each time it is launched.

See also

RFID_PerformInventory, RFID_StopInventory, RFID_DeletePreFilter

Remarks

Example:

RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
PRE_FILTER prefilter;
UINT8 tagPattern[2] = {0x12, 0x11};
UINT32 filterIndex = 0;
ANTENNA_INFO antennaInfo;
TRIGGER_INFO triggerInfo;
LPTAG_DATA pTagData;
HANDLE inventoryDone = CreateEvent(NULL, FALSE, FALSE, NULL);
UINT16 antennaIDList[2] = {1, 3};
antennaInfo.pAntennaList = antennaIDList;
antennaInfo.length = 2;
triggerInfo.startTrigger.type = START_TRIGGER_TYPE_IMMEDIATE;
//we want the inventory to stop when 3 tags are found with in a duration of 2 seconds
triggerInfo.stopTrigger.type = STOP_TRIGGER_TYPE_TAG_OBSERVATION_WITH_TIMEOUT;
triggerInfo.stopTrigger.value.tagObservation.n = 3;
triggerInfo.stopTrigger.value.tagObservation.timeoutMilliseconds = 2000;
triggerInfo.tagReportTrigger = 0;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.208.20"), 0, 0, 0))
{
pTagData = RFID_AllocateTag(readerHandle);
if(NULL == pTagData)
{
printf("\n Tag Allocation failed");
}
else
{
 
// Register an Event for Inventory Completion
RFID_RegisterEventNotification(readerHandle, INVENTORY_STOP_EVENT, inventoryDone);
 
// Set pre-filters
prefilter.filterAction = FILTER_ACTION_STATE_UNAWARE;
prefilter.filterActionParams.stateUnawareAction = STATE_UNAWARE_ACTION_UNSELECT;
prefilter.memoryBank = MEMORY_BANK_EPC;
prefilter.bitOffset = 32; // skip the PC bits
prefilter.tagPatternBitCount = 2 * 8;
prefilter.pTagPattern = tagPattern;
//Set this filter for All Antennas
rfidStatus = RFID_AddPreFilter(readerHandle, 0, &prefilter, &filterIndex);
rfidStatus = RFID_PerformInventory(readerHandle, NULL, &antennaInfo, &triggerInfo, NULL);
if(RFID_API_SUCCESS == rfidStatus)
{
printf("\n\n Inventory with pre-filter:");
WaitForSingleObject(inventoryDone, INFINITE);
// Fetch the tags in case of successful inventory with pre-filters
while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
{
printTagData(pTagData->pTagID, pTagData->tagIDLength);
//printTagData: Refer RFID_PerformInventory - Example
}
}
else
{
printf("Error %S", RFID_GetErrorDescription(rfidStatus));
}
rfidStatus = RFID_DeletePreFilter(readerHandle, 0, filterIndex);
}
rfidStatus = RFID_Disconnect(readerHandle);
}
CloseHandle(inventoryDone);
}

RFID_DeletePreFilter()

RFID_STATUS WINAPI RFID_DeletePreFilter	(	RFID_HANDLE32	readerHandle,
		UINT16	antennaID,
		UINT32	filterIndex
	)

This function removes one/all filters from the filter list, which the reader applies to sort a particular tag population.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	antennaID	0 for all Antenna or the specific antennaID.
[in]	filterIndex	Index to the Filter to be removed.

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_FILTER_INVALID_INDEX Invalid Index

Remarks

The Filter of matching filterIndex will be removed for the specified antennaID. If antennaID is zero, Filter of matching filterIndex will be removed for all Antenna, where-ever present. If filterIndex is zero, all Filters will be removed for the specified antennaID. If antennaID and filterIndex are both zero, all filters will be removed.

See also

RFID_PerformInventory, RFID_StopInventory, RFID_AddPreFilter

Remarks

Example: See

RFID_AddPreFilter

RFID_NXPBrandCheck()

RFID_STATUS WINAPI RFID_NXPBrandCheck	(	RFID_HANDLE32	readerHandle,
		LPPOST_FILTER	lpPostFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTRIGGER_INFO	lpTriggerInfo,
		UINT16	brandID
	)

This function performs the inventory operation.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpPostFilter	Filter Criteria for the inventory operation to be performed. If this is NULL, inventory operation will be based on the pre-filters, which if not set, the Reader's default filters will apply.
[in]	lpAntennaInfo	Antenna List on which the inventory operation is to be performed. If this is NULL, inventory is performed on ALL antennas.
[in]	lpTriggerInfo	Trigger Criteria for the inventory operation. If this is NULL, inventory starts right away when this API is called, and stops when RFID_StopInventory is called.
[in]	brandID	BrandID struct

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 out of range [Antenna ID/GPI]
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
• RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation
• RFID_NXP_BRANDID_CHECK_IN_PROGRESS BrandID check in progress, cannot perform requested operation

Remarks

Tags inventoried as a result of RFID_PerformInventory can be obtained using RFID_GetReadTag. The application can wait on the event registered for TAG_READ_EVENT before calling RFID_GetReadTag or RFID_GetEventData.

See also

RFID_NXPStopBrandCheck

Remarks

Example:

RFID_NXPBrandCheck

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.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpPostFilter	Filter Criteria for the inventory operation to be performed. If this is NULL, inventory operation will be based on the pre-filters, which if not set, the Reader's default filters will apply.
[in]	lpAntennaInfo	Antenna List on which the inventory operation is to be performed. If this is NULL, inventory is performed on ALL antennas.
[in]	lpTriggerInfo	Trigger Criteria for the inventory operation. If this is NULL, inventory starts right away when this API is called, and stops when RFID_StopInventory is called.
[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_API_PARAM_ERROR Invalid parameter given
• RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID/GPI]
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
• RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation

Remarks

Tags inventoried as a result of RFID_PerformInventory can be obtained using RFID_GetReadTag. The application can wait on the event registered for TAG_READ_EVENT before calling RFID_GetReadTag or RFID_GetEventData.

See also

RFID_StopInventory, RFID_SetSingulationControl, RFID_AddPreFilter, RFID_DeletePreFilter,

Remarks

Example:

//Sample Code that prints TagID and Memory Bank
void printTagData(UINT8*pTagID, UINT32 tagIDLength)
{
    char  tagBuffer[64] = {0, };
    char* pTagReportData = tagBuffer;
    for(UINT32 index = 0; index < tagIDLength; index++)
    {
        if(0 < index && index%2 == 0)
        {
            *pTagReportData++ = '-';
        }
        sprintf(pTagReportData, "%02X", pTagID[index]);
        while(*pTagReportData) pTagReportData++;
    }
    printf("\n Tag ID: %s", tagBuffer);
}
// Event Management and Simple Inventory, GPO
// Code snippet for Simple Inventory without filters
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
HANDLE TagArrived = CreateEvent(NULL, FALSE, FALSE, NULL);
LPTAG_DATA pTagData;
TAG_STORAGE_SETTINGS tagStorageSettings;
BOOLEAN gpoState = FALSE;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
    // Optional step, Tag Storage Settings
    tagStorageSettings.maxMemoryBankByteCount = 64;
    tagStorageSettings.maxTagCount = 100;
    tagStorageSettings.maxTagIDByteCount  = 12;
    rfidStatus = RFID_SetTagStorageSettings(readerHandle, &tagStorageSettings);
    
    // Register Event Handle for Managing events
    rfidStatus = RFID_RegisterEventNotification(readerHandle, TAG_READ_EVENT, TagArrived);
    pTagData = RFID_AllocateTag(readerHandle);
    if(pTagData)
    {
        printf("\n\n Inventory:");
        rfidStatus = RFID_PurgeTags(readerHandle, NULL);
        // Simple Inventory which runs without any pre/post filters
        // on All Antennas, and which runs till RFID_StopInventory is called
        rfidStatus = RFID_PerformInventory(readerHandle, NULL, NULL, NULL, NULL);
        // Lets wait for 3 seconds for the Inventory operation to fetch a tag
        if(WaitForSingleObject(TagArrived, 3000) == WAIT_OBJECT_0)
        {
             // You can read Tag using RFID_GetEventData
             rfidStatus = RFID_GetEventData(readerHandle, TAG_READ_EVENT, pTagData);
             if(RFID_API_SUCCESS == rfidStatus)
             printTagData(pTagData->pTagID, pTagData->tagIDLength);
        }
        rfidStatus = RFID_StopInventory(readerHandle);
        // You can also read Tag using RFID_GetReadTag
        while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
        {
            // Say GPO port 1 is connected to an LED, lets blink the
            // Led when a tag is read
            rfidStatus = RFID_SetGPOState(readerHandle, 1, TRUE);
            printTagData(pTagData->pTagID, pTagData->tagIDLength);
        }
        if(RFID_API_SUCCESS == RFID_GetGPOState(readerHandle, 1, &gpoState))
        {
            // Disable the GPO now that inventory is over.
            if(gpoState)
                RFID_SetGPOState(readerHandle, 1, FALSE);
        }
     }
     rfidStatus = RFID_DeregisterEventNotification(readerHandle, TAG_READ_EVENT);
     rfidStatus = RFID_Disconnect(readerHandle);
 }
 CloseHandle(TagArrived);

RFID_StartRFSurvey()

RFID_STATUS WINAPI RFID_StartRFSurvey	(	RFID_HANDLE32	readerHandle,
		UINT16	antennaID,
		LPRFSURVEY_STOP_TRIGGER	lpRfSurveyStopTriggerInfo,
		UINT32	startFrequency,
		UINT32	endFrequency,
		LPVOID	rsvd
	)

This function performs the rf survey operation.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	antennaID	Antenna id on which the rf survey operation is to be performed.
[in]	lpRfSurveyStopTriggerInfo	Stop Trigger Criteria for the rf survey operation. If this is NULL, rf survey stops when RFID_StopRFSurvey is called.
[in]	startFrequency	start frequency value.
[in]	endFrequency	end frequency value.
[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_API_PARAM_ERROR Invalid parameter given
• RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID]
• RFID_RFSURVEY_IN_PROGRESS RF Survey in progress, cannot perform requested operation

Remarks

RF Survey data as a result of RFID_StartRFSurvey can be obtained using RFID_GetRFSurvey. The application can wait on the event registered for RF_SURVEY_DATA_READ_EVENT before calling RFID_GetRFSurvey or RFID_GetEventData.

See also

RFID_StopRFSurvey

Remarks

Example:

RFID_GetRFSurvey()

RFID_STATUS WINAPI RFID_GetRFSurvey	(	RFID_HANDLE32	readerHandle,
		LPRFSURVEY_DATA	lpRFSurveyData
	)

This function returns a RFSurvey data if available.

Parameters

[in]	readerHandle	Handle to the RFID device.
[out]	lpRFSurveyData	Pointer to RF_SURVEY_DATA.

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_NO_RF_SURVEY_DATA No rf survey data

Remarks

None

See also

RFID_RegisterEventNotification, RFID_StartRFSurvey, RFID_SetRFSurveyStorageSettings, RFID_AllocateRFSurvey

Remarks

Example: See

RFID_StartRFSurvey

RFID_PerformZoneInventory()

RFID_STATUS WINAPI RFID_PerformZoneInventory	(	RFID_HANDLE32	readerHandle,
		LPPOST_FILTER	lpPostFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTRIGGER_INFO	lpTriggerInfo,
		LPZONE_SEQUENCE	lpZoneSequence,
		LPVOID	rsvd
	)

This function performs the inventory operation on Zone List.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpPostFilter	Filter Criteria for the inventory operation to be performed. If this is NULL, inventory operation will be based on the pre-filters, which if not set, the Reader's default filters will apply.
[in]	lpAntennaInfo	Zone information with Antenna List on which the inventory operation is to be performed in AAR. If this is NULL, inventory is performed on ALL available Zones.
[in]	lpTriggerInfo	Trigger Criteria for the inventory operation. If this is NULL, inventory starts right away when this API is called, and stops when RFID_StopInventory is called.
[in]	lpZoneSequence	Holds zoen information
[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_API_PARAM_ERROR Invalid parameter given
• RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID/GPI]
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
• RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation

Remarks

Tags inventoried as a result of RFID_PerformInventory can be obtained using RFID_GetReadTag. The application can wait on the event registered for TAG_READ_EVENT before calling RFID_GetReadTag or RFID_GetEventData.

See also

RFID_StopInventory, RFID_SetSingulationControl, RFID_AddPreFilter, RFID_DeletePreFilter,

Remarks

Example:

//Sample Code that prints TagID and Memory Bank
void printTagData(UINT8*pTagID, UINT32 tagIDLength)
{
   char  tagBuffer[64] = {0, };
   char* pTagReportData = tagBuffer;
   for(UINT32 index = 0; index < tagIDLength; index++)
   {
     if(0 < index && index%2 == 0)
     {
        *pTagReportData++ = '-';
     }
     sprintf(pTagReportData, "%02X", pTagID[index]);
     while(*pTagReportData) pTagReportData++;
   }
   printf("\n Tag ID: %s", tagBuffer);
}
// Event Management and Simple Inventory, GPO
// Code snippet for Simple Inventory without filters
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
HANDLE TagArrived = CreateEvent(NULL, FALSE, FALSE, NULL);
LPTAG_DATA pTagData;
TAG_STORAGE_SETTINGS tagStorageSettings;
BOOLEAN gpoState = FALSE;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
     // Optional step, Tag Storage Settings
     tagStorageSettings.maxMemoryBankByteCount = 64;
     tagStorageSettings.maxTagCount = 100;
     tagStorageSettings.maxTagIDByteCount  = 12;
     rfidStatus = RFID_SetTagStorageSettings(readerHandle, &tagStorageSettings);
     
     // Register Event Handle for Managing events
     rfidStatus = RFID_RegisterEventNotification(readerHandle, TAG_READ_EVENT, TagArrived);
     pTagData = RFID_AllocateTag(readerHandle);
     if(pTagData)
     {
         printf("\n\n Inventory:");
         rfidStatus = RFID_PurgeTags(readerHandle, NULL);
         // Simple Inventory which runs without any pre/post filters
         // on All Antennas, and which runs till RFID_StopInventory is called
         rfidStatus = RFID_PerformZoneInventory(readerHandle, NULL, NULL, NULL, NULL);
         // Lets wait for 3 seconds for the Inventory operation to fetch a tag
         if(WaitForSingleObject(TagArrived, 3000) == WAIT_OBJECT_0)
         {
             // You can read Tag using RFID_GetEventData
             rfidStatus = RFID_GetEventData(readerHandle, TAG_READ_EVENT, pTagData);
             if(RFID_API_SUCCESS == rfidStatus)
                 printTagData(pTagData->pTagID, pTagData->tagIDLength);
         }
         rfidStatus = RFID_StopInventory(readerHandle);
         // You can also read Tag using RFID_GetReadTag
         while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
         {
             // Say GPO port 1 is connected to an LED, lets blink the
             // Led when a tag is read
             rfidStatus = RFID_SetGPOState(readerHandle, 1, TRUE);
             printTagData(pTagData->pTagID, pTagData->tagIDLength);
         }
         if(RFID_API_SUCCESS == RFID_GetGPOState(readerHandle, 1, &gpoState))
         {
             // Disable the GPO now that inventory is over.
             if(gpoState)
                RFID_SetGPOState(readerHandle, 1, FALSE);
         }
     }
     rfidStatus = RFID_DeregisterEventNotification(readerHandle, TAG_READ_EVENT);
     rfidStatus = RFID_Disconnect(readerHandle);
}
CloseHandle(TagArrived);

RFID_AddZoneW()

RFID_STATUS WINAPI RFID_AddZoneW	(	RFID_HANDLE32	readerHandle,
		UINT16	zoneId,
		LPZONE_CONFIGW	zoneConfig,
		LPVOID	rsvd
	)

This function Adds the Zone and sets configuration for Antennas in the Zone.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	zoneId	ID of the Zone to be created, if the zone ID already exists returns Error
[in]	zoneConfig	Contains the name and List of Antenna configuration which is part of the Zone
[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_API_PARAM_ERROR Invalid parameter given
• RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID/GPI]
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
• RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation

Remarks

Zone information and antenna configuration will be set to the reader when performZoneInventory is called

See also

RFID_PerformZoneInventory,RFID_DeleteZone

Remarks

Example:

void printTagData(UINT8*pTagID, UINT32 tagIDLength)
{
char  tagBuffer[64] = {0, };
char* pTagReportData = tagBuffer;
for(UINT32 index = 0; index < tagIDLength; index++)
{
if(0 < index && index%2 == 0)
{
*pTagReportData++ = '-';
}
sprintf(pTagReportData, "%02X", pTagID[index]);
while(*pTagReportData) pTagReportData++;
}
printf("\n Tag ID: %s", tagBuffer);
}
// Event Management and Simple Inventory, GPO
// Code snippet for Simple Inventory without filters
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
HANDLE TagArrived = CreateEvent(NULL, FALSE, FALSE, NULL);
LPTAG_DATA pTagData;
TAG_STORAGE_SETTINGS tagStorageSettings;
BOOLEAN gpoState = FALSE;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.190"), 0, 0, 0))
{
RFID_ResetConfigToFactoryDefaults(readerHandle);
TAG_STORAGE_SETTINGS tagStorageSetting;
RFID_GetTagStorageSettings(readerHandle, &tagStorageSetting);
tagStorageSetting.tagFields |= (ZONE_ID|ZONE_NAME);
tagStorageSetting.discardTagsOnInventoryStop = true;
RFID_SetTagStorageSettings(readerHandle, &tagStorageSetting);
 
LPTAG_DATA pTagData = RFID_AllocateTag(readerHandle);
if(NULL == pTagData)
{
return;
}
 
// Get Global RF Config and Stop Condition
ANTENNA_RF_CONFIG globalAntennaRFConfig={0};
rfidStatus = RFID_GetAntennaRfConfig(readerHandle, 1, &globalAntennaRFConfig);
globalAntennaRFConfig.antennaStopTrigger.stopTriggerType = ANTENNA_STOP_TRIGGER_TYPE_DURATION_SECS;
globalAntennaRFConfig.antennaStopTrigger.stopTriggerValue = 3000;
 
rfidStatus = RFID_SetAntennaRfConfig(readerHandle, 0, &globalAntennaRFConfig);
 
// Override settings only for Antenna 1
globalAntennaRFConfig.antennaStopTrigger.stopTriggerType = ANTENNA_STOP_TRIGGER_TYPE_N_ATTEMPTS;
globalAntennaRFConfig.antennaStopTrigger.stopTriggerValue = 2;
 
rfidStatus = RFID_SetAntennaRfConfig(readerHandle, 1, &globalAntennaRFConfig);
 
//
UINT16 zoneAntennaList[4] = {1,2,3,4};
UINT16 zoneAntennaList1[4] = {0};
UINT16 zoneAntennaList2[4] = {0};
 
char antennaIDs[] = "1 2";
AddZone(1, "Zone one two", antennaIDs,zoneAntennaList);
char antennaIDs1[] = "3 4";
AddZone(2, "Zone three four", antennaIDs1,zoneAntennaList1);
char antennaIDs2[] = "6 7";
AddZone(3, "Zone six seven" ,antennaIDs2,zoneAntennaList2);
 
ANTENNA_INFO antennaInfo;
antennaInfo.length = 2;
antennaInfo.pAntennaList = zoneAntennaList;
antennaInfo.pAntennaOpList = NULL;
 
ZONE_SEQUENCE zoneseq = {0};
ZONE_INFO zoneInfo[3] = {{1,zoneAntennaList,2,C1G2_OPERATION,0},{2,zoneAntennaList1,2,C1G2_OPERATION,0},{3,zoneAntennaList2,2,C1G2_OPERATION,0}};
zoneseq.pZoneList = zoneInfo;
zoneseq.zoneListCount = 3;
 
rfidStatus = RFID_PerformZoneInventory(readerHandle, NULL, &antennaInfo, NULL, &zoneseq, NULL);
if(RFID_API_SUCCESS == rfidStatus)
LOG_MSG(TEXT("PerformZoneInventory Success"));
 
//Wait for sometime so that some tags are reported from the Reader
Sleep(10000);
//
rfidStatus = RFID_StopInventory(readerHandle);
int tagCount = 0;
while(RFID_API_SUCCESS == RFID_GetReadTag(readerHandle, pTagData))
{
if(pTagData->opCode != ACCESS_OPERATION_NONE)
{
tagCount = 0;
break;
}
else
{
printTagData(pTagData);
tagCount++;
}
}
 
rfidStatus = RFID_DeleteZone(readerHandle,1,NULL);
if(RFID_API_SUCCESS == rfidStatus)
printf("DeleteZone Success");
 
rfidStatus = RFID_DeleteZone(readerHandle,0,NULL);
if(RFID_API_SUCCESS == rfidStatus)
printf("RFID_DeleteZone Delete All Zone Success");
 
RFID_DeallocateTag(readerHandle, pTagData);
}
 
 
void AddZone(int id, char* name, char* antennaIDs,UINT16 * zoneAntennaList)
{
int antennaCount = 0;
char *pchT = antennaIDs;
while (*pchT++ != NULL)
{
if (*pchT == ' ')
antennaCount++;
}
if (antennaCount > 0) antennaCount++;
char *pch;
pch = strtok(antennaIDs, " ");
int antennaIndex = 0;
int antennaID;
 
ANTENNA_RF_CONFIG globalAntennaRFConfig={0};
RFID_STATUS rfidStatus = RFID_GetAntennaRfConfig(readerHandle, 1, &globalAntennaRFConfig);
globalAntennaRFConfig.antennaStopTrigger.stopTriggerType = ANTENNA_STOP_TRIGGER_TYPE_DURATION_SECS;
globalAntennaRFConfig.antennaStopTrigger.stopTriggerValue = 3000;
 
ZONE_CONFIG zoneConfig={0};
zoneConfig.antennaCount = antennaCount;
zoneConfig.lpAntennaConfiguartions;
zoneConfig.lpZoneGlobalAntennaConfiguration = NULL;
#ifndef UNICODE
strcpy(zoneConfig.ZoneName,name);
#else
mbstowcs(zoneConfig.ZoneName,name,MAX_PATH);
#endif
zoneConfig.lpAntennaConfiguartions = new ANTENNA_CONFIG[antennaCount];
while (pch != NULL)
{
antennaID = atoi(pch);
zoneAntennaList[antennaIndex] = antennaID;
zoneConfig.lpAntennaConfiguartions[antennaIndex].antennaID = antennaID;
 
zoneConfig.lpAntennaConfiguartions[antennaIndex].lpAntennaRfConfig = &globalAntennaRFConfig;
zoneConfig.lpAntennaConfiguartions[antennaIndex].lpAntennaRfConfig->antennaStopTrigger.stopTriggerType = ANTENNA_STOP_TRIGGER_TYPE_DURATION_SECS;
zoneConfig.lpAntennaConfiguartions[antennaIndex].lpAntennaRfConfig->antennaStopTrigger.stopTriggerValue = 2;
// Get Singulation Control
SINGULATION_CONTROL singulationControl;
RFID_GetSingulationControl(readerHandle, antennaID, &singulationControl);
singulationControl.tagPopulation = 2 ^ 6;
singulationControl.session = SESSION_S0;
zoneConfig.lpAntennaConfiguartions[antennaIndex].lpSingulationControl = &singulationControl;
zoneConfig.lpAntennaConfiguartions[antennaIndex].lpPreFilterList = NULL;
antennaIndex++;
// Fetch the next antenna
pch = strtok(NULL, " ");
}
rfidStatus = RFID_AddZone(readerHandle,id,&zoneConfig,0);
if(RFID_API_SUCCESS == rfidStatus)
LOG_MSG(TEXT("Addzone done"));
}

RFID_AddZoneA()

RFID_STATUS WINAPI RFID_AddZoneA	(	RFID_HANDLE32	readerHandle,
		UINT16	zoneId,
		LPZONE_CONFIGA	zoneConfig,
		LPVOID	rsvd
	)

RFID_DeleteZone()

RFID_STATUS WINAPI RFID_DeleteZone	(	RFID_HANDLE32	readerHandle,
		UINT32	zoneId,
		LPVOID	rsvd
	)

This function deletes zone based on provided zoneid.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	zoneId	Zone ID assigned at a time of AddZone
[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_API_PARAM_ERROR Invalid parameter given
• RFID_API_PARAM_OUT_OF_RANGE Parameter out of range [Antenna ID/GPI]
• RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation
• RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation
• RFID_TAG_LOCATING_IN_PROGRESS Tag Locating in progress, cannot perform requested operation
• RFID_NXP_EAS_SCAN_IN_PROGRESS NXP EAS SCAN in progress, cannot perform requested operation

Remarks

Provide zoneID value equal to zero to delete all zones

See also

RFID_PerformZoneInventory, RFID_AddZone

Remarks

Example: Refer to RFID_AddZone example

RFID_NXPStopBrandCheck()

RFID_STATUS WINAPI RFID_NXPStopBrandCheck

(

RFID_HANDLE32

readerHandle

)

This function stops the inventory operation.

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 Handle provided is invalid
• NXP_BRANDID_CHECK There is no BrandId check in progress

Remarks

See also

RFID_NXPBrandCheck

Remarks

Example: See

RFID_NXPStopBrandCheck

RFID_StopInventory()

RFID_STATUS WINAPI RFID_StopInventory

(

RFID_HANDLE32

readerHandle

)

This function stops the inventory operation.

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 Handle provided is invalid
• RFID_NO_INVENTORY_IN_PROGRESS There is no Inventory in progress

Remarks

See also

RFID_PerformInventory, RFID_SetSingulationControl, RFID_AddPreFilter, RFID_DeletePreFilter

Remarks

Example: See

RFID_PerformInventory

RFID_StopRFSurvey()

RFID_STATUS WINAPI RFID_StopRFSurvey

(

RFID_HANDLE32

readerHandle

)

This function stops the rf survey operation.

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 Handle provided is invalid
• RFID_NO_RF_SURVEY_OPERATION_IN_PROGRESS There is no RF Survey in progress

Remarks

See also

RFID_StartRFSurvey

Remarks

Example: See

RFID_StartRFSurvey