Namespace rfid.api

Classes

AccessFilter

This class represents the filter criteria for Access Operations like read, write, lock, and etc.

AccessOperationResult

Contains the result of AccessOperation on a particular tag. This is applicable for custom Tag access operation

Actions

This class represents the set of all operations that can be performed on the reader like Inventory and Access operations using various type of filters.

AntennaConfig

The Class which holds all configuration of the Given Antenna

AntennaInfo

This class contains the information about the Antennas on which an operation is to be performed. Inventory or Access can be performed on a list of selected Antenna.

AntennaPortInfo

Contains the result of Antenna Port on operation performed.

Antennas

This class represents the Antenna of the reader

Antennas.AntennaProperties

This class represents the antenna properties of the Reader

Antennas.AntennaRfConfig

The Class holds the RF configuration of the Antenna

Antennas.AntennaRfConfig.AntennaStopTrigger

Antenna Stop trigger configuration

Antennas.Config

This class contains required information for configuring the antenna

Antennas.PhysicalProperties

This class represents the Antenna Physical properties

Antennas.RFMode

This class represents the C1G2 RF Mode and the Tari value to use for the inventory operation.

Antennas.SingulationControl

This class represents the antenna configuration related to singulation control parameters session, Tag Population and the tag transit time

Antennas.SingulationControl.SingulationAction

This class contains configuration parameter related to state aware singulation action

BrandIDCheck

This class handles Brand ID check operation

CableLossCompensation

Holds Cable Loss Compensation related information

CAPIEvents

This class represents the events supported. The events are signalled ony when it is enabled. The properties allows to enable required events.

Config

This class allows to perform reader configuration

Events.AccessStartEventData

Represents Access start event data. Right now, no data is associated with this event.

Events.AccessStopEventData

Represents Access stop event data. Right now, no data is associated with this event.

Events.AntennaEventData

Contains the Antenna Event Data. Specifies the antenna ID and its connected status

Events.BufferFullWarningEventData

Represents Buffer Full warning event data. Right now, no data is associated with this event.

Events.DisconnectionEventData

Represents Reader Disconnect event data. Right now, no data is associated with this event.

Events.GPIEventData

Represents GPI Event Data (port and the current state)

Events.HandheldTriggerEventData

Represents Handheld Trigger Event Data (current state)

Events.InventoryStartEventData

Represents Inventory start event data. Right now, no data is associated with this event.

Events.InventoryStopEventData

Represents Inventory stop event data. Right now, no data is associated with this event.

Events.NXPEASAlarmEventData

Gives the ID of the antenna which found an NXP tag with EAS bit set during EAS Scanning Also gives the alarm code returned by the tag during EAS scanning

Events.ReaderExceptionEventData

Represents Reader Disconnect event data. Right now, no data is associated with this event.

Events.ReadEventArgs

Contains Read Event data contains tag data

Events.ReadEventData

Represents RFID Tag Data on read. If AttachTagDataWithReadEvent is true, the member TagData will point to the tag being reported. Else TagData will be null.

Events.RFSurvayStartEventData

Represents RFSurvey start event data. Right now, no data is associated with this event.

Events.RFSurveyEventArgs

Contains RF Survey Read Event data contains RF Survey data

Events.RFSurveyEventData

Represents RFID RF Survey Data on read. If AttachRFSurveyDataWithReadEvent is true, the member RFSurveyData will point to the RF Survey data being reported. Else RFSurveyData will be null.

Events.RFSurveyStopEventData

Represents RFSurvey stop event data. Right now, no data is associated with this event.

Events.StatusEventData

Contains the status event data for GPI, Buffer Full warning, Antenna Connected status, Inventory start/stop event, Access Start/stop event, and reader disconnect event

FrequencyHopInfo

Frequency Hop Information. This is transmitted only when IsHoppingEnabled is true.

The Fujitsu class comprises of methods for the custom Access operations supported by Fujitsu's 64K and 8K tags and their respective parameter types. The custom operations meant for 64K Fujitsu tags are ChangeWordLock,ChangeBlockLock,ReadBlockLock, BurstWrite and BurstRead; while those for 8K Fujitsu tags are AreaReadLock,AreaWriteLock,AreaWriteLockWithoutPassword. However,the operation ChangeBlockOrAreaGroupPassword changes either the block group password if the target tag is a 64K tag or the Area Group Password if the target tag is a 8K tag. For each of these operations,there are different methods to apply the operation on a single tag or a subset of tag-population, as identified by the Access-Filter.The method "(Operation-Name)Wait" refers to the single-tag,synchronous operation and the method "(Operation-Name)Event" refers to multiple-tag,asynchronous operation.Completion of the operation will be reported as Events.StatusNotify event of type ACCESS_STOP_EVENT.

Fujitsu.AreaReadLockAccessParams

Parameters for AreaReadLock operation meant for Fujitsu's 8K Tags.Specifies the AreaGroup,its Password and the Payload Action-Mask pair for AreaReadLock operation.

Fujitsu.AreaWriteLockAccessParams

Parameters for AreaWriteLock operation meant for Fujitsu's 8K Tags.Specifies the AreaGroup,its Password and the Payload Action-Mask pair for AreaWriteLock operation.

Fujitsu.AreaWriteLockWOPasswordAccessParams

It is the parameter for Fujitsu's Custom operation for 8K Tags- ChangeAreaWriteLockWithoutPassword.It specifies only the AreaGroup and PayloadAction.

Fujitsu.BurstEraseAccessParams

Parameters for BurstErase operation meant for Fujitsu's 64K Tags.Specifies the memory Bank,ByteOffset and length of the Data to be erased together with the AccessPassword.

Fujitsu.BurstWriteAccessParams

The parameter for Fujitsu's BurstWrite operation, meant for 64K Tags.Specifies the Byte-Array to be written,memoryBank and ByteOffset of the starting word and the AccessPassword.

Fujitsu.ChangeBlockLockAccessParams

The parameter for Fujitsu's ChangeBlockLock Operation,meant for 64K Tags.Specifies the BlockGroup,Payload Mask-Action pair and the BlockGroup's Password.

Fujitsu.ChangeBlockOrAreaGroupPasswordAccessParams

This is the same parameter for two operations - ChangeBlockGroupPassword(64K Tags) and ChangeAreaGroupPassword(8K Tags).

Fujitsu.ChangeWordLockAccessParams

This is the parameter for Fujitsu's ChangeWordLock operation meant for 64K Tags.Specifies the Memory Bank and ByteOffset for the two words to be locked,the BlockGroup password and the Payload Action-Mask pair meant for the ChangeWordLock operation.

Fujitsu.ReadBlockLockAccessParams

The parameter for Fujitsu's ReadBlockLock operation, meant for 64K Tags.Specifies the BlockGroup.

FujitsuBurstEraseResult

Result of Fujitsu's BurstErase operation on a 64K Tag

FujitsuBurstWriteResult

Result of Fujitsu's BurstWrite operation on a 64K Tag

FujitsuReadBlockLockResult

Result of Fujitsu's ReadBlockLock operation.Contains a status of the 16 block-lock flags for the specified Block group of 64K Fujitsu tag.

FujitsuStats

Represents the Fujitsu Stats

GPIs

This class represents the General Purpose Input (GPI)

GPIs.Port

Represents the individual GPI Port

GPITrigger

GPI-Trigger information.

GPOs

Represents the General Purpose Output (GPO)

GPOs.Port

This class represents the individual GPO Port

HandheldTrigger

Handheld-Trigger information.

Impinj

The Impinj class comprises of the custom Access operations meant for Impinj tags.Currently the following operations are supported - QTRead and QTWrite which read and write the Control Data for Impinj QT Tags. QT tags offer special functionalities like Private/Public memory map and read range reduction which can be enabled/disabled by writing the QT Control word.However,currently read range reduction is not supported in the Reader software.

Impinj.QTData

Data returned from Impinj's QT tag.Consists of Control data.

Impinj.QTReadAccessParams

Parameter for the Impinj QTRead operation

Impinj.QTWriteAccessParams

Parameters for Impinj's QTWrite Access operation.

ImpinjStats

Represents the Impinj Stats

InvalidUsageException

InvalidUsageException is thrown when an invalid usage is detected by the class library.

Inventory

This class handles Inventory operations.

LedInfo

This class contains the LED information of the reader such as LED Color, duration and blink flag

LLRPConnection

This class contains methods for set/get the LLRP connection configuration

LLRPConnectionConfig

This class contains the LLRP Connection Configuration required for Server/Client connectivity

LocationInfo

Contains the result of locating operation performed.

LoginInfo

This class contains the login information of the reader

NGE_Regulatory_Configuration

NGERegion

NgeRegionConfig

NXP

The NXP class comprises of the Access operations meant for NXP tags. These operation include SetEASWait and SetEASEvent(for setting/resetting EAS bits on NXP tags), ReadProtectWait & ResetReadProtectEvent(for setting the Quiet bit on one or more NXP tags), ResetReadProtectEvent(for resetting Quiet bit on all the NXP tags) and ChangeConfig(for changing and reading the Config-word for the NXP G2iL tags)

NXP.ChangeConfigParams

Parameters of the Change Config operation for NXP-G2iL tags

NXP.ChangeConfigResult

Result of NXP Change Config operation

NXP.ReadProtectParams

Parameters for ReadProtect Access Operation

NXP.ResetReadProtectParams

Parameters for ResetReadProtect Access Operation

NXP.SetEASParams

Parameters for SetEAS Access Operation

NXPStats

Represents the NXP Stats

OperationFailureException

OperationFailureException is thrown when a failure occurs in the class library. This failure usually is one that stops the proper functioning of the class library.

PerAntennaReceiveSensitivityRange

For future use

PeriodicTrigger

Periodic Trigger Information.

PixieEvents

PostFilter

PostFilter Information. PostFilters are applied on Inventoried Tags. Each Tag will be checked if it matches both pattern A and pattern B, as per the "MatchPattern" condition.

PreFilters

Filter criteria for Inventory. PreFilters will be applied before each round of Inventory. Access operations also invole implicit Inventory before the Access operation can be performed. Simple Inventory operation (i.e. without PostFilters) gets the Tags selected out of PreFilter(s) Tags as a result of (implicit) Inventory Operation move in for further Access Operation.

PreFilters.PreFilter

PreFilter Information. Maps to one SELECT command of C1G2.

PreFilters.StateAwareActionParams

Parameters for StateAware action.

PreFilters.StateUnawareAction

Parameters for StateUnaware action.

Profile

This class contains methods for uploading or downloading the configuration file

RadioConfigUpdate

This class helps to perform radio config OEM update in the reader

RadioFirmwareUpdate

This class helps to perform radio firmware update in the reader

ReaderCapabilities

This class represents the Reader Capabilities

ReaderCapabilities.ReaderIdentification

Represents Reader Identification. This carries an identification parameter that is unique within the local administration domain. The identifier could be the Reader MAC address or EPC. The IDType defines the type of the identification value contained in this Parameter.

ReaderInfo

This class contains the reader's information which includes name, description, location and contact

ReaderManagement

This class encapsulates the Reader Management functionality such as reboot, firmware update. Also, proprietary reader functions such as Antenna Mode (Bi-Static or Mono-static), Enable/Get Read Point status functionality can be performed using this class.

ReaderModuleVersion

This class represents the Name and Version of a module of the Reader.

ReaderRegion

This class contains methods for getting or setting reader's region

ReaderRegion.ActiveRegionInfo

This class contains the information of currently active region regulatory

ReaderRegion.CommunicationStandardInfo

This class contains given region regulatory related standard information

ReaderStatistics

This class represents the Reader statistics

ReadPoint

This class contains the functionality related to read point (Antenna). It exposes functionality like enable or get read point status

REGION_CONFIG_DATA

RegionConfig

regLBT

regOnOff

REGULATORY_CONFIG_DATA

REGULATORY_LINKPROFILE_DATA

ReportTriggers

Periodic Trigger Information.

RfidApi4Abstract

RfidGlobalData

Global data object to hold capabilities and configurations.

RFIDReader

Provides the RFIDReader object.

RFModes

RF Modes supported by the reader

RFModeTable

Represents the RF Mode table that the reader is capable of operating.

RFModeTableEntry

This class represents the RF Mode table entry

RFSurvey

This class handles RF Survey operations.

RFSurveyData

Represents RFID RF Survey Data

RFSurveyEventReportInfo

Specifies the configuration of events for the reader to report RF Survey Data state changes

RssiRangeFilter

RSSI Range Filter is used to configure filter settings on the reader to filter tags based on the received signal strength of the tag.

SecureConnectionInfo

This class contains additional information for establishing secure connection.

SecureModeConfig

This class contains the LLRP Secure Connection Info

SeenTime

Represents the Tag Seen time. This can be either Uptime or UTC time at any point of time

SoftwareUpdate

This class helps to perform software updates in the reader

SoftwareUpdateInfo

This class contains parameters required for the software update

STANDARD_INFO_LISTW

STANDARD_REGION_INFOW

StartTrigger

Start Trigger Information.

StopTrigger

Stop Trigger Information.

SystemInfo

This class contains the information related to the reader such as firmware version, FPGA version, reader name, reader location, UP Time, RAM and flash memort available

TagAccess

This class handles all the Tag Access operations. Access operations include Read, Write, Lock, Kill, BlockWrite, BlockErase.

TagAccess.BlockEraseAccessParams

Parameters for Block-Erase Access Operation.

TagAccess.BlockPermalockAccessParams

Parameters for Block Permalock Access Operation.

TagAccess.KillAccessParams

Parameters for Kill Access Operation.

TagAccess.LockAccessParams

Parameters for Lock Access Operation.

TagAccess.ReadAccessParams

Parameters for Read Access Operation.

TagAccess.RecommisionAccessParams

Parameters for Recommision Access Operation.

TagAccess.Sequence

This class gives support for doing a sequence of Access Operations at one go.

TagAccess.Sequence.Operation

This class represents a single operation that is to be added to the Tag Access Operation Sequence.

TagAccess.WriteAccessParams

Parameters for Write Access Operation.

TagAccess.WriteSpecificFieldAccessParams

Parameters for Write Specific Field like TagID, Kill Password or Access Password Access Operation.

TagData

Represents RFID Tag Data

TagEventReportInfo

Specifies the configuration of events for the reader to report tag state changes

TagLocationing

This class handles tag locationing functionality

TagPatternBase

Tag Pattern Information for Filtering. If bit i in the mask (TagMask) is zero, then bit i of the target tag (MemoryBankData) is a don’t care (X); if bit i in the mask is one, then bit i of the target tag is bit i of the tag pattern. For example, “all tags” is specified using a mask length of zero.

TagStorageSettings

To configure tag storage related settings such as Maximum tag count, maximum size of memory bank and Maximum tag ID length

TagZoneInfo

Contains the result of Zone operation performed.

TemperatureStatus

TimeZone

This class contains methods for getting or setting the reader's time zone

TriggerInfo

Contains Trigger criterea to be used for an Inventory or Access Sequence operation/

TriggerWithTimeout

Triggers with timeout.

UpdateStatus

Represents the software update status

UpTime

Represents the Uptime. Holds both First seen and last seen time

USBOperationMode

This class provides information of the reader's USB operation mode.

UserApp

This class contains methods for user application deployment in the reader

UserAppInfo

User App information

UserInfo

This class contains the reader's login credentials includes Username, Oldpassword, Newpassword

UTCTime

This class represents UTC Time. It includes both First and last seen time stamp

VersionInfo

This class contains version information for the current API library

Zones

This Class contains the configuration of the Zones used for RFID Operations. The Zone Configuration will be used when the RFID Operation (eg. Inventory) is performed on the reader. The Antennas specified in the ZoneSequence to perform Inventory will use the configuration specified in this class.

Zones.ZoneConfig

Logical group of Antennas denoting a Zone along with the configurations

ZoneSequence

The List of Zones on which RFID Operation to be performed

ZoneSequence.ZoneInfo

The List of Zones along with Antenna Sequence on which RFID Operation to be performed, The Zones can be repeated to have finer control of the Operation Sequence.