Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Layout reviewed for PDF export bugs

...

Console Parameters

CHARON-AXP console line TTA0 (COM2) has the following parameters:

ParameterTypeValue

(info) All the values in the following tables are case insensitive

communication

Parametercommunication
Type

Text string

Value
  • "ascii" - for connection to terminals  (default)

  • "binary" - for binary (packet) protocols, which are used mainly for communicating with PLCs

line

Parameterline
TypeIdentifier
Value

This parameter is used to connect a particular serial line mapping interface to the controller.

Example:

set COM2 line=TTA0

All the values in this table are case insensitive.

...

Example

 

set COM2 communication="binary"

 

...

TypeFunction
physical_serial_line

This type of mapping associates a COM port on a host system with an emulated HP Alpha serial line controller virtual "line".

The COM port can be a physical hardware port or a logical COM port.

virtual_serial_lineThis type of mapping associates a network connection on the host system with an emulated HP Alpha serial line controller virtual "line"

Example:

load physical_serial_line TTA0

...

Back to Table of Contents

physical_serial_line

...

line

line
Parameterline
Type
Description
Text string
Value

A defined COM port on a host system in the form of "\\.\COMn" (or "COM<n>:")

Example:

set OPA0 line="\\.\COM1"

baud

Parameterbaud
TypeNumeric
Value

Forces the baud rate of the corresponding COM port to be a specified value.

The variety of supported values depends on the underlying physical communication resource (COM port). The most widely used values are: 300, 1200, 9600, 19200, 38400.

Example:

set OPA0 baud=38400

break_on

Parameterbreak_on
TypeText string
Value

Specifies what byte sequences received over the physical serial line will trigger a HALT command.

This parameter works only for the console line.

Specify the following values: "Crtl-P", "Break" or "none" ("none" disables triggering a HALT condition).

Example:

set OPA0 break_on="Crtl-P"

The default value is "Break".

(warning) This parameter can be specified only for COM1 (OPA0) console

stop_on

Parameterstop_on
TypeText string
Value

Specifies what byte sequences received over the physical serial line will trigger a STOP condition. The STOP condition causes CHARON-AXP to exit.

Specify the one of the following values: “F6” or “none” ("none" disables triggering a STOP condition).

Example:

set OPA0 stop_on="F6"

The default value is "none".

Setting "F6" triggers the STOP condition upon receipt of the "<ESC>[17~" sequence. Terminals usually send these sequences by pressing the F6 button

(warning) This parameter can be specified only for COM1 (OPA0) console

log

Parameterlog
TypeText string
Value

A string specifying a file name to store the content of the console sessions or a directory where the log files for each individual session will be stored.

If an existing directory is specified, CHARON-AXP automatically enables creation of individual log files, one for each session using the same scheme as used for the generation of the rotating log files. If the "log" parameter is omitted, CHARON-AXP does not create a console log.

Examples:

set OPA0 log=”log"log.txt”txt"

.

set OPA0 log=
"C:\Charon\Logs
"
Note

Only existing directory can be used as a value of the "log" parameter.

Example of mapping a console line to a host physical serial line

...

load physical_serial_line OPA0
set OPA0 line="\\.\COM1"

Back to Table of Contents

virtual_serial_line

host

Parameterhost
Type
Description
hostText string
Value

A remote host’s IP address or hostname (and optionally a remote TCP/IP port number) for the virtual serial line connection. If omitted, the virtual serial line does not initiate a connection to the remote host and will listen for incoming connection requests.

Specify the value in the following form:

set OPA0 host="<host-name>[:<port-no>]"

If the "<port-no>" is not specified, the virtual serial line uses the TCP/IP port number specified by the "port" parameter (see below).

port

Parameterport
TypeNumeric
Value

The TCP/IP port number for the virtual serial line. A virtual serial line always listens on this port for incoming connection requests.

If multiple virtualized machines are running on a server, ensure the port number is unique across the platform.

application

Parameterapplication
TypeText string
Value

An application (a terminal emulator is assumed in most cases) to be started on initialization of this serial line emulation. The specified application startup string may contain all required parameters.

Example:

set OPA application = "putty.exe -load OPA0"

In this example the terminal emulator application: "putty" is started with the parameters "-load OPA0" telling it to load a specific saved session named "OPA0", (created separately) from the host registry.

The "application" parameter is often combined with a "port" parameter:

set TTA0 port = 10003 application = "putty.exe -load TTA1"

break_on

Parameterbreak_on
TypeText string
Value

Specifies what byte sequences received over a virtual serial line triggers a HALT command.

Specify one of the following values: "Crtl-P", "Break" or "none" to disable triggering a HALT condition. The commands are case insensitive.

Example:

set OPA0 break_on="Crtl-P"

The default value is "Break".

(warning) This parameter can be specified only for COM1 (OPA0) console

stop_on

Parameterstop_on
TypeText string
Value

Specifies what byte sequences received over the virtual serial line will trigger a STOP condition. The STOP condition causes CHARON-AXP to exit.

Specify one of the following values: “F6” or “none” ("none" disables triggering a STOP condition). The commands are case insensitive.

Example:

set OPA0 stop_on="F6"

The default value is "none".

Setting "F6" triggers the STOP condition upon receipt of the "<ESC>[17~" sequence.

(warning) This parameter can be specified only for COM1 (OPA0) console

log

Parameterlog
TypeText string
Value

A string specifying the filename to store the content of the console sessions or a directory where log files for each individual session will be stored.

If an existing directory is specified, CHARON-AXP automatically enables the creation of individual log files, one for each session using the same scheme as used for the generation of the rotating log files. If the "log" parameter is omitted, CHARON-AXP does not create any console log.

Examples:

set OPA0 log=”log"log.txt”txt"
set OPA0 log=
”C
"C:\Charon\Logs
"
Note

Only existing directory can be used as a value of the "log" parameter.

Example

...

1

Mapping a console line to a host TCP/IP port 10003 and starting a "Putty" terminal emulator with a configuration "OPA" directing it to connect to the port 10003:

load virtual_serial_line OPA0
set OPA port = 10003 application = "putty.exe -load OPA0"

Notes on "virtual_serial_line" options

...

 

Note: the examples above are mainly used for inter-CHARON communications. They are used to connect CHARON-AXP to an application that communicates to CHARON-AXP as described below.

Example

...

2

Two CHARON systems connected to each other:

...