Octane SDK
2.0 Beta
|
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... | |
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.
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.
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 fault options.
Enum defining the possible status outcomes for the tag kill operation.
Enum for defining the tag memory bank to perform lock operation on.
Enum defining the possible status outcomes for the tag lock operation.
Enum specifying the type of lock operation to perform.
Enumeration used to determine whether to configure the tag in reduced sensitivity (i.e. Short Range) mode, or not.
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.
Enumeration used to indicate the results of a QtGetConfig operation.
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.
Enum defining the possible status outcomes for the tag QT operation.
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.
Enum defining the possible status outcomes for the tag read operation.
Enum used as the return type for the RShellEngine.Send method, indicating whether it succeeds, or not.
Enum for configuring the tag search mode, which controls whether tags are singulated only once, or repeatedly.
The possible inventory tag filter combinations.
Enum for determining which lock operation to perform on the tag memory bank; this determines what state to leave the tag memory bank in.
An enumeration used to indicate a tag's model name.
Enum defining the possible status outcomes for the tag write operation.