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

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...

Inheritance diagram for Impinj.OctaneSdk.Settings:
Impinj.OctaneSdk.ImpinjSerializableClass

Static Public Member Functions

static Settings FromXmlString (string xml)
 Method for importing reader configuration settings from an XML string. More...
 
static Settings Load (string path)
 Read the XML representation of settings from a file and return a new Settings instance with those values. More...
 

Properties

AntennaConfigGroup Antennas [get, set]
 Per-antenna settings: power, sensitivity, etc. may be iterated with foreach or subscripted by antenna port number. More...
 
AutoStartConfig AutoStart [get, set]
 The conditions in which an Impinj reader will automatically start operation. More...
 
AutoStopConfig AutoStop [get, set]
 The conditions in which an Impinj reader will automatically stop operation. More...
 
FilterSettings Filters [get, set]
 The settings for defining any tag filters that the reader must use to select a portion of the tag population to participate in singulation. More...
 
GpiConfigGroup Gpis [get, set]
 Enable general purpose input (GPI) events on specific GPI ports. May be iterated with foreach or subscripted by GPI port number. More...
 
GpoConfigGroup Gpos [get, set]
 Enable general purpose output (GPO) events on specific GPO ports. May be iterated with foreach or subscripted by GPO port number. More...
 
bool HoldReportsOnDisconnect [get, set]
 Indicates whether the reader has been configured to hold reports and events; i.e. the reader events and reports parameter HoldEventsAndReportsUponReconnect is set to true. More...
 
KeepaliveConfig Keepalives [get, set]
 Optionally cause the reader to send a keep-alive message periodically. More...
 
LowDutyCycleSettings LowDutyCycle [get, set]
 The settings for the reader Low Duty Cycle feature, which optionally reduces RF activity. More...
 
ReaderMode ReaderMode [get, set]
 The selected reader mode for this configuration. More...
 
ReportConfig Report [get, set]
 Set how tags are reported and select optional report fields. More...
 
SearchMode SearchMode [get, set]
 The selected tag search mode for this configuration. More...
 
ushort Session [get, set]
 Session number (0 - 3) to use for the inventory operation for this configuration. More...
 
ushort TagPopulationEstimate [get, set]
 An estimate of the tag population in view of the RF field of the antenna. More...
 
List< double > TxFrequenciesInMhz [get, set]
 Transmit frequencies to use in regions that allow it. An empty list means the reader chooses. More...
 
XArrayConfig XArray [get, set]
 xArray configuration More...
 

Additional Inherited Members

- Public Member Functions inherited from Impinj.OctaneSdk.ImpinjSerializableClass
void Save (string path)
 Output the class contents as an XML file. More...
 
string ToXmlString ()
 Output the class contents as an XML string. More...
 

Detailed Description

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,

Member Function Documentation

static Settings Impinj.OctaneSdk.Settings.FromXmlString ( string  xml)
static

Method for importing reader configuration settings from an XML string.

Parameters
xmlXML string to parse.
Returns
Populated Settings object.
static Settings Impinj.OctaneSdk.Settings.Load ( string  path)
static

Read the XML representation of settings from a file and return a new Settings instance with those values.

Parameters
pathThe path and filename of the XML file to load.
Returns
Populated instance of Settings class based on file contents.

Property Documentation

AntennaConfigGroup Impinj.OctaneSdk.Settings.Antennas
getset

Per-antenna settings: power, sensitivity, etc. may be iterated with foreach or subscripted by antenna port number.

AutoStartConfig Impinj.OctaneSdk.Settings.AutoStart
getset

The conditions in which an Impinj reader will automatically start operation.

AutoStopConfig Impinj.OctaneSdk.Settings.AutoStop
getset

The conditions in which an Impinj reader will automatically stop operation.

FilterSettings Impinj.OctaneSdk.Settings.Filters
getset

The settings for defining any tag filters that the reader must use to select a portion of the tag population to participate in singulation.

GpiConfigGroup Impinj.OctaneSdk.Settings.Gpis
getset

Enable general purpose input (GPI) events on specific GPI ports. May be iterated with foreach or subscripted by GPI port number.

GpoConfigGroup Impinj.OctaneSdk.Settings.Gpos
getset

Enable general purpose output (GPO) events on specific GPO ports. May be iterated with foreach or subscripted by GPO port number.

bool Impinj.OctaneSdk.Settings.HoldReportsOnDisconnect
getset

Indicates whether the reader has been configured to hold reports and events; i.e. the reader events and reports parameter HoldEventsAndReportsUponReconnect is set to true.

KeepaliveConfig Impinj.OctaneSdk.Settings.Keepalives
getset

Optionally cause the reader to send a keep-alive message periodically.

LowDutyCycleSettings Impinj.OctaneSdk.Settings.LowDutyCycle
getset

The settings for the reader Low Duty Cycle feature, which optionally reduces RF activity.

ReaderMode Impinj.OctaneSdk.Settings.ReaderMode
getset

The selected reader mode for this configuration.

ReportConfig Impinj.OctaneSdk.Settings.Report
getset

Set how tags are reported and select optional report fields.

SearchMode Impinj.OctaneSdk.Settings.SearchMode
getset

The selected tag search mode for this configuration.

ushort Impinj.OctaneSdk.Settings.Session
getset

Session number (0 - 3) to use for the inventory operation for this configuration.

ushort Impinj.OctaneSdk.Settings.TagPopulationEstimate
getset

An estimate of the tag population in view of the RF field of the antenna.

List<double> Impinj.OctaneSdk.Settings.TxFrequenciesInMhz
getset

Transmit frequencies to use in regions that allow it. An empty list means the reader chooses.

XArrayConfig Impinj.OctaneSdk.Settings.XArray
getset

xArray configuration