Raritan Dominion SX16, Installation And Operation Manual, Page: 134 / 162

120 D
OMINION
SX I
NSTALLATION AND
O
PERATIONS
M
ANUAL
•
Data received from each target system on the RS-232 port is sent to all connected Java user consoles and also
stored in an internal TCL buffer. Each internal buffer has the following properties:
−
Data received on an RS-232 port from a target device is stored in this buffer.
−
The TCL Engine is the only reader of this data.
−
Internal buffers are circular buffers; 64Kbytes.
−
The buffer uses the FIFO storage method.
−
A data stream methodology for data retrieval is used and there is no random access capability.
Extensions have been made to the TCL framework to enable retrieving data from the TCL internal buffer and to
send commands to the target systems. A single script can include instructions to access any RS-232 port. The script
has the ability to take away the write access to an RS-232 port from other users, which is communicated to each user
through the GUI. Once the script acquires the write access, other users will not be allowed to take the write access
until the script releases it. There are several requirements to be considered
•
If the script has write access and the user resets TCL through the GUI, the TCL interpreter will release write
access before resetting.
•
If the script has write access and the user logs out without releasing the write access, access will be held by the
TCL interpreter until a user connects to the interpreter and instructs the interpreter to release it or resets the
interpreter.
•
It is important for the scriptwriter to release the write access, if acquired, in the boot script.
•
The write access lock is always associated with a port number. The user is responsible for releasing any locks
acquired during script execution.
With the following commands (which may be used interactively by a TCL user or in a TCL script), the user can
access the RS-232 ports. Each command takes a number as the final argument to indicate which serial port should be
affected:
•
amplock/ampunlock <port>
−
TCL engine locks the write access for this port. GUI users using the Java Console cannot supersede TCL
and force TCL unlock by the issuing the Get Write Access or F8 key. An administrator may only force a
TCL unlock by issuing a Reset from the Script Shell window or main GUI.
−
The TCL user must lock the write access in order for the TCL Engine to write to the Console.
•
ampclear <port>
−
Mark all data in the TCL internal buffer associated with the port as having been READ. Essentially, this
command flushes all data in the TCL internal buffers.
•
ampread <timeout> <termination string> <port>
−
TCL will start examining the unread data in a TCL internal buffer and return the result until:
A timeout has occurred or
A termination string is found in the data stream.
−
If zero is given as the timeout, no timeout limit will be checked.
•
ampwrite <output string> <port>
−
The string is written to Console port.
•
ampexec <output string> <timeout> <termination string> <port>
−
This command is simply an ampwrite follow by an ampread.
The above extensions to TCL, along with the standard TCL commands, provide a development platform for
powerful scripts for managing the target devices. This guide provides details on all of the extensions provided in the
Dominion SX product. A few sample scripts are also provided.
The TCL command queuer provides the following features:
•
Serialize multiple TCL Command Requests.
•
Process one command with one response.
•
Multi-lined single command (multiple commands issued by user as a single task by using “;” between
commands) is processed as a single request and single response is returned.
•
Execution result returned to the command issuer.