Datasat RS20i - Command Format

RS20i Installation and Operating Guide Page E-2
Appendix E. Remote Command API Document #: 9301H52900 Ver. 1.02
Password Protection
The RS20i may be protected from unauthorized access by setting a password under the
System > Access Control screen. There are two levels of password protection in the RS20i,
labeled as NetCmd Password and Setup Password in the system access screen on the
RS20i.
NetCmd Password
The NetCmd Password is used to prevent unauthorized access to the RS20i through a network
connection. The NetCmd Password does not prevent access through the serial command.
Setup Password
The Setup Password prevents unauthorized access to any RS20i setup commands through the
RS20i local front panel or remotely through serial or Ethernet connections. This does not affect
the operator level commands that are used in this document.
Authentication Command
The AUTH command must be sent to the RS20i before sending a password protected
command. If this is not done, then the command results in no action and the RS20i returns the
string “SECERR”. Sending the correct password enables all network commands for the
password level for as long as the network connection is maintained.
Not all network commands require a password. Inquiry commands such as SYSTEM and
IDENTIFY will operate without a password.
Command Format
The general command format for all configuration commands is listed below:
@COMMAND [arg1] [arg2]<CR>
Each COMMAND and its arguments (arg1, arg2) are defined in this document. Whether or not
arg1 and/or arg2 are used depends on the command. Square brackets [] around the argument
in this document indicate that the argument is optional.
The command is terminated by a <CR>. The response returns ASCII text and is also terminated
by <CR> character at the end. The <CR> represents an ASCII character with the value 0x0D.
How to enter this character in the command is entirely dependant on the remote program or
interface used. On a terminal interface, it is added by pressing ENTER on the keyboard. In
some GUI interfaces it is represented by “\r”, and for XML it may be &#10.
Important: If you are having problems with executing a simple command to the RS20i, check
that the command string starts with ‘@’ and properly sends the carriage return at the end.
Some commands are characterized as “Read” and are used only to read status or information
from the RS20i. Commands that are “Read/Write” can be used to set the specific configuration
item, or just read it.
For “Read/Write” commands the last argument is the value to write to the configuration. Omit
the final argument in order to read the configuration item without changing it.