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

Class for interacting with the RShell interface of an Impinj reader. More...

Public Member Functions

void Close ()
 Used to close the RShell session with an Impinj reader. More...
 
void Open (string address, string username, string password, int timeoutMs)
 Used to open an RShell session with the Impinj reader. More...
 
RShellCmdStatus Send (string cmd, out string reply)
 Used to send an RShell command to an Impinj reader. More...
 

Detailed Description

Class for interacting with the RShell interface of an Impinj reader.

Member Function Documentation

void Impinj.OctaneSdk.RShellEngine.Close ( )

Used to close the RShell session with an Impinj reader.

void Impinj.OctaneSdk.RShellEngine.Open ( string  address,
string  username,
string  password,
int  timeoutMs 
)

Used to open an RShell session with the Impinj reader.

Parameters
addressThe reader hostname or IP address to establish an RShell session with.
usernameThe username used to log on to the Impinj reader with (reader default is "root").
passwordThe password associated with the reader username (reader default is "impinj" for the user "root").
timeoutMsThe timeout period for establishing an RShell connection.
Exceptions
OctaneSdkExceptionThrown when either an RShell connection cannot be established with the Impinj reader, an invalid username or password is provided, or a connection timeout occurs.
RShellCmdStatus Impinj.OctaneSdk.RShellEngine.Send ( string  cmd,
out string  reply 
)

Used to send an RShell command to an Impinj reader.

Parameters
cmdThe RShell command to send to the reader (e.g. "show network summary").
replyThe output from the reader that results from the cmd command.
Returns
Enum identifying whether the Impinj reader reported that the RShell command succeeded or failed.