Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added connection_override

Anchor
TOC
TOC
Include Page
KBCOMMON:KB-CSSstyle
KBCOMMON:KB-CSSstyle

...

(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

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


...

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"

Note

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 "set XXX alias=YYY" syntax. Lines using the legacy syntax are not supported.


Mapping Serial line controllers to system resources

...