Online help (Pseudo Terminal)

Installation

The archive file is compressed in zip format.

Please make a suitable folder, and place all files in the folder you created with the same folder structure.

File organization

PseudoTerm.exe

"Pseudo Terminal" Application file.

PseudoTerm.exe.config

Setting file.

ja-JP/PseudoTerm.resources.dll

Japanese resource file.



Uninstallation

Please delete each folder where the application exists.




Menu description


File

Load Scenario List

Load the scenario list file.

Close Scenario List

Close the scenario list file.

Create Scenario

Create a new scenario file.

Edit Scenario

Edit an existing scenario file.

Create Scenario List

Create a new scenario list file.

Edit Scenario List

Edit an existing scenario list file.

Setting

Make application settings for the application.

Exit

Exit the application.



Help

Help Topics

Open the online help page.

Choose Language

Select the display language of the application as "English" or "Japanese".
The display language will be switched after the next application is started.

About Pseudo Terminal

Displays application version information.


To Keep Using ...

Enter the license key.
This item cannot be selected if the license key registration has already been completed.




Main Dialog




(1) Device

Select the communication port for data communication.
The communication ports that can be selected are the serial port currently available on the computer and the network port registered in the network settings.

(2) "Connect" button

Open the communication device.

(3) "Disconnect" button

Close the communication device.

(4) Encoding

Displays the character code of communication data.

(5) List of Always Scenarios

Displays a list of always scenarios registered in the loaded scenario file.

(6) "Run" button

Starts running the always scenario.

(7) "Stop" button

Stops the execution of the always scenario.

(8) List of Manual Scenarios

Manual scenario list in the scenario list file Displays the title of the scenario list as a selection list.

(9) "Send" button

Executes the scenario selected in the manual scenario list.

(10) "Cancel" button

Suspend the running manual scenario.

(11) Log message list

Display log messages.

(12) "Clear" button

Clears the log message list.

(13) "Copy" button

Copy the contents of the log message list to the clipboard.



Register and edit scenario list


Create a list of scenario files to use for always and manual scenarios on the main screen.




(1) Scenario Filename

Enter the file name of the scenario list file to be created.

(2) "..." button

Select a scenario list file name from an existing file.

(3) Encoding

Select the character code of the communication data.
Selectable character codes are registered in the setting dialog.

(4) Start Code

Specify when a start code for send or receive data such as STX (0x02) is required.
Specify in the range of 0 to 255.
Specify -1 if you do not want to use the start code.
You can specify up to two start codes.
* This is to determine the start position of the received data.

(5) End Code

Specify this when you need an exit code for send or receive data such as ETX (0x03) or line feed code (0x0D, 0x0A).
Specify in the range of 0 to 255.
Specify -1 if you do not want to use an exit code.
You can specify up to two exit codes.
* This is to determine the end position of the received data.

(6) Check Code

Specifies the number of bytes in the checkcode when error checking codes such as checksums and CRC codes are added after the exit code.
* Information is required to determine the number of bytes of data sent and received, and the check code itself is not evaluated.



Always Scenario

A always scenario runs multiple scenarios at the same time.
The execution order for simultaneous execution is from the beginning of the scenario file list.
In addition, the comparison with the received data is also performed sequentially from the beginning of the scenario file list, and the comparison is terminated when a matching scenario is detected.

(7) Always scenario file list

Title

The title of the scenario set in the scenario file is displayed.

Filename

Displays the file name of the scenario file with the full path.

(8) "Add" button

Add an existing scenario file to the scenario file list.

(9) "Up" button

Moves the selected scenario file in the scenario file list up one line in the list.
(Raise the execution priority of the scenario.)

(10) "Down" button

Moves the selected scenario file in the scenario file list down one line in the list.
(Decrease the execution priority of the scenario.)

(11) "Delete" button

Deletes the selected scenario file in the scenario file list from the list.



Manual Scenario

The manual scenario is executed by selecting one scenario from multiple scenarios.
The comparison with the received data is performed before the resident scenario, and if they match, the comparison with the resident scenario is not performed.



(7) Manual scenario file list

Title

The title of the scenario set in the scenario file is displayed.

Filename

Displays the file name of the scenario file with the full path.

(8) "Add" button

Add an existing scenario file to the scenario file list.

(9) "Delete" button

Deletes the selected scenario file in the scenario file list from the list.



Register and edit scenarios


Register a sequence of send and receive commands as a "scenario".
(In this application, actions such as data transmission and reception are called "actions", and a collection of actions is called a "scenario".)





(1) Filename

Enter the file name of the scenario file to be created.

(2) "..." button

Select a scenario file name from an existing file.

(3) Title

Sets the title of this scenario to be displayed in the scenario list.

(4) Action list

Action

Displays the action type of the scenario.

Time settings

Shows the waiting time.

Text

Displays the character string of the send / receive data used in the action.

(5) "Add" button

Add the contents of the action settings to the end of the action list.

(6) "Edit" button

Overwrites the contents of the action setting with the action selected in the action list.

(7) "Up" button

Moves the selected action in the action list up one line in the list.

(8) "Down" button

Moves the selected action in the action list down one line in the list.

(9) "Delete" button

Deletes the action selected in the action list.

Action settings

(10) Action

Displays the action type of the scenario.

(11) Timer

When the action type is "Receive", the time of the reception wait timeout is displayed in (seconds).
When the action type is "Wait", the waiting time is displayed in (seconds).

(12) Data type

Displays the data type of the parameter to be added to the action.

(13) Separator

Shows the delimiter between the command and the parameter.

(14) Separator

Shows the delimiter between parameters.

(15) Plain text

When the data type is "Plain text", the character strings to be sent and received are displayed.
When the action type is "Log output", the character string to be output to the log is displayed.

(16) Command / parameter list

If the data type is Command / Parameter, a list of commands and parameters is displayed.

Data Type

Displays the command and parameter data type.

Comparison

Displays how to compare commands and parameters with received data.

Length

Displays the command and parameter data length.

Data

Displays the command and parameter string.



Register and edit actions


Edit the action settings.




(1) Action

Select the action type of the scenario from the following items.

Send

Send data.
* Please include the start code, end code, and check code in the send data.

Receive

Wait for data reception from the connection destination.
* Please include the start code, end code, and check code in the receive data.

Wait

Waits for the set time.

Log output

Output a message to the log.

(2) Timer

When the action type is "Receive", specify the time for the reception wait timeout in (seconds).
If the action type is "Wait", specify the waiting time in (seconds).

(3) Data type

Select the data type of the parameter to be added to the action from the following items.

Plain text

The data to be sent and received will be a normal character string.

Command / Parameter

The data to be sent and received is in the format of "Command Parameter, Parameter, ...".

(4) Separator

Sets the delimiter between the command and the parameter.
To specify a space as the delimiter, enter a single-byte space or enter "sp" as a character string.
* Cannot be set when the data type is "Plain text".

(5) Separator

Sets the delimiter between parameters.
The input content is the same as "(12) Delimiter between command and parameter".

(6) Plain text

If the data type is "Plain Text", enter the character string to be sent or received.
If the action type is "Log Output", enter the character string to be output to the log.
The following escape characters can be used.

\n

LF

\r

CR

\t

TAB

\\

backslash "\"

\x

Hexadecimal ASCII characters
* Enter 1 to 2 hexadecimal digits after "\x".

(7) Command / parameter list

Select the action type of the scenario from the following items.

Data Type

Displays the command and parameter data type.

Comparison

Displays how to compare commands and parameters with received data.

Length

Displays the command and parameter data length.

Data

Displays the command and parameter string.

(8) "Add" button

Add a new parameter to the command and parameter list.

(9) "Edit" button

Edit the parameter settings selected in the command / parameter list.

(10) "Up" button

Moves the parameter selected in the command and parameter list up one line in the list.

(11) "Down" button

Moves the parameter selected in the command and parameter list down one line in the list.

(12) "Delete" button

Deletes the parameter selected in the command and parameter list.

(13) "Clear" button

Clears all the action settings currently being entered.



Edit commands and parameters


Sets the command or parameter string.



(1) Data Type

Select the data type of the command or parameter from the following items.

Command

The data is a string that represents the command.

String
(Parameter)

The data is a string of parameters.

Current Date & Time
(Parameter)

Embed the date and time when the scenario is executed as a parameter string.

Start/End Code

The data are start code, end code and check code.

(2) Comparison

Select the method to compare the command or parameter with the data received from the other party when the action type is "Receive" from the following items.

Not compare

This command or parameter does not compare to the received data.

All match

If the character string of this command or parameter is the same as the received data, comparison is OK.

Prefix match

If the character strings of this command or parameter match from the beginning of the received data, comparison is OK.

Backward match

If the character strings of this command or parameter match from the end of the received data, comparison is OK.

(3) Case sensitive

If checked, the comparison is case sensitive.
If unchecked, the comparison is case insensitive.

(4) Length

Specifies the number of bytes if the command or parameter has a fixed number of characters.
Specify -1 for variable length strings.

(5) Text

Sets the command or parameter string.

The following escape characters can be used.

\n

LF

\r

CR

\t

TAB

\\

backslash "\"

\x

Hexadecimal ASCII characters
* Enter 1 to 2 hexadecimal digits after "\x".


If the command and parameter data type is "Current Date & Time (parameter)", specify the date and time display format.

* The format is the same as the format that can be specified by the ToString() method of C#.

yyyyYear.
MMMonth.
ddDay.
HHHour.
mmMinue.
ssSecond.




Application settings


Set the communication port, etc.


Serial port



(1) Port name

Select the name of the serial port (COM1, COM2, ...) to be set.

(2) Baudrate

Select the communication speed of the serial port.

(3) Data bits

Select the number of bits for sending and receiving data.

(4) Parity bit

Select the parity bit method.

(5) Stop bit

Select the number of stop bits.



Network




Configured network port

(1) Network port list

Displays a list of configured network ports.

(2) "New" button

Adds the contents entered in the network port settings to the network port list.

(3) "Edit" button

Change the setting of the network port selected in the network port list.

(4) "Delete" button

Deletes the network port setting selected in the network port list.


Network port details selected in the network port list

(5) Title

The name to display in the list of network ports.

(6) Protocol

The communication protocol used by the network port.

(7) (Connect From)
Address

The IP address of the network port used by "Psuedo Terminal".

(8) (Connect From)
Port

The Port number of the network port used by "Psuedo Terminal".

(9) (Connect To)
Addressn

The IP address to connect to.

(10) (Connect To)
Port

The port number to connect to.



Encoding




(1) Character code list

Displays a list of correspondence between the code page number of the character code and the display name.

(2) "Add" button

Add a new code page to the character code list.

(3) "Edit" button

Change the setting of the code page selected in the character code list.

(4) "Delete" button

Deletes the setting of the code page selected in the character code list.



misc




Log file folder

(1) Output LOG

If checked, a log file will be created and the log will be output to a file.
If it is not checked, the log file will not be created.

The name of the log file to be created will be [PSEUDOTERM_YYYYMMDDhhmmss.log].

YYYYYears when creating the log file.
MMMonths when creating the log file.
DDDays when creating the log file.
hhHours when creating the log file.
mmMinutes when creating the log file.
ssSeconds when creating the log file.

(2) Log file storage folder name

Set the name of the folder where the log file is stored.

(3) "..." button

Select the name of the folder where the log file is stored from the existing folders.



Network settings


Set the network port.



(1) Title

Set the name to be displayed in the list of network ports.

(2) Protocol

Select the communication protocol used for the network port from the following items.

UDP

UDP protocol.

TCP(Server)

A TCP protocol that uses "Psuedo Terminal" as a TCP server.

TCP(Client)

A TCP protocol that uses "Psuedo Terminal" as a TCP client.

* If the protocol setting is "TCP (Server)", only one terminal can be connected.

(3) (Connect From)
Address

Set the IP address of the network port used by "Psuedo Terminal".
* If the protocol setting is "TCP (Client)", this setting has no effect.

(4) (Connect From)
Port

Set the port number of the network port used by "Psuedo Terminal".
* If the protocol setting is "TCP (Client)", this setting has no effect.

(3) (Connect To)
Address

Set the IP address of the connection destination.
* If the protocol setting is "TCP (Server)", this setting has no effect.

(4) (Connect To)
Port

Set the port number of the connection destination.
* If the protocol setting is "TCP (Server)", this setting has no effect.



Character code setting


Set the code page to be added / edited to the character code list and the display name.



(1) Code page

Enter the code page number of the character code to be displayed.
* See the code page for the "EncodingInfo.DisplayName" property in C#.

(2) Name

Enter the name displayed in the character code selection list.



Choose Language


Set the display language of the application.



(1) Choose Language

Select the display language of the application from the following languages.

English
Japanese



Enter the licence key


Enter the application license key.



(1) "To Buy ..." button

Displays the homepage where you can purchase the license key.

(2) Username

Enter the user name to register the license.

(3) Licence key

Enter the license key you purchased.