Equinox Systems ESP-2 OPTO Installation and User Manual

Brand: Equinox Systems

Model: ESP-2 OPTO

Type: Installation and User Manual

ESP-2 OPTO Serial Hub

Installation and User Guide

590-397-001B

October 2004

Equinox ESP-2 OPTO Serial Hub Installation and User Guide iii

Contents

Section 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

1.1 What You Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Section 2 - Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

2.1 Pin Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.2 Electrical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3 Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.4 Installing the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Installing on a table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Installing on a wall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.5 Installing the Ferrite Core (POE Only). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.6 Reinitializing and Resetting the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Reinitializing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Resetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Section 3 - Serial Port Connection Methods and Attributes . . . . . . . . . .9

3.1 Serial Port Redirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.2 Telnet Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3.3 Raw TCP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3.4 Raw TCP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

3.5 Configuration Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3.6 Serial Port Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Section 4 - Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

4.1 Accessing the Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.2 About the Web Interface Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.3 Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.4 Displaying or Changing Network Configuration Values . . . . . . . . . . . . . . . . . . 16

4.5 Displaying or Changing Port Attributes and Connection Methods . . . . . . . . . . 17

4.6 Displaying Hardware Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.7 Displaying or Updating FLASH Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

4.8 Displaying or Changing Configurable Features . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.9 Downloading a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4.10 Displaying General Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.11 Displaying Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

4.12 Displaying Connection Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4.13 Rebooting the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4.14 Reinitializing the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Section 5 - Configuration Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

5.1 Accessing the Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Accessing with Telnet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Accessing a hub with no configured IP address . . . . . . . . . . . . . . . . . . . . . . . . 24

Accessing on port 1 or 2 using the configuration utility connection method . . 24

5.2 About the Configuration Utility Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

5.3 Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

iv Equinox ESP-2 OPTO Serial Hub Installation and User Guide

5.4 Displaying or Changing Network Configuration Values . . . . . . . . . . . . . . . . . . 26

5.5 Displaying or Changing Port Attributes and Connection Methods . . . . . . . . . . 27

5.6 Displaying Hardware Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

5.7 Displaying or Updating FLASH Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

5.8 Displaying or Changing Configurable Features . . . . . . . . . . . . . . . . . . . . . . . . . 29

5.9 Downloading a Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

5.10 Rebooting the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.11 Reinitializing the Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.12 Displaying General Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.13 Displaying Port Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

5.14 Displaying Connection Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

5.15 Displaying and Using Debug Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Section 6 - Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

6.1 Sample Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.2 File Format and Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

6.3 Port Connection Method Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Port Redirection command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Port Telnet Server command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Port TCP Server command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Port TCP Client command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Port Configuration Utility command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

6.4 Port Attributes Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

6.5 Network Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

6.6 Configurable Features Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6.7 Initiating a Configuration File Download. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

6.8 Completion Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 1

Section 1 - Introduction

The Equinox ESP 2-port OPTO serial hub contains an autosensing 10/100 Ethernet

port plus two optically-coupled RS-232 serial ports. The optical coupling uses ground

and positive voltage from the target devices (TDs) that are attached to the ESP-2

OPTO hub serial ports; there is no metallic connection between the ESP-2 OPTO hub

and the TD or between the two TDs. This ensures proper current flow, even when the

TD and the ESP-2 OPTO hub are attached to different electrical power circuits using

different ground references.

Modular adaptors are available to facilitate the connection between the ESP-2 OPTO

serial hub and the TD.

Two models are available. The ESP-2 OPTO model uses an Equinox external power

supply (PS), which is provided with the hub. The ESP-2 OPTO POE model supports

power supplied by an Ethernet hub, compatible with IEEE 802.3af, Power over

Ethernet (POE). The POE model may alternatively use the Equinox external PS. See

Electrical on page 5 for more information.

All ESP-2 OPTO serial hubs support several ways to access the serial ports (see

Serial Port Connection Methods and Attributes on page 9 for detailed information

about each connection method):

• Serial port redirection

• Telnet server

• Raw TCP server

• Raw TCP client

• Configuration utility

Serial port redirection uses Equinox drivers installed on a host computer. The ESP-2

serial hub drivers are supported on the following operating systems:

Windows

2000 Windows XP

Windows NT

4.0 Windows Server 2003

OpenServer™ 5.0.5a or higher UnixWare

7.0.1a or higher

Linux

AIX

4.3 and 5.1

Sun

Solaris

™

for X86 or SPARC 8 or higher

For serial port redirection, the ESP-2 hub is configured using the appropriate

drivers running on any Microsoft Windows host, or espdiag and espcfg for

OpenServer, UnixWare, Linux, Sun or AIX. Certain configuration values are set

during driver installation.

All other connection methods do not require the use of drivers.

You may configure and manage the ESP-2 serial hub using the following methods:

• Web interface - see Web Interface on page 15.

• Configuration utility - see Configuration Utility on page 24.

• Configuration files - see Configuration Files on page 32.

2 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

• EquiView Plus (Windows/NT systems and later), espcfg and espdiag (Unix sys-

tems) - these utilities have limited support for connection methods other than port

redirection. EquiView Plus is included on the Equinox SuperSerial Software CD,

and provides a guided interface. For EquiView Plus information, see the CD or

the Equinox web site, www.equinox.com, for instructions.

The web interface and the configuration utility offer the most comprehensive sets of

available operations.

The ESP-2 hub supports attended and unattended configuration. With attended

configuration, you set values and request actions directly through the web interface or

the configuration utility. Unattended configuration uses a flat text file containing

configuration commands. The commands are processed as if they were requested

using the web interface or the configuration utility. The command file may be read by

BootP during initial ESP-2 hub configuration. Downloading a command file may also

be requested using the web interface and configuration utility. See Configuration

Files on page 32 for more information.

1.1 What You Get

The ESP-2 OPTO serial hub model includes an external power supply with an

attached PS-to-unit barrel connector. The line cord for the power supply is

appropriate to the intended country of operation.

Table 2 lists the modular adaptors available from Equinox that allow a serial CAT 5

straight-through cable to mate with the connector on the TD.

An optional power supply that uses a connector on these adaptors is also available;

see Electrical on page 5 for more information.

Table 1: ESP-2 OPTO Hub Kit Contents

Part Number Description

520-351

-or-

520-352

ESP-2 OPTO Serial Hub (plus external power supply and line cord)

-or-

ESP-2 OPTO POE Serial Hub

590-397 Installation Guide (this document)

021-0013 Split/Snap-On Ferrite Core

Table 2: Modular Adaptors

Part Number Allows CAT 5 cable to mate with this connector on TD

210113 DB-9 Female DCE

210114 DB-9 Male DTE

210115 DB-25 Female DCE

210116 DB-25 Male DTE

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 3

Section 2 - Hardware

All connectors, LEDs and buttons are on the front of the ESP-2 OPTO serial hub, as

shown in Figure 1.

Figure 1: ESP-2 OPTO Serial Hub

The POWER connector is located in the lower left corner of the front panel; see

Electrical on page 5 for more information.

The Ethernet port supports 10/100 auto detect (speed and duplex) connections. The

LAN connector accepts 10BaseT or 100BaseT LAN interface cable. A CAT 5 cable

is required for 100BaseT operation. Table 5 on page 4 lists the pin assignments.

The PORT 1 and PORT 2 connectors are standard RJ-45 8-pin jacks. Table 4 on

page 4 lists the pin assignments.

Table 3 describes the LEDs and buttons on the front panel.

2.1 Pin Assignments

Table 4 lists the pin assignments for each port’s RJ-45 connector. This information is

also provided on a label on the bottom of the hub.

Table 3: LEDs and Buttons

Item Description

POWER The POWER LED is lit when the hub is connected to a power source.

ON LINE

The ON LINE LED is lit (not blinking) when the hub’s self-test and

initialization procedures have completed successfully.

The 10 LED is lit when the hub is connected to a 10 Mbps LAN, and the 100

LED blinks when traffic is present.

100

The 100 LED is lit when the hub is connected to a 100 Mbps LAN, and the 10

LED blinks when traffic is present.

RESET Pushing the RESET button reboots the hub; see Resetting on page 8.

INIT

Pushing and holding the INIT button restores the hub to factory defaults; see

Reinitializing on page 8.

4 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

Table 5 lists the pin assignments for the RJ-45 shielded Ethernet connector. The 4-

wire power and 8-wire power columns apply to ESP-2 OPTO hubs that use POE;

additional information follows the table.

Table 4: Serial Port Assignments

Pin Signal Direction Description

1 N/C * N/C * N/C *

2 DSR ** Input from TD

Data Set Ready (DSR) is driven by the remote device’s Data

Terminal Ready (DTR) signal and is used to power TxD pin 5

3 N/C * N/C * N/C *

4 RxD Input from TD Receive Data (RxD)

5 TxD Output to TD

Transmit Data (TxD) is powered by pin 2 and/or pin 8, with pin

6 as the return

6 GND To TD only

Signal Ground; this is an isolated return for TxD and RxD with

no connection to the hub’s logic or chassis ground

7 N/C * N/C * N/C *

8 CTS ** Input from TD

Clear to Send (CTS) is driven by the remote device’s Ready

to Send (RTS) signal and is used to power TxD pin 5

* Unused pins (labeled N/C) should not have wires attached to them. Floating wires could

cause unbalanced noise, shorten overall distances and degrade performance.

** DSR and CTS are required for operation, but are not seen by the hub’s CPU.

Table 5: Ethernet Connector Pin Assignments

Pin Signal 4-Wire Power 8-Wire Power

1 Transmit Data + +48 or -48 VDC N/A

2 Transmit Data - +48 or -48 VDC N/A

3 Receive Data + -48 or +48 VDC N/A

4 * N/A +48 or -48 VDC

5 * N/A +48 or -48 VDC

6 Receive Data - -48 or +48 VDC N/A

7 * N/A -48 or +48 VDC

8 * N/A -48 or +48 VDC

* These pins are usually connected in a standard CAT 5 cable. There is special termination

for those signals in the interface to eliminate any problems if they are connected.

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 5

In powered network cables with two twisted pairs (4-wire cables), DC power of one

polarity is present on the TX pair (1 and 2) and the opposite on the RX pair (3 and 6).

The polarity itself is undefined. In powered network cables with the full CAT 5 cable

(4 twisted pairs), power may be provided as described for the two-pair method or over

the two spare twisted pairs (polarity undefined), but not both. The ESP-2 OPTO serial

hub will automatically accept either method.

2.2 Electrical

All ESP-2 OPTO serial hubs support a Universal 5 VDC power supply (PS). This

external supply, which must be supplied by Equinox, has a standard IEC AC input

connector that accepts power cords for USA and international power connections.

The ESP-2 OPTO hub model includes the PS and a line cord.

The ESP-2 OPTO POE hub model supports power supplied by an Ethernet hub

compatible with IEEE 802.3af, Power over Ethernet. The POE model also supports

the 5 VDC PS, which may be ordered separately.

In environments where a DTR or RTS RS-232 signal is not available to power the

TxD signal, a Universal PS can supply 9 VDC using a connector on a modular

adaptor at the TD. This Universal supply has a standard IEC connector for the AC

input power cord. This PS may be ordered from Equinox.

Surge protection is provided for each serial port up to 15,000 volts electrostatic

discharge (ESD).

2.3 Technical Specifications

Table 6 lists the ESP-2 OPTO serial hub technical specifications.

2.4 Installing the Hub

The ESP-2 serial hub may be installed on a table or on a wall.

WARNING: For hubs that use the power supply, the power outlet should be near the equipment

and be easily accessible.

You may replace an existing ESP-2 OPTO hub with a similarly configured hub

without affecting the server or having to reconfigure the ports.

Table 6: Operating Specifications

Specification Operating Range

Dimensions 4.75”W x 4.38”D x 1.62”H

Temperature

to 50

C (32

to 122

Humidity 10 to 90% non-condensing

Power +5 VDC at less than 450 ma

6 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

Installing on a table

The ESP-2 hub ships ready to use in a tabletop environment. This includes four

rubber feet on the bottom of the hub.

Installing on a wall

The ESP-2 hub contains two sets of mounting flanges for flexibility in mounting

options on a wall or other vertical surface. You will need to provide the appropriate

number of screws and washers.

• You may install the hub with the bottom (the side containing the large label)

against the wall, using the four flanges on the bottom of the hub.

The hub ships with rubber feet installed in these flanges for tabletop installation.

Remove them by grasping the bottom of each foot and gently pulling it down and

out of the hole. Then, use your screws and washers to attach the hub to the wall.

• You may install the hub with the back against the wall, using the two flanges on the

back. In this case, you may remove the four rubber feet on the bottom of the hub or

leave them installed. Use your screws and washers to attach the hub to the wall.

With either installation, you may orient the hub to best fit your configuration.

To initiate the startup sequence and configure the IP address:

1. The MAC address is printed on a label on the bottom of the hub. This address

will be used as a Unit ID to distinguish different ESP hubs on the network.

Record the MAC address.

00 - 80 - 7D - _____ - _____ - _____

2. Attach a 10BaseT or 100BaseT LAN interface cable to the LAN connector on the

front of the hub. A CAT 5 cable is required for 100BaseT operation.

If the hub’s power will be supplied through the external power supply, attach the

other end of the LAN interface cable to the Ethernet hub or switch

3. Connect devices to the serial ports on the front of the hub, using appropriate

cables (and adaptors, if needed).

4. Make the power connection for the hub.

a. If the hub’s power will be supplied through the external power supply, plug

the barrel connector of the PS into the front of the ESP-2 hub, then attach the

line cord connector to an appropriate power source.

b. If the hub’s power will be supplied through Power-Over-Ethernet, attach the

open end of the LAN interface cable to the Ethernet hub or switch.

5. Configure the IP address:

If you are using the web interface, you may initially access the hub using the

predefined IP address (see Accessing the Web Interface on page 15), then

configure the network address information (see Displaying or Changing Network

Configuration Values on page 16).

-or-

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 7

The configuration utility is automatically enabled on port 1. Using a terminal

emulation program of your choice (with a serial connection at 19200 baud, 8 bits,

no parity and one stop bit), you may access the configuration utility on this port

(see Accessing the Configuration Utility on page 24), then configure the network

address information (see Displaying or Changing Network Configuration Values

on page 26).

-or-

If you are using the serial port redirection connection method, install the ESP

drivers included on the CD (be sure to check the Equinox web site,

www.equinox.com, for the latest version). If you are using a Windows host

system, install the EquiView Plus version 5.2 management utility included on the

distribution CD (or downloaded/updated from the Equinox web site). The

Release Notes also contain driver installation information.

-or-

If you are using a configuration file with a BootP or DHCP server, consult your

operating system documentation to determine how to configure the BootP or

DHCP server.

• After the ESP-2 hub acquires an IP address (by any method), it will no

longer use BootP or DHCP. Therefore, you cannot change the network

values using this method.

• The ESP-2 hub requires a permanent IP allocation. If you are using DHCP, it

must have an infinite lease on the assigned IP address; an IP address with a

finite lease will not be accepted.

The BootP or DHCP server may also specify a configuration file using the

“bootfile” parameter. See Configuration Files on page 32 for more information.

2.5 Installing the Ferrite Core (POE Only)

A split/snap-on ferrite core (part number 021-0013) is included in the shipment. It is

recommended that this be used to further suppress electromagnetic interference

(EMI) for ESP-2 POE hubs by installing the ferrite core on the LAN (Ethernet) cable.

Use Figure 2 for reference.

Figure 2: Ferrite Core

8 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

To install the ferrite core:

1. Open the ferrite case and thread the network cable through the center so that the

ferrite is approximately 1-2 inches from the plug.

2. Wrap the other end of the cable around the ferrite casing to thread it through a

second time.

3. While stretching the cable to create a snug fit, carefully bring the other side of the

ferrite case over and snap it in place. Be careful to avoid crimping or squeezing

any part of the cable.

Use of the ferrite core is the responsibility of the user. The ESP-2 OPTO hub

generates, uses and may radiate radio frequency energy and, if not used in accordance

with these instructions, may cause harmful interference to radio communications.

2.6 Reinitializing and Resetting the Hub

The information in this section is not a standard part of the startup sequence;

however, it is provided for reference if the serial hub must be reinitialized or reset.

Reinitializing

The INIT button on the front panel may be used to remove configured information

from an ESP-2 hub. The hub stores nonvolatile data such as SNMP community name,

system contact and IP address in the EEPROM. This information is erased by

pressing and holding the INIT button until reinitialization occurs.

When the INIT button is first pressed, the ON LINE LED will begin to blink to

confirm that you have pressed the INIT button. As the INIT button remains pressed,

the ON LINE LED will blink at a faster rate. After approximately 12 seconds, the ON

LINE LED will turn off. At this point, all nonvolatile information will be reset to the

factory defaults and the hub will immediately reboot.

You may also reinitialize the hub using the web interface (see Reinitializing the Hub

on page 23) or the configuration utility (see Reinitializing the Hub on page 30).

Resetting

The RESET button on the front panel may be used to reset the serial hub. Pushing this

button will cause an immediate reboot.

You may also reset (reboot) the hub using the web interface (see Rebooting the Hub

on page 22) or the configuration utility (see Rebooting the Hub on page 30).

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 9

Section 3 - Serial Port Connection Methods and Attributes

There are several methods a remote device may use to access a serial port on an ESP-2

OPTO hub and then transmit/receive data from that port:

• Serial port redirection - see page 9

• Telnet server - see page 10

• Raw TCP server - see page 11

• Raw TCP client - see page 12

• Configuration utility - page 13

Each connection method may be separately enabled or disabled for each ESP-2 port. A

port may have multiple connection methods enabled, with the following exceptions:

• The raw TCP client connection method is exclusive; that is, when it is enabled on

a port, no other connection methods can be enabled for that port. (Conversely, if

other connection methods are enabled for a port, you cannot enable the raw TCP

client connection method on that port until you disable the other methods.)

• If you enable the raw TCP server connection method and enable the idle TCP

buffering option on a port, then the TCP server connection method becomes

exclusive; no other connection methods can be enabled for that port.

In any case, a port may be actively open and used by only one method at a time.

You may configure port connection methods using:

The web interface - see Displaying or Changing Port Attributes and Connection

Methods on page 17.

-or-

The configuration utility - see Displaying or Changing Port Attributes and

Connection Methods on page 27.

-or-

A configuration file - see Port Connection Method Commands on page 33.

Serial port attributes may be configured for all connection methods.

3.1 Serial Port Redirection

The serial port redirection connection method uses an ESP-2 driver on a host

computer to communicate with the ESP-2 serial hub. The driver creates a virtual

COMM or tty port interface within the host’s operating system.

Table 7 describes this method’s configurable items for each serial port.

Table 7: Serial Port Redirection Configurable Items

Item Description

Enable/

disable

Enables or disables the serial port redirection connection method on the serial

port. The default value is enabled. This method cannot be enabled if the raw

TCP client connection method is already enabled for the port.

10 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

To use the serial port redirection connection method, you must install drivers on the

host computer. See the Release Notes posted on the Equinox web site,

www.equinox.com, for information.

3.2 Telnet Server

The Telnet server connection method allows a user to make a Telnet connection to a

serial port on the ESP-2 hub and then transmit/receive data using the standard Telnet

protocol. This method is also known as reverse Telnet.

When this method is enabled, the Telnet server within the ESP-2 hub will accept a

connection from any valid remote IP address. There is no filtering of remote

addresses. The connection will be accepted only if the port is not already open and in

use by any connection method, including an existing Telnet session on that port. If the

port is currently in use, the connection request will be rejected.

The Telnet session will remain established until the remote client ends the session, the

Telnet TCP socket is broken or the inactivity time-out (if enabled) occurs.

Table 8 describes this method’s configurable items for each serial port.

Serial

buffering

Specifies the length of time accumulated serial data should be buffered before

being sent to the remote server. Valid values are 0-65535 hundredths of a second.

For example, a value of 100 indicates that once serial data is received, the

ESP-2 hub will buffer the data until 1 second (100 hundredths of a second) has

elapsed, at which time all data will be sent.

A 0 value indicates that data will be sent as soon as it is available. The default

value is 0 (send immediately). If the buffer becomes half full, the time is

ignored and the data is sent.

Table 8: Telnet Server Connection Method Configurable Items

Item Description

Enable/

disable

Enables or disables the Telnet server connection method on the port. The

default value is disabled. This method cannot be enabled if the raw TCP client

connection method is already enabled for the port.

Local IP port

number

Specifies the IP port number on which the Telnet server will listen. This value

cannot conflict with the port numbers specified for other enabled connection

methods on either port. Valid values are 1024-65535. The default value is 3001

for port 1 and 3002 for port 2.

Inactivity time-

out

Specifies the length of time before the Telnet session is disconnected if there is

no activity. Valid values are 0-65535 seconds.

For example, a value of 60 indicates the Telnet session will be disconnected if

there is no activity for a period of 60 seconds.

A 0 value disables the inactivity time-out. The default value is 0 (disabled).

Table 7: Serial Port Redirection Configurable Items (Continued)

Item Description

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 11

3.3 Raw TCP Server

The raw TCP server connection method allows a remote client to make a TCP socket

connection to a serial port on the ESP-2 hub and then transmit/receive data using standard

TCP. The remote client initiates the TCP session, using a predefined IP port number.

When this method is enabled, the TCP server will accept a connection from any valid

remote IP address. There is no filtering of remote addresses. When a remote raw TCP

client attempts to establish a connection, the raw TCP server will accept the

connection only if the port is not already open and in use by any connection method,

including an existing raw TCP server connection on that port. If the port is currently

in use, the connection request will be rejected.

The TCP session will remain established until the remote client closes the TCP

socket, the TCP connection is broken or the inactivity time-out (if enabled) occurs.

Table 9 describes this method’s configurable items for each serial port.

Serial

buffering

Specifies the length of time accumulated serial data should be buffered before

being sent across the network to the Telnet client. Valid values are 0-65535

hundredths of a second.

For example, a value of 100 indicates that once serial data is received, the

ESP-2 hub will buffer the data until 1 second (100 hundredths of a second) has

elapsed, at which time all data will be sent.

A 0 value indicates that data will be sent as soon as it is available. The default

value is 0 (send immediately). If the buffer becomes half full, the time is

ignored and the data is sent.

Table 9: Raw TCP Server Connection Method Configurable Items

Item Description

Enable/

disable

Enables or disables the raw TCP server connection method on the port. The

default value is disabled. This method cannot be enabled if the raw TCP client

connection method is already enabled for the port.

Local IP port

number

Specifies the IP port number on which the TCP server will listen. This value

cannot conflict with port numbers specified for other enabled connection

methods on either port. Valid values are 1024-65535. The default value is 4001

for port 1 and 4002 for port 2.

Inactivity time-

out

Specifies the length of time before the TCP session is disconnected if there is

no activity. Valid values are 0-65535 seconds.

For example, a value of 60 indicates the TCP session will be disconnected if

there is no activity for a period of 60 seconds.

A 0 value disables the inactivity time-out. The default value is 0 (disabled).

Table 8: Telnet Server Connection Method Configurable Items (Continued)

Item Description

12 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

3.4 Raw TCP Client

The raw TCP client connection method allows the ESP-2 hub to make a TCP-based

connection to a remote server and then transmit/receive data using standard TCP. The

ESP-2 hub initiates the TCP session.

When this method is enabled, the raw TCP client will attempt to establish a connection

with the configured server when the connection mode requirement has been satisfied.

The TCP session will remain established until the client closes the TCP socket, the TCP

connection is broken or the inactivity time-out (if enabled) occurs.

Table 10 describes this method’s configurable items for each serial port.

Serial

buffering

Specifies the length of time accumulated serial data should be buffered before

being sent to the remote server. Valid values are 0-65535 hundredths of a second.

For example, a value of 100 indicates that once serial data is received, the

ESP-2 hub will buffer the data until 1 second (100 hundredths of a second) has

elapsed, at which time all data will be sent.

A 0 value indicates that data will be sent as soon as it is available. The default

value is 0 (send immediately). If the buffer becomes half full, the time is ignored

and the data is sent.

Idle TCP

buffering

When enabled, the most recent 20K bytes of data are held in an internal buffer.

Once the connection is established, the buffered serial data is sent to the remote

endpoint of the TCP connection. When this option and this connection method

are enabled, you may not enable any other connection method for this port.

Table 10: Raw TCP Client Connection Method Configurable Items

Item Description

Enable/

disable

Enables or disables the raw TCP client connection method on the port. The

default value is disabled. This method cannot be enabled if any other serial

port connection method is already enabled on the port.

Destination IP

address

Specifies the IP address of the remote server. This is a required item; there is

no default value. Only a single destination address can be configured for each

serial port. The address cannot be 0.0.x.x, 127.x.x.x, 192.1.1.1, 248-255.x.x.x

or the IP address of the ESP-2 hub.

Destination IP

port number

Specifies the IP port number on which the remote server is listening. Valid

values are 0-65535. The default value is 4001 for port 1 and 4002 for port 2.

Local IP port

number

Specifies the IP port number for the embedded TCP client. Valid values are

1024-65535. This value cannot conflict with port numbers specified for other

enabled connection methods on the other port. The default value is 4001 for

port 1 and 4002 for port 2.

Table 9: Raw TCP Server Connection Method Configurable Items (Continued)

Item Description

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 13

3.5 Configuration Utility

The configuration utility connection method may be used on either of the ESP-2 serial

ports. Using the internal configuration utility, you may specify attributes of the ESP-2

hub and its serial ports. This includes enabling serial port connection methods and

specifying their configurable items, plus configuring serial port attributes. The menu-

based interface also allows you to configure network parameters, download and

install FLASH images, reboot, reinitialize and monitor ESP-2 hub status.

See Configuration Utility on page 24 for more information.

Table 11 describes this method’s configurable items for each serial port.

Inactivity time-

out

Specifies the length of time before the TCP session is disconnected if there is

no activity. Valid values are 0-65535 seconds.

For example, a value of 60 indicates the TCP session will be disconnected if

there is no activity for a period of 60 seconds.

A 0 value disables the inactivity time-out. The default value is 0 (disabled).

Connection

mode

Specifies the criteria for establishing the TCP connection. Valid values are:

Autostart Always attempt to establish the TCP connection.

Connect on Data The TCP connection will be established upon receiving

the first data character from the serial port.

Serial

buffering

Specifies the length of time accumulated serial data should be buffered before

being sent to the remote server. Valid values are 0-65535 hundredths of a second.

For example, a value of 100 indicates that once serial data is received, the

ESP-2 hub will buffer the data until 1 second (100 hundredths of a second) has

elapsed, at which time all data will be sent.

A 0 value indicates that data will be sent as soon as it is available.

The default value is 0 (send immediately). If the buffer becomes half full, the

time is ignored and the data is sent.

Idle TCP

buffering

Enables or disables buffering of received serial data while waiting for a TCP

connection to be established. The default value is disabled.

When enabled, the most recent 20K bytes of data are held in an internal buffer.

Once the connection is established, the buffered serial data is sent to the

remote endpoint of the TCP connection.

Table 11: Configuration Utility Connection Method Configurable Items

Item Description

Enable/

disable

Enables or disables the configuration utility connection method on the port.

The default value is enabled for port 1 and disabled for port 2. This method

cannot be enabled if the raw TCP client connection method is already enabled

on the port.

Table 10: Raw TCP Client Connection Method Configurable Items (Continued)

Item Description

14 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

3.6 Serial Port Attributes

Each serial port has a set of attributes, which may be modified.

NOTE: When a port is configured for the serial redirection connection method, the attributes are

specified within the protocol. Therefore, although you may change the attributes, any changes

you specify will not take effect.

Table 12 lists the serial port attributes with their valid and default values.

Inactivity time-

out

Specifies the length of time before the configuration utility is disconnected if

there is no activity. Valid values are 0-65535 seconds.

For example, a value of 60 indicates the configuration utility will be

disconnected if there is no activity for a period of 60 seconds.

A 0 value disables the inactivity time-out. The default value is 0 (disabled).

Table 12: Serial Port Valid and Default Values

Attribute Valid and Default Values

Baud rate

Valid values: 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800,

9600, 19200, 38400, 57600, 76800, 115200 and 230400

Default value: 19200

Bits per character

(size)

Valid values: 5, 6, 7 and 8

Default value: 8

Parity

Valid values: None, Even, Odd, Mark and Space

Default value: None

Stop bits

Valid values: 1 and 2

Default value: 1

Flow control

Valid values: None and XON/XOFF

Default value: None

Flow control settings are full duplex

Table 11: Configuration Utility Connection Method Configurable Items (Continued)

Item Description

Equinox ESP-2 OPTO Serial Hub Installation and User Guide 15

Section 4 - Web Interface

You may use a standard web browser to access the ESP-2 hub embedded web server.

Any browser that supports frames may be used, and the web interface is accessible

from any system, regardless of operating system type.

You may configure network parameters, change port attributes and connection

methods, download and install FLASH images, reboot or reinitialize the hub and

monitor status and statistics. You may also download a configuration file.

Most of the operations available in the web interface are also available in the serial

configuration utility. For more information, see Configuration Utility on page 24.

4.1 Accessing the Web Interface

The ESP-2 web interface may be accessed using any standard web browser with the IP

address of the hub as the URL. For example, if an ESP-2 serial hub has an IP address of

192.168.0.5, entering the URL

http://192.168.0.5 will connect to the web interface.

If the ESP-2 hub does not have a nondefault IP address (because it has not yet been

configured or the hub has been reinitialized), you may enter the URL

http://192.1.1.1 to access the hub.

NOTE: The predefined IP address (192.1.1.1) is fixed, and unexpected errors may occur if

another device has the same IP address or if there is more than one uninitialized ESP-2 serial

hub on the network. After the hub’s web interface is accessed, you must configure an IP address

before the hub becomes operational. After the IP address is configured, the hub will no longer be

accessible with the predefined IP address.

The ability to use the web interface is a configurable option. By default, this option is

enabled. You may disable/enable it using the web interface (see Displaying or

Changing Configurable Features on page 19), the configuration utility (see

Displaying or Changing Configurable Features on page 29) or in a configuration file

(see Configurable Features Commands on page 35).

4.2 About the Web Interface Window

When you access the web interface, the left column of the window contains the Main

Menu. Clicking on a Main Menu item brings up the corresponding information in the

right column of the window.

In most cases, when you change values, the EEPROM configuration is updated

immediately; however, the changes will not take effect until:

The ESP-2 serial hub reboots - this applies to network address value changes,

configurable feature setting changes, updating a FLASH image or downloading a

configuration file.

-or-

The next connection is established with the port after the change was made - this

applies to changing serial port attributes or connection methods.

16 Equinox ESP-2 OPTO Serial Hub Installation and User Guide

4.3 Passwords

The ESP-2 web interface requires an administration password for access. When the

hub ships (or after it is reinitialized), there is no configured password. When you

access the ESP-2 serial hub, you are prompted for a username and password. The

username field is ignored. If a password has not yet been set, any alphanumeric

password will be accepted. Once you enter the web interface, you will be required to

configure a password before you may perform any other operations.

Some browsers have a feature to remember the password. If this is enabled, you won’t

need to enter the password at the username/password prompt in future sessions.

The administration password is common between the web interface and the

configuration utility. When using the web interface, the password is encrypted by the

browser when it is sent to the interface.

If you reinitialize the ESP-2 serial hub, the password is lost. You will be required to

create a password the next time you access the web interface or the configuration utility.

To set or change the password:

1. From the Main Menu, select Change Password.

2. Enter the new 5-32 character password in the New Password field. Passwords are

case sensitive and may contain any alphanumeric characters.

3. Repeat the new password in the New Password (re-enter) field.

4. Click the Apply button.

Once the password is validated, the EEPROM configuration will be updated. A

reboot is not required.

The new password will be required the next time the web interface or the

configuration utility is accessed.

4.4 Displaying or Changing Network Configuration Values

The Network Configuration display includes the ESP-2 serial hub IP address, subnet

mask and gateway address. You must configure a nondefault IP address for the ESP-2

hub before the hub becomes operational.

To display or change network configuration values:

1. From the Main Menu, select Network Configuration.

2. To change an entry, enter a valid value in the IP Address, Subnet Mask and Gate-

way Address fields. The addresses must be entered in standard IP dot notation.

The gateway address must be in the same subnet as the IP address. You cannot

set the IP address to: a Class A address of 0.0.x.x, a loopback address of

127.x.x.x, the default value of 192.1.1.1 or an address at or above 248.x.x.x. The

subnet mask cannot be 0.0.0.0.

3. If you changed any values, click the Apply button. The EEPROM configuration is

modified, but the change does not take effect until the next reboot of the ESP-2 hub.

Page is loading ...

Equinox Systems ESP-2 OPTO Installation and User Manual

Equinox Systems ESP-2 OPTO Installation and User Manual

Equinox Systems ESP-2 OPTO Installation and User Manual

Related papers

Other documents