User Manual EKI-1321/1322 1/2-port RS-232/422/485 to GPRS IP Gateway
Copyright The documentation and the software included with this product are copyrighted 2013 by Advantech Co., Ltd. All rights are reserved. Advantech Co., Ltd. reserves the right to make improvements in the products described in this manual at any time without notice. No part of this manual may be reproduced, copied, translated or transmitted in any form or by any means without the prior written permission of Advantech Co., Ltd. Information provided in this manual is intended to be accurate and reliable.
Declaration of Conformity CE This product has passed the CE test for environmental specifications. Test conditions for passing included the equipment being operated within an industrial enclosure. In order to protect the product from being damaged by ESD (Electrostatic Discharge) and EMI leakage, we strongly recommend the use of CE-compliant industrial enclosure products.
6. Put this equipment on a reliable surface during installation. Dropping it or letting it fall may cause damage. 7. The openings on the enclosure are for air convection. Protect the equipment from overheating. DO NOT COVER THE OPENINGS. 8. Make sure the voltage of the power source is correct before connecting the equipment to the power outlet. 9. Position the power cord so that people cannot step on it. Do not place anything over the power cord. 10.
Contents Chapter Chapter 1 Overview...............................................1 1.1 1.2 1.3 1.4 Introduction ............................................................................................... 2 Features .................................................................................................... 3 Specifications ............................................................................................ 3 Package Check List .......................................................
3.3 Network Settings..................................................................................... 29 4 Setting COM Redirector ................... 33 4.1 Setting COM Redirector (Virtual COM port)............................................ 34 4.1.1 Auto Mapping.............................................................................. 34 4.1.2 Manual Mapping ......................................................................... 35 4.1.3 Manual Direct Mapping Virtual COM Port...............
Chapter 1 Overview 1
1.1 Introduction Advantech's EKI-1300 series of Industrial Device Servers are a robust, feature-rich, and cost effective way to network-enable equipment in an industrial automation environment. The EKI-1321/1322 provides one or two serial ports, cellular GPRS interface to connect any RS-232/422/485 devices to Cellular WAN.
1.3 Specifications Cellular Interface Standard Compliance: GSM/GPRS Quad Band 850/900 and 1800/1900MHz Antenna Connector: Reverse SMA GPRS Standard: – GPRS Multi-slot: Class 10 – GPRS Terminal Device: Class B – GPRS Coding Schemes: CS1 to CS4 LAN Interface Ethernet: 10/100 Mbps auto sensing No. of Ports: 1 Port Connector: RJ45 Protection: Built-in 1.5 KV magnetic isolation Serial Interface Interface: RS-232/422/485, software selectable No.
Software Utility: Advantech Serial Device Server Configuration Utility Driver support: 32-bit/64-bit Windows 2000/XP/Vista/7, Windows Server 2003/ 2008, Windows CE 5.
Chapter 2 Getting Started 2
2.1 Understanding EKI-1321/1322 The EKI-1321/1322 is network-based, serial device server for connecting RS-232/ 422/485 devices, such as CNCs, PLCs, scales, and scanners, directly to a TCP/IP network. Once connected through EKI-1321/1322, serial device will be able to send and receive data through cellular ISP network like any other network device. It extends traditional COM ports of a PC with access over a TCP/IP network.
Advantech Serial Device Server Configuration Utility is a serial COM port redirector that creates virtual COM ports and provides access to serial device connected to Advantech serial device server. You can configure the serial device server and enable the Virtual COM port using one integrated utility.
2.1.2.2 Multi-Access Mode (Shared COM port mode) Most of serial devices are connected directly and physically to the PC serial ports via a cable. The operation system, ex. Windows XP, provides the COM ports that user’s application can access, and control the serial device through the serial cable. This means that the serial device can be connected to one host and only one application on this host can handle input, output and control operation on this device.
In TCP server mode, you might initiate the TCP connection from host to EKI serial device server. This operation mode support max. five simultaneous connections for each serial port on EKI serial device server from one host or several hosts, however multi-hosts collect the data from one serial port at the same time Figure 2.4 TCP Server Mode 9 EKI-1321/1322 User Manual Getting Started 2.1.3 TCP Server Mode Chapter 2 2.1.2.
2.1.4 TCP Client Mode In TCP Client mode, the TCP connection will be established from EKI serial device server. This operation mode supports maximum four simultaneous connections for each serial port on EKI-1321/1322 to one host or several hosts. You should configure the IP address and TCP port number of the network hosts which the EKI serial device server connect to using Advantech Serial Device Server Configuration Utility.
UDP is used primarily for broadcasting messages over a network. In the UDP server mode, EKI-1321/1322 access max. of 8 hosts’ UDP message. In the UDP client mode, EKI serial device servers transmit UDP message to max. of 4 hosts simultaneously. Chapter 2 2.1.6 UDP Server/Client Mode 2.1.
2.2 Hardware In this section, we will give you an overview of EKI-1321/1322 hardware and installation. 2.2.1 LED Indicators There are LEDs display the power status, network status, and serial communication status located on the front panel of EKI-1321 and EKI-1322, each of them has its own specific meaning as below. Table 2.
Chapter 2 2.2.2 Dimensions (Units: mm) 120 129.8 27 27 Figure 2.7 Front View of EKI-1321/1322 13 EKI-1321/1322 User Manual Getting Started 120 2.2.2.
74.30 74.3 85 85 93.90 93.9 102.88 102.88 Figure 2.8 Side View of EKI-1321/1322 Figure 2.9 Back View of EKI-1321/1322 Figure 2.
Chapter 2 EKI-1321 Figure 2.
2.3 Connecting Hardware Next, we will explain how to find a proper location for your EKI-1321/1322, and then explain how to connect to the network, hook up the power cable, and connect to the EKI-1321/1322 serial port. 2.3.1 Choosing the Location Due to its versatility and innovative design, EKI serial device server can be: Fixed to a panel/wall mount Fixed to a DIN-rail. 2.3.2 Wall/Panel Mounting The EKI-1321/1322 can be attached to a wall or a panel using the included metal brackets.
Chapter 2 2.3.2.2 Panel Mounting Getting Started Figure 2.
2.3.3 DIN-rail Mounting You can mount the EKI-1321/1322 on a standard DIN rail. The DIN-rail kit is screwed on the serial device server when out of factory. If the DIN-rail kit is not screwed on the serial device server, use the three screws to attach the DIN-rail kit on the serial device server first. Figure 2.14 Attach to DIN-rail 2.3.4 GPRS Connection EKI-1321 and EKI-1322 operate in the cellular GSM/GPRS environment, which access the Internet or intranet through GSM/GPRS network.
Chapter 2 2.3.5 Power Connection The EKI-1321/1322 supports dual 12 to 48VDC power inputs. Getting Started Figure 2.15 EKI-1321 Power Connector Figure 2.16 EKI-1322 Power Connector You can connect an alarm indicator, buzzer or other signaling equipment through the relay output. 2.3.6 Serial Connection EKI-1321/1322 provides one or two ports DB9 (male) connectors. RS-232/422/485 pin assignments as below: Table 2.
2.4 Serial Device Server Configuration Utility Advantech Serial Device Server Configuration Utility integrates device server management and virtual COM port mapping utility. After installation, this utility not only configures the EKI-1321/1322, but also connects and configures the ADAM series and EDG series device servers. Virtual COM port configuration and management was also integrated in this utility. The best improvement, you don’t restart the host computer while you setup new virtual COM ports.
5. The setup program will specify a default installation path: C:\Program Files\Advantech eAutomation\Serial Device Server Configuration Utility\, press “Install” button to continue the process. 21 EKI-1321/1322 User Manual Getting Started Carefully read the Software License Agreement, and press “Yes” to continue the process. Chapter 2 4.
6. After setup program has copied all program files to your computer, press “Finish” button for completing the installation process.
Chapter 3 3 Utility Configuration
3.1 Configuration Utility Overview EKI-1321/1322 provides an easy-to-use configuration utility to configure your serial device server through an Ethernet connection. For secure administration, it can also restrict the access rights for configuration to only one host PC to enhance network security. With this secure function enabled, other PCs will not have permission for configuration.
3.2.1 Auto Searching From here all device on the same network domain will be searched and display on Device Server List Area. You can click on the device name to show the features of the specific device. Click on the "+" before the model name, and the utility will expand the tree structure to show the individual device name. Click on the “-“ before the model name, and the utility will collapse the tree structure.
Select the device in this sub-tree. The first tab on the “Configuration Area” shows the summary of “Basic Information” included device Type, version, and name, “Ethernet Information”, and “Serial Port Information”. In the serial port information frame, it displays the operation mode, status and connected host IP. Click on the “+” before the device name, and the utility will expand the interfaces on this device server.
Chapter 3 Click on each item, you will entry the configuration page to change the setting. The configuration will be introduced on following sections. Utility Configuration 3.2.2 Clear Device List and Search Again You can click the button on the “Quick Tool Area”; utility will clear all list device servers in the Device Server List Area and re-search again. Don’t use this function frequently. The warning message will be pop-up when you double click this button.
3.2.3 Manual Appending Using “Add IP address to Favorite” or “Search a Range of IP addresses” function, you are able to add one device or group of devices to “Favorites”. These devices can locate on local network domain or other network domain.
This section explains how to configure the EKI-1321/1322 series network using this utility so that it can communicate over a network with serial devices. Click on the “+” before the model name (e.g. EKI-1322), and the utility will expand the tree structure to show the individual device name. And click on the “+” before the device name, and the utility will expand the interfaces on this device server. Select the Ethernet interface. Chapter 3 3.
MAC address: The MAC address is for the local system to identify and locate each serial device servers. This MAC address is already set before delivery from factory, hence no need for further configuration. IP address, Subnet Mask, Default Gateway: You can choose from four possible IP Configuration modes --- Static IP, DHCP + Auto-IP, BOOTP + Auto-IP, and DHCP + BOOTP + Auto-IP.. Static IP User defined IP address, Subnet Mask, and Default Gateway.
When you have finished the configuration of these settings for each category, please press the “Apply” button in order to make these settings effective on the Serial Device Server. (Will reboot your Serial Device Server immediately) 31 EKI-1321/1322 User Manual Utility Configuration Note! Chapter 3 DNS Setting In order to use DNS feature, you need to set the IP address of the DNS server to be able to access the host with the domain name.
EKI-1321/1322 User Manual 32
Chapter 4 Setting COM Redirector 4
4.1 Setting COM Redirector (Virtual COM port) Advantech COM port mapping software is a serial COM port redirector that creates virtual COM ports and provides access to serial devices connected to Advantech serial device servers. Your serial device applications can communicate with serial devices connected to Advantech serial device servers without software changes.
Right click the serial device name on the sub-tree of Device Server List area and select the “Manual Mapping” function. ADAM series, EDG series, and EKI wireless series have only one IP address. Select the serial port on the device server and the host COM that you want to set. Press
4.1.2.1 Auto Reconnect Property Sometimes, the connection between Advantech serial device server and HOST is interrupted by network traffic or powered-off by accident. In such a situation, the host has to reconnect to Advantech serial device server. The function "Auto Reconnect" is for this purpose, if the Advantech serial server loses the connection to its host, the COM redirector will try to re-establish the connection while the host's AP access the virtual COM port.
Click the button on the Quick Toolbar, you can add a target by selecting the Device Type and inputting the IP address without physically connecting the serial device server to the network. If you want to remove the virtual COM port, you can remove them one by one or group remove ports. 4.1.4.1 Individually Remove Right click on COM port you have mapped and select “Remove This Port”. 37 EKI-1321/1322 User Manual Setting COM Redirector 4.1.4 Remove the Virtual COM Port Chapter 4 4.1.
4.1.4.2 Group Remove Port Right click on Virtual Com Ports on Device Server List Area and select “Group Remove Port”, you can choose which ports you want to remove.
Chapter 5 5 Web Configuration
5.1 Overview EKI-1321/1322 serial device server can be configured through a web interface. By using a standard web browser, the same procedure as with the Windows configuration utility can be used. In the browser's address field, enter the IP Address of your EKI-1321/1322 serial device server. The default IP setting is 10.0.0.1, but you should use the IP which you have previously assigned for this device. Once the IP is entered, you will be presented with the following windows.
Chapter 5 By Browser You can change the Device Name/Device Description, time and time zone and enable/disable the configuration methods on this page.The configuration methods include Web, Telnet and SNMP. 5.4 DDNS Configuration When the EKI-132x receives IP address from DHCP server, remote servers will be unable to access it using a fixed IP address. With DDNS, a remote server can access the EKI-132x using its domain name of its IP address.
DDNS Provider (default=www.DynDns.org): Currently, www.dyndns.org is the only option available for Server address. Username: This is the user name used for update authentication. Password: This is the password used for update authentication. DDNS Alias: In this field, use the name that you created on www.dyndns.com. The EKI-1321/1322 will update the DynDNS server with this host name. 5.
EKI-1321/1322 User Manual Web Configuration 43 Chapter 5 IP Address: Enter the IP address of the host on your local network that you want to link the incoming service to. Port: The public port is the port seen from the Internet side. Public ports cannot be set to ports used by OP modes (950, 966, 4001, …).
5.6 OpenVPN Configuration To provide the secure communication links when accessing a private network from the public Internet . With the help of VPN, cellular devices acting as a VPN client can initiate a connection with a VPN server. OpenVPN Configuration: configure the VPN server information and import the CA/ CERT/KEY file in this web page. OpenVPN Status: Enable or disable the VPN tunnel function. Protocol: UDP or TCP protocol. Cipher: setup the cipher mode for VPN tunnel.
5.7.1 Eth1 Configuration Eth1 page is where you assign the EKI-132x IP address, netmask, Gateway and other parameters for the Ethernet interface. Chapter 5 5.7 Ethernet Configuration Web Configuration Mode (default=Static): You can choose from four possible IP configuration modes. Option Description Static IP User defined IP address, Subnet Mask, and Default Gateway. DHCP/Auto-IP DHCP Server assigned IP address, Subnet Mask, Default Gateway, and DNS.
Default Gateway(default=255.255.255.255): Enter the IP address of the gateway if applicable. A gateway is a network computer that acts as an entrance to another network. Usually, the computers that control traffic within the network or at the local Internet service provider are gateway nodes. The EKI-132x needs to know the IP address of the default gateway computer in order to communicate with the hosts outside the local network environment.
5.8 Port Configuration There are Basic, Operation Mode, and Advanced Settings in the serial port configuration. There are various operation modes that are suitable for different application. 47 EKI-1321/1322 User Manual Web Configuration APN: Before using the GPRS/UMTS/HSDPA also need APN (Access Point Name) must be added as a modem initialization command. Phone Number: Use this field to configure the number used to dial out.
5.8.1 Setting Serial Port Parameters Type: The EKI-1321/1322 offers three kinds of serial protocols, RS-232, RS-422 and RS-485. You can use any of these three serial protocols according to your requirements. Baud Rate: The EKI-1321/1322 supports baud rates from 50 to 921.6Kbps. You can use the pull-down list to choose a standard baud rate or directly input any specific baud rate you want. Parity: The EKI-1321/1322 provides five options: None, Odd, Even, Space, and Mark.
Flow Control: The EKI-1321/1322 provides four options: None, XOn/XOff, RTS/ CTS, and DTR/DSR. Note! When you have finished the configuration of these settings for each category, please press the “Save” button in order to make these settings effective on all serial device servers. (Will restart your serial device server immediately) 49 EKI-1321/1322 User Manual Web Configuration Stop Bits: The EKI-1321/1322 provides three options: 1, and 2.
5.8.2 Setting Virtual COM Operating Mode Parameters The Advantech serial device servers extend traditional COM ports of a PC to Ethernet access. Through Ethernet networking, users can control and monitor remote serial devices and equipment over LAN or WAN. Advantech serial device servers come with a COM port redirector (Virtual COM driver) that transmits all serial signals intact. This means that your existing COM-based software can be preserved, without modifying to fulfill the needs.
EKI-1321/1322 provides Multi-access function through cellular WAN. Allow the maximum of five connections to open one serial port simultaneously. In the mode, all connections have to use the same serial setting. If one serial setting of these connections is different from others, the data communication may operate incorrectly. Normal mode: Disabling “Response Timeout” parameter, EKI-1321/1322 will operate in “normal mode”.
Pack Condition: There are 3 types of pack condition by length, time or specific character. “By size”: the system will collect the data with fixed size and send out according to your setting. “By interval”: the system will collect the data in fixed interval and send out. “By end-character”: the system will send out the package when it find the coming of specific character. RVcom Number: 0 means disable RVcom function. There can have maximum of 5 peers.
EKI-1321/1322 User Manual Web Configuration 53 Chapter 5 Data Listen Port: The TCP (UDP) port number represents the source port number, and the number is used to identify the channel for remote initiating connec- tions. Range: 1024-65533. If an unknown caller wants to connect to the system and asks for some services, they need to define the TCP (UDP) port to carry a long-term conversation. Each node on a TCP/IP network has an IP address, and each IP address allows connections on one or more TCP port.
5.8.4 Setting Control Operating Mode Parameters In controlling mode, the EKI device presents a modem interface to the attached serial device: it accepts AT-style modem commands to connect/disconnect to other networking device. If you want serial device running application program to connect/disconnect to different devices dynamically, you can use controlling mode. The “Control mode” provides three kinds of modem AT-style commands.
The “+++” command cannot be divided. The “+” character can be changed in Hang-up Character, and the guard time, which prefixes and suffixes the “+++” in order to protect the raw data, can be changed in Guard Time (ms). See picture. AT Commands EKI supports the following common AT commands used with a typical modem: AT command Description ATA Answer ATD Dial up the IP address#Port No.
5.8.5 Setting RFC2217 Operating Mode parameters RFC-2217 mode is similar to Real COM mode in that a driver is used to establish a transparent connection between a host computer and a serial device by mapping the serial port on the EKI-132x to a local COM port on the host computer. RFC2217 defines general COM port control options based on the Telnet protocol. Listen Port: This is the TCP port number assignment for the serial port on the EKI132x.
Short Message Service (SMS) is a telecommunications protocol that allows sending "short" (160 characters or less) text messages. It is available on most digital mobile phones and some personal digital assistants with built-in wireless capability. GSM technology offers the benefit of using SMS (short message service) as an easy way to communicate over the mobile network. Chapter 5 5.8.
5.8.7 Advanced Setting The EKI-1321/1322 serial device server provides the advanced settings for some special applications which need critical time requirements. In normal applications, these settings are recommended not to be set to avoid the unusual action happened. Enable Delay Time (ms) When you enable the delay time, the serial port will postpone the received data for the time interval you set, and then send the received data to the TCP/IP network.
Note! These settings are just for some special application cases.We strongly recommend do not enable the advanced settings in normal usage. Chapter 5 You can configure what happen to the RTS and DTR signals when the cellular and Ethernet connection goes down. 5.9 Monitor COM information Go to “Setting” page under Monitor Configuration to view the setting of current Port. 5.9.2 Statistical information Go to “Statistic” page under Monitor Configuration to view network statistics.
5.9.3 Connected IP information Go to “ConnectedIP” page under Monitor Configuration to view the IP address of Host connected to EKI-1321/1322.
On the Alert Settings page, you may configure how administrators are notified by certain system, network, configuration, power, and cellular connection events. Rely on the events, administrators can collect different options for automatic notification. Mail refers to send an e-mail to a specified mail address. Trap refers to send an SNMP Trap. Agent refers to send the SNMP agent setting. SMS refers to send a message to a specified phone number. Web Configuration 5.10.1 Setting Chapter 5 5.
5.10.2 Event In this page, you can configure what kind of events do you want to log or send out the mail/message through the four methods we provided. Currently, we provide system event included of cold start, warm start, authentication failure, IP address/Password change, serial DCD/DSR port change and Ethernet link down information. You can select 4 methods (Mail, SNMP, log file or SMS) to record or send the event messages. 5.11 LogFile You can select how to handle the system log file.
The configuration will take effect after clicking "Save" button. But all configurations will save to flash memory after this reboot step. Press the "Reboot" button and the system will give a reset response. It will take a few seconds to reconnect with the new values. Chapter 5 5.
EKI-1321/1322 User Manual 64
Appendix A Troubleshooting A
A.1 Successful GPRS Connection The GPRS Dial-Up status is separated into two parts. Those information is shown by the Status LED and GPRS Ready LED. Note! You can refer to Chapter 2.2.1 LED Indicators Status LED is represented by 1. The Status LED is lit with an orange light. It means the device is detecting signal strength. 2. The Status LED is lit with a green light. It means the device tries to dial-up and ask for a IP address from the GPRS ISP network GRPS Ready LED is represented by 1.
If the GPRS connection in the device is failed, the light-up order of the LEDs and time interval between each state is very critical information to check the cause. There are two possible scenarios for failed GPRS connection. 1. If you meet the following scenario, the possible cause is the ping action can not reach to target. We suggest that you can check the content in Ping Target field of GPRS/3G configuration page. We suggest you can change the content to public server, such as www.google.com. 2.
www.advantech.com Please verify specifications before quoting. This guide is intended for reference purposes only. All product specifications are subject to change without notice. No part of this publication may be reproduced in any form or by any means, electronic, photocopying, recording or otherwise, without prior written permission of the publisher. All brand and product names are trademarks or registered trademarks of their respective companies. © Advantech Co., Ltd.