Ss 1
Ss 1
User’s Guide
CE Marking Warning
All trademarks and trade names are the properties of their respective
owners.
TABLE OF CONTENTS
Chapter 1 Introduction ............................................ 1
EtherPath Functions..................................................... 2
Other Features ............................................................. 4
Physical Details ........................................................... 6
Appendix B Programming..................................... 70
Introduction ............................................................... 70
Description and Behavior .......................................... 71
Application Notes...................................................... 74
Example Code ........................................................... 75
ii
Chapter 1
Introduction
This chapter provides an overview of the
EtherPath's features and capabilities.
1
EtherPath User’s Guide
EtherPath Functions
The EtherPath can be used in several modes – simple Client/Server
or Server, as illustrated below, point-to-multiple-point
(EtherModem) Client/Server, and reverse telnet Client. These
modes are described below.
Client/Server Mode
In this mode, two EtherPaths are used. Both are connected to serial
RS-232 devices. This is termed a “Nailed-Up” connection.
• The "Client" EtherPath will automatically establish a
connection to the "Server" EtherPath upon power-up.
• The device on one EtherPath communicates with the other
serial port device as if it was directly connected via a serial port
cable.
2
Introduction
• The EtherPaths and the LAN are completely transparent to PC
application and serial port device.
Server Mode
3
EtherPath User’s Guide
EtherPath will connect to any port number under user control with
either hardware (pin6) dialing or AT dialing.
By using the "AT Dial" commands, the connected device can direct
the EtherPath to connect to multiple remote devices, one at a time.
Other Features
Automatic Connection
When used in Client/Server mode, the “Client” EtherPath will
automatically establish a connection to the “Server” EtherPath on
power-up, or under the control of an RS-232 control signal.
AT Commands
The EtherPath responds to most common AT commands when in
the Client mode. Commands are listed in the Appendix.
Connection Recovery
The EtherPath uses a proprietary protocol to ensure the client/server
session always exists on TCP/IP. When data hasn't been transferred
through the connection for some time, the EtherPath will
communicate with the other device (either EtherPath or PC) to
ensure that the connection is still open.
If there is no response, the device will reset to the initial state, and
attempt to reconnect.
Also, if the RS-232 link is broken, it will be reconnected
automatically if possible (when in Hardware-connect mode).
This operation is described in the Appendix.
Protocol Conversion
The RS-232 device at the client end and the device at the server end
of a link do not have to use the same communications protocols on
4
Introduction
the RS232 link (speed, parity, flow control). The EtherPaths will
convert the data to the correct protocol.
Upgradeable Firmware
Firmware upgrades are downloadable to the EtherPath. The utility
program required for this, and the actual firmware upgrades, are
available from your dealer.
5
EtherPath User’s Guide
Physical Details
The EtherPath front and rear panels are shown below.
Figure 1: EtherPath
6
Introduction
Configuration Switch
There is a momentary action push button switch on the right side of
the unit behind a small hole. Pressing this switch places the unit in
configuration mode and is used only when configuring the
EtherPath via the serial port, as explained in Chapter 3 -
Configuration. Return from configuration mode by exiting the
configuration menu or by power cycling the unit. This switch may
be depressed with a tiny screw driver or stiff wire. (A straightened
paper clip works nicely).
7
EtherPath User’s Guide
LED Indicators
There are two red LED indicators on the rear panel adjacent to the
LAN connector and one green LED indicator on the front panel
between the 9-pin serial connectors.
ON Server Mode
8
Introduction
9
EtherPath User’s Guide
Package Contents
You should find the following items packaged with your EtherPath:
• The EtherPath Unit
• Power Adapter
• This User’s Guide
If any of the above are missing, contact your dealer immediately.
Software Requirements
The EtherPath supports the following protocols.
• TCP/IP
• UDP
• ARP
• ICMP
• TELNET
10
Chapter 2
Installation
This Chapter details the LAN installation process
for the EtherPath.
Overview
For Telnet Mode or Web Browser Mode configuration, LAN
installation is performed before configuration. There must also be a
valid IP address in the unit prior to configuration with these
methods. The default value may not work with your network.
If you use Terminal Mode configuration, then the configuration
should be performed prior to LAN installation. See Chapter 3 for
details.
LAN Installation
11
EtherPath User’s Guide
Only use the power adapter provided
with the EtherPath. Using a different
one may cause hardware damage.
12
Chapter 3
Terminal/Telnet
Configuration
This Chapter describes how to configure the
EtherPath's using Terminal configuration mode or
Telnet configuration mode. Web Browser mode is
covered in the next chapter.
Overview
The EtherPath can be configured using any of the following
methods:
• Web Browser - After installing the EtherPath in your LAN,
use your Web Browser for configuration. See Chapter 4 -
Browser Configuration for details.
• Terminal Mode - Use a serial cable connection and a
communication program. The advantage of this method is that
you give the EtherPath a compatible IP Address prior to
installation in your network.
• Telnet Mode - After installing the EtherPath in your LAN,
connect to it using Telnet for configuration.
Both Terminal and Telnet modes provide the same user interface.
13
EtherPath User’s Guide
Terminal Configuration
Terminal configuration requires the following:
• PC with terminal emulation program, or a dumb terminal.
• Serial cable to connect the PC to the EtherPath. See the
Appendix for cable requirements. A Crossover (null modem)
cable is required when using a 9 pin PC port.
Procedure
1. Connect the EtherPath to your PC or terminal using a null-
modem cable.
2. Press the configuration setup switch momentarily. It is located
on the side of the EtherPath and accessed through a small hole.
Use a small pen or paper clip to access the switch.
3. Start the terminal program and configure the terminal program
with the following settings.
Setting Value
Flow control protocol None
Baud rate 9600
Data 8 bits
Parity None
Stop Bit 1
4. Connect your terminal program to the appropriate port (e.g.
COM 1).
14
Operation
5. The configuration program should now start and after a few
seconds display a sign-on screen.
If nothing appears on your screen, press ESC.
Refer to Terminal/Telnet Interface on page 17 for details on
using the configuration program.
Telnet Configuration
1. Install the EtherPath into your LAN as described in Chapter 2.
Ensure that the EtherPath is powered on. The EtherPath must
have anIP address appropriate for YOUR network.
2. Connect to the EtherPath with the command:
telnet IP_Address Port_number
Where:
IP_Address is the IP address of the EtherPath
Port_number (for configuration) is 8000.
For example, if the default IP address had not been changed,
then you would enter the command:
telnet 192.168.1.1 8000
15
EtherPath User’s Guide
to examine the Properties for the TCP/IP protocol.
• If your PC is NOT using an IP Address within the range
192.168.1.2 to 192.168.1.254, with a Network Mask of
255.255.255.0, then you must either change the
EtherPath's IP address using a directly connected
terminal or change your PC to an address in the above
range and reboot. Once the PC will communicate with
the EtherPath, the EtherPath address may be changed,
and the PC reconfigured to its proper address.
16
Operation
Terminal/Telnet Interface
The Signon screen displays the version number.
EtherPath V4.0
--------------------------------
Device Name: GW403930
Physical Location: Head Office
Pressing any key will then take you to the Main Menu.
17
EtherPath User’s Guide
Entering Data
Enter the number of the field you wish to change, followed (on the
same line) by a space and the data for that field.
Example
On screen one, to set the IP address (field 1) to 192.168.1.10
=>1 192.168.1.10
Menu Options
Main Menu Option 1.
Setting IP Addresses
18
Operation
Selecting 1 ( 1. Set Local & Remote IP Address, Subnet
Mask, Gateway Address ) from the Main Menu will result in a
screen which looks like the following.
19
EtherPath User’s Guide
1. Local IP Address
The IP address of this EtherPath device on your LAN. The default
IP Address is 192.168.1.1
2. Remote IP Address
In “Client” mode, this is the IP address of the remote “Server”
device which this client will automatically connect to when powered
up (if RS-232 PIN 6 is high or forced) and configured for hardware
dialing. This is also the default server that will be used for AT
dialing when in PMP mode.
In “Server” mode, this value is not required, and will be ignored.
3. Gateway IP Address
If the remote EtherPath (in “Client/Server” mode) is not on the same
LAN, then the gateway to the other LAN must be entered here.
4. Subnet Mask
The network mask indicates what class of TCP/IP network you
have. The default value is for a class “C” network, with up to 255
users. This value should work in small networks. If in doubt, consult
your network administrator.
5. Name of Contact Person: Supervisor
This is a text field. It can be used to store the name of the person
responsible for the Serial Port Device.
6. Device Name
This is a text field. It can be used to store a descriptive name for the
device.
20
Operation
7. Physical Location
This is a text field. It can be used to store a the location of the
device.
8. Port Number
This is the TCP/IP port number the EtherPath listens on when in
server mode. The default is port 3000. When in client mode, this is
the port on the remote server that a connection is attempt with. This
value may be overridden when in Ethermodem mode by including a
port number in the ATD command.
9. IP Fragmentation
If set to ZERO, IP blocks sent from this EtherPath may be
fragmented in transit, and blocks may be fragmented by the
EtherPath. If set to ONE, the 'DONTFRAG' bit is set in IP packets,
and all blocks are transmitted intact. This is normally set to 0 , but
is set to 1 for some SCADA applications. The default is 0.
21
EtherPath User’s Guide
Main Menu Option 2.
Set Manager/Telnet IP Address
Selecting (2) from the Main Menu will result in the following
screen.
Entry Manager_IpAddr
***** ***************
1. 000.000.000.000
2. 000.000.000.000
3. 000.000.000.000
4. 000.000.000.000
MANAGER SETUP:
set Entry_Number IP_Address
clear Entry_Number
0 --Return to main menu.
EXAMPLE:
to set entry #3 to IP address=138.239.0.24,
=> set 3 138.239.0.24
to clear entry #2 IP address,
=> clear 2
22
Operation
Main Menu Option 3.
Set Serial Port Data
Selecting (3) from the Main Menu will result in the following
screen.
PORT CONFIGURATION:
Flow Control: NONE
Baud Rate: 9600
Data: 8 Bits Parity: NONE Stop: 1 Bit
Pin 6 Control: FORCED ON
Client Dial Mode: HARDWARE (Pin 6)
This screen allows you to change the settings for the RS232 link.
The settings used should match the device connected to the serial
port of the EtherPath.
Note that the EtherPath's serial settings must match the device that
is plugged into THAT EtherPath. The device at the other end of the
Ethernet link may be set differently.
23
EtherPath User’s Guide
Flow Control
The choices are “None”, “XON/XOFF”, and “RTS/CTS”. It is
common to use NONE for installation troubleshooting, then set it
correctly to match the connected device. If RTS/CTS is used, the
cables must have handshake lines wired correctly.
Baud Rate
Speeds between 300 bps and 230.4Kbps are supported.
Parity
The choices are “None”, “Odd”, or “Even”.
Data Bits
The choices are 7 or 8. This does NOT include the parity bit. The
two most common settings are 7 bit PLUS appropriate parity or 8
bit with NO parity. Default is 8 bits.
Stop Bits
The choices are 1 or 2. Commonly use 1.
Pin 6 Control
If Forced On, the EtherPath responds as if interface pin 6 is always
high. If From Interface, its condition is a read from the RS-232
cabling must be correct for proper operation.
Dial Mode
The choices are “ATD” or “Hardware”. This configures the
EtherPath, when in client mode, to connect to a remote device when
it receives an asserted hardware (pin 6) signal or when it receives
an “ATD” command. For a full-time Nailed-up connection, use
Hardware. See Chapter 5, Point-to-Multiple-Point-Mode for use of
the "AT" setting.
24
Operation
Main Menu Option 4.
Advanced Configuration Screen
Selecting (4) from the Main Menu will display the following:
ADVANCED CONFIGURATION:
Transmit Timer: 10 ms (Mode: IDLE TIMEOUT)
Block Size: 512 Bytes
Flow OFF Buffer Level: 80% Flow ON Buffer
Level: 20%
Line Terminator Character: 13 (Dec) Transmit on LT
Char: OFF
Server End-of-Line Filter: ON
Client Local Character Echo: OFF
25
EtherPath User’s Guide
1. Transmit Timer
When in Timer Mode: The time period for which data will be
stored in the buffer before being sent. Allowable values range from
1ms to 10,000ms (10 seconds). A commonly used value is 20 msec.
When in Idle Timeout Mode: The time period this unit's port must
be idle (after receiving a character) before sending a block of data
via the Ethenet. This is used to keep incoming blocks of data intact.
It is useful for some protocols such as Modbus RTU. Its setting
depends upon the port speed, and should be several character times..
Allowable values range from 1ms to 10,000msec (10 seconds). A
typical value for a 9.6 Kbps port is about 3 msec.
M. Timer Mode
When set to 0, the timer is a free-running clock and if there is data
in the buffer, an IP packet is transmitted every TIMER msec.
When set to 1, the timer is a serial port idle time value. If there is
data in the buffer and the serial port has been idle for TIMER msec,
then an IP packet is transmitted.
2. Block Size
The maximum ethernet packet buffer size. The minimum value is 1
byte, the maximum 4096 bytes (4 K). Typical values are either in a
low range of 10-20 characters for polling applications or very large
in the range of 500 to 1500 for file transfer applications.
Normally, the timer triggers a packet transmission before the block
fills. If the buffer contains BLOCKSIZE characters, an IP packet is
transmitted.
3. Flow Control OFF Buffer Level
If the amount of data stored in the buffer reaches this point, and the
EtherPath is unable to transmit the data, then no further input will be
accepted.
26
Operation
Under normal operation, this will not happen. This is normally left
at the default value.
4. Flow Control ON Buffer Level
Once the High_Water mark has been reached, the “no-input
accepted” mode will continue until the EtherPath has transmitted
enough data to reduce the buffer contents to this point. This is
normally left at the default value.
5. Line_Terminator_Character
This setting is used to change the Line Terminator Character. The
Line Terminator Character causes any data in the buffer to be
transmitted immediately the character is received, provided: This is
the binary value of the trigger charaacter.
• The EtherPath is being used in “Client” mode.
• The following setting (Transmit_on_LT_Char) is ON.
6. Transmit_on_LT_Char
When this setting is ON, any data in the buffer will be sent
immediately upon receipt of a Line_Terminator_Character (see
previous setting). When the setting is OFF, the
Line_Terminator_Character has no effect.
In “Server” mode, this setting has no effect.
7. Server End-of-Line Filter
This setting can turn the filter function ON or OFF.
If ON, then when a CR/LF (Carriage Return, Line Feed) character
pair is received, it is converted to a CR only before it is sent to the
serial port output. CR/LF pairs are normally used in the MS-DOS
environment to mark the end of a line, but may cause problems in
other environments.
CR/NULL character pairs are also converted to a CR only.
27
EtherPath User’s Guide
• If this setting is OFF, then no conversion is done.
• In "Client Mode", this setting has no effect.
8. Client Local Character Echo
If ECHO is ON, the client EtherPath will locally echo all incoming
characters in client mode.
If ECHO is OFF, the client EtherPath will not echo characters or
transmit any status messages to the serial port. This mode should be
used if any messages from the EtherPath would create interference.
OFF is the most commonly used value.
28
Operation
Main Menu Option 5.
Display Settings
Selecting (5) from the Main Menu displays a screen like the
following example.
Local Address: 205.166.54.213 Serial NO:
00:09:AA:00:4A:9E
Remote Address: 205.166.54.220
Gateway Address: (NOT SET) Subnet Mask:
255.255.255.0
Name of Contact Person: Supervisor
Device Name: GW004A9E
Physical Location: Head Office
Client Mode - Remote Port: 3000
IP Fragmentation: ALLOWED
MANAGER CONFIGURATION:
Entry Manager_IP_Addr
***** ***************
1. 0.0.0.0
2. 0.0.0.0
3. 0.0.0.0
4. 0.0.0.0
PORT CONFIGURATION:
Flow Control: NONE
Baud Rate: 38400
Data: 8 Bits Parity: NONE Stop: 1 Bit
Pin 6 Control: FORCED ON
Client Dial Mode: HARDWARE (Pin 6)
ADVANCED CONFIGURATION:
Transmit Timer: 20 ms (Mode: TRANSMIT TIMER)
Block Size: 512 Bytes
Flow OFF Buffer Level: 80% Flow ON Buffer
Level: 20%
Line Terminator Character: 13 (Dec) Transmit on LT
Char: OFF
Server End-of-Line Filter: OFF
Client Local Character Echo: OFF
29
EtherPath User’s Guide
Note that no data can be changed. Pressing any key from the above
screen will return you to the Main Screen.
All data items except the following have been explained on the
preceding pages.
Current Statistics
30
Operation
Port Bytes Transmitted
Number of Characters transmitted through the serial (RS232)
connection.
Current Configuration
Switches Status
Current setting of the DIP Switches.
Current Connection IP Address
The device (PC, terminal, or remote EtherPath) to which the
EtherPath is currently connected through the LAN link. If it is
not connected, this field will display “No active connection”.
31
EtherPath User’s Guide
Main Menu Option 6.
Reset Configuration to Default
Selecting (6) from the Main Menu will restore all values to their
defaults.
If using Telnet, the connection will be lost when the EtherPath
reboots. To reconnect, you must connect to the default IP Address
of 192.168.1.1 or change the EtherPath IP address to one that is
appropriate for your network before rebooting with main menu
option 7.
32
Operation
Chapter 4
Browser Configuration
This Chapter describes how to configure the
EtherPath using a Web Browser. The EtherPath
must have an IP address appropriate to your
network before using this method.
Overview
This configuration method uses your Web Browser to configure the
EtherPath. This provides the most user-friendly interface than the
Telnet/Terminal method.
• The EtherPath must be installed in your LAN before this
configuration method can be used.
• Most Browsers will work. The only requirement is that they
support HTML tables and forms.
Connection Procedure
To establish a connection to the EtherPath, follow this procedure:
33
EtherPath User’s Guide
(IP_Address is the IP address of the EtherPath)
For example, http://192.168.1.1
If you can't connect
If the EtherPath does not respond, check the following:
• The EtherPath is properly installed, LAN connections
are OK, and it is powered ON.
• Check that your PC is using a compatible IP Address
and Network Mask.
In Windows9x variations, the IP Address and Network
Mask can be checked by using Control Panel-Network
to examine the Properties for the TCP/IP protocol.
• If your PC is NOT using an IP Address within the range
192.168.1.2 to 192.168.1.254, with a Network Mask of
255.255.255.0, then you must either change the
EtherPath's IP address using a directly connected
terminal or change your PC to an address in the above
range and reboot. Once the PC will communicate with
the EtherPath, the EtherPath address may be changed,
and the PC reconfigured to its proper address.
• Insure that your browser isn't using a proxy server. If it
is, configure the browser to not use the proxy for the
EtherPath's IP address. (This may not work in Internet
Explorer and you might have to temporarily disable
using the proxy server)
4. Once connected, you will see the first screen. Refer to the
following section for details on using the Web-based interface.
34
Operation
Web-based Interface
The first screen is similar to Figure 2.
35
EtherPath User’s Guide
This screen allows you to change the settings for the RS232 link.
The settings used should match the device connected to the serial
port of the EtherPath.
Note that the EtherPath's serial settings must match the device that
is plugged into THAT EtherPath. The device at the other end of the
Ethernet link may be set differently.
Flow Control
The choices are “None”, “XON/XOFF”, and “RTS/CTS”. It is
common to use NONE for installation troubleshooting, then set it
correctly to match the connected device. If RTS/CTS is used, the
cables must have handshake lines wired correctly.
36
Operation
Baud Rate
Speeds between 300 bps and 230.4Kbps are supported.
Parity
The choices are “None”, “Odd”, or “Even”.
Data Bits
The choices are 7 or 8. This does NOT include the parity bit. The
two most common settings are 7 bit PLUS appropriate parity or 8
bit with NO parity.
Stop Bits
The choices are 1 or 2. Commonly use 1.
Dial Mode
The choices are “ATD” or “Hardware”. This configures the
EtherPath, when in client mode, to connect to a remote device when
it receives an asserted hardware (pin 6) signal or when it receives
an “ATD” command. For a full-time Nailed-up connection, use
Hardware. See Chapter 5, Point-to-Multiple-Point-Mode for use of
the "AT" setting.
37
EtherPath User’s Guide
38
Operation
Transmitted through the LAN connection.
Packet Errors Number of packets containing errors transmitted
or received by the EtherPath through the LAN
connection.
Under normal conditions, this should be 0.
39
EtherPath User’s Guide
Advanced Configuration Screen
40
Operation
When in Idle Timeout Mode: The time period this unit's port must
be idle (after receiving a character) before sending a block of data
via the Ethenet. This is used to keep incoming blocks of data intact.
It is useful for some protocols such as Modbus RTU. Its setting
depends upon the port speed, and should be several character times..
Allowable values range from 1ms to 10,000msec (10 seconds). A
typical value for a 9.6 Kbps port is about 3 msec.
Timer Mode
When set to 0, the timer is a free-running clock and if there is data
in the buffer, an IP packet is transmitted every TIMER msec.
When set to 1, the timer is a serial port idle time value. If there is
data in the buffer and the serial port has been idle for TIMER msec,
then an IP packet is transmitted.
Block Size
The maximum Ethernet packet buffer size. The minimum value is 1
byte, the maximum 4096 bytes (4 K). Typical values are either in a
low range of 10-20 characters for polling applications or very large
in the range of 500 to 1500 for file transfer applications.
Normally, the timer triggers a packet transmission before the block
fills. If the buffer contains BLOCKSIZE characters, an IP packet is
transmitted.
Flow Control OFF Buffer Level
If the amount of data stored in the buffer reaches this point, and the
EtherPath is unable to transmit the data, then no further input will be
accepted.
Under normal operation, this will not happen. This is normally left
at the default value.
41
EtherPath User’s Guide
Flow Control ON Buffer Level
Once the High_Water mark has been reached, the “no-input
accepted” mode will continue until the EtherPath has transmitted
enough data to reduce the buffer contents to this point. This is
normally left at the default value.
Line_Terminator_Character
This setting is used to change the Line Terminator Character. The
Line Terminator Character causes any data in the buffer to be
transmitted immediately the character is received, provided: This is
the binary value of the trigger character.
• The EtherPath is being used in “Client” mode.
• The following setting (Transmit_on_LT_Char) is ON.
Transmit_on_LT_Char
When this setting is ON, any data in the buffer will be sent
immediately upon receipt of a Line_Terminator_Character (see
previous setting). When the setting is OFF, the
Line_Terminator_Character has no effect.
In “Server” mode, this setting has no effect.
Server End-of-Line Filter
This setting can turn the filter function ON or OFF.
If ON, then when a CR/LF (Carriage Return, Line Feed) character
pair is received, it is converted to a CR only before it is sent to the
serial port output. CR/LF pairs are normally used in the MS-DOS
environment to mark the end of a line, but may cause problems in
other environments.
CR/NULL character pairs are also converted to a CR only.
• If this setting is OFF, then no conversion is done.
• In "Client Mode", this setting has no effect.
42
Operation
Client Local Character Echo
If ECHO is ON, the client EtherPath will locally echo all incoming
characters in client mode.
If ECHO is OFF, the client EtherPath will not echo characters or
transmit any status messages to the serial port. This mode should be
used if any messages from the EtherPath would create interference.
OFF is the most commonly used value.
This screen allows you to set all data relating to your LAN.
43
EtherPath User’s Guide
Local IP Address
The IP address of this EtherPath device on your LAN. The default
IP Address is 192.168.1.1
Remote IP Address
In “Client” mode, this is the IP address of the remote “Server”
device which this client will automatically connect to when powered
up (if RS-232 PIN 6 is high or forced) and configured for hardware
dialing. This is also the default server that will be used for AT
dialing when in PMP mode.
In “Server” mode, this value is not required, and will be ignored.
Gateway IP Address
If the remote EtherPath (in “Client/Server” mode) is not on the same
LAN, then the gateway to the other LAN must be entered here.
Subnet Mask
The network mask indicates what class of TCP/IP network you
have. The default value is for a class “C” network, with up to 255
users. This value should work in small networks. If in doubt, consult
your network administrator.
Name of Contact Person: Supervisor
This is a text field. It can be used to store the name of the person
responsible for the Serial Port Device.
Device Name
This is a text field. It can be used to store a descriptive name for the
device.
Physical Location
This is a text field. It can be used to store a the location of the
device.
44
Operation
Port Number
This is the TCP/IP port number the EtherPath listens on when in
server mode. The default is port 3000. When in client mode, this is
the port on the remote server that a connection is attempt with. This
value may be overridden when in Ethermodem mode by including a
port number in the ATD command.
IP Fragmentation
If set to ZERO, IP blocks sent from this EtherPath may be
fragmented in transit, and blocks may be fragmented by the
EtherPath. If set to ONE, the 'DONTFRAG' bit is set in IP packets,
and all blocks are transmitted intact. This is normally set to 0 , but
is set to 1 for some SCADA applications. The default is 0.
45
EtherPath User’s Guide
Overview
This screen may be ignored if SNMP is not used.
These are text fields, commonly used in SNMP (Simple Network
Management Protocol) Programs to identify this device when
browsing the network.
These values have no effect on the operation of the EtherPath. Other
standard MIB values are returned to the SNMP manager along with
this information.
46
Operation
Contact Person
This text field can be used to store the name of the person
responsible for the Serial Port Device.
Device Name
This can be used to store a descriptive name for the device.
Physical Location
This can be used to store he location of the device.
47
EtherPath User’s Guide
Operation
• This screen displays all current settings for this EtherPath
• Clicking the "Set to Defaults" button will restore ALL
values to their factory default values.
When this is done, the EtherPath will reboot, and the
existing connection will be lost. You must reconnect using
the default IP Address of 192.168.1.1.
48
Chapter 5
Operation
This Chapter explains how to use the EtherPath,
once it is installed and configured. Although it
may be used with automated equipment such as
RTUs, POS, or other computer-based devices; the
example configurations shown in this chapter use
terminals or terminal emulation on a PC for
illustrations. It is often useful to set up the
EtherPath using this method before connecting
other equipment.
49
EtherPath User’s Guide
configuration if hardware dialing is enabled and pin 6 is
asserted.
• You may now proceed as if the remote serial port device was
directly connected to the serial port of your local serial device.
• If Pin 6 control is set to From Interface, then the serial device
must provide a high level signal on pin 6 before the EtherPath
will accept or place an Ethernet connection.
50
Operation
Server Mode
• Install and connect the EtherPath and Serial Port Device as
described in Chapters 3 and 4.
• Any PC or workstation on the LAN/WAN should now be able
to use Telnet to connect to the Serial Port Device with the
command:
telnet IP_Address Port_number
Where IP_Address is the IP address of the EtherPath, and
Port_number is the configured value (default value is 3000).
For example, if the default IP address and port number have not
been changed (and they are appropriate for your network), then
you would enter the command:
telnet 192.168.1.1 3000
• You should see a “Connected” message from the telnet client
when the connection is established. Some telnet clients don’t
display this message.
• You may now proceed as if the remote serial port device was
connected to the serial port of your PC or workstation.
• If there is a firewall in the link between the EtherPath and your
workstation, you may need to configure it to pass packets using
the port number configured into the EtherPath.
Client/Server Point-to-Multiple-Point
(EtherModem) Mode
• EtherModem mode requires multiple EtherPaths configured in
“Server” mode and a single EtherPath configured in “Client”
51
EtherPath User’s Guide
mode. Under user control with "AT" commands, the “Client”
connects to multiple “Servers”, one at a time similar to the way
a dial-up modem would. "Server" and "Client" refer to the
operational mode settings of the EtherPath.
• All EtherPaths must be connected as described in Chapters 3
and 4. One serial port device is connected to each “Server”
EtherPath, and additional serial devices (usually a workstation)
are connected to the “Client” EtherPaths.
• The “Client” EtherPath must be configured for “ATD” dialing.
This is the unit that will place the calls to the other EtherPaths.
• At the “Client” end, start the Terminal emulation program (or
use a real terminal). The communication settings for this device
must be the same as the values entered into the “Client”
EtherPath device earlier.
• Power up the local EtherPath. It will be in command mode,
awaiting a connection command. Type the command “AT
<enter>” to test the RS-232 connection. It should answer with
an “OK” message. If not, check the serial port rate and wiring
connections. “Dial” a remote EtherPath by using an “ATD”
dial command.. “ATD1.2.3.4:5555” , where 1.2.3.4 is the IP
address of the remote EtherPath and 5555 is the optional
connection port number configured in the remote EtherPath.
The EtherPath will automatically connect to the remote
EtherPath. If an address isn’t given, the IP address stored
during configuration is used. If a port isn’t given, the port
number stored during configuration is used.
• Upon establishing a connection, a “Connect” message is
displayed. If unable to establish a connection a “Busy”
message is displayed.
• You may now proceed as if the remote serial port device was
connected to the serial port of your workstation.
52
Operation
• Disconnect from that remote EtherPath with either the “+++”
command followed by “ATH” or by lowering the hardware lead
on pin six.
• See the Appendix for a complete list of AT commands and
responses.
53
EtherPath User’s Guide
54
Operation
55
EtherPath User’s Guide
This page intentionally blank.
56
Chapter 6
Troubleshooting
This chapter outlines some problems that may
occur during installation or operation and some
possible solutions to them.
Hardware Problems
Before anything else, check that all cables used are wired
correctly and properly connected.
P2: When using 10Base-T cabling, the EtherPath unit does not
work.
S2: Check the Hub’s link LED for the port to which theEtherPath is
connected. If it is off, make sure the network cable between the
EtherPath and hub is in good condition. You may only use one
of the LAN connections at a time. Make sure the Hub supports
57
EtherPath User’s Guide
10BaseT or 100BaseT. Sometimes it helps to move the
network cable to a different hub port or power cycle the hub
(especially when using smart hubs or Ethernet switches).
58
Troubleshooting
59
EtherPath User’s Guide
configuration to set a compatible IP Address in the
EtherPath.
• Check that you have used the correct port address. The
default address is “3000” for normal operation and “8000”
for configuration.
• Is there a firewall in the Ethernet path. If so, it must be
configured to pass the ports in use by the EtherPath.
• Are you trying to connect to the EtherPath data port with a
web browser? That only works for configuration.
• Web Browsers often are configured to use a proxy server.
The browser might need to be configured to NOT use the
proxy when connecting to the EtherPath, or the proxy
server may be configured to pass the requests correctly.
• MOST EtherPath connection problems are due to incorrect
RS-232 wiring. The second most common errors are
incorrect IP addressing on either the EtherPath or on the
PC used for testing.
60
Troubleshooting
Other Problems
61
EtherPath User’s Guide
• The communication parameters between the PC/terminal
and the local (“Client”) EtherPath match.
• The communication parameters between the serial port
device and the remote (“Server”) EtherPath match.
P6: Why does the "Server Mode" EtherPath close the TCP/IP
connnection to the "Client Mode" EtherPath (or other client
program).
S6: The "Server Mode" EtherPath will disconnect the link if it does
not receive any packets from the "Client Mode" EtherPath (or
other client program) within a 3 mintue period or if hardware
pin 6 is lowered. See Appendix B for more details.
P7: The connection works, but is too slow.
S7: If in Transmit timer mode, lower the transmit timer to send
packets more frequently. 20 to 30 msec. is a good range for
many users. If in Idle timeout mode perhaps the serial data rate
may be increased so characters arrive at the EtherPath faster.
62
Troubleshooting
63
Appendix A
Specifications
EtherPath Specifications
• Flash Memory: 512 Kbytes
• SRAM: 256 Kbytes
• EEPROM: 512 Bytes
• LAN Buffer: 2 Kbytes
• RS-232 Buffer: 4 Kbytes
• RS-232: one male DE-9 connector
• Network: Ethernet 10Base-T/ 100Base-T
• CPU: 16 Bit
• Power: 9 to 12 VDC (260 ma) or Optional power supplies
• Switch: Configuration
• LED: 3 multi-purpose
• Default IP address: 192.168.1.1
• Default Receive port: 3000
64
Specifications
65
EtherPath User’s Guide
66
Specifications
RTS
Output. Input flow control. When the internal buffer reaches the
“Flow Off” buffer level, this signal is lowered. When the buffer
level decreases to the “Flow ON” buffer level, this signal is raised.
CTS
Input. When Flow Control is set for CTS/RTS, lowering this signal
will halt data flow from the EtherPath RS-232 port.
Ring Indicator
Not used
67
EtherPath User’s Guide
CABLES
Commonly used cable connections:
SS-1 PC
1,6 4
2 3
3 2
4 1,6
5 5
7 8
8 7
RJ-45 DE-9S
1 BLU N/C
2 ORG N/C
3 BLK 4,1,6
4 RED 5
5 GRN 2
6 YEL 3
7 BRN 8
8 WHT 7
68
Specifications
SS-1 to Modem
Specialty Cables
1 WHT / ORG 3
2 ORG / WHT 6
3 WHT / GRN 1
4 BLU / WHT N/C
5 WHT / BLU N/C
6 GRN / WHT 2
7 WHT / BRN N/C
8 BRN / WHT N/C
69
EtherPath User’s Guide
Appendix B
Programming
This Appendix explains the EtherPath's remote
programming interface. This is not used in most
applications. The information is for those writing
programs to access the EtherPath via the Ethernet.
Introduction
It is rather straightforward to implement a software application to
communicate with serial devices through the EtherPath. Topics
covered in this appendix are:
• EtherPath description and behavior
• Application notes
• Links to sample code
In addition to user-written software applications, there are “port
redirector” software packages that work quite well with the
EtherPath. If you are not a "network programmer", then port
redirector may be the quickest way to get an application on-line.
For UNIX systems (AIX, Linux, SCO5, FreeBSD, OSF), Termnet
works quite well. It is GNU’d freeware available from
http://www.dcbnet.com or http://www.linuxlots.com
For Microsoft Windows systems, Serial/IP is an excellent low-cost
program, also available from http://www.dcbnet.com.
70
Specifications
Server Mode
In Server mode, the EtherPath runs under the TCP/IP network
protocol. It will listen on a configured port number. The server will
wait for connection after initialization.
After a connection is established, the server always keeps checking
for data on both Ethernet and Serial Ports.
71
EtherPath User’s Guide
If data from the Ethernet network is received, it will first check for a
special control symbol, filter it if found and then send the rest of the
data to the serial port.
If data from the serial port is received, it will read the data from the
serial buffer, move the data into the network buffer and send it by
Ethernet to the application when the buffer is full or on the next tick
of the transmit timer.
Transmit Conditions
The EtherPath will transmit an Ethernet packet when any of these
conditions are met:
• Transmit Timer is up and running in Transmit Timer Mode
• Idle Timer is up and running in Idle Timeout Mode.
• Transmit Buffer full
• LT Character is encountered and Transmit on Line Terminator
Function is ON ( Client Only )
72
Specifications
73
EtherPath User’s Guide
Application Notes
There are a number of application notes available from the DCB
web site at http://www.dcbnet.com . These cover port redirection,
selecting the proper product (EtherPath vs. EtherPoll), SNMP,
middleware for the EtherPath, a demonstration client-server
software system, and other issues.
A complete copy of the SNMP MIB is available from the same site
along with a free port redirector program (along with source code)
for various UNIX workstations. A trial port redirector program for
Windows is also available. A demonstration program for a
Windows workstation is printed in the next section.
These and more are available in the Education section of that web
site.
74
Specifications
Example Code
In addition to the UNIX port redirector program, a client program
which connects to a EtherPath configured in server mode is
available on the DCB website in source code form. It is written for
Microsoft Windows in Microsoft C. This is located at
http://www.dcbnet.com under the support section.
75
EtherPath User’s Guide
Appendix C
AT Command
Summary
This Appendix explains the EtherPath's AT
command set operation and responses.
AT Commands
The EtherPath recognizes the following AT commands (when
AT Dialing is enabled):
76
Specifications
AT Command Responses
The serial port responses depend on the ATE setting:
Verbose Terse
OK 0
CONNECT 1
CARRIER 3
ERROR 4
BUSY 7
AT Command Operation
When ATE1 is in effect, there are some addition error
messages such as "Invalid IP address" and "Invalid Entry"
77
EtherPath User’s Guide
Appendix D
RS-422/ RS-485
Interface
This Appendix describes the EtherPath's 4-2843
RS-422/485 interface. This interface option may
be jumper configured in the field or pre-configured
at the factory.
Introduction
The 9-pin serial connector on the EtherPath may be for either RS-
232 or RS-422 (4-wire RS-485 point-to-point) operation using
internal jumpers.
RS-232 Setting
ALL jumpers should be placed in the positions nearest the board
edge.
79