Physical connection
RS-232, 9600 baud, 8 data bits, 1 stop bit, parity = NONE, flow control = NONE.

Protocol Properties
The protocol is an ASCI protocol, which means that commands can be sent to the router from a terminal or keyboard, as well as from an external control or automation system. The protocol is compact and concise. The protocol is human readable and writable.

The Prompt '>'
The control port uses a prompt that makes the terminal screen easier to read (similar to a dos command line). If the last command was understood and executed properly, the prompt is a greater than '>' symbol. If the last command returned an error, the command prompt will show an 'E', the error code, then the prompt (ex. E06>).

If the last command was a query the prompt will show the response followed by a greater than symbol (ex. 1,2,3>)

Command Format:

Commands are entered using a simple command format.

• Command Character.
• Up to 6 numeric arguments separated by commas.
• Carriage Return <CR> OR Command Delimiter <#> OR Query Operator "?"

(ex. "X1,2,3<CR>" sets output 1 to input 2 on level 3)

If there are less than 2 arguments, the command does not require a comma. For example "X1<CR>" and "C<CR>" are valid. If a comma is entered after the command character but before any arguments, it will be discarded.

The Query Operator '?'
Adding a question mark to the end of a command will act like entering <CR> except it will process the command as a query and print the data requested before returning a prompt. For example "X1?" returns the status of output 1 on all levels, while "X1,2?" returns the status of output 1 on level 2.

Escape Key [ESC]
The escape key will clear the command buffer and any stacked commands and return to the prompt.

Other Characters
All characters that are not a valid command char, argument value, argument delimiter, command delimiter, query operator, or any other character not specifically listed in this documents will be ignored by the command processor.

 

 

LEGAL ARGUMENT VALUES:

ERROR CODES:

GENERAL COMMAND DESCRIPTIONS:

DETAILED COMMAND DESCRIPTIONS:

X Command (Crosspoint command)
Purpose: The X command is used to make changes to and retrieve status from router crosspoints on routers with more than 1 output. Setting router crosspoints with the X command is simple and direct. Use as many of the optional parameters that are need to achieve the desired result.

X[out]<CR>
A X command with one argument will always act as a query and is identical to X[out]?. This command will return the status of [out] on all levels.
EX: "X1<CR>" may return a response of "1,1,2,2>" (4 level router) indicating that output 1 is set to input 1 on levels 1 & 2, and input 2 on levels 3 & 4.

X[out],[in]<CR>
A X command that has two arguments will switch [out] to [in] on all levels.
EX: "X1,2<CR>" sets output 1 to input 2 on all levels.

X[out],[in],[lev]<CR>
A X command that has three arguments will switch [out] to [in] on [lev].
EX: "X1,2,3<CR>" will switch output 1 to input 2 on level 3.

X[out],[in],[lev-a],[lev-b]<CR>
A X command that has four arguments will switch [out] to [in] on [lev-a] and on [lev-b].
EX: "X1,2,3,4<CR>" will switch output 1 to input 2 on level 3 and level 4.

Up to 4 levels can be listed in an X command for a total of 6 arguments.
EX: "X1,6,1,2,3,4<CR>" will switch output 1 to input 6 on levels 1,2,3 and 4. This command is identical to "X1,6<CR>".

X Command Stacking
X commands can be stacked, enabling multiple crosspoints to be changed simultaneously. Entering a command delimeter <#> at the end of a command, rather than <CR> will cause that command to be stacked until the next <CR> is received.

EX: "X1,1#X2,2#X3,3<CR>" will switch output 1 to input 1, output 2 to input 2, and output 3 to input 3 when the <CR> is entered.

X Queries
X queries are similar to X commands but they are terminated with the Query operator "?" and have a maximum of 2 arguments.

X[out]?
Returns the status of [out] on all levels separated by commas and ending with a prompt. The format is [lev-a],[lev-b],[lev-c],[lev-d]>.
EX: "X1?" may return a 2,2,2,2> indicating that output 1 is set to input 2 on all 4 levels.

X[out][lev]?
Returns the status of [out] on [lev] ending with a prompt.
EX: "X1,2?" may return a 3> indicating that output 1 is set to input 3 on level 1.

Y Command (Single output Crosspoint Command)
Purpose: The Y command is used to make changes to and retrieve status from crosspoints on a single output router. Separating this command from the X command will prevent users from having to enter the [out] argument which will always be '1' on single output routers. The 'Y' command will work on all routers but will only act on output 1.

Setting router crosspoints with the Y command is simple and direct.

Y<CR>
A Y command without an argument will always act as a query. This command will return the status of output 1 on all levels.
EX: "Y<CR>" may return a response of "1,1,2,2>" (4 level router) indicating that output 1 is set to input 1 on levels 1 & 2, and input 2 on levels 3 & 4.

Y[in]<CR>
A Y command that has one arguments will switch output 1 to [in] on all levels.
EX: "Y2<CR>" sets output 1 to input 2 on all levels.

Y[in],[lev]<CR>
A Y command that has one argument will switch output 1 to [in] on [lev].
EX: "Y1,2<CR>" sets output 1 to input 1 on level 2.

Y Queries
Y queries are similar to Y commands but they are terminated with the Query operator "?" and have a maximum of 1 argument.

Y?
A Y query with no argument returns the status of output 1 on all levels.
EX: "Y?" may return a 2,2,2,2> indicating that output 1 is set to input 2 on all 4 levels.

Y[lev]?
A Y query with one argument returns the status of output 1 on [lev].
EX: "Y1?" may return a 2> indicating that output 1 is set to input 2 on level 2.

P Command (Print command)
Purpose: The P command enables or disables printing of updates to the serial port. Printing is for diagnostic purposes only.

P[ena]<CR>
The P command will set the diagnostic printing mode to [ena].
EX: "P1<CR>" sets diagnostic printing to ENABLED.

When printing is enabled, any router crosspoint updated from the control panel network will cause the new status of the crosspoint(s) to be printed to the serial port The format of this printing is as follows.

O[out],[in],[lev],[lev],[lev],[lev]<CR>
EX: "O1,2,2,2,2<CR>" is printed to the serial port when a control panel changes the status of output 1 and the new status of output 1 is input 2 on all levels.

The printing feature, when enabled will effect the responsiveness of the router frame to external stimulus from the control panel network and from the control port. The degree of this penalty will vary depending on the size of the router and traffic on the various frame CPU interfaces. For this reason, printing will always be initialized to DISABLED on start-up and the value will not be stored in NV storage.

 

C Command (System Configuration command)
Purpose: The C command is used to make changes to and retrieve configuration information from the routing switcher.

This command is intended for use by the factory only and requires a password to change any of the configuration parameters. This will prevent accidental changes to the router's configuration by users. The routers configuration can be displayed without a password.

C<CR>
A C command without an argument will always act as a query. This command will display the router configuration screen on the terminal, followed by a prompt.
EX: "C<CR>".

C[cfg],[out-ct],[in-ct],[lev-ct],[flags-1],[flags-2]<CR>
EX: "C156,16,16,1,0,0<CR>" configures the router for 16 inputs, 16 outputs, 1 level and sets configuration flags 1 & 2 to zero.

A C command must include all 6 arguments, and the correct password, or it will be treated as a query. After each change using the 'C' command the routers new configuration will be printed to the serial port. The new configuration will also be saved to NV storage.

Configuration Screen:
### CONFIGURATION ###
OUTPUTS: 16
INPUTS: 16
LEVELS: 1
FLAGS-1: 0
FLAGS-2: 0

S Command (Status command)
Purpose: The S command is used to print the router status to the serial port for diagnostic purposes. This report is printed in tabulated format and shows the status of each crosspoint and lock. This command does not require a <CR> to complete the command. As soon as the 'S' is entered the report will be printed.

This command is intended for use by the factory only. The processor will not be able to process stimulus from other interfaces from the time this report begins printing to the time this port finishes this report.

S
Just type 'S'

---

Home | About ISIS | Contact Us | Buy - US | Buy - International | Catalog | Request Info | News and Events