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:

communication

Parametercommunication
Type
Value

communication

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.

...

TypeFunction
physical_serial_line

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

The TTY port can be physical hardware port or a logical TTY 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"
operator_consoleThis type of mapping associates the current TTY console with the OPA0 console port (if CHARON-AXP does not run as service)

Example:

load physical_serial_line TTA0

Back to Table of Contents

physical_serial_line

line

Description
Parameterline
Type
lineText string
Value

A defined TTY port on host system:

SyntaxDescription
"/dev/tty<N>"Virtual serial lines
"/dev/ttyS<N>"Onboard serial lines
"/dev/ttyUSB<N>"Modem or USB serial lines adapters
"/dev/tty<XXX>"Proprietary (depending on a driver) devices such as DIGI or MOXA cards
Note

A specific account for running CHARON ("charon") does not allow usage of physical consoles "/dev/tty<N>" as CHARON consoles. If you plan to map CHARON console to "/dev/tty<N>" use only "root" account for CHARON running.

baud

Parameterbaud
TypeNumeric
Value

Forces the baud rate of the corresponding TTY port to a specified value.The variety of supported values depends on the underlying physical communication resource (TTY 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 either “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=
"/Charon/Logs
"
Note

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

Example

...

Mapping a console line to a host physical serial line:

...

Back to Table of Contents

virtual_serial_line

host

Description
Parameterhost
Type
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.

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 either “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=
"/Charon/Logs
"
Note

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

Example

...

Mapping a console line to a host TCP/IP port 10003:

load virtual_serial_line OPA0 port=10003

Notes on "virtual_serial_line" options

...

 

...

Back to Table of Contents

operator_console

break_on, stop_on

Parameter
TypeDescription
break_on, stop_on
TypeText string
Value

These two parameters are hardcoded to the following values and cannot be changed:

stop_on="F6"
break_on="Ctrl-P,F5"

Example

...

load operator_console OPA0

...

 

...

 

"ttyY" notation specifics

Note that the "ttyY" notation can have different forms depending on the nature of the device used:

...