Nxp

Functions
RFID_STATUS WINAPI	RFID_NXPSetEAS (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPNXP_SET_EAS_PARAMS lpNXPSetEASParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function sets the EAS (Electronic Article Surveillance) bit on one more NXP tags in the FOV. More...
RFID_STATUS WINAPI	RFID_NXPReadProtect (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPNXP_READ_PROTECT_PARAMS lpNXPReadProtectParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function sets the Quiet bit on one more NXP tags in the FOV. More...
RFID_STATUS WINAPI	RFID_NXPResetReadProtect (RFID_HANDLE32 readerHandle, LPNXP_RESET_READ_PROTECT_PARAMS lpNXPResetReadProtectParams, LPANTENNA_INFO lpAntennaInfo, LPVOID rsvd)
	This function resets the Quiet bit on the NXP tags in the FOV.The antenna Info on which this operation is to be performed may be specified. More...
RFID_STATUS WINAPI	RFID_PerformNXPEASScan (RFID_HANDLE32 readerHandle, LPANTENNA_INFO lpAntennaInfo, LPTRIGGER_INFO lpTriggerInfo, LPVOID rsvd)
	This function performs the NXP EAS Scan operation. More...
RFID_STATUS WINAPI	RFID_StopNXPEASScan (RFID_HANDLE32 readerHandle)
	This function stops the NXP EAS Scan operation. More...
RFID_STATUS WINAPI	RFID_NXPChangeConfig (RFID_HANDLE32 readerHandle, UINT8 *pTagID, UINT32 tagIDLength, LPNXP_CHANGE_CONFIG_PARAMS lpNXPChangeConfigParams, LPACCESS_FILTER lpAccessFilter, LPANTENNA_INFO lpAntennaInfo, LPTAG_DATA lpTagData, LPVOID rsvd)
	This function sets the change config word for G2IL Tags. More...

Detailed Description

Function Documentation

RFID_NXPSetEAS()

RFID_STATUS WINAPI RFID_NXPSetEAS	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPNXP_SET_EAS_PARAMS	lpNXPSetEASParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function sets the EAS (Electronic Article Surveillance) bit on one more NXP tags in the FOV.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Pointer to the byte array containing tagID
[in]	tagIDLength	Length of the byte array containing tagID
[in]	lpNXPSetEASParams	Pointer to NXP_SET_EAS_PARAMS structure containing the Access-Password and the desired EAS-bit state of the NXP tag(s).
[in]	lpAccessFilter	Pointer to Access filter structure specifying the tag-filter criteria for the current Access operation
[in]	lpAntennaInfo	Pointer to ANTENNA_INFO structure specifying the Antenna IDs on which the access operation is to be performed
[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.
RFID_API_PARAM_ERROR Parameter is invalid. RFID_ACCESS_NXP_TAG_SET_EAS_FAILED Failed to change EAS bit on the specified tag.**
RFID_API_COMMAND_TIMEOUT Timeout and no responses from the reader. RFID_COMM_NO_CONNECTION No Connection exists to the Host. RFID_INVENTORY_IN_PROGRESS Inventory in progress, cannot perform requested operation. RFID_ACCESS_IN_PROGRESS Access Operation in progress, cannot perform requested operation. RFID_READER_FUNCTION_UNSUPPORTED Function not supported by Reader. RFID_ACCESS_TAG_NOT_FOUND Tag(s) not found in the field which matches the set Filter(s).

Remarks

See also

RFID_PerformTagLocationing

Remarks

Example: See

// Code Snippets for setting tag's EAS bits and Running EAS on the supported reader
 
UINT8 NXPtagID[12] = {0x4e, 0x58, 0x50, 0x27, 0xb6, 0x8e, 0x3a, 0x00, 0x00, 0x00, 0x00, 0xc8};
UINT8 NXPPasswordData[4] = {0x12, 0x34, 0x56, 0x78};
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
CONNECTION_INFO connectionInfo;
connectionInfo.version = RFID_API3_5_1;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.208.38"), 0, 0, &connectionInfo))
{  
 
     // Write Access-password into NXP tag
     WRITE_ACCESS_PARAMS writeAccessParams;
     writeAccessParams.accessPassword = 0;
     writeAccessParams.pWriteData = NXPPasswordData;
     writeAccessParams.writeDataLength  = 4; 
     writeAccessParams.memoryBank = MEMORY_BANK_RESERVED;     
     writeAccessParams.byteOffset = 4;    
     if(rfidStatus == RFID_API_SUCCESS)
     {
         NXP_SET_EAS_PARAMS setEASParams;         
         setEASParams.accessPassword = 0x12345678;         
         setEASParams.EASState = true;          
         // Set EAS bit on the NXP tag          
         if(RFID_API_SUCCESS == RFID_NXPSetEAS(readerHandle, NXPtagID, 12, &setEASParams, NULL, NULL, NULL))         
         {
             // Fill up AntennaInfo structure to specify EAS operation to be performed on atleast on antenna during Inventory API call
              READER_CAPS readerCaps;            
              RFID_GetReaderCaps(readerHandle, &readerCaps);               
              ANTENNA_INFO AntennaInfo;               
              AntennaInfo.length = readerCaps.numAntennas;               
              AntennaInfo.pAntennaList = new UINT16[AntennaInfo.length];             
              AntennaInfo.pAntennaOpList = new OPERATION_QUALIFIER[AntennaInfo.length];               
              for(UINT32 nIndex = 0; nIndex < AntennaInfo.length; nIndex++)              
              {             
                  AntennaInfo.pAntennaList[nIndex] = nIndex+1;               
                  AntennaInfo.pAntennaOpList[nIndex] = NXP_EAS_SCAN;**               
              }               
              HANDLE hEASAlarmEvent = CreateEvent(NULL, false, false, NULL);               
              RFID_RegisterEventNotification(readerHandle, NXP_EAS_ALARM_EVENT, hEASAlarmEvent); 
             
              // Inventory API called here inititates EAS operation in all antennae and reader sets off EAS_ALARM_EVENT once it receives**               
              // EAS Alarm Notification from the tag whose EAS bit has just been set
              
              RFID_PerformInventory(readerHandle, NULL, &AntennaInfo, NULL, NULL);              
              WaitForSingleObject(hEASAlarmEvent, INFINITE);           
              RFID_StopInventory(readerHandle);
              
              // This code reset the EAS bit on the same tag to prevent raising false alarms
              
              setEASParams.EASState = false;**               
              RFID_NXPSetEAS(readerHandle, NXPtagID, 12, &setEASParams, NULL, NULL, NULL);
       
              // Clean-up              
              if (AntennaInfo.pAntennaList)               
              {            
                   delete []AntennaInfo.pAntennaList;               
                   AntennaInfo.pAntennaList = NULL;            
              }
              if (AntennaInfo.pAntennaOpList)               
              {              
                   delete []AntennaInfo.pAntennaOpList;             
                   AntennaInfo.pAntennaOpList = NULL;               
              }              
           }          
        }
        RFID_Disconnect(readerHandle);**               
    }

RFID_NXPReadProtect()

RFID_STATUS WINAPI RFID_NXPReadProtect	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPNXP_READ_PROTECT_PARAMS	lpNXPReadProtectParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function sets the Quiet bit on one more NXP tags in the FOV.

One can specify the Access filter-criteria on which this operation is to be performed. Also, the antenna Info on which this operation is to be performed may be specified

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Pointer to the byte array containing tagID
[in]	tagIDLength	Length of the byte array containing tagID
[in]	lpNXPReadProtectParams	Pointer to NXP_READ_PROTECT_PARAMS structure containing the Access-Password of the NXP tag(s)
[in]	lpAccessFilter	Pointer to Access filter structure specifying the tag-filter criteria for the current Access operation
[in]	lpAntennaInfo	Pointer to ANTENNA_INFO structure specifying the Antenna IDs on which the access operation is to be performed
[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 One of the parameters has taken an erroneous value
• RFID_ACCESS_NXP_TAG_READ_PROTECT_FAILED Failed to set the Quiet bit on the specified tag

Remarks

The API RFID_NXPReadProtect sets the Quiet bit on one or more NXP tags. As a result, these tags trace-back a string of zeroes during Inventory and don't respond to access-operations, there by preventing unsecure access to Tag information. To put them back into normal mode, one has to call RFID_NXPResetReadProtect API.

See also

RFID_NXPResetReadProtect

Remarks

Example:

// Code snippets to set Quiet bit on a single NXP tag and protect it from further access operations.
// ResetQuiet operation is also shown
{
UINT8 NXPtagID[12] = {0x4e, 0x58, 0x50, 0x27, 0xb6, 0x8e, 0x3a, 0x00, 0x00, 0x00, 0x00, 0xc8};
UINT8 NXPPasswordData[4] = {0x12, 0x34, 0x56, 0x78};
UINT32 nSuccess = 0, nFailure = 0;
RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
CONNECTION_INFO connectionInfo;
connectionInfo.version = RFID_API3_5_1;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.208.38"), 0, 0, &connectionInfo))
{
// Write Access-password into NXP tag
WRITE_ACCESS_PARAMS writeAccessParams;
writeAccessParams.accessPassword = 0;
writeAccessParams.pWriteData = NXPPasswordData;
writeAccessParams.writeDataLength  = 4;
writeAccessParams.memoryBank = MEMORY_BANK_RESERVED;
writeAccessParams.byteOffset = 4;
rfidStatus = RFID_Write(readerHandle, NXPtagID, 12, &writeAccessParams, NULL, NULL, NULL);
if(rfidStatus == RFID_API_SUCCESS)
{
NXP_READ_PROTECT_PARAMS readProtectParams;
readProtectParams.accessPassword = 0x12345678;
rfidStatus = RFID_NXPReadProtect(readerHandle, NXPtagID, 12, &readProtectParams, NULL, NULL, NULL);
if(rfidStatus == RFID_API_SUCCESS)
{
NXPPasswordData[3] = 87;
 
rfidStatus = RFID_Write(readerHandle, NXPtagID, 12, &writeAccessParams, NULL, NULL, NULL);
// Access will fail on a quietened tag
 
NXP_RESET_READ_PROTECT_PARAMS resetReadProtectParams;
resetReadProtectParams.accessPassword = 0x12345678;
rfidStatus = RFID_NXPResetReadProtect(readerHandle, &resetReadProtectParams, NULL, NULL);
RFID_GetLastAccessResult(readerHandle, &nSuccess, &nFailure);
// nSuccess -> greater than equal to 1
 
rfidStatus = RFID_Write(readerHandle, NXPtagID, 12, &writeAccessParams, NULL, NULL, NULL);
// Access will now succeed
}
}
}
RFID_Disconnect(readerHandle);
}

RFID_NXPResetReadProtect()

RFID_STATUS WINAPI RFID_NXPResetReadProtect	(	RFID_HANDLE32	readerHandle,
		LPNXP_RESET_READ_PROTECT_PARAMS	lpNXPResetReadProtectParams,
		LPANTENNA_INFO	lpAntennaInfo,
		LPVOID	rsvd
	)

This function resets the Quiet bit on the NXP tags in the FOV.The antenna Info on which this operation is to be performed may be specified.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpNXPResetReadProtectParams	Pointer to NXP_RESET_READ_PROTECT_PARAMS structure containing the Access-Password of the NXP tag(s)
[in]	lpAntennaInfo	Pointer to ANTENNA_INFO structure specifying the Antenna IDs on which the access operation is to be performed
[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 One of the parameters has taken an erroneous value

Remarks

The API RFID_NXPResetReadProtect puts back all the NXP tags into normal mode. All the NXP tags with the matching access-password will be affected.

See also

Remarks

Example: See RFID_NXPReadProtect

See RFID_NXPReadProtect

RFID_PerformNXPEASScan()

RFID_STATUS WINAPI RFID_PerformNXPEASScan	(	RFID_HANDLE32	readerHandle,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTRIGGER_INFO	lpTriggerInfo,
		LPVOID	rsvd
	)

This function performs the NXP EAS Scan operation.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	lpAntennaInfo	Antenna List on which the operation is to be performed. If this is NULL, the operation is performed on ALL antennas.
[in]	lpTriggerInfo	Trigger Criteria for the operation. If this is NULL, operation starts right away when this API is called, and stops when RFID_StopNXPEASScan 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

Upon seeing a Tag with its EAS bit set, the alarm event NXP_EAS_ALARM_EVENT will be signaled. NXP_EAS_ALARM_DATA has the information related to the alarm and can be obtained using RFID_GetEventData. The application can wait on the event registered for NXP_EAS_ALARM_EVENT before calling RFID_GetEventData.

See also

RFID_StopNXPEASScan

Remarks

Example:

RFID_HANDLE32 readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
 
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.208.51"), 0, 0, NULL))
{
NXP_SET_EAS_PARAMS NXPSetEASParams;
HANDLE hInventoryStartEvent = CreateEvent(NULL, false, false, NULL);
HANDLE hInventoryStopEvent = CreateEvent(NULL, false, false, NULL);
HANDLE hAccessStartEvent = CreateEvent(NULL, false, false, NULL);
HANDLE hAccessStopEvent = CreateEvent(NULL, false, false, NULL);
HANDLE hEASAlarmEvent = CreateEvent(NULL, false, false, NULL);
RFID_RegisterEventNotification(readerHandle, INVENTORY_START_EVENT, hInventoryStartEvent);
RFID_RegisterEventNotification(readerHandle, INVENTORY_STOP_EVENT, hInventoryStopEvent);
RFID_RegisterEventNotification(readerHandle, ACCESS_START_EVENT, hAccessStartEvent);
RFID_RegisterEventNotification(readerHandle, ACCESS_STOP_EVENT, hAccessStopEvent);
RFID_RegisterEventNotification(readerHandle, NXP_EAS_ALARM_EVENT, hEASAlarmEvent);
 
// set few tags' EAS bit enabled
NXPSetEASParams.EASState = true;
NXPSetEASParams.accessPassword = 0x12345678;
RFID_NXPSetEAS(readerHandle, NULL, 0, &NXPSetEASParams, NULL, NULL, NULL);
WaitForSingleObject(hAccessStartEvent, INFINITE);
WaitForSingleObject(hAccessStopEvent, INFINITE);
 
// Lets see if those tags are reported
rfidStatus =  RFID_PerformNXPEASScan(readerHandle, NULL, NULL, NULL);
if(rfidStatus == RFID_API_SUCCESS)
{
WaitForSingleObject(hInventoryStartEvent, INFINITE);
// Lets wait for an EAS ALARM
if(WAIT_OBJECT_0 == WaitForSingleObject(hEASAlarmEvent, 10000))
{
NXP_EAS_ALARM_DATA easAlarmData;
RFID_GetEventData(readerHandle, NXP_EAS_ALARM_EVENT, &easAlarmData);
printf("\n A Tag was found on antenna %d with EAS bit set", easAlarmData.antennaID);
}
rfidStatus = RFID_StopNXPEASScan(readerHandle);
WaitForSingleObject(hInventoryStopEvent, readerHandle);
}
rfidStatus = RFID_Disconnect(readerHandle);
}

RFID_StopNXPEASScan()

RFID_STATUS WINAPI RFID_StopNXPEASScan

(

RFID_HANDLE32

readerHandle

)

This function stops the NXP EAS Scan 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_NXP_EAS_SCAN_IN_PROGRESS There is no NXP EAS Scan operation in progress

Remarks

See also

RFID_PerformNXPEASScan

Remarks

Example: None.

RFID_NXPChangeConfig()

RFID_STATUS WINAPI RFID_NXPChangeConfig	(	RFID_HANDLE32	readerHandle,
		UINT8 *	pTagID,
		UINT32	tagIDLength,
		LPNXP_CHANGE_CONFIG_PARAMS	lpNXPChangeConfigParams,
		LPACCESS_FILTER	lpAccessFilter,
		LPANTENNA_INFO	lpAntennaInfo,
		LPTAG_DATA	lpTagData,
		LPVOID	rsvd
	)

This function sets the change config word for G2IL Tags.

Parameters

[in]	readerHandle	Handle to the RFID device.
[in]	pTagID	Pointer to the byte array containing Tag ID
[in]	tagIDLength	Length of the byte array containing Tag ID
[in]	lpNXPChangeConfigParams	Pointer to LPNXP_CHANGE_CONFIG_PARAMS structure containing the NXP_CHANGE_CONFIG_PARAMS
[in]	lpAccessFilter	Pointer to Access filter structure specifying the tag-filter criteria for the current Access operation
[in]	lpAntennaInfo	Pointer to ANTENNA_INFO structure specifying the Antenna IDs on which the access operation is to be performed
[in]	lpTagData	Pointer to TAG_DATA structure
[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 Parameter is invalid.
• RFID_ACCESS_NXP_CHANGE_CONFIG_FAILED NXP Change Config failed.

Remarks

See also

See RFID_StopNXPEASScan

Remarks

Example:

// Code Snippets for QT Data Write
RFID_HANDLE32           readerHandle;
RFID_STATUS rfidStatus = RFID_API_SUCCESS;
CONNECTION_INFO         connectionInfo;
connectionInfo.version = RFID_API3_5_1;
if(RFID_API_SUCCESS == RFID_Connect(&readerHandle, TEXT("157.235.207.191"), 0, 0, &connectionInfo))
{
// Perform Inventory to get the tags
RFID_PerformInventory(readerHandle, NULL, ANTENNA_LIST, NULL, NULL);
Sleep(300);
RFID_StopInventory(readerHandle);
 
NXP_CHANGE_CONFIG_PARAMS nxpParams;
 
nxpParams.accessPassword = 0x01;
nxpParams.NXPChangeConfigWord = 0x02;
 
while (RFID_GetReadTag(readerHandle, pTagData) == RFID_API_SUCCESS)
{
TagIDLength = pTagData->tagIDLength;
memcpy(TagID, pTagData->pTagID, TagIDLength);
rfidStatus = RFID_NXPChangeConfig(readerHandle, TagID, TagIDLength, &nxpParams,NULL,NULL,lpTagData, NULL);
}
}