Console

Owned by Copy Page Tree
Last updated: Feb 09, 2024 by W.ErberVersion comment
5 min read

Table of Contents

General Description

CHARON-AXP offers two-port serial console on all supported AXP models.

Example for OPA0 console ("COM1" port):

set COM1 alias=OPA0

(info) Starting with Charon-AXP V4.12 build 204-14, the line above is optional. OPA0 is mapped by default to COM1.

Example when using the TTA0 console ("COM2" port):

set COM2 alias=TTA0

Refer to Console#Mapping Serial line controllers to system resources for details of mapping.

The CHARON emulated console supports only 80 symbols in one line.

<Go to top>


General parameters

CHARON-AXP console lines COM1 and COM2 have the following parameters:

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

alias

Parameteralias
TypeIdentifier
Value

This parameter is used to set an useful name for COM1 or COM2 ports.  It can be any name, for example "Console1", but usually it is "OPA0" for COM1 and "TTA0" for COM2.

This name is logged in CHARON log file, it can also be used for parametrization in CHARON configuration file along with "COM1" and "COM2" identifiers.

The main purpose of this parameter is migration from old CHARON systems (which do not have the described implementation of consoles) to the current design, since it allows retaining the original name used for parametrization, since the rest of the parameters stay the same in both implementations. 

This note applies to builds before 204-13

If the "alias" parameter is not specified CHARON log file will miss the name for the given console, for example " : Connected. Remote 127.0.0.1:63516" will be displayed instead of "OPA0 : Connected. Remote 127.0.0.1:63516". So it is always recommended to specify the "alias" parameter.

Example:

set COM2 alias=TTA0


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

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: "Ctrl-P", "Break" or "none" ("none" disables triggering a HALT condition).

Please note:

If your guest operating system is OpenVMS in addition to "none" setting you have to set a specific console parameter "controlp" to "off" in the following way:

>>> set controlp off
>>> power off

The second line is to preserve the ROM settings.

Example:

set OPA0 break_on="Ctrl-P"

The default value is "Break".


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 Virtual Machine (VM) 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.

Example 1:

set OPA0 log="log.txt"

Example 2:

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

For rotating logs:

  • Specify only an existing directory
  • If you want to store the OPA0 log file in the Charon virtual machine home directory (default for virtual machine log file), use: set OPA0 log=".\."

log_file_size

Parameterlog_file_size
TypeText string
Value

If log rotation is enabled, the log_file_size parameter determines the log file size threshold at which a new log is automatically created.

  • "unlimited" or "0" (default) - the feature is disabled
  • "default" - default size is used (4Mb)
  • <size>[KMG] - size of the current log file in bytes with additional multipliers:

    • K - Kilobyte - multiply by 1024

    • M - Megabyte - multiply by 1024*1024

    • G - Gigabyte - multiply by 1024*1024*1024

Example 1:

set OPA0 log_file_size="default"

Example 2:

set OPA0 log_file_size=10M

(warning) Minimum log file size is 64K, maximum is 1G. Setting size less then 64K effectively makes the log file unlimited.

log_flush_period

Parameterlog_flush_period
TypeNumeric
Value
  • <period-in-seconds>

Defines a period of flushing log to disk.

Default period is 60 seconds (it means that every minute log file is flushed to disk)

Example:

set OPA0 log_flush_period=30

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 OPA0 application = "putty -load CHTERM-VT100 -title OPA0@XYZ -P 10003"

In this example the terminal emulator application "putty" is started with the parameters:

  • "-load CHTERM-VT100" telling it to load a specific saved session named "CHTERM-VT100" (created separately), from the host registry
  • "-title" specifies the name of the given instance of putty terminal emulator
  • "-P" stands for communication port used

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

set TTA0 port = 10004 application = "putty -load CHTERM-VT100 -title TTA0@XYZ -P 10004"

The CHTERM-VT100 settings in form of ".reg" file can be found under Charon installation location in the subfolder "Build_xxxx\x64"

connection_override

Parameter

connection_override

Typetext string
Value
"enable"
Allows new connection to override existing connection, if any. Enabled connection override on OPA0 allows to intercept virtual serial console.
When emulator detects new connection request on the port (10003 for the below example), it closes old connection, if any, and switches to the new one.
Example:
set COM1 alias = OPA0
set OPA0 port = 10003 connection_override = enable
(warning) This is implemented only for serial lines using the new syntax, not for lines using the legacy syntax (load virtual_serial_line ...).

access_control

(info) Available only since build 204-14

Parameteraccess_control
Typetext string
Value

"disable"

Since build 204-13, Incoming connection requests are by default filtered for virtual serial lines and then allowed only for the localhost. This is to avoid security scanners that can block the port.

Example:

set OPA0 access_control = disable

(warning) This is implemented only for serial lines using the new syntax, not for lines using the legacy syntax (load virtual_serial_line ...).


Mapping Serial line controllers to system resources

line

Parameter

line

TypeText string
Value

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

Example:

set OPA0 line="\\.\COM1"

OPA0 console configuration examples

Using legacy syntax (not recommended)

This example maps OPA0 to port 10003, enable F6 key (emulator stop) and logs the console input/output to a rotating log file in its home directory:

load virtual_serial_line OPA0

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log=".\."

Using new syntax (recommended)

This example maps OPA0 to port 10003, enable F6 key (emulator stop), logs the console input/output to a rotating log file in its home directory and enables the connection_override feature:

set COM1 alias=OPA0 (optional starting with build 204-14)

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log=".\."

set OPA0 connection_override=enable

<Go to top>


© Stromasys, 1999-2024  - All the information is provided on the best effort basis, and might be changed anytime without notice. Information provided does not mean Stromasys commitment to any features described.