Octane SDK  2.0 Beta
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | Events | List of all members
Impinj.OctaneSdk.ImpinjReader Class Reference

The main class for controlling and configuring an Impinj RFID reader. More...

Public Member Functions

void AddOpSequence (TagOpSequence sequence)
 Adds a sequence of tag operations (read, write, lock, kill) to the reader. More...
 
void ApplyDefaultSettings ()
 Applies the default settings to the reader. More...
 
void ApplySettings (Settings settings)
 Applies the provided settings to the reader. More...
 
void Connect ()
 Connect to an Impinj RFID reader. The Address property must be set prior to calling this method. More...
 
void Connect (string address)
 Connect to an Impinj RFID reader. More...
 
void Connect (string address, int port)
 Connect to an Impinj RFID reader. More...
 
void ConnectAsync ()
 Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails. The Address property must be set prior to calling this method. More...
 
void ConnectAsync (string address)
 Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails. More...
 
void ConnectAsync (string address, int port)
 Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails. More...
 
void DeleteAllOpSequences ()
 Deletes all tag operation sequences from the reader. More...
 
void DeleteOpSequence (uint sequenceId)
 Deletes a tag operation sequence from the reader. More...
 
void Disconnect ()
 Closes the connection to the reader. More...
 
void EnableOpSequence (uint sequenceId)
 Enables a tag operation sequence on the reader. More...
 
 ImpinjReader (string address, string name)
 Creates and initializes an ImpinjReader object. More...
 
 ImpinjReader ()
 Creates and initializes an ImpinjReader object. More...
 
Settings QueryDefaultSettings ()
 Returns the reader default settings. More...
 
FeatureSet QueryFeatureSet ()
 Queries the reader for a summary of the features that it supports. More...
 
Settings QuerySettings ()
 This function queries the reader for its current settings. More...
 
Status QueryStatus ()
 This function queries the reader for a summary of its current status. More...
 
*void QueryTags ()
 Tells the reader to send all the tag reports it has buffered. The ReportMode should be set so that reader accumulates tag reads (WaitForQuery or BatchAfterStop). More...
 
void ResumeEventsAndReports ()
 This function tells the reader to resume sending reports and events. Messages in the queue on the reader may then be sent. More...
 
void SaveSettings ()
 Instructs the Reader to save the current configuration to persistent storage. The saved parameters then become the Reader's power-on and reset settings. More...
 
void SetGpo (ushort port, bool state)
 This function is used to set the value of a GPO signal to the specified value. The output is set to high when state is true, and low when state is false. More...
 
void Start ()
 Starts the reader. Tag reports will be received asynchronously via an event. More...
 
void Stop ()
 Stops the reader. Tags will no longer be read. More...
 
void TurnBeaconOff ()
 Turns the xArray beacon light off. More...
 
void TurnBeaconOn (ulong duration)
 Turns the xArray beacon light on. More...
 

Properties

string Address [get, set]
 Contains the IP address or hostname of the reader. More...
 
*int ConnectTimeout [get, set]
 The connection timeout in milliseconds. If a connection to the reader cannot be established in this time, an exception is thrown. More...
 
*ImpinjReaderDebug Debug [get, set]
 Handle to the build in debug logging handler. More...
 
bool IsConnected [get]
 Indicates whether or not a connection to the reader exists. More...
 
int MaxConnectionAttempts [get, set]
 Number of times to attempt a reader connection before an exception is thrown. More...
 
int MessageTimeout [get, set]
 The message reply timeout. More...
 
string Name [get, set]
 Assigns a name to this reader. For example, "Dock Door #1 Reader". This name can be used to identify a particular reader in an application that controls multiple readers. More...
 
RShellEngine RShell [get, set]
 Handle for establishing RShell communications with the reader. More...
 

Events

AntennaEventHandler AntennaChanged
 Event to provide notification when an AntennaChanged event occurs. More...
 
ConnectAsyncCompleteHandler ConnectAsyncComplete
 Event to provide notification of a completed asynchronous connection attempt. More...
 
ConnectionLostHandler ConnectionLost
 Event to provide notification that the TCP/IP connection to the Impinj Reader has been lost. More...
 
DiagnosticsReportedHandler DiagnosticsReported
 Event to provide notification of a diagnostic report. Only available on the xArray. More...
 
GpiChangedHandler GpiChanged
 Event to provide notification when a GPI port status changes. More...
 
KeepaliveHandler KeepaliveReceived
 Event to provide notification that a keep alive TCP/IP packet was received from the reader. More...
 
LocationReportedHandler LocationReported
 Event to provide notification of a location report. Only available on the xArray. More...
 
ReaderStartedEventHandler ReaderStarted
 Event to provide notification when the reader has started. More...
 
ReaderStoppedEventHandler ReaderStopped
 Event to provide notification when the reader has started. More...
 
ReportBufferOverflowEventHandler ReportBufferOverflow
 Event to provide notification when the report buffer on the reader could not hold more tag reports. More...
 
ReportBufferWarningEventHandler ReportBufferWarning
 Event to provide notification when the report buffer on the reader is nearly full. More...
 
TagOpCompleteHandler TagOpComplete
 Event to provide notification that a tag operation has completed, including the results of the operation. More...
 
TagsReportedHandler TagsReported
 Event to provide notification when a tag report is available. More...
 
TransitionReportedHandler TransitionReported
 Event to provide notification of a transition report. Only available on the xArray. More...
 

Detailed Description

The main class for controlling and configuring an Impinj RFID reader.

Constructor & Destructor Documentation

Impinj.OctaneSdk.ImpinjReader.ImpinjReader ( string  address,
string  name 
)

Creates and initializes an ImpinjReader object.

Impinj.OctaneSdk.ImpinjReader.ImpinjReader ( )

Creates and initializes an ImpinjReader object.

Member Function Documentation

void Impinj.OctaneSdk.ImpinjReader.AddOpSequence ( TagOpSequence  sequence)

Adds a sequence of tag operations (read, write, lock, kill) to the reader.

Parameters
sequenceThe sequence of operations to add to the reader.
Exceptions
OctaneSdkExceptionThrown if a zero length operations sequence is provided.
void Impinj.OctaneSdk.ImpinjReader.ApplyDefaultSettings ( )

Applies the default settings to the reader.

Exceptions
OctaneSdkExceptionThrown if this method is called prior to establishing a connection with a reader.
void Impinj.OctaneSdk.ImpinjReader.ApplySettings ( Settings  settings)

Applies the provided settings to the reader.

Parameters
settingsSettings to apply to the reader
Exceptions
OctaneSdkExceptionThrown when this method is called prior to establishing a connection with a reader, or if the settings are invalid.
void Impinj.OctaneSdk.ImpinjReader.Connect ( )

Connect to an Impinj RFID reader. The Address property must be set prior to calling this method.

Exceptions
OctaneSdkExceptionThrown when the connection attempt fails or if the Address property has not been set.
void Impinj.OctaneSdk.ImpinjReader.Connect ( string  address)

Connect to an Impinj RFID reader.

Parameters
addressIP address or hostname of the target reader.
Exceptions
OctaneSdkExceptionThrown when the connection attempt fails.
void Impinj.OctaneSdk.ImpinjReader.Connect ( string  address,
int  port 
)

Connect to an Impinj RFID reader.

Parameters
addressIP address or hostname of the target reader.
portTCP/IP port number used by the target reader.
Exceptions
OctaneSdkExceptionThrown when the connection attempt fails.
void Impinj.OctaneSdk.ImpinjReader.ConnectAsync ( )

Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails. The Address property must be set prior to calling this method.

Exceptions
OctaneSdkExceptionThrown when the connection attempt fails or if the Address property has not been set.
void Impinj.OctaneSdk.ImpinjReader.ConnectAsync ( string  address)

Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails.

Parameters
addressIP address or hostname of the target reader.
Exceptions
OctaneSdkExceptionThrown when the connection attempt fails.
void Impinj.OctaneSdk.ImpinjReader.ConnectAsync ( string  address,
int  port 
)

Connect to an Impinj RFID reader asynchronously. An event will be raised when the connection attempt succeeds or fails.

Parameters
addressIP address or hostname of the target reader.
portTCP/IP port number used by the target reader.
Exceptions
OctaneSdkExceptionThrown when the connection attempt fails.
void Impinj.OctaneSdk.ImpinjReader.DeleteAllOpSequences ( )

Deletes all tag operation sequences from the reader.

void Impinj.OctaneSdk.ImpinjReader.DeleteOpSequence ( uint  sequenceId)

Deletes a tag operation sequence from the reader.

Parameters
sequenceIdThe sequence ID of the operation sequence to delete.
Exceptions
OctaneSdkExceptionThrown if the referenced sequence does not exist on the reader.
void Impinj.OctaneSdk.ImpinjReader.Disconnect ( )

Closes the connection to the reader.

void Impinj.OctaneSdk.ImpinjReader.EnableOpSequence ( uint  sequenceId)

Enables a tag operation sequence on the reader.

Parameters
sequenceIdThe sequence ID of the operation sequence to enable.
Exceptions
OctaneSdkExceptionThrown if the referenced sequence does not exist on the reader.
Settings Impinj.OctaneSdk.ImpinjReader.QueryDefaultSettings ( )

Returns the reader default settings.

Returns
The default settings of the reader.
Exceptions
OctaneSdkExceptionThrown when this method is called prior to establishing a connection with a reader.
FeatureSet Impinj.OctaneSdk.ImpinjReader.QueryFeatureSet ( )

Queries the reader for a summary of the features that it supports.

Returns
An object summarizing the features supported by the reader.
Settings Impinj.OctaneSdk.ImpinjReader.QuerySettings ( )

This function queries the reader for its current settings.

Returns
An object containing the current reader settings
Exceptions
OctaneSdkExceptionThrown if a communication error occurs while talking with the reader, the reader has not been configured, or if the configuration was not applied by the SDK.
Status Impinj.OctaneSdk.ImpinjReader.QueryStatus ( )

This function queries the reader for a summary of its current status.

Returns
An object containing the current reader status.
Exceptions
OctaneSdkExceptionThrown if a communication error occurs while talking with the reader.
* void Impinj.OctaneSdk.ImpinjReader.QueryTags ( )

Tells the reader to send all the tag reports it has buffered. The ReportMode should be set so that reader accumulates tag reads (WaitForQuery or BatchAfterStop).

Don't include these classes in the documentation

Exceptions
OctaneSdkExceptionThrown when this method is called prior to establishing a connection with a reader.
void Impinj.OctaneSdk.ImpinjReader.ResumeEventsAndReports ( )

This function tells the reader to resume sending reports and events. Messages in the queue on the reader may then be sent.

Exceptions
OctaneSdkExceptionThrown if a communication error occurs while talking with the reader.
void Impinj.OctaneSdk.ImpinjReader.SaveSettings ( )

Instructs the Reader to save the current configuration to persistent storage. The saved parameters then become the Reader's power-on and reset settings.

void Impinj.OctaneSdk.ImpinjReader.SetGpo ( ushort  port,
bool  state 
)

This function is used to set the value of a GPO signal to the specified value. The output is set to high when state is true, and low when state is false.

Parameters
portGPO port to set
stateValue to set GPO to
Exceptions
OctaneSdkExceptionThrown if a communication error occurs while talking with the reader.
void Impinj.OctaneSdk.ImpinjReader.Start ( )

Starts the reader. Tag reports will be received asynchronously via an event.

Exceptions
OctaneSdkExceptionThrown if the Start method is called before connecting to a reader.
void Impinj.OctaneSdk.ImpinjReader.Stop ( )

Stops the reader. Tags will no longer be read.

void Impinj.OctaneSdk.ImpinjReader.TurnBeaconOff ( )

Turns the xArray beacon light off.

void Impinj.OctaneSdk.ImpinjReader.TurnBeaconOn ( ulong  duration)

Turns the xArray beacon light on.

Parameters
durationThe period in milliseconds to blink the beacon light.

Property Documentation

string Impinj.OctaneSdk.ImpinjReader.Address
getset

Contains the IP address or hostname of the reader.

Read only.

* int Impinj.OctaneSdk.ImpinjReader.ConnectTimeout
getset

The connection timeout in milliseconds. If a connection to the reader cannot be established in this time, an exception is thrown.

Don't include these classes in the documentation

* ImpinjReaderDebug Impinj.OctaneSdk.ImpinjReader.Debug
getset

Handle to the build in debug logging handler.

bool Impinj.OctaneSdk.ImpinjReader.IsConnected
get

Indicates whether or not a connection to the reader exists.

int Impinj.OctaneSdk.ImpinjReader.MaxConnectionAttempts
getset

Number of times to attempt a reader connection before an exception is thrown.

int Impinj.OctaneSdk.ImpinjReader.MessageTimeout
getset

The message reply timeout.

string Impinj.OctaneSdk.ImpinjReader.Name
getset

Assigns a name to this reader. For example, "Dock Door #1 Reader". This name can be used to identify a particular reader in an application that controls multiple readers.

RShellEngine Impinj.OctaneSdk.ImpinjReader.RShell
getset

Handle for establishing RShell communications with the reader.

Event Documentation

AntennaEventHandler Impinj.OctaneSdk.ImpinjReader.AntennaChanged

Event to provide notification when an AntennaChanged event occurs.

ConnectAsyncCompleteHandler Impinj.OctaneSdk.ImpinjReader.ConnectAsyncComplete

Event to provide notification of a completed asynchronous connection attempt.

ConnectionLostHandler Impinj.OctaneSdk.ImpinjReader.ConnectionLost

Event to provide notification that the TCP/IP connection to the Impinj Reader has been lost.

DiagnosticsReportedHandler Impinj.OctaneSdk.ImpinjReader.DiagnosticsReported

Event to provide notification of a diagnostic report. Only available on the xArray.

GpiChangedHandler Impinj.OctaneSdk.ImpinjReader.GpiChanged

Event to provide notification when a GPI port status changes.

KeepaliveHandler Impinj.OctaneSdk.ImpinjReader.KeepaliveReceived

Event to provide notification that a keep alive TCP/IP packet was received from the reader.

LocationReportedHandler Impinj.OctaneSdk.ImpinjReader.LocationReported

Event to provide notification of a location report. Only available on the xArray.

ReaderStartedEventHandler Impinj.OctaneSdk.ImpinjReader.ReaderStarted

Event to provide notification when the reader has started.

ReaderStoppedEventHandler Impinj.OctaneSdk.ImpinjReader.ReaderStopped

Event to provide notification when the reader has started.

ReportBufferOverflowEventHandler Impinj.OctaneSdk.ImpinjReader.ReportBufferOverflow

Event to provide notification when the report buffer on the reader could not hold more tag reports.

ReportBufferWarningEventHandler Impinj.OctaneSdk.ImpinjReader.ReportBufferWarning

Event to provide notification when the report buffer on the reader is nearly full.

TagOpCompleteHandler Impinj.OctaneSdk.ImpinjReader.TagOpComplete

Event to provide notification that a tag operation has completed, including the results of the operation.

TagsReportedHandler Impinj.OctaneSdk.ImpinjReader.TagsReported

Event to provide notification when a tag report is available.

TransitionReportedHandler Impinj.OctaneSdk.ImpinjReader.TransitionReported

Event to provide notification of a transition report. Only available on the xArray.