Setup Commands¶
The defaults for the Set Baud and Set Echo Mode commands are configured in Composer via the Unit Properties dialog. Settings made via these Control Protocol commands will be overridden by the values in the last pushed Site File on the next hardware reboot or push. To establish the permanent state, right-click on each unit and select Unit Properties, then click Configure Remote Control Port(s). Settings may be set independently for the Ethernet and RS-232 ports.
Note: If you ever find yourself in a situation where you are not sure of the RS-232 port settings, you can use Composer to return the unit to default values. Simply open the Hardware->Upgrade Firmware/Hardware Settings dialog and click on the Erase Memory button. You can then select to erase the Remote Control Port Settings. Doing this will set the baud rate, echo mode and quiet mode settings to the factory default values.
Alternatively, the rear panel reset button can be used to return the settings to factory defaults. However, that should be only used as a last resort since it also resets many other settings.
(SB) Set Baud
The Set Baud command controls the remote control port’s RS-232 baud rate. The syntax of the command is:
SB \
Where\
If the command is accepted, the device will respond with the string:
ACK\
If the command is interpreted but fails for any reason the device will respond with the string:
NAK\
The baud rate is saved in non-volatile memory so it is retained across power cycles. This command can be sent to either the Ethernet or RS-232 port, but only affects the remote control RS-232 port.
Note: New devices default to a baud rate of 57600.
(SQ) Set Quiet Mode
The Set Quiet Mode command controls the text output of the control port during responses. When quiet mode is turned on, it restricts the output to just ACK, NAK or simple values. All command descriptions above assume that quiet mode is turned ON. Quiet mode ON should generally be used for normal operation.
When quiet mode is set to OFF, lengthy strings intended to be read by humans are sent in response to commands. This mode is useful when using a terminal program for testing or debugging. The syntax of the command is:
SQ \
Where \
If the “SQ 0” command is accepted, the device will respond with the string:
Setting Quiet Mode to false.\
If the command is interpreted but fails for any reason the device will respond with the string:
NAK\
The quiet mode state is kept separately for the Ethernet port and the RS-232 port. A Set Quiet Mode command received on the Ethernet port does not affect the RS-232 port and vice versa. The quiet mode state is saved in non-volatile memory, so it is retained across power cycles.
Note: New devices default to quiet mode ON.
(EH) Set Echo Mode
The Set Echo Mode command controls the text output of the control port during commands. When echo mode is turned on, all characters that are received on the RS-232 or Ethernet port are sent or “echoed” back. This mode is useful when using a terminal program for testing or debugging.
When echo mode is turned off, the characters received are not echoed back. All command descriptions above assume that echo mode is turned off. Echo mode OFF should generally be used for normal operation. The syntax of the command is:
EH \
Where\
If the command is accepted, the device will respond with the string:
ACK\
If the command is interpreted but fails for any reason the device will respond with the string:
NAK\
The echo mode state is kept separately for the Ethernet port and the RS-232 port. A Set Echo Mode command received on the Ethernet port does not affect the RS-232 port and vice versa. The echo mode state is saved in non-volatile memory so it is retained across power cycles.
Note: New devices default with echo mode OFF.
NOP (No Operation)
The NOP command will always return an ACK in Quiet mode to indicate that the system has received the command. The NOP command can be used to keep a TCP connection active or as a simple check of whether a system is up and running and responding to commands.
Q! (Quit TCP/IP Session)
The Q! command will close the current TCP/IP session. If the command is accepted, the unit will respond with the string:
ACK\
If the command is interpreted but fails for any reason the unit will respond with the string:
NAK\
A typical reason for failure is that the command was not sent over a TCP/IP connection.
RI (IP address)
The RI command returns the IP address of the unit.
As an example:
RI\
192.168.100.150
V (Version)
The V command returns the version of the software in the unit. Up to thirteen different versions of software will be returned corresponding to different subsystems within the devices. For this command to be useful, it is recommended to run the command while verbose mode is turned on or temporarily turned on with the $v command prefix (described in Special Command Prefix section).
As an example:
$v V \
Firmware Version: V2.000
Build Date: Tue Apr 8 12:36:30 PDT 2014
Internal Build: V8.00
Linux Version: V3.2.0
Dante firmware: F:3.6.4 Sym:5.42
Startup firmware: V2.18
Front panel firmware: V2.29
RS-485 firmware: V1.25
RS-232 firmware: V1.55
TCP/IP firmware: V1.02
ARC-Web firmware: V1.10
ARC-Web executable: V1.09
ARC-Web CGI firmware: V1.09
Dialer CGI firmware: V1.55
Additional Info:
Linux version 3.2.0-ADI-2012R1-pre-9-pae+ (uclinux-devel@linux-tclw)
(gcc version 4.3.5 (ADI-2010R1-RC4) ) #3119 Tue Nov 19 17:13:55 PST 2013 TCP/IP instance #1 of 4 >
R! (Reboot Symetrix device)
The R! command will reboot the unit.