TruePort Windows User Guide

TruePort Windows User Guide
TruePort Windows User
Guide
Chapter 0
This document provides the procedure for installing and using TruePort on
Windows 2000/Server 2003/Server 2003 R2/XP/Vista/Server 2008/Server 2008 R2/Windows
7/Windows 8/ Windows 8.1/ Windows Server 2012 and Windows Server 2012 R2.
What is TruePort? .........................................................................3
TruePort Full Mode vs Lite Mode ................................................3
Full Mode................................................................................................... 3
Lite Mode................................................................................................... 3
TruePort I/O Access Options................................................................... 4
Modbus ASCII/RTU Mode.................................................................... 4
I/O Signal Mode ................................................................................... 4
Installing TruePort on the TruePort Host ...................................5
Trueport on Windows 8/8.1 and Windows Server 2012/2012 R2.......... 5
Trueport on previous versions of Windows .......................................... 7
Adding Additional TruePort Adapters and Updating ................8
Windows 8/8.1 and Windows Server 2012/2012 R2............................... 8
Adding Trueport Adapters on previous versions of Windows ............ 9
Uninstalling TruePort on the TruePort Host...............................9
TruePort on Windows 8/8.1 and Windows Server 2012/2012 R2 ......... 9
Uninstalling TruePort through Windows Control Panel ..................... 10
Uninstalling Trueport on previous versions of Windows................... 11
Configuring TruePort on a Terminal/Device Server ................12
Server-Initiated Mode ............................................................................. 12
On the IOLAN Device Server ............................................................. 12
On the JetStream/LanStream ............................................................ 12
Client-Initiated Mode .............................................................................. 13
Client I/O Access Mode (I/O Models Only) ........................................... 13
TruePort Windows User Guide, Part #5500165-17
1
Modbus I/O Access ............................................................................ 13
Perle API I/O Access .......................................................................... 14
Configuring Ports on the TruePort Host ..................................15
Configuring the COM Port Connection.................................................17
Access Device Server Serial Port....................................................... 17
Access Device Server I/O Channels .................................................. 18
Connection Profile Settings ................................................................ 19
Client-Initiated Connection Settings ................................................... 20
Configuring Advanced COM Port Settings........................................... 21
Application Options............................................................................. 21
Configuring SSL/TLS.............................................................................. 22
Configuring Packet Forwarding ............................................................ 22
Working with the TruePort Adapter ..........................................24
Restoring TruePort Adapter Defaults ................................................... 24
Deleting a TruePort Adapter on the TruePort Host ............................. 25
Working with COM Port Parameters.........................................25
Adding COM Ports on the TruePort Host ............................................. 25
Copying COM Port Settings on the TruePort Host .............................. 27
Deleting a COM Port on the TruePort Host ..........................................27
Restoring COM Port Defaults ................................................................ 28
Configuring SSL/TLS .................................................................29
SSL/TLS Configuration Information...................................................... 29
SSL/TLS Support Files ........................................................................... 31
TruePort Port Configured as SSL/TLS Server.................................... 31
TruePort Port Configured as SSL/TLS Client ..................................... 31
CLI Conventions .........................................................................32
Adapter specific commands .................................................................. 32
Com Port specific commands ...............................................................33
2
What is TruePort?
What is TruePort?
Trueport redirects serial COM/TTY based traffic over Ethernet to a remote IOLAN. Trueport is a
COM port redirector. TruePort can be used when you want to improve data security, as you can create
an SSL/TLS connection between the TruePort host port and the Device Server, which will encrypt the
data between the two points.
TruePort Full Mode vs Lite Mode
You can configure TruePort on Windows in either Full Mode or Lite Mode. When you start TruePort
in Full Mode, the serial configuration parameters are set on the TruePort host. When you start
TruePort in Lite Mode, the serial configuration parameters are set on the device/terminal server. On
Windows, serial configuration parameters consist of bits per second (baud rate speed), data bits,
parity, stop bits, and flow control. In either mode, the data is passed in raw format, although you can
enable the SSL/TLS connection option to encrypt the data going through a port.
Full Mode
This mode allows complete device control and operates exactly like a directly connected serial COM
port. It provides a complete COM port interface between the attached serial device and the network,
providing hardware and software flow control.
TruePort 6.1 and lower, IOLAN Device Server firmware 3.4 and lower, JetStream, and LanStream in
Full Mode use the TCP protocol on the configured port and the UDP protocol on port 668 (some
firewalls block UDP packets by default and might need to be reconfigured to support Full Mode
communication). TruePort 6.2 and higher and IOLAN Device Server firmware 3.5 and higher do not
use the UDP protocol.
The port serial configuration parameters set on the TruePort host must match the serial configuration
parameters set on the device (in this example, to the Card Reader), as shown below:
Match Serial Configuration Parameters
perle
Network
Card
Reader
Terminal/Device Server
TruePort Host
Data
Lite Mode
This mode provides a simple raw data interface between the device and the network. Although the
port will still operate as a directly attached COM port, control signals are ignored. Lite Mode uses the
TCP protocol on the configured port. In this mode, the serial communications parameters are
configured on the terminal/device server and must match those configured on the device (in this
example, a Card Reader), as shown below:
Match Serial Configuration Parameters
perle
Network
Card
Reader
Terminal/Device Server
Data
TruePort Host
3
TruePort Full Mode vs Lite Mode
TruePort I/O Access Options
Modbus ASCII/RTU Mode
If you have a Modbus serial application running on a pc to a network, you can use TruePort as a
virtual serial connection to communicate with the Device Server over the network to access I/O data.
You also have the option of enabling SSL as a security option to encrypt the data that is
communicated between the Device Server and the host machine (SSL/TLS must be configured on
both the Device Server and in TruePort).
UID: 15
Power
perle
Network
Device Server
PC running a
Modbus Serial
Application/
TruePort
I/O Digital
Output
I/O Signal Mode
If you have a custom application that talks to a serial port, you can use TruePort as a virtual serial
port to communicate with the Device Server over the network to access I/O data. You also have the
option of enabling SSL as a security option to encrypt the data that is communicated between the
Device Server and the host machine (SSL/TLS must be configured on both the Device Server and in
TruePort).
PC running
Custom
Application (API)/
TruePort
Power
perle
Network
Device Server
I/O Digital
Output
4
Installing TruePort on the TruePort Host
Installing TruePort on the TruePort Host
To get the latest TruePort release, download the appropriate TruePort installation wizard from the
Perle website.
trueport-setup-x86.exe—32-bit Windows 2000, XP, Windows Server 2003, Windows Server 2003
R2, Vista, Windows Server 2008, Windows 7 and Windows 8 operating systems.
trueport-setup-x64.exe—64-bit Windows XP, Windows Server 2003, Windows Server 2003 R2,
Vista, Windows Server 2008, Windows Server 2008 R2, Windows 7, Windows 8, Windows 8.1,
Windows Server 2012 and Windows Server 2012 R2 operating systems.
trueport-setup-ia64.exe—64-bit Windows Server 2003 or Windows Server 2008 running on an
Itanium processor. Double-click the TruePort installation wizard and follow the installation
instructions.
To install the TruePort software on your system, double-click the TruePort installation wizard and
follow the installation instructions.
Trueport on Windows 8/8.1 and Windows Server 2012/2012 R2
Once Trueport is installed on your system, you can access Trueport in the following ways:
1.
Simply, double-click the Trueport Management Tool desktop icon.
2.
Alternatively, you can press the Windows function key then right click on the screen. In the
search field begin typing TruePort. All applications starting with true....will be displayed on the
left panel on the screen. From the search results, double-click to open the Trueport Management
Tool.
5
Installing TruePort on the TruePort Host
3.
Lastly, you can right-click on the Windows 8/81 or Windows Server 2012/2012 R2 Start screen.
Click All Apps at the bottom of the screen. Scroll through the apps installed by group. Trueport
is listed under the Perle group. Double-click to open the Trueport Management Tool.
Accessing Trueport on previous versions of Windows
Double-click the Trueport Management Tool Desktop icon or select Start, All Programs, Perle,
TruePort, TruePort Management.
6
Adding Additional TruePort Adapters and Updating
If you have existing TruePort adapters configured, you will see the configured Trueport adapters,
otherwise click the Add button to add a new Trueport Adapter.
Click the Add button to add a new TruePort adapter. In the following window, you can define a
TruePort adapter name and its network location.
Specify a name for the TruePort adapter and then the IPv4/IPv6 address or Hostname (the Hostname
must be resolvable) for the Device Server it will be communicating with. To accept server-initiated
TCP connections from any IP address configure an IPV4 address of "0.0.0.0" or a IPV6 address of
"::". Click Next> and follow the instructions for rest of the wizard.
Note: If you have a firewall on your network, you might need to add the Trueport.exe application to the program exception list to run correctly.
Adding Additional TruePort Adapters and Updating
Windows 8/8.1 and Windows Server 2012/2012 R2
Whenever you add any additional TruePort adapters to your system, Windows might install the latest
digitally signed driver in its database (depending on your Windows operating system and settings). To
ensure you have the latest driver installed after you add the TruePort adapter, do one of the following:
z
Right-click on the Windows 8/8.1 or Windows Server 2012 /2012 R2 Start screen. Click All
Apps at the bottom of the screen. Scroll through the apps installed by group. Trueport is listed
under the Perle group. Double-click to open Trueport Update.
z
Reinstall the drivers as described in Installing TruePort on the TruePort Host.
7
Adding Additional TruePort Adapters and Updating
Click the Next button to continue.
Click the Finish button to complete the Update process.
Adding Trueport Adapters on previous versions of Windows
Whenever you add any additional TruePort adapters to your system, Windows might install the latest
digitally signed driver in its database (depending on your Windows operating system and settings). To
ensure you have the latest driver installed after you add the TruePort adapter, do one of the following:
z
Click Start, All Programs, Perle, TruePort, TruePort Update and follow the installation
instructions
z
Reinstall the drivers as described in Installing TruePort on the TruePort Host.
8
Uninstalling TruePort on the TruePort Host
Uninstalling TruePort on the TruePort Host
TruePort on Windows 8/8.1 and Windows Server 2012/2012 R2
On some installations of Window 8/8.1 and Windows Server 2012/2012 R2, you may find the
Trueport uninstall App under All Apps. Right-click on the Windows 8/8.1 or Windows Server
2012/2012 R2 Start screen, then click All Apps at the bottom of the screen. Scroll through the Apps
installed by group. Trueport may be listed under the Perle group. If so, double-click to open the
Trueport Uninstall App.
It is recommended that you use the Windows Control panel to uninstall Trueport. See Uninstalling
TruePort through Windows Control Panel
Trueport Uninstall App
Uninstalling TruePort through Windows Control Panel
Within control panel, click on Programs -> uninstall a program.
9
Uninstalling TruePort on the TruePort Host
Select the Perle Trueport Driver, then right click, then select uninstall. Perle Trueport
Prerequisite will be automatically uninstalled with the Trueport driver.
Uninstalling Trueport on previous versions of Windows
To uninstall the TruePort serial adapter(s), do the following:
1. Select Start, All Programs, Perle, TruePort, Uninstall from the taskbar.
2. Click Yes in the Perle TruePort Uninstall confirmation window.
3. Click the Uninstall button.
The TruePort application will now be uninstalled from your system.
10
Configuring TruePort on a Terminal/Device Server
Configuring TruePort on a Terminal/Device Server
When you add a port, you need to configure the port(s) on the host running TruePort and you also
need to configure the port(s) on the terminal server.
Server-Initiated Mode
When you configure TruePort for server-initiated mode, the terminal/device server must initiate
communication to the TruePort host.
To configure a terminal/device server for server-initiated mode (which is the default mode), you need
to set the Line Service to TruePort (firmware version 3.0 or higher) or Silent Raw and assign the
port number to be the same port number configured on the TruePort host (by default, this number
starts at 10000).
On the IOLAN Device Server
The following instructions provide an example of how to set up two ports the IOLAN Device Server
using the CLI to TruePort. You will set the Line Service to TruePort (firmware version 3.0 or
higher) or Silent Raw and on 1-port model you don’t specify a line number.
1.
Connect to the Device Server (for example, via Telnet).
2.
Log in to the Device Server as the admin user.
3.
Add the host running TruePort to the host table using the add host command as shown in the
following example:
add host hpux50 192.152.247.61
You are now ready to configure the ports that will connect to the TruePort host.
4.
To configure the ports, enter each of the following commands:
set line 1 service
set line 2 service
set line 3 service
set line 4 service
kill line 1-4
trueport
treuport
trueport
trueport
windows50
windows50
windows50
windows50
10000
10001
10002
10003
5.
At the command prompt, type save and press Enter.
6.
At the command prompt, type logout and press Enter.
The configuration of Device Server’s ports is now complete.
On the JetStream/LanStream
Configuring a JestStream\LanStream using the CLI is almost same as the Device Server CLI. You
will set the Line Service to Silent Raw.
11
Configuring TruePort on a Terminal/Device Server
Client-Initiated Mode
Note:
Client-Initiated mode is available on IOLAN Device Server models with firmware 3.0 or
higher.
When you configure TruePort for Client-Initiated mode, the TruePort host will initiate
communication with the Device Server.
To configure a Device Server for Client-Initiated mode, you need to set the Line Service to
TruePort, enable the Client Initiated option, and assign the port number to be the same port number
configured on the client initiated configured TruePort host (by default, this number starts at 10001).
The following instructions provide an example of how to set up 4 ports on a IOLAN Device Server
for TruePort client initiated mode.
1.
Connect to the Device Server (for example, via Telnet).
2.
Log in to the Device Server as the admin user.
3.
To configure the ports, enter each of the following commands:
set line 1 service
set line 2 service
set line 3 service
set line 4 service
kill line 1-4
trueport
trueport
trueport
trueport
client-initiated
client-initiated
client-initiated
client-initiated
4.
At the command prompt, type save and press Enter.
5.
At the command prompt, type logout and press Enter.
on
on
on
on
10001
10002
10003
10004
The configuration of the Device Server is now complete.
Client I/O Access Mode (I/O Models Only)
Client I/O access mode allows:
z
A Modbus RTU/ASCII serial application running on a TruePort host to access Device Server I/O
using Modbus commands
z
A serial application running on a TruePort host to access Device Server I/O using the Perle API
(see the Utilities chapter of your User’s Guide for TruePort API documentation).
Note:
Client I/O Access is only available in conjunction with IOLAN Device Servers running
version 3.1 or higher.
Modbus I/O Access
To configure a Device Server for Client I/O Access mode for a Modbus RTU/ASCII serial
application, you need to enable I/O TruePort Services, enable I/O Modbus Slave, assign a Modbus
slave UID to match the configured on the Modbus RTU serial application, and assign the port number
to be the same port number configured UID on the client I/O Access configured TruePort host (by
default, this number is 33816).
The following instructions provide an example of how to set up an IOLAN Device Server for
TruePort I/O Access.
1.
Connect to the Device Server (for example, via Telnet).
2.
Log in to the Device Server as the admin user.
3.
To enable the I/O TruePort service, enter following command:
set io trueport mode on listen 33816
4.
To enable I/O Modbus slave, enter following command:
set io modbus mode on uid 1
12
Configuring TruePort on a Terminal/Device Server
5.
Reboot the Device Server by entering the following command:
reboot
The configuration of the Device Server is now complete.
To configure the TruePort host running a Modbus ASCII serial application to access Device Server
I/O, type the following command:
addports -client mydeviceserver:33816 -initconnect -io mb_ascii 0 0
The command creates a single port configured for Client I/O Access mode which will connect to host
mydeviceserver on TCP port 33816 and will support a serial Modbus ASCII application.
Perle API I/O Access
To configure a Device Server for Client I/O Access mode for a serial application, you need to enable
I/O TruePort Services.
The following instructions provide an example of how to set up an IOLAN Device Server for
TruePort I/O Access.
1.
Connect to the Device Server (for example, via Telnet).
2.
Log in to the Device Server as the admin user.
3.
To enable the I/O TruePort service, enter following command:
set io trueport mode on listen 33816
4.
Reboot the Device Server by entering the following command:
reboot
The configuration of the Device Server is now complete.
To configure the TruePort host running a custom serial application to access Device Server I/O, type
the following command:
addports -client mydeviceserver:33816 -initconnect -io io_api 0 0
The command creates a single port configured for Client I/O Access mode which will connect to host
mydeviceserver on TCP port 33816 and will support a custom serial application using the Perle API.
13
Configuring Ports on the TruePort Host
Configuring Ports on the TruePort Host
After you have configured the ports on the terminal server, you can configure the TruePort host. Do
the following (you can configure a maximum of 4096 COM ports per a host with a maximum of 49
COM ports per a single TruePort adapter.
1.
When you have finished the Add TruePort Adapter Wizard (launched from the TruePort
Management Tool, select the TruePort adapter and click the Properties button to configure it.
2.
Click the Configuration tab. On this window, you can connect to a terminal/device server either
by HTTP or Telnet. To configure the TruePort adapter and its associated COM ports, click the
Settings button.
14
Configuring Ports on the TruePort Host
3.
The Properties tab displays configuration options for the TruePort Adapter.
Configure the TruePort adapter Network Settings:
z
Adapter Name—Enter a name for the TruePort adapter to make it easier to recognize.
z
IP Address—Enter the IPv4 or IPv6 address of the terminal/device server that will be
associated with this TruePort adapter on the network.
z
Host Name—Enter the host name of the terminal/device server that will be associated with
this TruePort adapter on the network. Note: the host name must be resolvable for this option
to work (for example, by a DNS lookup).
z
Check for duplicate TCP ports—When enabled, displays an error message when there are
duplicate TCP port numbers assigned to different COM ports.
z
Reset all TCP Ports—Click this button to reset the TCP port numbers of all configured
ports. Note: this does not reset any parameter values other than the TCP port numbers back
to their default values.
15
Configuring Ports on the TruePort Host
Configuring the COM Port Connection
To access the COM port settings:
1.
Click the adapter in the TruePort Management Tool and click the Properties button.
2.
In the adapter Properties window, click the Configuration tab and then click the Settings button.
3.
Click the COM port you want to configure.
As you configure the COM ports, the COM port label will change to reflect the configuration.
Access Device Server Serial Port
Select this option if you are accessing a serial device connected to the Device Server’s serial port.
Select the appropriate Connection Mode:
z
Full Mode—All serial configuration and control is driven by the TruePort host and serial
application.
z
Lite Mode—Serial port parameters are configured on the terminal/device server. COM port
settings on the TruePort host are ignored. Set this mode if the associated serial port on the Device
Server is configured for multihost.
z
Automatic—Automatically selects either Full or Lite Mode.
Note:
All versions of the JetStream 4000 and 8500, LanStream 2000, and IOLAN software support
TruePort Full Mode operation. The JetStream 6x series software version must be 4.03 or
greater.
After you have configured the appropriate Connection Mode, you need to determine how the
connection is going to be initiated:
z
Accept Connection from device server—The Device Server initiates the connection to the
TruePort host. You must configure the port that TruePort will listen on for an incoming TCP
connection from the Device Server.
z
Initiate Connection to device server—The TruePort host initiates the connection to the Device
Server. You must configure the port that TruePort will use to initiate the TCP connection to the
Device Server.
16
Configuring Ports on the TruePort Host
z
Client-Initiated Connection—Click this button to configure connection options when the
TruePort host is initiating the connection to the Device Server. See Client-Initiated Mode for an
explanation of the client-initiated connection options.
Access Device Server I/O Channels
Select this option when you are using TruePort to communicate to a Device Server I/O model with a
Modbus program or the Perle API.
Specify the TCP Port that will be used to make the connection (this must match the Listening Port
specified in the Device Server for I/O TruePort in the Global Settings--the default is 33816).
Select the I/O Application Type:
z
I/O Access—TruePort is acting as a virtual COM port for an application using the Perle API.
z
Modbus ASCII—TruePort is acting as a virtual COM port for a Modbus ASCII program.
z
Modbus RTU—TruePort is acting as a virtual COM port for a Modbus RTU program.
z
Client-Initiated Connection—Click this button to configure the connection options. See
Client-Initiated Mode for an explanation of the client-initiated connection options.
17
Configuring Ports on the TruePort Host
Connection Profile Settings
A set of predefined connection profiles have been defined to make it easier to achieve the correct
configuration for common TCP connection requirements.
To access the connection profile settings for a COM port, click the Change Profile button on the
Configuration tab.
Specify one of the following optimization modes:
z
Minimize Latency—This option ensures that all application data is immediately forwarded to
the serial device. Select this option for timing-sensitive applications.
z
Optimize Network Throughput—This option provides optimal network usage while ensuring
that the application performance is not compromised. Select this option when you want to
minimize overall packet count, such as when the connection is over a WAN.
z
Reduce Message Fragmentation—This option detects the message, packet, or data blocking
characteristics of the serial data and preserves it throughout the communication. Select this
option for message-based applications or serial devices that are sensitive to inter-character delays
within these messages.
You can also define the packet forwarding rules based on the packet definition or the frame definition
(see Configuring Packet Forwarding for more information).
18
Configuring Ports on the TruePort Host
Client-Initiated Connection Settings
You can configure how client-initiated connections behave.
To access the client-initiated settings for a COM port, enable the Initiate Connection to device
server option on the Configuration tab and click the Settings button.
Connection Management Options
z
Connect at system startup—When enabled, the TruePort host will try to connect to the Device
Server when the TruePort service starts, as opposed to waiting for the application to open the
serial port before initiating the connection to the Device Server.
z
Close TCP connection when COM port is closed—When enabled, closes the TCP connection
when the serial application closes the COM port, otherwise, the TCP connection remains open
even after the serial application has closed the COM port.
z
Delay close of TCP connection for—Specifies the amount of time, in seconds, to wait after the
application closes the serial port, before the TCP connection is closed to avoid bringing the TCP
connection down and up if the application is closing and opening the COM port often. The
default is 3 seconds. Valid values are 1-65535.
Connection Options
z
Retry forever—The TruePort host will continue to attempt to reconnect to the Device Server.
z
Number of retries—Specifies the number of additional retry attempts for a client-initiated
connection, beyond the first attempt. Valid values are 0-255. The default is 5 retries.
z
Time between connection retries—Specifies the number of seconds between TCP connection
retries after a client-initiated connection failure. Valid values are 1-255. The default is 30
seconds.
z
Restore dropped connections—When enabled, the TruePort host will attempt to reconnect to
the Device Server after an existing TCP connection is dropped.
19
Configuring Ports on the TruePort Host
Configuring Advanced COM Port Settings
In the adapter Settings window, click on the COM port you want to configure and then click on the
Advanced tab.
Application Options
You can select Simulate COM port transmit delays to control the read/write delay time. Enabling
this option will cause the TruePort application to delay returns to an application that is doing a write
to the COM port. The delay will approximate the time it would have taken to transmit the data if it
was being written to a real serial port. If you just enable this option without changing the zero value
of the other options, a write delay will be created based on the serial device’s baud rate.
z
Additional Transmit Delay—This delay, in milliseconds (ms), is added to the calculated serial
delay, based on the configured baud rate, to compensate for additional delays introduced by the
network. Valid values are 0-9999 ms. The default is 0 ms.
z
Additional Receive Delay—This delay, in milliseconds (ms), is added to the Windows
communication delay. Valid values are 0-9999 ms. The default is 0 ms.
Depending on the requirements of your serial application, you can specify the response to the serial
application when the COM port is opened.
z
Always return successful—Opens the serial port without waiting, even if there is no network
connection, and doesn’t give an error. Any written data is discarded if the TruePort connection is
not fully established.
z
Return when connection is fully established—Waits up to the specified time, in seconds or
milliseconds, for the TruePort connection to be fully established. The TruePort connection is
fully established when:
z
The TCP connection between the terminal/device server and the TruePort host is up.
z
The SSL/TLS negotiation succeeds (if used).
z
The TruePort Full mode protocol negotiation succeeds (if used).
If a timeout occurs before a network connection is established, an error is returned. Valid values
are 1-65535 for seconds and 0-99999 for milliseconds. The default is 5 seconds.
20
Configuring Ports on the TruePort Host
z
Enumerate attached Device (ie: modems)—Enumerate serial devices connected to the Device
Server com port.
z
Drain output before setting config—Drain transmit data before making COM port
configuration changes.
Other Advanced Settings that you can configure are:
z
Send keep alive packets—Enable this option if you want to test if the TCP connection is still up
when no data has been sent for a while by sending keep-alive messages to the Device Server.
z
Keep Alive Interval—Specifies the number of seconds to wait on an idle connection before
sending a keep-alive message. The default is 30 seconds. If no response to the keep alive is
received from the device server then the TCP connection is closed.
z
Enable TCP Nagle algorithm—When you enable the Nagle Algorithm, the number of small
packets sent by TruePort across the network is reduced. The default is enabled.
z
Use legacy UDP Protocol (Full Mode only)—Use legacy UDP Protocol if your IOLAN Device
Server firmware is 3.4 and lower, however for best performance it is recommended that you
upgrade to the latest version of the Device Server firmware located on our Perle website.
Configuring SSL/TLS
See SSL/TLS Configuration Information for configuration information.
Configuring Packet Forwarding
The Packet Forwarding feature allows you to control how the data coming from a serial application is
packetized before forwarding the packet onto the LAN network.
Configure the following parameters:
Enable Packet
Forwarding
Check this box if you want to enable Packet Forwarding for this port.
21
Configuring Ports on the TruePort Host
Packet Definition
This section allows you to set a variety of packet definition options. The first
criteria that is met causes the packet to be transmitted. For example, if you set
a Force Transmit Timer of 1000 ms and a Packet Size of 100 bytes,
whichever criteria is met first is what will cause the packet to be transmitted.
Packet Size
The number of bytes that must be written by the application before the packet
is transmitted to the network. A value of zero (0) ignores this parameter. Valid
values are 0-1024 bytes. The default is 0.
Idle Time
The amount of time, in milliseconds, that must elapse between characters
before the packet is transmitted to the network. A value of zero (0) ignores this
parameter. Valid values are 0-65535 ms. The default is 0.
Force Transmit
Timer
When the specified amount of time, in milliseconds, elapses after the first
character is written by the application, the packet is transmitted. A value of
zero (0) ignores this parameter. Valid values are 0-65535 ms. The default is 0.
End Trigger1
Character
When enabled, specifies the character that when written by the application will
define when the packet is ready for transmission. The content of the packet is
based on the Trigger Forwarding Rule. Valid values are in hex 0-FF. The
default is 0.
End Trigger2
Character
When enabled, creates a sequence of characters that must be written by the
application to specify when the packet is ready for transmission (if the End
Trigger1 character is not immediately followed by the End Trigger2 character,
TruePort waits for another End Trigger1 character to start the End
Trigger1/End Trigger2 character sequence). The content of the packet is based
on the Trigger Forwarding Rule. Valid values are in hex 0-FF. The default is 0.
Frame Definition
This section allows you to control the frame that is transmitted by defining the
start and end of frame character(s). If the internal buffer (1024 bytes) is full
before the EOF character(s) are received, the packet will be transmitted and the
EOF character(s) search will continue. The default frame definition is SOF=00
and EOF=00.
SOF1 Character
When enabled, the Start of Frame character defines the first character of the
frame, any character(s) received before the Start of Frame character is ignored.
Valid values are in hex 0-FF. The default is 0.
SOF2 Character
When enabled, creates a sequence of characters that must be received to create
the start of the frame (if the SOF1 character is not immediately followed by the
SOF2 character, TruePort waits for another SOF1 character to start the
SOF1/SOF2 character sequence). Valid values are in hex 0-FF. The default is
0.
Transmit SOF
Character(s)
When enabled, the SOF1 or SOF1/SOF2 characters will be transmitted with
the frame. If not enabled, the SOF1 or SOF1/SOF2 characters will be stripped
from the transmission.
EOF1 Character
Specifies the End of Frame character, which defines when the frame is ready to
be transmitted. The content of the frame is based on the Trigger Forwarding
Rule. Valid values are in hex 0-FF. The default is 0.
22
Working with the TruePort Adapter
EOF2 Character
When enabled, creates a sequence of characters that must be received to define
the end of the frame (if the EOF1 character is not immediately followed by the
EOF2 character, TruePort waits for another EOF1 character to start the
EOF1/EOF2 character sequence), which defines when the frame is ready to be
transmitted. The content of the frame is based on the Trigger Forwarding Rule.
Valid values are in hex 0-FF. The default is 0.
Trigger Forwarding Determines what is included in the Frame (based on the EOF1 or EOF1/EOF2)
Rule
or Packet (based on Trigger1 or Trigger1/Trigger2). Choose one of the
following options:
z
Strip-Trigger—Strips out the EOF1, EOF1/EOF2, Trigger1, or
Trigger1/Trigger2, depending on your settings.
z
Trigger—Includes the EOF1, EOF1/EOF2, Trigger1, or
Trigger1/Trigger2, depending on your settings.
z
Trigger+1—Includes the EOF1, EOF1/EOF2, Trigger1, or
Trigger1/Trigger2, depending on your settings, plus the first byte that
follows the trigger.
z
Trigger+2—Includes the EOF1, EOF1/EOF2, Trigger1, or
Trigger1/Trigger2, depending on your settings, plus the next two bytes
received after the trigger.
Working with the TruePort Adapter
Restoring TruePort Adapter Defaults
You can restore the TruePort Adapter defaults by either:
z
Selecting the TruePort Adapter and then clicking the Restore Defaults button.
z
Select any COM port and then click the Restore Defaults button. For Device Server settings,
click the Property Settings checkbox.
S
23
Working with COM Port Parameters
Deleting a TruePort Adapter on the TruePort Host
To remove a TruePort serial adapter(s), do the following:
Highlight the TruePort adapter you want to remove.
Click the Remove button.
Click the Yes button to verify that you want to remove the adapter.
The TruePort serial adapter is now uninstalled from your system.
Working with COM Port Parameters
Adding COM Ports on the TruePort Host
To add COM ports on the TruePort host, do the following:
1.
Select the TruePort adapter that has the COM port you want to add and then click the Properties
button.
2.
Click the Configuration tab and then click the Settings button.
3.
If you click the Add Ports button when the TruePort adapter is selected, you will get the
following:
24
Working with COM Port Parameters
If you click on one of the configured ports and click the Add Ports button, you will see the
following (notice that COM5 is selected):
4.
Specify the number of ports you want to add. If you selected a COM port before you clicked the
Add Ports button, you can choose to create the new COM ports with the default COM port
settings or with the settings already configured for the selected COM port.
5.
Select the starting COM port (COM1 to COM4096). Any COM port(s) being used by other
applications will not be shown in the drop-down list of COM ports.
6.
Click OK to add the specified COM ports.
25
Working with COM Port Parameters
Note:
If the installed TruePort driver is an unsigned driver, you may have to click through the
Hardware Wizard for every TruePort COM port configured in your system. If you are adding
a large number of ports, we recommend that you use the TruePort Update program to avoid
clicking through the Hardware Wizard for each TruePort COM port.
This will automatically add and update all added COM ports with the currently installed
TruePort driver (this may take several minutes, depending on how many COM ports you are
adding).
Copying COM Port Settings on the TruePort Host
If you have multiple COM ports that will need the same or very similar configuration settings, you
can configure one COM and then copy its settings to other COM ports by doing the following:
1.
Select the TruePort adapter that has the COM port you want to copy and then click the
Properties button.
2.
Click the Configuration tab and then click the Settings button.
3.
Select that COM port with the configured settings and click the Copy Settings To button.
4.
Select the COM port(s) you want to copy the settings to and then click OK.
Deleting a COM Port on the TruePort Host
To delete a COM port on the TruePort host, do the following:
1.
Select the TruePort adapter that has the COM port you want to delete and then click the
Properties button.
2.
Click the Configuration tab and then click the Settings button.
3.
Click the Remove Ports button to display the Remove Ports window.
26
Working with COM Port Parameters
4.
Check the COM port(s) you want to delete and click OK. You can also delete all the COM ports
by clicking the Select All button and then OK. You must also click OK on the main Settings
window to actually delete the COM ports.
Restoring COM Port Defaults
You can restore any or all of the default settings on a COM port by selecting the COM port and
clicking the Restore Defaults button.
Enable/disable any of the following settings:
z
Connection Settings—Resets all the parameters on the Connection tab to their default settings.
z
Advanced Settings—Resets all the parameters on the Advanced tab to their default settings.
z
SSL/TLS Settings—Resets all the parameters on the SSL/TLS tab to their default settings.
z
Packet Forwarding Settings—Resets all the parameters on the Packet Forwarding tab to their
default settings.
When you have enabled the settings to want to restore to their default settings, click OK.
27
Configuring SSL/TLS
Configuring SSL/TLS
The SSL/TLS feature is designed to work with the IOLAN SDS, SCS, and STS Device Server
models. When TruePort is used with the Device Server, the cipher specified by the Device Server will
be used for the TruePort connection. Also, if the Device Server is set for SSL/TLS Type Server, then
you need to set the TruePort SSL/TLS Type to Client, and vise versa.
SSL/TLS Configuration Information
The following section provides more information about the SSL/TLS configuration parameters:
Enable SSL/TLS
Encryption
Check this box if you want to encrypt the data via SSL/TLS between the
TruePort host and the Device Server.
SSL/TLS Version
Specify whether you want to use:
z
Any—The TruePort service will try a TLSv1 connection first. If that fails,
it will try an SSLv3 connection. If that fails, it will try an SSLv2
connection.
z
TLSv1—The connection will use only TLSv1.
z
SSLv3—The connection will use only SSLv3.
SSL/TLS Type
Specify whether the TruePort service will act as an SSL/TLS client or server.
Verify Peer
Certificate
The certificate received from the peer will be verified against the CA list,
along with any values entered in the validation criteria, for an SSL connection;
any fields left blank will not be validated against the peer certificate.
Certificate Authority The full path and file name of the CA (certificate authority) file.
Filename
Supply Certificate
Check this box if you need to specify the path and file name of the certificate
file.
28
Configuring SSL/TLS
Certificate Filename The full path and file name of the certificate file.
Certificate
Passphrase
If you encrypted the private key with a passphrase when it was created, you
will need to enter it here to have a successful SSL/TLS connection.
The following section describes the SSL validation criteria.
Note:
The values that you enter here are case sensitive, so the peer certificate must match exactly
or the connection will fail.
Country
A two character country code; for example, US.
State/Province
Up to a 128 character entry for the state/province; for example, IL.
Locality
Up to a 128 character entry for the location; for example, a city.
Organization
Up to a 64 character entry for the organisation; for example, Acme Software.
Organization Unit
Up to a 64 character entry for the unit in the organisation; for example, Payroll.
Common Name
Up to a 64 character entry for common name; for example, the host name or
fully qualified domain name.
Email
Up to a 64 character entry for an email address; for example,
[email protected]
29
Configuring SSL/TLS
SSL/TLS Support Files
When you enable the SSL/TLS option for a port, you need to make sure the TruePort host and Device
Server have the appropriate support files: certificates/private keys and/or the CA list file. The IOLAN
CD-ROM contains a self-signed RSA certificate named samplecert.pem. The samplecert.pem
file can be used for both the certificate file on the SSL/TLS server and the CA list file on the
SSL/TLS client.
TruePort Port Configured as SSL/TLS Server
When the TruePort port is configured as an SSL/TLS server, the SSL/TLS private key and certificate
is required for all key exchange methods except ADH (Anonymous Diffie-Hellman). The private key
needs to be appended to the certificate file, to create one certificate/private key file. This
certificate/private key file then becomes the TruePort certificate. Copy the TruePort certificate file to
the directory you specified in the SSL/TLS configuration.
If the TruePort SSL/TLS server is configured to verify an SSL client, a CA list file is also required.
The CA list file is a certificate, or list of certificates, of the Certificate Authorities (CA) who created
and signed the peer certificates.
TruePort Port Configured as SSL/TLS Client
When the TruePort port is configured as an SSL/TLS client and peer verification is configured, a CA
list file is required. The CA list file is a certificate, or list of certificates, of the Certificate Authorities
(CA) who created and signed the peer certificates (the peer certificate(s) must be downloaded to the
Device Server). This CA list file should be copied to the TruePort host directory specified in the
SSL/TLS configuration.
30
CLI Conventions
CLI Conventions
This section explains how to interpret the CLI syntax. Trueport CLI commands are arranged into two
categories. CLI commands to be performed on the Trueport adapter or CLI commands to be
performed on the com ports associated with the Trueport adapter.
To view all valid commands type tpcon ?. To get Help on a specific command type tpcon
help <command name>. Definitions for CLI command parameters can be found in the graphical
portion of this manual.
Note:
CLI commands need to be "Run as Administrator" within the Command Prompt.
The command will be interrupted as follows:
For example: tpcon add adapter <adapter name> [ipaddr|hostname] <ip
addr|host name> <com> <number of ports>
tpcon add adapter "Trueport Adapter" ipaddr 172.16.44.55 com3 4
–
Square brackets ([]) show the options that are available for the command.
–
Angle brackets (<>) show that the text inside the brackets is a description for a variable
value that you must fill in according to your requirements. In the add adapter command, you
must determine the values for adapter name, ip addr|host name, com and
number of ports. Any spaces within a value must be enclosed in quotes for example:
"Trueport Adapter". The angle brackets can also contain a range that can be used.
–
The pipe (|) shows an ’or’ condition. For example, valid values for ipaddr|hostname are ip
addr or host name.
All Trueport CLI commands must be typed on a DOS command prompt within the Program
Files\Perle System Limited\Trueport directory. You must run these commands as administrator within
the command prompt.
C:\Program Files\Perle Systems Limited\Trueport tpcon add adapter
"Trueport Adapter" ipaddr 172.16.44.55 com3 4
Adapter specific commands
For adapter commands the format is as follows:
tpcon <command> [<arg>....]
<command> - specifies a command (see command list below).
<arg>... - one or more arguments that modify a command
tpcon add adapter <adapter name> [ipaddr|hostname] <ip address|host
name> <com> <number of ports>
tpcon remove adapter <adapter name> [ipaddr|hostname] <ip address|
host name>
tpcon add-ports adapter <adapter name> [ipaddr|hostname] <ip address
| host name> <com> <number of com ports>
tpcon remove-ports adapter <adapter name> [ipaddr|hostname]<ip
address|host name> <com|ALL>
tpcon show-adapter *|<adapter name> [ipaddr|hostname]<ip
address|host name>
tpcon show-port adapter [ipaddr|hostname]<ip address|host name>
<com>
31
CLI Conventions
Com Port specific commands
For com port commands the format is as follows:
tpcon <com> <command> [<arg>......]
<com> - the com port <com1-com49>
<command> - specifies a command (see command list below).
<arg>... - one or more arguments that modify a command
tpcon list
tpcon <com> show
tpcon <com> baud-rate
<50|75|110,134|150|200|300|600|1200|1800|2000|2400|4800|7200|9600|14
400|19200|28800|33400|56000|57600|64000|76800|115200|128000|150000|2
30400|256000>
tpcon <com> data-bits <5|6|7|8>
tpcon <com> parity <None|Even|Odd|Mark|Space>
tpcon <com> stop-bits <1|1.5|2>
tpcon <com> flow-control <None|Xon|Xoff|Hardware>
tpcon <com> port-number <new com number>
tpcon <com> tx-fifo-limit <1-128>
tpcon <com> tx-fifo-trigger <0-127>
tpcon <com> access [Ports|IO-channels]
tpcon <com> connection-mode [Automatic|Lite|Full]
tpcon <com> accept <1-65535>
tpcon <com> initiate <1-65535>
tpcon <com> connect-startup [Disable|Enable]
tpcon <com> tcp-close-com-close [Disable|Enable]
tpcon <com> delay-tcp-close <0-65535 seconds>
tpcon <com> connection-retry <Forever|0-255 seconds>
tpcon <com> retry-interval <1-255 seconds>
tpcon <com> restore-connection [Disable|Enable]
tpcon <com> io-tcp-port <1-65535>
tpcon <com> io-application [Io-access|Modbus-ascii|Modbus-rtu]
tpcon <com> profile
[optimize-throughput|min-latency|reduce-fragmentation]
tpcon <com> simulate-delays [Disable|Enable]
tpcon <com> tx-delay <0-9999 milliseconds>
tpcon <com> rx-delay <0-9999 milliseconds>
tpcon <com> open-response <Always|Established>
tpcon <com> max-wait <0-65535 seconds>
tpcon <com> enum-devices [Disable|Enable]
tpcon <com> drain-before-config [Disable|Enable]
tpcon <com> keep-alive-interval <0-65535 seconds>
tpcon <com> nagle [Disable|Enable]
tpcon <com> udp [Disable|Enable]
tpcon <com> ssl [Disable|Enable]
32
CLI Conventions
tpcon <com> ssl-version [Any|tslv1|sslv3]
tpcon <com> ssl-type [Server|Client]
tpcon <com> verfiy-peer [Disable|Enable]
tpcon <com> ca-name <1-260 characters>
tpcon <com> ssl-country <2 characters>
tpcon <com> ssl-state <1-128 characters>
tpcon <com> ssl-locality <1-64 characters>
tpcon <com> ssl-organization <1-64 characters>
tpcon <com> ssl-organization-unit <1-64 characters>
tpcon <com> ssl-common-name <1-64 characters>
tpcon <com> ssl-email <1-64 characters>
tpcon <com> supply-certificate [Disable|Enable]
tpcon <com> certificate-file-name <1-260 characters>
tpcon <com> cert-passphrase <1-255 characters>
tpcon <com> packet-forwarding [Disable|Enable]
tpcon <com> packet-definition [Packet|Frame]
tpcon <com> packet-size <0-1024>
tpcon <com> idle-time <0-65535>
tpcon <com> force-transmit <0-65535>
tpcon <com> end-trigger1 [Disable|Enable]
tpcon <com> end-trigger1-char <0-FF hexidecimal>
tpcon <com> end-trigger2 [Disable|Enable]
tpcon <com> end-trigger2-char <0-FF hexidecimal>
tpcon <com> sof1-char <0-FF hexidecimal>
tpcon <com> sof2 <Disable|Enable>
tpcon <com> sof2-char <0-FF hexidecimal>
tpcon <com> tx-sof [Disable|Enable]
tpcon <com> eof1-char <0-FF hexidecimal>
tpcon <com> eof2 [Disable|Enable]
tpcon <com> eof2-char <0-FF hexidecimal>
tpcon <com> trigger-rule [trigger|trigger+1|trigger+2|strip]
tpcon <com> max-wait-units <S|M>
33
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement