Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example for OPA0 console ("COM1" port):

set COM1 alias=OPA0

(info) Starting with Charon-AXP V4.11 build 204-13, 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 695402606 Mapping Serial line controllers to system resources for details of mapping.

Include Page
KBCOMMON:DOC-GoToToc
KBCOMMON:DOC-GoToToc

...

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.

Note
titleThis 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


Div
classpagebreak



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

...

Parameterapplication
TypeText string
Value

A command line for calling some host application for communication to Charon on a given COM line.

Typically this parameter is used for mapping COM1 or COM2 or some "xterm" terminal emulator

Example:

set OPA0 application = "xterm -title OPA0 -e telnet 127.0.0.1 10003"

If "putty" terrminl emulator is going to be used as an option copy the following file to your home directory:

# mkdir -p $HOME/.config/putty/sessions (if it does not already exist)
cp /opt/charon/putty/sessions/CHTERM-VT100 $HOME/.config/putty/sessions

Example:

set OPA0 application = "putty -load CHTERM-VT100 -title OPA0@XYZ -P 10003"

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

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


Div
classpagebreak


Notes on "port" and "application" parameters

...


set COM1 alias=OPA0 port=10003 application="xterm -title OPA0 -e chterm -h 127.0.0.1:10003"


In this example CHARON-AXP OPA0 console connects to port 10003 of localhost ("127.0.0.1") and at the same time it starts "xterm" with parameters "-title OPA0 -e chterm -h 127.0.0.1:10003", instructs it to connect to the port 10003 of the host with TCP/IP address "127.0.0.1" (localhost)

Include Page
KBCOMMON:DOC-GoToToc
KBCOMMON:DOC-GoToToc

...

...

Mapping Serial line controllers to system resources

...

MappingTypeCommentary

"/dev/tty<N>"

where N is from 0 to 11

Linux virtual tty

Those tty devices must be free from the Linux "getty/mgetty" and similar programs (specified in "/etc/inittab")

Example:

"/dev/tty1"

"/dev/ttyS<N>"

where N is a number

Onboard serial lines

Example:

"/dev/ttyS1"

"/dev/tty<XXX>"

where XXX is a complex letter/number notation

Proprietary (depending on a driver) devices 

Example for a first port of a MOXA card:

"/dev/ttyR01"

Example for a first port of a DIGI card:

"/dev/ttyaa"

"/dev/ttyUSB<N>"

where N is a number

Modem or USB serial lines adapters

Example:

"/dev/ttyUSB1"

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 /charon/myaxp/logs folder:

load virtual_serial_line OPA0

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log="/charon/myaxp/logs"

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 /charon/myaxp/logs folder and enables the connection_override feature:

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

set OPA0 port=10003

set OPA0 stop_on="F6"

set OPA0 log="/charon/myaxp/logs"

set OPA0 connection_override=enable

Include Page
KBCOMMON:DOC-GoToToc
KBCOMMON:DOC-GoToToc