Product Documentation and Knowledge Base - HomeDocumentation


Charon-AXP


Console

Owned by Copy Page Tree
Last updated: Jul 30, 2019 by Kirill Nikolaev (Unlicensed)

Table of Contents

<Go to top>

General Description

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

Example for OPA0 console ("COM1" port):

set COM1 alias=OPA0

When using the TTA0 console ("COM2" port):

set COM2 alias=TTA0

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

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.

Usually it is "OPA0" for COM1 and "TTA0" for COM2

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).

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".

(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 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 VM 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 VM does not create a console log.

Examples:

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

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

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 the log is automatically rotated.

  • "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

Examples:

set OPA0 log_file_size="default"

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.

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.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"

<Go to top>

Mapping Serial line controllers to system resources

line

Parameterline
TypeText string
Value

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

Example:

set OPA0 line="\\.\COM1"


<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.