Callisto Terminal Commands

The PC Server software is intended to plug into a global data base and
communicate with an ASCII terminal client or PC Client via a serial port.
The client can request periodic data from the data base, issue control
commands, and request special information.

Conventions

A few symbols are reserved below to simplify the description

• Items enclosed in pointy brackets < > are mandatory.

• Items enclosed in square brackets [ ] are optional.
• The | character means select one or the other items it separates.
• The @ character symbolizes Carriage Return, 0xD.
• The ^ character symbolizes Line Feed, 0xA.
• Characters between single quotes ' are literal.

Commands from the Terminal

Commands from the terminal or PC client have the following format

<Command> [optional parameters] @

Commands consist of a keyword and parameters which tell the PC Server

what to do.

All commands and options are case-insensitive. Blanks before the command
are ignored. Keywords must begin with a letter or digit.

Optional parameters begin with the character '-'. The optional

parameters are command dependent.

Commands from the terminal or PC client are echoed back except that Carriage
Return characters are expanded to the two characters Carriage Return and
Line Feed.

Responses from the Terminal or PC client

Responses from the PC Server to the Terminal or PC Client have the

format

<Response data> @^ '>'

Special Function Keys

Escape

Presently executing commands can be aborted with the Escape character,

0x1B.

When the PC Server sees the escape character, it does not echo it
back. First it terminates all response transmissions in progress and
then sends

@^ '>'

Command repeat

The PC Server will repeat its last command when it sees a

control-R character, 0x12, as the first character after a prompt
is issued. The last command will be echoed to the PC client
and then that command will be executed.

A control-R character embedded in a command sequence is ignored.

SHELLS

The IOE2 and EDGE firmware require the use of terminal shells to utilize all available
terminal commands. IOE1 and IOGs do not require the use of terminal shells. Shells break
up the available terminal commands into groups of commands that perform similar
functions. For example the Core98 shell contains commands for interacting the RTU’s
global database.

To retrieve a list of available shells:

COMMAND: SHELL

To enter a shell:
IOE2
COMMAND: <name of shell>

EDGE
COMMAND: SHELL <name of shell>

To exit a shell:
COMMAND: EXIT
COMMANDS AND RESPONSES

Listed below are the set of commands a PC client can issue to the PC Server.

COMMAND: <data type> <point number> [optional parameters]

Requires ‘Core98’ shell

This command tells the PC Server to send data of the type specified for the point number.

Valid data type keywords are

ACCUM accumulations
ANALOG analog and analog upset values
BINARY binary values
STATUS status and status upset values

The optional parameters are

-NNNN indicates send multiple point data beginning with <point number>
and ending with the point numbered NNNN. Responses are limited
to 20 lines no matter how many points are specified.

-S indicates continue to scan one report after the next without

stopping until Escape is received.

The response is formatted

<point number> ':' ' ' <value> @^

Note: If the reading from an analog or status point is upset,

the space following the colon is replaced by an asterisk, '*'.
If the values are invalid because they have not been updated
recently, the space following the colon is replace by a
question mark, '?'.

COMMAND: SOE [optional parameters]

Requires ‘Core98’ shell

This command tells the PC Server to send an SOE value.

If there is an SOE, the response is formatted

<point number> ':' ' ' <value> ' ' ' ' '@' <year> ':' <halfday>
':' <hd_sec> ':' <ms> @^

where value is '1' or '0' representing the state

 otherwise if there is no SOE, the response is formatted
"Nothing to report" @^

The optional parameters are

-S indicates continue to scan one report after the next without

stopping until Escape is received.

COMMAND: TRIP <point number> <duration>

COMMAND: CLOSE <point number> <duration>

Requires ‘Core98’ shell

This command tells the PC Server to automatically issue a select-

before-operate trip or close command sequence to the specified point
for the specified number of 10-millisecond periods.

COMMAND: SETPOINT <point number> <decimal value>

Requires ‘Core98’ shell

This command tells the PC Server to automatically issue a select-

before-operate setpoint command sequence to the specified point
with the specified value.

COMMAND: BINOUT <point number> <signed 'S' | unsigned 'U'> <0x style hex value>

Requires ‘Core98’ shell

This command tells the PC Server to automatically issue a select-

before-operate setpoint command sequence to the specified point
with the specified value.

COMMAND: PORTS [c | <m | s | t> <1 | 2> [bit]]

This command asks the PC Server to list the parameters configured

for each port in use by a process. Unconfigured ports are not
displayed.

A typical display response looks like this

#...BR..DPS.B/B.A/S..CTS.RTS.DCD..ICTO..RXTO..OWNER... @^
1 9600 8N1 Byt Asy 25 2 0 5 20 DNPCLnkl @^

where
BR is baud rate
DPS is number of data bits, parity, number of stop bits
B/B is bit or byte oriented
A/S is asynchronous or synchronous
CTS is clear-to-send delay which can be no of milliseconds or hardware
RTS is request-to-send hold delay after last bit leaves
 DCD is delay following receipt of data carrier detect hardware signal
ICTO is inter-character timeout
RXTO is receive-to-transmit minimum delay time
OWNER is name of process using comm port

The optional arguments may be used to force an on-board modem to specific

keyed states. The module must be in default mode to use this feature.
The choices of keying are

m = MARK, s = SPACE and t = toggle (alternate) between MARK and SPACE,

1 or 2 specify which modem, and
the optional "BIT" must be specified for bit-oriented protocols.

c = CLEAR (stop) the forced keying.

COMMAND: READ <0x style hex start address> [0x style hex number bytes]

This command tells the PC Server to retrieve data from the specified
flash memory area for the user to view. The "Number of bytes" parameter
is optional and the default value is 128 bytes.

COMMAND: REASON

This command tells the PC Server to display the reason for the most
recent start up or re-boot operation.

Code Reason
-------- --------------------------------------------------
0 unknown or power up
1 one or more tasks failed to register
2 C++ new operator failed
3 voyager VOYOP_RESTART_NODE from my node
4 voyager VOYOP_RESTART_NODE from another node
5 0x80 control reboot command from my node
6 0x80 control reboot command from another node
7 writing to flash from my node
8 writing to flash from another node
9 unable to find config file in flash
10 registration and task config do not match
11 not enough queues requested
12 illegal registration
13 re-boot initiated by operator from Terminal
14 re-boot requested from master station
15 process detected something it did not like
16 process's private reason #0
17 process's private reason #1
18 process's private reason #2
19 process's private reason #3
20 process's private reason #4
21 process's private reason #5
22 process's private reason #6
23 process's private reason #7
24 process's private reason #8
 25 process's private reason #9
26 process's private reason #10
27 process's private reason #11
28 process's private reason #12
29 process's private reason #13
30 process's private reason #14
31 process's private reason #15
128-223 watchdog timed out a task - subtract 128 to get task number
225 Nucleus - not enough memory to init
226 Nucleus - no tasks defined
227 Nucleus - invalid partition size
228 Nucleus - invalid queue item size
229 Nucleus - memory slicked by someone
230 Nucleus - begining of the task's stack was overwritten
231 Nucleus - error detected in TASK_CONFIG_BLOCK

COMMAND: REBOOT [optional parameters]

This command tells the PC Server to re-boot the rtu into the specififed
software operating mode. If the software operating mode is not specified
the the rtu will be rebooted into the current software operating mode.

The optional parameters are

-D indicates reboot into SOP_MODE_DEFAULT

-P indicates reboot into SOP_MODE_DOWNLOAD_PARTIAL
-F indicates reboot into SOP_MODE_FULLY_FUNCTIONAL

COMMAND: SEEP <-R | -W> <0x_address> <0x_hex_write_value>

This command is used to read or write to a single address in Serial

EEPROM memory.

To read a value enter a -R for the first parameter and an address

for the second parameter. Do not type a third parameter.

To write a value enter a -W for the first parameter and an address

for the second parameter. Enter the value to be stored in the
third parameter.

COMMAND: FLASH <ERASE 0x_address>

This command is used to erase the entire flash chip.

The address must be the base address of the flash chip.

The the software operating mode must be in default mode otherwise

the command is ignored by the core.

COMMAND: MODE [node_num]

COMMAND: SOP [node_num]

These commands tell the PC Server to retrieve and display the current
software operating mode.

They also tell the PC Server to list all of the tasks and show whether
they are running or stopped, and if they are stopped what caused the
stop.

The optional node_num will returns similar, but not the same information
from the specified node.

COMMAND: STRAPS

This command displays the setting of the hardware jumper straps (links).
The response on an IOE/IOB module looks like one of this

Node 004 RTU 017 Grp 001 @^

The response on a Polaris module looks like one of the following

depending upon the setting of RTU/Node strap setting.

Node 001 Grp 005 @^

RTU 001 Grp 005 @^

COMMAND: TIME [yyyy:mm:dd:hh:mm:ss]

This command tells the PC Server to get or set the time.

Typing "TIME" without any arguments causes the PC Server to report

the current time.

Typing "TIME" followed by "yyyy:mm:dd:hh:mm:ss" causes the PC Server

to set the current time.

COMMAND: HELP

This command displays a brief listing of the commands.

COMMAND: LEVEL [n [password]]

Not available for IOE2 and EDGE

This command displays the current security level or sets it.

There are three levels 0, 1 and 2. At level 0, the user cannot issue
controls or setpoints and cannot read or set passwords. At level 1,
the user can do everything that can be done at level 0 plus he can issue
controls and setpoints. At level 2, the user can do everything that
can be done at level 1 plus he can view or change the passwords.

To view the current security level, enter LEVEL.

To enter the next higher security level, the command must include the
level number and password arguments. To drop to a lower security level,
the command only needs to include the security number argument.
COMMAND: PASSWORD

Not available for IOE2 and EDGE

Passwords can only be viewed and changed at level 2.

Passwords consist of 8 or less letters and digits.

The default password to enter level 1 is "THUNDER".

The default password to enter level 2 is "STORM".

COMMAND: IPCONFIG

Available only for IOE2 and EDGE

Displays current Ethernet setting including IP address.