Octane SDK  2.0 Beta
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Classes | Enumerations
Package Impinj.OctaneSdk

Classes

class  AntennaConfig
 Class used to define the configuration settings for an individual antenna port. More...
 
class  AntennaConfigGroup
 Container class encapsulating all of the antenna configuration objects. This is for internal use only, and does not appear in the generated documentation.
 
class  AntennaEvent
 Class used to encapsulate the details of a ImpinjReader.AntennaChanged reader event. More...
 
class  AntennaHubStatus
 Class encapsulating all antenna hub status information. More...
 
class  AntennaHubStatusGroup
 Container class encapsulating all of the antenna hub status objects. This is for internal use only, and does not appear in the generated documentation.
 
class  AntennaIds
 Helper class used when identifying that all antennas should be used when configuring a tag operation.
 
class  AntennaStatus
 Class containing The status information for an individual antenna port. More...
 
class  AntennaStatusGroup
 Container class encapsulating all of the antenna status objects. This is for internal use only, and does not appear in the generated documentation.
 
class  AsyncConnectInfo
 
class  AutoStartConfig
 Class for defining the trigger conditions that will prompt an Impinj reader to automatically start operation. Even when an auto-start trigger is set, the Reader may be explicitly started using the ImpinjReader.Stop() method. More...
 
class  AutoStopConfig
 Class for defining the trigger conditions that will prompt an Impinj reader to automatically stop its current operation. Even when an auto-stop trigger is set, the Reader may be explicitly stopped using the ImpinjReader.Stop() method. More...
 
class  BitPointers
 Helper class used when defining EPC memory accesses.
 
class  BlockPermalockMask
 Uses to specify which blocks to permalock. More...
 
class  DiagnosticReport
 xArray diagnostic report More...
 
class  FeatureSet
 Container class used to encapsulate the features supported by a given Impinj reader. An object of this type is returned by a call to ImpinjReader.QueryFeatureSet(). More...
 
class  FilterSettings
 Class used to define inventory tag filter settings. More...
 
class  GpiConfig
 Class that is used to define the configuration settings for an individual general purpose input (GPI) port. More...
 
class  GpiConfigGroup
 Container class encapsulating all of the GPI configuration objects. This is for internal use only, and does not appear in the generated documentation.
 
class  GpiEvent
 Class used to encapsulate the details of a ImpinjReader.GpiChanged reader event. More...
 
class  GpiStatus
 Class containing the status information for a general purpose input (GPI) port. More...
 
class  GpiStatusGroup
 Container class encapsulating all of the GPI status objects. This is for internal use only, and does not appear in the generated documentation.
 
class  GpoConfig
 Class used to define the configuration settings for an individual general purpose output (GPO) port. More...
 
class  GpoConfigGroup
 Container class encapsulating all of the GPO configuration objects. This is for internal use only, and does not appear in the generated documentation.
 
class  GpsCoordinates
 Helper class used to manage GPS coordinates within a tag object. More...
 
class  ImpinjReader
 The main class for controlling and configuring an Impinj RFID reader. More...
 
class  ImpinjReaderDebug
 Class for exporting the reader LLRP configuration to file for debug purposes. More...
 
class  ImpinjSerializableClass
 Parent class that enables child classes to output contents in XML format. More...
 
class  ImpinjTimestamp
 Timestamp class supporting Impinj Reader and LLRP timestamp data. Timestamps from the reader are microseconds since the Epoch (00:00:00 UTC, January 1, 1970) (16 digit numbers) More...
 
class  KeepaliveConfig
 Helper class used to manage the reader Keep Alive event configuration More...
 
class  KillTagParams
 Class used to carry the configuration for the ImpinjReader.KillTag(KillTagParams) operation
 
class  KillTagResult
 Class that contains the result of ImpinjReader.KillTag(KillTagParams) operation More...
 
class  LocationConfidenceFactors
 Contains the confidence factors for a location report. More...
 
class  LocationConfig
 Class used to define the location configuration for an xArray. More...
 
class  LocationReport
 xArray location report More...
 
class  LockTagParams
 Class to carry the configuration for a ImpinjReader.LockTag(LockTagParams) operation, which is flagged for obsolescence.
 
class  LockTagResult
 Class to carry the results of a ImpinjReader.LockTag(LockTagParams) operation More...
 
class  LowDutyCycleSettings
 Class for configuring the Impinj Reader Low Duty Cycle reader capability More...
 
class  OctaneSdkException
 Exception class for uniquely identifying Impinj Octane SDK exceptions. More...
 
class  PcBits
 Helper class used to encode and decode the PC word.
 
class  PlacementConfig
 Class used to define the placement configuration for an xArray. More...
 
class  ProgramAccessPasswordParams
 Specialization of the ProgramTagMemoryParams class used to carry the configuration for a ImpinjReader.ProgramAccessPassword(ProgramAccessPasswordParams) operation
 
class  ProgramAccessPasswordResult
 Class that contains the result of a ImpinjReader.ProgramAccessPassword(ProgramAccessPasswordParams) operation
 
class  ProgramEpcParams
 
class  ProgramEpcResult
 Class to carry the results of a ImpinjReader.ProgramEpc(ProgramEpcParams) operation
 
class  ProgramKillPasswordParams
 Specialization of ProgramTagMemoryParams class used to carry the configuration for a ImpinjReader.ProgramKillPassword(ProgramKillPasswordParams) operation.
 
class  ProgramKillPasswordResult
 Class to carry the results of a ImpinjReader.ProgramKillPassword(ProgramKillPasswordParams) operation
 
class  ProgramTagMemoryParams
 Parent class that is specialized to define the configuration for specific tag programming operations.
 
class  ProgramTagMemoryResult
 Parent Class to carry the results of tag memory programming operations, including not just the results of the write operation, but also any lock or verify operations, if the program operation is configured to use them.
 
class  ProgramUserMemoryParams
 Class to carry the configuration for a ImpinjReader.ProgramUserMemory(ProgramUserMemoryParams) operation
 
class  ProgramUserMemoryResult
 Class for containing the results of a ImpinjReader.ProgramUserMemory(ProgramUserMemoryParams) operation
 
class  ReaderStartedEvent
 Class used to encapsulate the details of a ImpinjReader.ReaderStarted reader event. More...
 
class  ReaderStoppedEvent
 Class used to encapsulate the details of a ImpinjReader.ReaderStopped reader event. More...
 
class  ReadKillPasswordParams
 Specialization of the ReadTagMemoryParams class used to carry the configuration for a ImpinjReader.ReadKillPassword(ReadKillPasswordParams) operation.
 
class  ReadKillPasswordResult
 Class to carry the results of a ImpinjReader.ReadKillPassword(ReadKillPasswordParams) operation. More...
 
class  ReadTagMemoryParams
 Parent class that is specialized to define the configuration for specific tag read operations. More...
 
class  ReadTagMemoryResult
 Parent class used to carry the results of any tag read operations, including not just the results of the read operation, but also any lock or verify operations, if the program operation is configured to use them. More...
 
class  ReadTidMemoryParams
 Specialization of the ReadTagMemoryParams class used to carry the configuration for a ImpinjReader.ReadTidMemory(ReadTidMemoryParams) operation.
 
class  ReadTidMemoryResult
 Class to carry the results of a ImpinjReader.ReadTidMemory(ReadTidMemoryParams) operation. More...
 
class  ReadUserMemoryParams
 Specialization of the ReadTagMemoryParams class used to carry the configuration for a ImpinjReader.ReadUserMemory(ReadUserMemoryParams) operation.
 
class  ReadUserMemoryResult
 Class that contains the result of a ImpinjReader.ReadUserMemory(ReadUserMemoryParams) operation More...
 
class  ReportBufferOverflowEvent
 Class used to encapsulate the details of a ImpinjReader.ReportBufferOverflow reader event. More...
 
class  ReportBufferWarningEvent
 Class used to encapsulate the details of a ImpinjReader.ReportBufferWarning reader event. More...
 
class  ReportConfig
 Class for configuring the tag inventory reports returned by the reader. More...
 
class  RoSpecEvent
 Class encapsulating an ROSpec event. More...
 
class  RShellEngine
 Class for interacting with the RShell interface of an Impinj reader. More...
 
struct  RxSensitivityTableEntry
 Structure used to map a dBm value for receiver sensitivity to the appropriate index in the sensitivity level table used internally to the reader. More...
 
class  SectorConfig
 Contains sector configuration for xArray More...
 
class  Settings
 Class for containing all the settings necessary for a reader to begin singulating. It is a composite class consisting of other composite classes containing individual settings, and is consumed by the following methods: ImpinjReader.ApplySettings, and produced by the following methods: ImpinjReader.QuerySettings, ImpinjReader.QueryDefaultSettings, More...
 
class  Status
 Class encapsulating the reader status information, as returned by ImpinjReader.QueryStatus(). More...
 
class  SyncProgramOpStatus
 
class  SyncReadOpStatus
 
class  Tag
 Class used to contain the details for a specific tag. More...
 
class  TagBlockPermalockOp
 Used to perform a block permalock operation. More...
 
class  TagBlockPermalockOpResult
 Contains the results of a block permalock operation. More...
 
class  TagData
 Class used to hold tag data in the raw form in which it is stored on the tag (list of unsigned shorts). More...
 
class  TagFilter
 Class for containing the settings for a single inventory filter. More...
 
class  TagKillOp
 Class used to specify a tag kill operation. WARNING:- once killed, a tag will permanently cease functioning. More...
 
class  TagKillOpResult
 Specialization of TagOpResult class that contains the results of an individual tag kill operation, as reported in the TagOpReport parameter of a ImpinjReader.TagOpComplete event. More...
 
class  TagLockOp
 Class used to specify a tag lock operation. More...
 
class  TagLockOpResult
 Specialization of TagOpResult class that contains the results of an individual tag lock operation, as reported in the TagOpReport parameter of a ImpinjReader.TagOpComplete event. More...
 
class  TagModelDetails
 Contains model-specific details about the tag. You must enable FastID in the TagReport to get this information. FastID is only available on Impinj Monza 4 and later tags. More...
 
class  TagOp
 Parent class for tag operation definitions More...
 
class  TagOpReport
 Container class used to encapsulate all tag operation results, as reported in the TagOpReport parameter of the ImpinjReader.TagOpComplete event. More...
 
class  TagOpResult
 Parent class that contains the results of an individual tag operation, as reported in the TagOpReport parameter of the ImpinjReader.TagOpComplete event. More...
 
class  TagOpSequence
 Class for containing and configuring a sequence of tag operations that are submitted to the reader using the ImpinjReader.AddOpSequence method. More...
 
class  TagQtGetOp
 Used to retrieve the current QT status of a tag. More...
 
class  TagQtGetOpResult
 Contains the current QT status of a tag. More...
 
class  TagQtSetOp
 Used to set Monza QT tag chip features. Through QT technology, a tag owner/user can maintain two data profiles (one public, one private), allowing confidentiality of business-sensitive data while assuring consumers of privacy. The tag owner stores confidential data in the private data profile, which is protected by a password-controlled command and may only be accessed at very short read distances. More...
 
class  TagQtSetOpResult
 Contains the results of an individual Monza QT operation, as reported in the TagOpReport parameter of a ImpinjReader.TagOpComplete event. More...
 
class  TagReadOp
 Class used to specify a tag read operation. More...
 
class  TagReadOpResult
 Specialization of TagOpResult class that contains the results of an individual tag read operation, as reported in the TagOpReport parameter of a ImpinjReader.TagOpComplete event. More...
 
class  TagReport
 Container class used to encapsulate individual tag details returned from the reader. More...
 
class  TagWordPointer
 Helper class used for accessing the tag kill or access passwords.
 
class  TagWriteOp
 Class used to specify a tag write operation. More...
 
class  TagWriteOpResult
 Specialization of TagOpResult class that contains the results of an individual tag write operation, as reported in the TagOpReport parameter of a ImpinjReader.TagOpComplete event. More...
 
class  TargetTag
 Helper class used to identify a specific tag or set of tags on which to perform an operation. More...
 
class  TiltSensorValue
 Holds the X, Y, and Z values returned by the tilt sensor. More...
 
class  TransitionConfig
 Class used to define the transition configuration for an xArray. More...
 
class  TransitionReport
 xArray transition report More...
 
class  TransitionZone
 Class used to define a zone for the transition algorithm More...
 
struct  TxPowerTableEntry
 Structure used to map a dBm value for transmit power to the appropriate index in the transmit power level table used internally to the reader. More...
 
class  WordPointers
 Helper class used when defining tag memory accesses.
 
class  XArrayConfig
 Class used to define the configuration for an xArray. More...
 

Enumerations

enum  AccessResult { AccessResult.foo }
 
enum  AntennaEventType { AntennaEventType.AntennaDisconnected = 0, AntennaEventType.AntennaConnected = 1 }
 Enum defining the possible types of antenna event. More...
 
enum  AutoStartMode { AutoStartMode.None = 0, AutoStartMode.Immediate = 1, AutoStartMode.Periodic = 2, AutoStartMode.GpiTrigger = 3 }
 Enum defining the possible Impinj reader autostart modes. More...
 
enum  AutoStopMode { AutoStopMode.None = 0, AutoStopMode.Duration = 1, AutoStopMode.GpiTrigger = 2 }
 Enum defining the possible Impinj reader autostop modes. More...
 
enum  BlockPermalockResult {
  BlockPermalockResult.Success = 0, BlockPermalockResult.Insufficient_Power = 1, BlockPermalockResult.NonspecificTagError = 2, BlockPermalockResult.NoResponseFromTag = 3,
  BlockPermalockResult.NonspecificReaderError = 4, BlockPermalockResult.IncorrectPasswordError = 5, BlockPermalockResult.TagMemoryOverrunError = 6
}
 An enumerations used to indicate the results of a block permalock operation. More...
 
enum  CommunicationsStandardType {
  CommunicationsStandardType.Unspecified = 0, CommunicationsStandardType.US_FCC_Part_15 = 1, CommunicationsStandardType.ETSI_302_208 = 2, CommunicationsStandardType.ETSI_300_220 = 3,
  CommunicationsStandardType.Australia_LIPD_1W = 4, CommunicationsStandardType.Australia_LIPD_4W = 5, CommunicationsStandardType.Japan_ARIB_STD_T89 = 6, CommunicationsStandardType.Hong_Kong_OFTA_1049 = 7,
  CommunicationsStandardType.Taiwan_DGT_LP0002 = 8, CommunicationsStandardType.Korea_MIC_Article_5_2 = 9
}
 Enum used to identify the supported regions on Impinj readers, which has an impact on the RF frequencies, transmit power level and dwell times that the reader is allowed to use. More...
 
enum  ConnectAsyncResult { ConnectAsyncResult.Success, ConnectAsyncResult.Failure }
 Enumeration used to specify the result of an asynchronous connection attempt More...
 
enum  GpoMode {
  GpoMode.Normal = 0, GpoMode.Pulsed = 1, GpoMode.ReaderOperationalStatus = 2, GpoMode.LLRPConnectionStatus = 3,
  GpoMode.ReaderInventoryStatus = 4, GpoMode.NetworkConnectionStatus = 5, GpoMode.ReaderInventoryTagsStatus = 6
}
 Defines the modes that may be used to configure the GPO ports when the Advanced GPO features are used. More...
 
enum  HubConnectedStatus { HubConnectedStatus.Unknown = 0, HubConnectedStatus.Disconnected = 1, HubConnectedStatus.Connected = 2 }
 Enum defining the antenna hub connection status options. More...
 
enum  HubFaultStatus {
  HubFaultStatus.No_Fault = 0, HubFaultStatus.RF_Power = 1, HubFaultStatus.RF_Power_On_Hub_1 = 2, HubFaultStatus.RF_Power_On_Hub_2 = 3,
  HubFaultStatus.RF_Power_On_Hub_3 = 4, HubFaultStatus.RF_Power_On_Hub_4 = 5, HubFaultStatus.No_Init = 6, HubFaultStatus.Serial_Overflow = 7,
  HubFaultStatus.Disconnected = 8
}
 Enum defining the antenna hub fault options. More...
 
enum  KillResultStatus {
  KillResultStatus.Success = 0, KillResultStatus.ZeroKillPasswordError = 1, KillResultStatus.InsufficientPower = 2, KillResultStatus.NonspecificTagError = 3,
  KillResultStatus.NoResponseFromTag = 4, KillResultStatus.NonspecificReaderError = 5
}
 Enum defining the possible status outcomes for the tag kill operation. More...
 
enum  LocationReportType { LocationReportType.Entry = 0, LocationReportType.Update = 1, LocationReportType.Exit = 2 }
 Enum that specifies the location report type. More...
 
enum  LockMemoryBank {
  LockMemoryBank.KillPassword = 0, LockMemoryBank.AccessPassword = 1, LockMemoryBank.Epc = 2, LockMemoryBank.Tid = 3,
  LockMemoryBank.User = 4
}
 Enum for defining the tag memory bank to perform lock operation on. More...
 
enum  LockResultStatus {
  LockResultStatus.Success = 0, LockResultStatus.InsufficientPower = 1, LockResultStatus.NonspecificTagError = 2, LockResultStatus.NoResponseFromTag = 3,
  LockResultStatus.NonspecificReaderError = 4
}
 Enum defining the possible status outcomes for the tag lock operation. More...
 
enum  LockType {
  LockType.None = 0, LockType.Unlocked = 1, LockType.Locked = 2, LockType.PermaUnlocked = 3,
  LockType.PermaLocked = 4
}
 Enum specifying the type of lock operation to perform. More...
 
enum  MemoryBank { MemoryBank.Reserved = 0, MemoryBank.Epc = 1, MemoryBank.Tid = 2, MemoryBank.User = 3 }
 Enum for defining the tag memory bank to access. More...
 
enum  QtAccessRange { QtAccessRange.Unknown = 0, QtAccessRange.NormalRange = 1, QtAccessRange.ShortRange = 2 }
 Enumeration used to determine whether to configure the tag in reduced sensitivity (i.e. Short Range) mode, or not. More...
 
enum  QtDataProfile { QtDataProfile.Unknown = 0, QtDataProfile.Private = 1, QtDataProfile.Public = 2 }
 Enumeration used to determine which QT data profile to use. The Private/Public profile capability, available in Monza 4QT tag chips, provides two memory configurations (i.e. profiles) in a single chip; one Private and one Public. Only one profile is exposed at a time. More...
 
enum  QtGetConfigResultStatus {
  QtGetConfigResultStatus.Success = 0, QtGetConfigResultStatus.NonspecificTagError = 1, QtGetConfigResultStatus.NoResponseFromTag = 2, QtGetConfigResultStatus.NonspecificReaderError = 3,
  QtGetConfigResultStatus.IncorrectPasswordError = 4
}
 Enumeration used to indicate the results of a QtGetConfig operation. More...
 
enum  QtPersistence { QtPersistence.Unknown = 0, QtPersistence.Temporary = 1, QtPersistence.Permanent = 2 }
 Enumeration used to manage whether switching to the private Monza QT Data Profile should be persistent, or whether the tag should revert to the private state once the tag loses power. More...
 
enum  QtSetConfigResultStatus {
  QtSetConfigResultStatus.Success = 0, QtSetConfigResultStatus.InsufficientPower = 1, QtSetConfigResultStatus.NonspecificTagError = 2, QtSetConfigResultStatus.NoResponseFromTag = 3,
  QtSetConfigResultStatus.NonspecificReaderError = 4, QtSetConfigResultStatus.IncorrectPasswordError = 5
}
 Enum defining the possible status outcomes for the tag QT operation. More...
 
enum  ReaderMode {
  ReaderMode.MaxThroughput = 0, ReaderMode.Hybrid = 1, ReaderMode.DenseReaderM4 = 2, ReaderMode.DenseReaderM8 = 3,
  ReaderMode.MaxMiller = 4, ReaderMode.DenseReaderM4Two = 5, ReaderMode.AutoSetDenseReader = 1000, ReaderMode.AutoSetDenseReaderDeepScan = 1002
}
 Enum defining the configured Reader mode, which controls the modulation and data rate for the the link between the reader and the tags. AutoSetDenseReader is recommended as the most robust mode. Not all modes are available on all models and regions. More...
 
enum  ReadResultStatus { ReadResultStatus.Success = 0, ReadResultStatus.NonspecificTagError = 1, ReadResultStatus.NoResponseFromTag = 2, ReadResultStatus.NonspecificReaderError = 3 }
 Enum defining the possible status outcomes for the tag read operation. More...
 
enum  ReportMode { ReportMode.WaitForQuery, ReportMode.Individual, ReportMode.IndividualUnbuffered, ReportMode.BatchAfterStop }
 Enum for defining how often inventory reports are sent from the reader. More...
 
enum  RoSpecEventType { RoSpecEventType.StartOfROSpec = 0, RoSpecEventType.EndOfROSpec = 1, RoSpecEventType.PreemptionOfROSpec = 2 }
 Enum identifying the type of ROSpec event that has occurred. More...
 
enum  RShellCmdStatus { RShellCmdStatus.Success, RShellCmdStatus.Failure, RShellCmdStatus.Unknown }
 Enum used as the return type for the RShellEngine.Send method, indicating whether it succeeds, or not. More...
 
enum  SearchMode {
  SearchMode.ReaderSelected = 0, SearchMode.SingleTarget = 1, SearchMode.DualTarget = 2, SearchMode.TagFocus = 3,
  SearchMode.SingleTargetWithSuppression
}
 Enum for configuring the tag search mode, which controls whether tags are singulated only once, or repeatedly. More...
 
enum  SequenceState { SequenceState.Disabled = 0, SequenceState.Active = 1 }
 Enum for defining the operation state for a sequence. More...
 
enum  SequenceTriggerType { SequenceTriggerType.None = 0, SequenceTriggerType.ExecutionCount = 1 }
 Enum used to identify the sequence stop trigger. More...
 
enum  TagFilterMode {
  TagFilterMode.None = 0, TagFilterMode.OnlyFilter1 = 1, TagFilterMode.OnlyFilter2 = 2, TagFilterMode.Filter1AndFilter2 = 3,
  TagFilterMode.Filter1OrFilter2 = 4
}
 The possible inventory tag filter combinations. More...
 
enum  TagFilterOp { TagFilterOp.Match, TagFilterOp.NotMatch }
 
enum  TagLockState {
  TagLockState.Lock = 0, TagLockState.Permalock = 1, TagLockState.Permaunlock = 2, TagLockState.Unlock = 3,
  TagLockState.None = 4
}
 Enum for determining which lock operation to perform on the tag memory bank; this determines what state to leave the tag memory bank in. More...
 
enum  TagModelName {
  TagModelName.Monza4QT, TagModelName.Monza4U, TagModelName.Monza4E, TagModelName.Monza4D,
  TagModelName.Monza5, TagModelName.Monza5U, TagModelName.MonzaX_2K_Dura, TagModelName.MonzaX_8K_Dura,
  TagModelName.Other
}
 An enumeration used to indicate a tag's model name. More...
 
enum  TransitionReportType { TransitionReportType.NewTag = 0, TransitionReportType.StrayTag = 1, TransitionReportType.TagTransition = 2 }
 Enum that specifies the transition report type. More...
 
enum  TransitionZoneRange { TransitionZoneRange.Standard = 0, TransitionZoneRange.Large = 1 }
 Enum for defining the xArray transitional zone range. More...
 
enum  WriteResultStatus {
  WriteResultStatus.Success = 0, WriteResultStatus.TagMemoryOverrunError = 1, WriteResultStatus.TagMemoryLockedError = 2, WriteResultStatus.InsufficientPower = 3,
  WriteResultStatus.NonspecificTagError = 4, WriteResultStatus.NoResponseFromTag = 5, WriteResultStatus.NonspecificReaderError = 6
}
 Enum defining the possible status outcomes for the tag write operation. More...
 
enum  XArrayMode { XArrayMode.WideAreaMonitor, XArrayMode.Transition, XArrayMode.Location }
 Enum for defining the xArray operational mode. More...
 

Enumeration Type Documentation

Enumerator
foo 

Obsolete.

Enum defining the possible types of antenna event.

Enumerator
AntennaDisconnected 

Indicates an antenna disconnected event.

AntennaConnected 

Indicates an antenna connected event.

Enum defining the possible Impinj reader autostart modes.

Enumerator
None 

No autostart mode specified

Immediate 

Start immediately after the reader is configured.

Periodic 

Periodic autostart mode specified.

GpiTrigger 

GPI trigger autostart mode specified.

Enum defining the possible Impinj reader autostop modes.

Enumerator
None 

No autostop mode specified.

Duration 

Autostop defined by a timeout.

GpiTrigger 

Autostop defined by a GPI trigger value.

An enumerations used to indicate the results of a block permalock operation.

Enumerator
Success 

The operation was successful.

Insufficient_Power 

There was insufficient power to perform the operation.

NonspecificTagError 

The operation failed for an unknown reason.

NoResponseFromTag 

The operation failed because the reader did not receive a response from the tag.

NonspecificReaderError 

The operation failed for an unknown reason.

IncorrectPasswordError 

The operation failed because an incorrect password was supplied.

TagMemoryOverrunError 

The operation failed because it attempted to access memory outside of the valid range.

Enum used to identify the supported regions on Impinj readers, which has an impact on the RF frequencies, transmit power level and dwell times that the reader is allowed to use.

Enumerator
Unspecified 

Unspecified regulatory region.

US_FCC_Part_15 

Comply with Federal Communications Commission (FCC) Part 15.247 and 15.249. Required for use in North America.

ETSI_302_208 

Comply with ETSI EN 302 208 specification. Required for use in the European Union and United Arab Emirates (UAE).

ETSI_300_220 

Comply with ETSI EN 30 2220 specification, replaced in 2004 by the ETSI EN 302 208 specification. Not supported on Speedway Revolution.

Australia_LIPD_1W 

Comply with ACMA’s Low Interference Potential Devices (LIPD) Class License 2000, with a maximum transmit power of 1 Watt.

Australia_LIPD_4W 

Comply with ACMA’s Low Interference Potential Devices (LIPD) Class License 2000, with a maximum transmit power of 4 Watts. Required for use in Australia.

Japan_ARIB_STD_T89 

Comply with ARIB's STD-T89 specification. Required for use in Japan.

Hong_Kong_OFTA_1049 

Comply with the Office of the Telecommunications Authority (OFTA) of Hong Kong, China, standard HKTA 1049. Required for use in Hong Kong.

Taiwan_DGT_LP0002 

Comply with Taiwan Directorate General of Telecommunications (DGT) specification LP0002. Required for use in Taiwan.

Korea_MIC_Article_5_2 

Comply with Ministry of Information and Communication (MIC) of Republic of Korea (South Korea) RFID standard. Required for use in South Korea.

Enumeration used to specify the result of an asynchronous connection attempt

Enumerator
Success 

Successfully connected to the reader

Failure 

Failed to connect to the reader

Defines the modes that may be used to configure the GPO ports when the Advanced GPO features are used.

Enumerator
Normal 

Normal mode; GPO value must be set via SetGpo()

Pulsed 

Pulsed mode; GPO value must be set via SetGpo(), but will change to opposite state after a timeout.

ReaderOperationalStatus 

Reader Operational Status; GPO value of true means reader is operational, false means the reader is not operational.

LLRPConnectionStatus 

LLRP Connection Status; GPO value of true means the LLRP connection is operational, false means the LLRP connection is not operational.

ReaderInventoryStatus 

Reader Inventory Status; GPO value is true while the reader is performing a tag inventory.

NetworkConnectionStatus 

Network Connection Status; GPO value of true means that the Network connection is operational, false means that the network connection is not operational.

ReaderInventoryTagsStatus 

Reader Inventory Tag Status; GPO value is true whenever a unique tag has been inventoried.

Enum defining the antenna hub connection status options.

Enumerator
Unknown 

The antenna hub is in an unknown state.

Disconnected 

The antenna hub is disconnected.

Connected 

The antenna hub is connected.

Enum defining the antenna hub fault options.

Enumerator
No_Fault 

No known antenna hub fault exists.

RF_Power 

A non-specific RF power distribution error has occurred.

RF_Power_On_Hub_1 

An RF power distribution error has occurred; RF power is present on Hub 1.

RF_Power_On_Hub_2 

An RF power distribution error has occurred; RF power is present on Hub 2.

RF_Power_On_Hub_3 

An RF power distribution error has occurred; RF power is present on Hub 3.

RF_Power_On_Hub_4 

An RF power distribution error has occurred; RF power is present on Hub 4.

No_Init 

The hub has not yet been initialized.

Serial_Overflow 

A serial communications error has occurred between the reader and the hub controller.

Disconnected 

The antenna hub is disconnected.

Enum defining the possible status outcomes for the tag kill operation.

Enumerator
Success 

The tag kill operation was successful.

ZeroKillPasswordError 

The tag kill password was set to zero; a non-zero password is required to kill a tag.

InsufficientPower 

The tag did not meet the required RSSI threshold.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

Enum that specifies the location report type.

Enumerator
Entry 

An entry report

Update 

An update report

Exit 

An exit report

Enum for defining the tag memory bank to perform lock operation on.

Enumerator
KillPassword 

Perform a lock operation on the Kill password memory region in the reserved memory bank.

AccessPassword 

Perform a lock operation on the Access password memory region in the reserved memory bank.

Epc 

Perform a lock operation on the EPC memory bank.

Tid 

Perform a lock operation on the TID memory bank.

User 

Perform a lock operation on the User memory bank.

Enum defining the possible status outcomes for the tag lock operation.

Enumerator
Success 

The tag lock operation completed successfully.

InsufficientPower 

The tag did not meet the required RSSI threshold.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

Enum specifying the type of lock operation to perform.

Enumerator
None 

Perform no lock operation on the tag memory bank; the tag memory bank lock status remains unaffected.

Unlocked 

Perform an 'Unlock' operation on the tag memory bank; the tag memory bank can never subsequently be unlocked.

Locked 

Perform a 'Lock' operation on the tag memory bank; the tag memory bank can subsequently be unlocked.

PermaUnlocked 

Perform a 'Permaunlock' operation on the tag memory bank; the tag memory bank can never subsequently be locked.

PermaLocked 

Perform a 'Permalock' operation on the tag memory bank; the tag memory bank can never subsequently be unlocked.

Enum for defining the tag memory bank to access.

Enumerator
Reserved 

Tag reserved memory.

Epc 

Tag Electronic Product Code (EPC) memory

Tid 

Tag identifier (TID) memory

User 

Tag user memory

Enumeration used to determine whether to configure the tag in reduced sensitivity (i.e. Short Range) mode, or not.

Enumerator
Unknown 

Leave tag access range as-is.

NormalRange 

Normal-Range tells tag to use normal sensitivity.

ShortRange 

Short-Range tells tag to reduce sensitivity, adding a layer of physical security by preventing readers farther than roughly one meter from the tag from switching the tag from Public to Private (or vice versa).

Enumeration used to determine which QT data profile to use. The Private/Public profile capability, available in Monza 4QT tag chips, provides two memory configurations (i.e. profiles) in a single chip; one Private and one Public. Only one profile is exposed at a time.

Enumerator
Unknown 

Leave the tag data profile as-is.

Private 

Select the Private, or confidential, Data Profile, where users have access to a 128-bit EPC, 512-bit User Memory, 16-bit TID header, and 48 bit serial number.

Public 

Select the Public Data Profile, where users have access to the 96-bit public EPC and the 32 bit base TID.

Enumeration used to indicate the results of a QtGetConfig operation.

Enumerator
Success 

The tag QT operation was successful.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

IncorrectPasswordError 

An incorrect QT password was used.

Enumeration used to manage whether switching to the private Monza QT Data Profile should be persistent, or whether the tag should revert to the private state once the tag loses power.

Enumerator
Unknown 

Leave the tag persistence configuration as-is.

Temporary 

Stay in the private data profile a until the tag loses power, when it will automatically revert to the Public profile.

Permanent 

Stay in the private data profile.

Enum defining the possible status outcomes for the tag QT operation.

Enumerator
Success 

The tag QT operation was successful.

InsufficientPower 

The tag did not meet the required RSSI threshold.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

IncorrectPasswordError 

An incorrect QT password was used.

Enum defining the configured Reader mode, which controls the modulation and data rate for the the link between the reader and the tags. AutoSetDenseReader is recommended as the most robust mode. Not all modes are available on all models and regions.

Enumerator
MaxThroughput 

Fastest possible data transfer rates between tag and reader when the population of readers is very low and the likelihood of interference between readers is very low.

Hybrid 

Provides a fast read rate when there are is modest interference from other readers, but a low likelihood of co-channel, adjacent channel, or alternate-channel interferers.

DenseReaderM4 

Provides an intermediate read rate when the population of readers is large and the likelihood of interference is high.

DenseReaderM8 

Provides a low read rate (~half that of DenseReaderM4) for extreme interference environments where tags are stationary or moving slowly.

MaxMiller 

Provides maximum reliability and read rate when the population of readers is low and the Likelihood of interference is low.

DenseReaderM4Two 

Faster Forward link than Mode 2, available with regions: ETSI, China, India, Japan (916.7-920.9 MHz and 952-956 MHz), Korea, and South Africa.

AutoSetDenseReader 

The reader monitors RF noise and interference and then automatically and continuously optimizes the reader’s configuration, selecting the appropriate configuration settings for the best, most reliable performance for environments where tags might be transient.

AutoSetDenseReaderDeepScan 

The reader monitors RF noise and interference and then automatically and continuously optimizes the reader’s configuration, selecting the appropriate configuration settings for the best, most reliable performance for environments where tags are relatively static.

Enum defining the possible status outcomes for the tag read operation.

Enumerator
Success 

The tag read operation was successful.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

Enum for defining how often inventory reports are sent from the reader.

Enumerator
WaitForQuery 

Buffer on the reader and only send the tag report once asked for.

Individual 

Generate reports one at a time.

IndividualUnbuffered 
BatchAfterStop 

Buffer on the reader until the reader has stopped.

Enum identifying the type of ROSpec event that has occurred.

Enumerator
StartOfROSpec 

This is an ROSpec start event.

EndOfROSpec 

This is an end of ROSpec event.

PreemptionOfROSpec 

ROSpec has been preempted by an ROSpec of a higher priority.

Enum used as the return type for the RShellEngine.Send method, indicating whether it succeeds, or not.

Enumerator
Success 

Indicates that the Impinj reader reported that the RShell command succeeded.

Failure 

Indicates that the Impinj reader reported that the RShell command failed.

Unknown 

Indicates that an error, such as a timeout, has occurred when sending an RShell command to the Impinj reader.

Enum for configuring the tag search mode, which controls whether tags are singulated only once, or repeatedly.

Enumerator
ReaderSelected 

Reader automatically selects a tag search mode.

SingleTarget 

Reader inventories tags that are in the session inventory state A only, inverting the inventory flag to state B for the appropriate session interval so that they no longer respond to reader queries; useful when there is a high tag count, or for a high-throughput application, where a reduction in repeated tag observation is acceptable.

DualTarget 

Reader inventories tags in session inventory state A first, inverting their inventory flag to state B. Once all of the tags in state A have responded, the reader then inventories tags in state B. This process continues for as long as the tags stay in the antenna field of view. This is useful when there is a low to medium tag count or for low-throughput applications where repeated tag observation is desirable.

TagFocus 

For Monza tags and Session 1 ONLY; reader inventories tags and then uses the Monza TagFocus feature to suppress repeated observations for extended periods of time while tags are energized. This is useful for high-throughput applications where a single observation of each tag is acceptable.

SingleTargetWithSuppression 

Enum for defining the operation state for a sequence.

Enumerator
Disabled 

Indicates that all sequence operations are disabled.

Active 

Indicates that all sequence operations are active.

Enum used to identify the sequence stop trigger.

Enumerator
None 

Indicates that there is no stop trigger; the sequence runs indefinitely.

ExecutionCount 

Indicates that the sequence will run for the number of times specified in the ExecutionCount parameter.

The possible inventory tag filter combinations.

Enumerator
None 

No inventory tag filter.

OnlyFilter1 

Filter only on conditions defined in Filter 1.

OnlyFilter2 

Filter only on conditions defined in Filter 2.

Filter1AndFilter2 

Filter on conditions defined in Filters 1 AND 2.

Filter1OrFilter2 

Filter on conditions defined in Filters 2 OR 2.

Enumerator
Match 

Only select tags that match the filter.

NotMatch 

Only select tags that do not match the filter.

Enum for determining which lock operation to perform on the tag memory bank; this determines what state to leave the tag memory bank in.

Enumerator
Lock 

Leave the tag memory bank in the 'Lock' state; the tag memory bank can subsequently be unlocked.

Permalock 

Leave the tag memory bank in the 'Permalock' state; the tag memory bank can never subsequently be unlocked.

Permaunlock 

Leave the tag memory bank in the 'Permaunlock' state; the tag memory bank can never subsequently be locked.

Unlock 

Leave the tag memory bank in the 'Unlock' state; the tag memory bank can subsequently be locked.

None 

Do not change the lock state of the tag memory bank.

An enumeration used to indicate a tag's model name.

Enumerator
Monza4QT 

Impinj Monza 4QT

Monza4U 

Impinj Monza 4U

Monza4E 

Impinj Monza 4E

Monza4D 

Impinj Monza 4D

Monza5 

Impinj Monza 5

Monza5U 

Impinj Monza 5U

MonzaX_2K_Dura 

Impinj Monza X-2K Dura

MonzaX_8K_Dura 

Impinj Monza X-8K Dura

Other 

An unknown tag

Enum that specifies the transition report type.

Enumerator
NewTag 

New tag.

StrayTag 

Stray tag.

TagTransition 

Stray tag.

Enum for defining the xArray transitional zone range.

Enumerator
Standard 

Standard transition zone.

Large 

Large transition zone.

Enum defining the possible status outcomes for the tag write operation.

Enumerator
Success 

The tag write operation was successful.

TagMemoryOverrunError 

The tag write operation request contained more data than can fit in the target memory bank.

TagMemoryLockedError 

The target memory bank is in the locked state.

InsufficientPower 

The tag did not meet the required RSSI threshold.

NonspecificTagError 

An unidentified tag error occurred.

NoResponseFromTag 

No ACK response was received from the tag in response to the operation.

NonspecificReaderError 

An unidentified reader error occurred.

Enum for defining the xArray operational mode.

Enumerator
WideAreaMonitor 

Wide Area Monitor mode. xArray will perform a tag inventory on all antennas.

Transition 

Transition mode. xArray will report when tags transition for one zone to another.

Location 

Location mode. xArray will report tag location.