RFID API Documentation  1.0
Reference guide for RFID API
TAG_DATA Struct Reference

Contains Tag related information. More...

Data Fields

STRUCT_INFO structInfo
 
UINT8pTagID
 Tag ID, for C1G2 this field refers EPC Data. More...
 
UINT32 tagIDLength
 Tag ID Length (Number of Bytes). More...
 
UINT32 tagIDAllocated
 Memory allocated for Tag ID (Number of Bytes) . More...
 
UINT16 PC
 PC BITS. More...
 
UINT32 XPC
 
UINT16 CRC
 XPC BITS - XPC_W1 = LOWORD(XPC) and XPC_W2 = HIWORD(XPC) . More...
 
UINT16 antennaID
 Antenna ID . More...
 
union {
   struct _UP_TIME {
      UINT64   firstSeenTimeStamp
 First Seen Time Stamp, Time of the first observation amongst the tag reports . More...
 
      UINT64   lastSeenTimeStamp
 Last Seen Time Stamp, Time of the last observation amongst the tag reports . More...
 
   }   upTime
 seenTime: Since System UP time . More...
 
   struct _UTC_TIME {
      SYSTEMTIME   firstSeenTimeStamp
 First Seen Time Stamp, Time of the first observation amongst the tag reports . More...
 
      SYSTEMTIME   lastSeenTimeStamp
 Last Seen Time Stamp, Time of the last observation amongst the tag reports . More...
 
   }   utcTime
 seenTime: As System time . More...
 
seenTime
 
INT8 peakRSSI
 
UINT16 channelIndex
 Channel Index, Index of the first channel the tag was seen. More...
 
UINT16 tagSeenCount
 Tag seen count, Number of tag reports. More...
 
ACCESS_OPERATION_CODE opCode
 C1G2 Operation as a result of which this Tag is being reported. More...
 
ACCESS_OPERATION_STATUS opStatus
 Result of C1G2 Access Operation, opCode. More...
 
MEMORY_BANK memoryBank
 The type descriptor describing the Bank type. More...
 
UINT8pMemoryBankData
 The data read from the specified Bank or Block Permalock Mask Data as specified by opCode. More...
 
UINT32 memoryBankDataByteOffset
 Byte offset of the data. More...
 
UINT32 memoryBankDataLength
 The length of the data(Number of Bytes) . More...
 
UINT32 memoryBankDataAllocated
 Memory allocated(Number of Bytes). More...
 
TAG_EVENT tagEvent
 
SYSTEMTIME tagEventTimeStamp
 Time Stamp at which the tagEvent occurred. More...
 
LPLOCATION_INFO lpLocation
 location information. More...
 
LPACCESS_OPERATION_RESULT lpAccessOperationResult
 Contains the result of AccessOperation on a particular tag. More...
 
UINT16 transmitPort
 Transmit port of the Antenna or Transmit port on which the Tag read. More...
 
UINT16 receivePort
 Receive port of the Antenna or Transmit port on which the Tag read. More...
 
LPTAG_ZONE_INFO lpZoneInfo
 Zone information on which the Tag is read. More...
 
INT16 phaseInfo
 Phase information reported by the reader when this tag was seen. More...
 
UINT8 brandValid
 Status of NXP Brand ID check status. More...
 
UINT8 reserved
 for future expansion for byte type More...
 
LPVOID lpReserved [6]
 Reserved for future. More...
 

Detailed Description

Contains Tag related information.

When Inventory or Read Access Operation is performed, Tags reported by Reader are reported back to application in the format of TAG_DATA.

Field Documentation

◆ structInfo

STRUCT_INFO TAG_DATA::structInfo

◆ pTagID

UINT8* TAG_DATA::pTagID

Tag ID, for C1G2 this field refers EPC Data.

◆ tagIDLength

UINT32 TAG_DATA::tagIDLength

Tag ID Length (Number of Bytes).

◆ tagIDAllocated

UINT32 TAG_DATA::tagIDAllocated

Memory allocated for Tag ID (Number of Bytes) .

◆ PC

UINT16 TAG_DATA::PC

PC BITS.

◆ XPC

UINT32 TAG_DATA::XPC

◆ CRC

UINT16 TAG_DATA::CRC

XPC BITS - XPC_W1 = LOWORD(XPC) and XPC_W2 = HIWORD(XPC) .

CRC.

◆ antennaID

UINT16 TAG_DATA::antennaID

Antenna ID .

◆ firstSeenTimeStamp [1/2]

UINT64 TAG_DATA::firstSeenTimeStamp

First Seen Time Stamp, Time of the first observation amongst the tag reports .

◆ lastSeenTimeStamp [1/2]

UINT64 TAG_DATA::lastSeenTimeStamp

Last Seen Time Stamp, Time of the last observation amongst the tag reports .

◆ upTime

struct { ... } ::_UP_TIME TAG_DATA::upTime

seenTime: Since System UP time .

◆ firstSeenTimeStamp [2/2]

SYSTEMTIME TAG_DATA::firstSeenTimeStamp

First Seen Time Stamp, Time of the first observation amongst the tag reports .

◆ lastSeenTimeStamp [2/2]

SYSTEMTIME TAG_DATA::lastSeenTimeStamp

Last Seen Time Stamp, Time of the last observation amongst the tag reports .

◆ utcTime

struct { ... } ::_UTC_TIME TAG_DATA::utcTime

seenTime: As System time .

◆ seenTime

union { ... } TAG_DATA::seenTime

◆ peakRSSI

INT8 TAG_DATA::peakRSSI

◆ channelIndex

UINT16 TAG_DATA::channelIndex

Channel Index, Index of the first channel the tag was seen.

◆ tagSeenCount

UINT16 TAG_DATA::tagSeenCount

Tag seen count, Number of tag reports.

◆ opCode

ACCESS_OPERATION_CODE TAG_DATA::opCode

C1G2 Operation as a result of which this Tag is being reported.

if opCode is ACCESS_OPERATION_NONE, this Tag is a result of Inventory operation.

◆ opStatus

ACCESS_OPERATION_STATUS TAG_DATA::opStatus

Result of C1G2 Access Operation, opCode.

◆ memoryBank

MEMORY_BANK TAG_DATA::memoryBank

The type descriptor describing the Bank type.

This field is to be ignored in case of opCode specified as ACCESS_OPERATION_BLOCK_PERMALOCK.

◆ pMemoryBankData

UINT8* TAG_DATA::pMemoryBankData

The data read from the specified Bank or Block Permalock Mask Data as specified by opCode.

◆ memoryBankDataByteOffset

UINT32 TAG_DATA::memoryBankDataByteOffset

Byte offset of the data.

◆ memoryBankDataLength

UINT32 TAG_DATA::memoryBankDataLength

The length of the data(Number of Bytes) .

◆ memoryBankDataAllocated

UINT32 TAG_DATA::memoryBankDataAllocated

Memory allocated(Number of Bytes).

◆ tagEvent

TAG_EVENT TAG_DATA::tagEvent

◆ tagEventTimeStamp

SYSTEMTIME TAG_DATA::tagEventTimeStamp

Time Stamp at which the tagEvent occurred.

This field is not relevant when tagEvent is NONE.

◆ lpLocation

LPLOCATION_INFO TAG_DATA::lpLocation

location information.

It will be present only when RFID_PerformTagLocationing or RFID_PerformInventory was invoked using Operation-qualifier LOCATE_TAG.

◆ lpAccessOperationResult

LPACCESS_OPERATION_RESULT TAG_DATA::lpAccessOperationResult

Contains the result of AccessOperation on a particular tag.

Applicable only when TagData.OpCode is one of ACCESS_OPERATION_FUJITSU_READ_BLOCKLOCK,ACCESS_OPERATION_FUJITSU_BURST_WRITE, ACCESS_OPERATION_FUJITSU_BURST_ERASE, ACCESS_OPERATION_IMPINJ_QT_READ and ACCESS_OPERATION_NXP_CHANGE_CONFIG

◆ transmitPort

UINT16 TAG_DATA::transmitPort

Transmit port of the Antenna or Transmit port on which the Tag read.

◆ receivePort

UINT16 TAG_DATA::receivePort

Receive port of the Antenna or Transmit port on which the Tag read.

◆ lpZoneInfo

LPTAG_ZONE_INFO TAG_DATA::lpZoneInfo

Zone information on which the Tag is read.

◆ phaseInfo

INT16 TAG_DATA::phaseInfo

Phase information reported by the reader when this tag was seen.

◆ brandValid

UINT8 TAG_DATA::brandValid

Status of NXP Brand ID check status.

0 if Brand ID check failed, 1 if success

◆ reserved

UINT8 TAG_DATA::reserved

for future expansion for byte type

◆ lpReserved

LPVOID TAG_DATA::lpReserved[6]

Reserved for future.

1 dword for tagEvent. 4 dwords for tagEventTimeStamp. 1 dword for locationInfo