DCB etherpath X4 User Manual

Serial server
Table of Contents

Advertisement

Quick Links

E ther Path - X 4
S erial S e rver
User's Guide
Revised April 5, 2012
Firmware Version 1.09

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the etherpath X4 and is the answer not in the manual?

Questions and answers

Summary of Contents for DCB etherpath X4

  • Page 1 E ther Path - X 4 S erial S e rver User’s Guide Revised April 5, 2012 Firmware Version 1.09...
  • Page 2: Fcc Statement

    FCC Statement This device complies with the limits for a Class B digital device, pursuant to Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference. (2) This device must accept any interference received, including interference that may cause undesired operation.
  • Page 3: Table Of Contents

    ABLE OF ONTENTS FCC Statement................i Chapter 1 Introduction..............1 EtherPath Functions.............1 Client/Server Mode...............1 Server Mode..................2 Point-to-Multiple-Point (EtherModem) Mode.......2 Reverse Telnet (Telnet Client) Mode..........2 Other Features..............2 Multiple Ports................2 Automatic Connection..............2 AT Commands................2 Connection Recovery..............2 Protocol Conversion..............3 Configuration Security..............3 Upgradeable Firmware..............3 On-board Tools................3 Physical Details..............4 Front Panel..................4 Rear Panel..................5...
  • Page 4 8. Telnet Setup Enable..............20 This option controls whether the Etherpath's telnet setup server waits for a user to setup the Etherpath X4 via telnet or not. If you select disable, and activate changes, you will no longer be able to configure via the telnet interface.
  • Page 5 Introduction Parity...................22 Data Bits..................22 Stop Bits..................22 DCD Input Control..............22 Client Dial Mode.................22 Set port dialing mode [AT Dial Hardware, (DCD) Dial, or Nailed Up] In AT dial mode, modem-like AT commands are used to connect to a remote server. In DCD dial, the client automatically connects to the remote server when the DCD signal goes high.
  • Page 6 Notes...................31 Tools...................31 Activate Changes..............32 Notes...................32 Store Configuration............33 Notes...................33 Chapter 6 Operation..............34 Overview................34 Client/Server Point-to-Point (Nailed-Up) Mode....34 Server Mode...............35 Client/Server Point-to-Multiple-Point (EtherModem) Mode35 Client (Reverse Telnet) Mode..........36 Method 1 (ATD dial mode)............36 Method 2 (Hardware Dial mode)..........36 Chapter 7 Configuration Security...........37 Overview................37 Level 0: ................37 Level 1:................37...
  • Page 7 Introduction CTS.....................45 RS-422 PIN Assignments RJ-45 Connector......45 RS-422 Port Operation............45 Transmit Data (TXD-A), PIN 1...........45 Transmit Data (TXD-B), PIN 2...........45 Receive Data (RXD-A), PIN 3............45 Receive Data (RXD-B), DCD Input..........46 CABLES................46 To PC 9-pin COM: port..............46 EtherPath-X4 to PC crossover ethernet cable......46 .................46 Appendix C Programming............47...
  • Page 8: Chapter 1 Introduction

    This chapter provides an overview of the EtherPath's features and capabilities. ongratulations on the purchase of your new EtherPath X4 serial server. The EtherPath is a versatile product that enables serial communications devices to operate via Ethernet. It is designed to easily connect up to four serial port devices to your network.
  • Page 9: Server Mode

    EtherPath-X4 User’s Guide The device on one EtherPath communicates with the other serial port device as if it was directly connected via a serial port cable. The EtherPaths and the LAN are completely transparent to PC application and serial port device. Server Mode This mode requires only a single EtherPath.
  • Page 10: Protocol Conversion

    Introduction 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 the RS232 link (speed, parity, flow control).
  • Page 11: Physical Details

    EtherPath-X4 User’s Guide Physical Details Front Panel The EtherPath-X4 front panel is shown below. Figure 1: EtherPath-X4 Front Panel Status Red LED Status Indicator Power Red LED Power Indicator Serial Port 1 RJ-45 Red LED Port 1 Activity Red LED Port 2 Activity RJ-45 Serial Port 2...
  • Page 12: Rear Panel

    Introduction Rear Panel The EtherPath-X4 rear panel is shown below. Some units use different power connectors. Figure 1: EtherPath-X4 Rear Panel Power port Connect the power adapter here. Switch Bank Configuration Switches LAN Activity Indicator Red LED Bottom Red LED LAN Link Indicator.
  • Page 13: Configuration Switches

    EtherPath-X4 User’s Guide Configuration Switches The rear panel contains four small switches, numbered 1 through four (left to right). These are used for configuration. The normal position for all switches is DOWN. Switch 1 This switch immediately resets the unit . When placed in the UP position, it resets the router just as if it had been power cycled.
  • Page 14 Introduction Rear Panel LED Indicators • The lower red LED is the Ethernet Status indicator. It is lit when there is a valid 10/100BaseT Ethernet connection. This LED flashes with activity on the Ethernet (even if the activity isn't directly to this unit).
  • Page 15: Front Panel Led Indicators

    EtherPath-X4 User’s Guide Front Panel LED Indicators • Lower Left LED is a power indicator. • Upper Left LED is a status indicator. It should always be on. Front Panel Port LED Indicators • OFF - no DCD • ON - DCD present or nailed up •...
  • Page 16: Package Contents

    Introduction Package Contents You should find the following items packaged with your EtherSeries Router: • The EtherPath Unit • Power Adapter (if applicable) • This User’s Guide CDROM • Short cable with RJ-45 connectors • 9-pin Remote-PC adapter If any of the above are missing, contact your dealer immediately. Software Requirements The EtherPath supports the following protocols.
  • Page 17: Chapter 2 Installation

    Chapter 2 Installation This Chapter details the LAN installation process for the EtherPath-X4. 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 IP address may not work with your network.
  • Page 18: Connect The Ethernet Cable

    Troubleshooting 5. The main command-line menu will then be displayed. See the Telnet/Command-line configuration section for configuration information. For a quick-start, you may only need to set the IP address using option 1, Set LAN properties. ---- Welcome to the EtherPathX4 version v1_0 Setup Program ---- 1 Set LAN properties 2 Set name/password...
  • Page 19: Verify The Ip Address Configuration

    EtherPath-X4 User’s Guide Verify the IP Address Configuration Enter the URL from step 1.8 (or http://192.168.1.1 if appropriate ) into your web browser. The login screen below should be displayed. Login Screen Log in using the user name “admin” and no password (blank field). If this screen doesn’t display, check the Troubleshooting Section in Chapter 6.
  • Page 20: Enter Your Configuration

    Troubleshooting 4. Enter Your Configuration Initial Main Menu From this index screen, you can select a section on the left and will be taken to configuration screens for each router subsystem. 5. Minimum Configuration The minimum configuration items required for basic operation are: IP address appropriate for your LAN.
  • Page 21 EtherPath-X4 User’s Guide Main Help Screen Entries are always tested for valid values. However, there are many “valid” values that are not appropriate for any given configuration. So, “appropriateness” isn’t tested. For example, an IP address of 300.400.500.256 will not be accepted, but the field will accept an IP address that is not appropriate for your installation.
  • Page 22: The Configuration Process

    Troubleshooting Chapter 3 The Configuration Process This Chapter describes configuration management process on the EtherPath-X4 using a Web Browser. Overview The EtherPath contains a quite flexible configuration management system. By using this system correctly, one can remotely configure the unit, save copies of that configuration to a PC, change configuration changes for later activation, and remote transfer firmware upgrades to the unit.
  • Page 23: Configuration Process Examples

    EtherPath-X4 User’s Guide Configuration Process Examples Make configuration changes, test them with Activate, then save them with Save. This is the most commonly used method for changing the configuration. It allows you to test the configuration prior to saving it. If, during the testing, you notice an abnormality; you can reset the unit to return to the last good configuration.
  • Page 24: Terminal/Telnet Configuration

    Troubleshooting Chapter 4 Terminal/Telnet Configuration This Chapter describes how to configure the EtherPath 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: •...
  • Page 25: Telnet Configuration

    EtherPath-X4 User’s Guide Connect your terminal program to the appropriate port (e.g. COM 1). The configuration program should now start and after a few seconds display a sign-on screen. If nothing appears on your screen, press the Enter key. Refer to Error: Reference source not found on page XX for details on using the configuration program. Telnet Configuration Install the EtherPath into your LAN as described in Chapter 2.
  • Page 26: Terminal/Telnet Interface

    Troubleshooting Terminal/Telnet Interface The Signon screen asks for a valid username and password. Connected to etherpathx4. Escape character is '^]'. Enter name: Enter password: Pressing any key will then take you to the Main Menu, which also displays the version number ---- Welcome to the EtherPathX4 version v1_0 Setup Program ---- 1 Set LAN properties 2 Set name/password...
  • Page 27: Ip Address

    8. Telnet Setup Enable This option controls whether the Etherpath's telnet setup server waits for a user to setup the Etherpath X4 via telnet or not. If you select disable, and activate changes, you will no longer be able to configure via the telnet interface.
  • Page 28: Main Menu Option 2

    Troubleshooting Main Menu Option 2. Set Admin Username and Password Selecting (2) from the Main Menu will result in the following screen. Username: admin Password: ---------------------------------------- 1 Username 2 Password 0 --Return to previous menu. If the entries are blank, then any user on the LAN can configure the EtherPath. If you are not sure about using this feature, leave the addresses all zeros.
  • Page 29: Baud Rate

    EtherPath-X4 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. RTS Toggle is a handshake mode commonly used with half duplex modems.
  • Page 30: Main Menu Option 4

    Troubleshooting Main Menu Option 4. Advanced Configuration Screen Selecting (4) from the Main Menu will display the following: Enter port (1-4):1 Transmit Timer (ms): 20 Timer Mode: transmit-timer Block Size: 512 Line terminator Character (Decimal 0-255): 13 Transmit On LT Char: off Server End-Of-Line Filter: off Client Local Character Echo: off Keep-Alive Frequency (1-32767 Seconds): 120...
  • Page 31: Block Size

    EtherPath-X4 User’s Guide 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.
  • Page 32: Server End Sends Telnet Nops, And The Client End Times Out. [0=Off, 1-32767 Seconds]

    Troubleshooting Setting this parameter to a non zero value will enable a Keep-Alive feature in the Unit. When the Unit is in Client mode, it will send Keep-Alive messages to the server at the specified frequency when the link between the client and server is idle. When the Unit is in Server mode, it will close the connection if the link is idle for more than 3.5 times the Keep-Alive Frequency.
  • Page 33: Main Menu Option 5. Display Settings

    EtherPath-X4 User’s Guide Main Menu Option 5. Display Settings Selecting (5) from the Main Menu displays a screen similar to the following example. Select a function by number ->: 5 ----------------------------------------------- LAN Configuration IP Address: 205.166.54.188 Subnet Mask: 255.255.255.0 Gateway IP Address: TCP Tx Timeout: normal SNMP enable: disable Web Setup Enable: enable...
  • Page 34: Reset Configuration To Default

    Troubleshooting 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.
  • Page 35: Main Menu Option 9. Exit Without Saving

    EtherPath-X4 User’s Guide Main Menu Option 9. Exit without Saving Selecting (0) from the Main Menu will exit the configuration program without saving any data you have entered.
  • Page 36: Web-Based Configuration

    Troubleshooting Chapter 5 Web-Based Configuration This Chapter describesweb-based configuration screens and some configuration hints for the EtherPath-X4 Overview The EtherPath-X4 is most easily configured using forms displayed on a web browser. In this chapter, we illustrate all entry forms, and describe their use. All configuration screens are accessed from the main index screen shown below.
  • Page 37: Administrative Maintenance

    EtherPath-X4 User’s Guide Administrative Maintenance The Administration section contains nine action buttons used to configure system-wide settings and perform a few high level operations. Maintenance Administrative Maintenance Screen Access to the Web Server is protected by HTTP Basic Authentication. This is a simple methodology where the Web Server will require a Web Browser to provide a username and password for each page requested.
  • Page 38: Notes

    Troubleshooting Save or Load Config File This screen allows you to save a configuration file to the workstation, or load a configuration file from the workstation to the EtherPath. The files are plain text files with the .cfg file extension. See the configuration overview chapter for more information on modifying saved configuration files.
  • Page 39: Activate Changes

    EtherPath-X4 User’s Guide Activate Changes Activate Changes Screen Activate Changes will move the current pending configuration to the active configuration. See the Configuration overview for more detail. Notes...
  • Page 40: Store Configuration

    Troubleshooting Store Configuration Store Configuration Screen This screen stores the pending configuration in the permanent memory. It does not activate the changes, but the changes will be activated upon the next boot or power cycle. See the configuration overview chapter for more detail. Notes...
  • Page 41: Chapter 6 Operation

    EtherPath-X4 User’s Guide Chapter 6 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.
  • Page 42: Server Mode

    Troubleshooting 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...
  • Page 43: Client (Reverse Telnet) Mode

    EtherPath-X4 User’s Guide Client (Reverse Telnet) Mode Method 1 (ATD dial mode) • The EtherPath must be configured for “ATD” dialing and set for "client". • 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”...
  • Page 44: Configuration Security

    Troubleshooting Chapter 7 Configuration Security This section discusses configuration options that restrict the configuration process. Overview The EtherPath uses the industry standard IP protocol. Since this is a well known standard, its security vulnerabilities are also well known and may be exploited. Several EtherPath options are available to enhance the inherent security of your EtherPath network.
  • Page 45: Level 3

    EtherPath-X4 User’s Guide Level 3: Configure Level 1 and Level 2 security as needed. Using the telnet or direct connection configuration, enter a user name and password pair. If there is a user name, then a password prompt will be issued upon establishing a telnet configuration session.
  • Page 46: Chapter 8 Troubleshooting

    Troubleshooting Chapter 8 Troubleshooting This chapter outlines some problems that may occur during installation operation and some possible solutions to them. If you follow the suggested troubleshooting steps and the EtherPath still does not function properly, please contact your dealer for further advice. Hardware Problems Before anything else, check that all cables used are wired correctly and properly connected.
  • Page 47: Can't Connect Via The Lan

    EtherPath-X4 User’s Guide Can't Connect via the LAN P1: Can't connect to the EtherPath using Telnet or Web Browser. S1: Check the following: • Start troubleshooting from a known state. Power the EtherPath and other equipment OFF and ON to reboot. •...
  • Page 48: Other Problems

    Troubleshooting Other Problems P1: Can’t run the configuration program using a serial cable connection. S1: Check that: • You did set the configuration switch (no. 2) to the UP position and power cycle the unit. • The communication parameters are set properly. •...
  • Page 49: Checking Device Operation

    EtherPath-X4 User’s Guide Checking Device Operation Once the EtherPath is installed on your Network, you can connect to it using Telnet, to verify its operation. The procedure is as follows. Leave the EtherPath in its normal operating mode. Use telnet to connect to the EtherPath with the command: telnet IP_Address 8000 Where IP_Address is the IP Address assigned to the EtherPath, and 8000 represents the Port number.
  • Page 50: Appendix A Specifications

    Troubleshooting Appendix A Specifications EtherPath - X4 Specifications • Flash Memory: 4 Mbytes • SRAM: 8 Mbytes • LAN Interface: 10/100BaseTx, Autosense • RS-232: Four RJ-48 (RJ-4-5) connectors pinned out as RS-561 • RS-232 speed: Up to 230.4.2 Kbps • CPU: Motorola Coldfire 5272 CPU 66 Mhz •...
  • Page 51: Appendix B Port Pinout And Cables

    EtherPath-X4 User’s Guide Appendix B Port Pin out and Cables This section describes the serial port pin outs and cables. RS-232 PIN Assignments The RJ-45 connectors with RS-232 port wiring contain the signals of a standard PC 9 pin DE-9P COM: port on a space-saving RJ-45 connector.
  • Page 52: Signal Ground

    Troubleshooting Signal Ground Common ground Output, always asserted. Not connected on port one and port two. Output. Input flow control signal. 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. Input.
  • Page 53: Transmit Data (Txd-A), Pin 1

    EtherPath-X4 User’s Guide RS-422 Port Operation Transmit Data (TXD-A), PIN 1 Output, Data from the unit. This is the negative side of a balanced signal. The return is on PIN 2, (TXD-B) Transmit Data (TXD-B), PIN 2 Output, Data from the unit. This is the positive side of a balanced signal. The return is on PIN 1, (TXD-B) Receive Data (RXD-A), PIN 3 Input, data into the unit.
  • Page 54: Etherpath-X4 To Pc Crossover Ethernet Cable

    Troubleshooting EtherPath-X4 to PC crossover ethernet cable An ethernet crossover cable may be constructed to allow the EtherPath's ethernet port to directly connect to a PC without using a hub. Use the following pinout: EtherPath-X4 -...
  • Page 55: Appendix C Programming

    EtherPath-X4 User’s Guide Appendix C Programming This Appendix explains the EtherPath's interface so that external programs that access it may be developed. 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.
  • Page 56: Server Mode

    Troubleshooting 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.
  • Page 57: Application Notes

    EtherPath-X4 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.
  • Page 58: At Command Summary

    Troubleshooting Appendix D 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): ATD <IP> connect to <IP_address> ATDT <IP> connect to <IP_address> ATH[0/1] on/off hook (ATH<cr>...
  • Page 59: Open Source Software Information

    This unit was designed and programmed with Open Source Linux software in mind. The core Linux operating system is uClinux, available from http://www.uclinux.org . DCB supports the Open Source software effort and is appreciative of the contribution many open source developers have made to the community Other open source software used in this product may be obtained from the original developers, and is made available in accordance with GNU licensing terms.

Table of Contents