Lantronix Com Port Redirector User manual

Part No. 900-445
Rev. C July 2006
Com Port Redirector v.4
Powered by TruPort™ Technology
Quick Start
Contents
Introduction .................................................................................................................................. 1
Overall Procedure ........................................................................................................................ 1
Installation .................................................................................................................................... 2
Device Server Configuration Guidelines...................................................................................... 4
Quick Setup.................................................................................................................................. 5
1. Com Port List........................................................................................................................ 5
2. Search for Device Servers ................................................................................................... 6
3. Add or Remove Com Ports .................................................................................................. 7
4. Configure the Com Port........................................................................................................ 8

1
Introduction
Lantronix's Com Port Redirector (CPR) v.4, powered by TruPort™technology, is a software
utility for network-enabling software applications that do not have network support. Com Port
Redirector installs virtual communication ports; these communication (com) ports are redirected
over a network to the serial port of a Lantronix device server. TruPort® Technology combines
RFC2217 Com Port control protocol with Lantronix® data handling, discovery, and device
server technology, enabling advanced remote serial interface control.
CPR supports Windows XP, Windows 2000 and 2003 server, and Windows Vista, including
Terminal Services.
Example of How Com Port Redirector Works
Com Port Redirector consists of the following modules:
CPR Manager enables you to map com ports to device servers, configure, and test comports.
CPR Monitor enables you to identify and troubleshoot problems.
You will find detailed instructions for using the modules in the Com Port Redirector online Help.
Overall Procedure
The following procedure summarizes the steps for using Com Port Redirector.
1. Install Com Port Redirector on each PC that will communicate with the device server.
2. Review the general usage guidelines for the device server.
3. Configure the device server and Com Port Redirector.
4. Verify the connectivity between Com Port Redirector and the device server.

2
Installation
To install Com Port Redirector:
1. Perform the appropriate step to start the installation:
If Com Port Redirector is on a CD-ROM, insert the CD-ROM into the computer’s CD-
ROM drive and click the Redirector button,
OR
If you downloaded Com Port Redirector, double-click the downloaded file.
The Lantronix CPR Welcome window displays.
2. Click the Next button. The Select Installation Folder window displays.
3. Browse to the folder where you want to install the CPR. We recommend you select the
default.

3
4. To view available disk space on your drives, click the Disk Cost button.
5. Click the Next button. The Confirm Installation window displays.
6. Click the Next button. The installation begins; then a warning message displays
indicating that CPR has not passed Windows Logo testing.
7. Click the Continue Anyway button. The installation continues and the warning displays
again.
8. Click the Continue Anyway button again. The installation continues until the Installation
Complete window displays.

4
9. Click the Close button.
Device Server Configuration Guidelines
Observe the following general guidelines when preparing the device server for use with Com
Port Redirector:
The device server to which Com Port Redirector will connect must have an IP address.
The PC running Com Port Redirector must have a good network connection to the device
server.
If redirecting over a Wide Area Network (WAN), both the PC and the device server must
have a correct gateway address configured in their TCP/IP settings.
Serial settings on the device server must match the settings of the serial device when
RFC2217 is not implemented. Serial settings include:
- Baud rate
-Parity
-Stop bits
- Flow control
-Interface mode (RS-232 or RS-422/485)
Consult your device server documentation for information about configuring these
serial settings for your device server.
Connect/Disconnect and Access Modes: You must configure the way the device server
accepts a connection appropriately for the device server to accept a network connection
from Com Port Redirector.
- CoBox, UDS, XPort, and XPress products: Set the Connect Mode to C0 and
Disconnect Mode to 00. If the CPR com port is set for Listen Mode, set the
Connect Mode to 05.

5
Note: If you are using RFC2217, set the Disconnect Mode to 40.
-MSS, ETS, and SCS products: Set the access mode to "Dynamic" or "Remote" on
the serial port receiving the connection from the Com Port Redirector.
Serial cabling between the managed serial device and the device server must be correct.
Consult your documentation for the pinouts of your device server.
Quick Setup
1. Com Port List
CPR enables you to create up to 256 com ports. The tree structure in the left pane of the
window displays existing com ports, and the Com Port List tab lists them on the right, along
with additional information, if available.
To view com port information:
1. Click the Com Port List tab (if not displaying).
2. View information about each listed com port, if available:
Com Port
List Setting
Description
IP Address IP address of the device server to which the com port is
connected.
TCP Port TCP port on the device server to which the com port is
connected (for example, 10001 if using channel 1 or 10002 if
using channel 2 on a UDS or XPort device server).
COM
Status
Indicates whether the com port is open or closed.
Network
Status
Status of the connection between the com port and the device
server, e.g., Disconnected.
2217 Yes indicates RFC 2217 is enabled.
BfrWr Yes indicates buffer writes is enabled.
SvrRec Yes indicates CPR will attempt reconnecting to the device
server if the device server disconnects from CPR.
NoCls Yes indicates that when an application closes the com port,
CPR will not close the network connection.
CntTO Number of seconds the com port will wait before attempting to
connect to the next device server in the list, or before aborting

6
Com Port
List Setting
Description
the connection attempt.
TORec Yes indicates CPR will re-establish the connection if a
connection times out.
KpAlv Yes indicates TCP KeepAlive is enabled.
2. Search for Device Servers
Use the search feature to list the Lantronix device servers currently on the network. You can
name a device server and its TCP port and hide or display the list of devices servers.
Note: This version of CPR does not detect the following Lantronix products: MSS, ETS, SCS,
MPS, and EPS.
To list device servers:
1. Click the Search icon . A list of Lantronix device servers on the local network
displays in the bottom pane of the window.
2. View the following information about the device server, if available:
Device
Seting
Description
IP
Address
IP address of the device server to which the com port is
connected.
TCP Port
Serial port (channel 1 or channel 2) on the device server to which
the com port is connected. All MSS products use port 3001 for
channel 1 and 3002 for channel 2. All CoBos products (UDS,
CoBox, and XPress) and XPort products use port 10001 for
channel 1 and 10002 for channel 2.
Note: For instructions on configuring port numbers using Telnet
or a web interface, see the user guide for the Lantronix device
server.
Device
Name
A user-supplied name that identifies the device server.

7
Device
Seting
Description
Port
Name
A user-supplied name that identifies the port.
HW
Address
Hardware address (also called MAC or Ethernet address) that
identifies the unit. It is on the product label, in the format: 00-20-
4a-XX-XX-XX, where the XXs are unique numbers assigned to
the product.
ID Device server type identifier (ID of the product).
Product Product name, for example, UDS200, XPort-O3, or SDS1100.
To name a device server and port:
1. In the Device pane, right-click in the device's row. A pop-up menu displays.
2. Select Name Device and Port. The Change Names dialog box displays.
3. Enter the Device Name and Port Name and click OK.
3. Add or Remove Com Ports
CPR allows up to 256 com ports.
Note: Any com ports on the system that are not CPR virtual com ports are inaccessible to CPR
Manager.
To add com ports:
1. Click the Add or Remove icon , or select Add and Remove from the Com Port
menu. A window displaying a list of numbered com ports opens.

8
2. Do one of the following:
To select com ports individually, select the appropriate checkboxes.
To select a range of com ports, enter the beginning and end of the range to the right
of the Check (Range) button and click the button.
To select all of the com ports, click the Select All button.
To clear all checkboxes, click the Select None button.
3. Click the OK button. The dialog box closes. The added com ports display in red and are
identified as new. The word "Modified" displays at the bottom of the window.
4. To save the settings, click the Save icon .
To remove a com port:
1. Click the Add or Remove icon , or select Add and Remove from the Com Port
menu.
2. Do one of the following:
To remove com ports individually, clear the appropriate checkboxes.
To remove a range of com ports, enter the beginning and end of the range to the right of
the Uncheck (Range) button and click the button.
To select no checkboxes, click the Select None button.
3. Click the OK button. The dialog box closes. Removed com ports that were never saved
no longer display. Removed com ports that were saved previously have "marked for
deletion." beside their names.
4. To save the changes, click the Save icon . The removed com ports no longer display.
4. Configure the Com Port
You must configure a new com port before it can be used by any communications software.
To configure com port settings:
1. Click the com port in the tree structure. The Settings tab displays.
Note: Alternatively, double-click the com port on Com Port List tab.

9
2. Enter the following information:
Com Port
Settings
Description
Buffer
Writes
If selected, when an application opens a COM port and starts
writing to that port, CPR will buffer those writes and try to send
as many as possible in a single TCP packet (speeds
processing).
Server
Reconnect
If selected, enables the com port to reconnect to the device
server after the device server disconnects from CPR.
No Net
Close
If selected, when an application closes the com port, CPR does
not close the network connection. To disconnect CPR from the
device server, right-click the com port in the com port tree view
on the left or in the Com Port List on the right, or select
Disconnect on the Com Port menu.
Connection
Timeout (in
seconds)
Number of seconds the com port should wait before attempting
to connect to the next device server in the list, or before
aborting the connection attempt.
Timeout
Reconnect
If selected, CPR re-establishes the connection if the connection
times out. When auto-reconnecting, CPR tries to reconnect until
the connection succeeds or the number of tries reaches the
value in Reconnect Limit.

10
Com Port
Settings
Description
Reconnect
Limit
(0 =
forever)
The number of times CPR attempts to re-establish the
connection. A value of 0 means CPR will continuously attempt
to connect.
Listen
Mode
If selected, CPR listens on the configured TCP port for
incoming connection requests. There are two kinds of Listen
Mode. From the drop-down list, select one of the following:
Normal - port closed after disconnect: The TCP port will
close once the connection to the device server is broken.
Auto- back to listen mode after disconnect: CPR goes back
into Listen Mode once the connection is broken.
TCP Port The number of the TCP port you want CPR to listen on. Click
the Add to Firewall button to add the TCP port to the firewall's
exclusion list if the firewall is turned on. The firewall will then
allow traffic on this TCP port.
TCP
KeepAlive
CPR uses the TCP protocol to detect when connections are no
longer valid. To enable this capability, select the checkbox.
(See the device server's user guide for more information.)
KeepAlive
Time
(msec)
The time, in milliseconds, that TCP will poll the connection with
the device server.
KeepAlive
Interval
(msec)
If TCP detects a connection failure, it will poll for the connection
every KeepAlive Interval milliseconds that you specify here. If,
after 5 tries, the connection is still invalid, TCP will notify CPR,
and CPR will tear down the connection socket.
If the CPR port is in Listen Mode - Auto, the CPR port will go
back to listening on the appropriate TCP port.
Use RFC
2217
Com port control option protocol that controls:
Device server serial port settings (baud rate, data bits,
parity, stop bits, flow control)
DTR relationships to DCD and DSR serial port signals
across the network.
Note: To use RFC2217, the device server must support this
protocol. To find out whether your device server supports
RFC2217, please see the documentation that comes with the
unit or the Lantronix web site (www.lantronix.com).
Connection
Timeout
Number of seconds the com port should wait before attempting
to connect to the next device server in the list, or before
aborting the connection attempt.
DTR If you selected Use RFC 2217, select one of the options to tie
the remote DTR with the DCD and DSR of the virtual com port.
The default is to tie DTR to DCD and keep DSR always active.

11
Com Port
Settings
Description
Tx Empty If you selected Use RFC 2217, select one of the following
options from the drop-down list:
CPR Transmit Buffer Empty: CPR notifies the
application when the CPR has transmitted data and its
buffer is empty.
Device Server Transmit Buffer Empty: CPR notifies
the application when the device server has transmitted
data and its buffer is empty.
Notes:
Overlapped and non-overlapped writes remain
pending until the transmit empty event occurs.
Only applications that have registered to receive
transmit empty events through Microsoft Windows'
APIs are notified of transmit empty events.
3. To redirect the com port to up to eight device servers, double-click each desired device
server in the Devices pane. The following information displays for each device server:
Note: Alternatively, right-click the device server in the list of devices and select Add to
Settings.
Service
Settings
Description
Service Number of the device server in the list of device ports that the
com port can connect to.
Note: When a com port is open, it attempts to connect to the
first device server in the list. If the com port does not make a
successful connection in the time specified in Connection
Timeout (above), it tries the next device server. This procedure
continues with each device server in turn until the com port
makes a successful connection or tries all the listed device
servers.
Host IP address of the device server.
TCP Port Port on the device server to which the com port will connect.
4. You have the following options:
To return the settings to default values, click the Reset to Defaults button.
To cancel your changes, click the Cancel Edits button.
To save your changes, click the Save icon , and in response to the confirmation
message, click OK. The completed Settings window displays. The "Modified"
message displays in the progress bar at the bottom of the window.
Note: Once you save the com port configuration, system names and information display
at the top of the window.