NPort Family Software Installation Guide Fourth Edition, May 2004
NPort Family Software Installation Guide The software described in this manual is furnished under a license agreement and may be used only in accordance with the terms of that agreement. Copyright Notice Copyright 2004 Moxa Technologies Co., Ltd. All rights reserved. Reproduction without permission is prohibited. Trademarks MOXA is a registered trademark of Moxa Technologies Co., Ltd. All other trademarks or registered marks in this manual belong to their respective manufacturers.
MOXA Internet Services Customer satisfaction is our number one concern. To ensure that customers receive the full benefit of our products, Moxa Internet Services has been set up to provide technical support, driver updates, product information, and user’s manual updates. The following services are provided: E-mail for technical support: address: support@moxa.com.tw Latest drivers and documents: address: http://www.moxa.com World Wide Web (WWW) site for product information: address: http://www.moxa.
Table of Contents 1 Introduction ........................................................................................1-1 NPort Family Features.....................................................................1-1 Operation Mode Specification Chart................................................1-2 How To Use This Manual.................................................................1-3 2 Initial IP Address Configuration .......................................................
5 Firmware Configuration ................................................................... 5-1 Server Configuration....................................................................... 5-2 Choosing the Proper Operation Mode............................................ 5-4 Host Based / Driver Mode.................................................... 5-4 Pair Connection Mode ......................................................... 5-6 Socket Modes ...........................................................
1 1 Introduction In this chapter, we present the following topics: NPort Family Features Operation Mode Specification Chart How To Use This Manual NPort Family Features The Moxa NPort Family of products covered by the software discussed in this guide consists of NPort Express (DE-211/311), NPort Server Lite (DE-301/302/331/332), and NPort Server Pro (DE-303/308). These products come with the following features: Long range connection through the Intranet/Internet between host and serial device.
Operation Mode Specification Chart Model NPort Express DE-311 NPort Express DE-211 Windows Real COM driver √ √ √ √ √ √ Linux fixed tty driver √ √ √ √ √ √ Linux real tty driver √ √ √ √ √ √ TCP Server √ √ √ √ √ √ TCP Client √ √ √ √ √ √ UDP Server/Client √ √ √ √ √ √ Pair Connection √ √ √ √ Ethernet Modem √ √ √ Operation Mode NPort Express Module DE-311M NPort Server NPort Server NPort Server Lite DE-301, Lite DE-302, Pro DE-308, DE-331 DE-304, DE-303 DE-3
How To Use This Manual First time installation See Chapter 2 for instructions on how to configure your NPort product’s IP address. Configuration See Chapter 3 for instructions on how to install NPort Management Suite, and how to use Configurator, a useful Windows GUI . See Chapter 5 for instructions on how to configure your NPort Product’s firmware via Telnet Console or Serial Console. See Chapter 5 for configuration parameter definitions.
2 2 Initial IP Address Configuration When setting up your NPort for the first time, the first thing you should do is configure the Device Server’s IP address. This chapter includes the following sections: Initializing NPort’s IP Address Factory Default IP Address NPort Management Suite the method we recommend ARP Telnet Console Serial Console (119200, n, 8, 1) Initializing NPort’s IP Address 0. Determine whether your NPort needs to use Static IP or Dynamic IP (either DHCP or BootP application). 1.
Factory Default IP Address NPorts are configured with the following default private IP address: Default IP address: 192.168.127.254 (IP addresses of the form 192.168.xxx.xxx are referred to as private IP addresses, since it is not possible to directly access a device configured with a private IP address from a public network. For example, you would not be able to ping such a device from an outside Internet connection.
3. Execute the ‘arp -s’ command from your computer’s MS-DOS prompt by typing: arp –s 192.168.200.100 00-90-E8-xx-xx-xx This is where 192.168.206.100 is the new IP address and 00-90-E8-xx-xx-xx is the MAC address for your NPort. You will need to change both numbers, as described above in points 1 and 2. 4. Next, execute a special Telnet command by typing: telnet 192.168.200.100 6000 After issuing this command, the Telnet session a Connect failed message will appear, as shown here.
5. To ensure proper operation, click on the Terminal menu, choose Preferences…, and then make sure VT100 Arrows is checked. 6. Use the keyboard arrow keys to highlight [serverConfig] as shown below, and then press Enter. 7. A window showing the various parameters required to configure the NPort opens up, with configurable parameters enclosed in square brackets. 8. Use the keyboard arrow keys to position the cursor over the first digit of the IP address.
PComm Lite.) NOTE You must set DIP switch 1 to the ON position to be able to establish a console connection. 1. Plug your NPort Express’s female serial port directly into your computer’s male RS-232 serial port, or use an appropriate converter (refer to the Hardware Installation Guide for details). 2. From the Windows desktop click on Start Terminal Emulator. Programs PComm Lite 3.
6. Choose 1 for ansi/vt100 terminal emulation type, and then press Enter. 7. Use the keyboard arrow keys to highlight [serverConfig], and then press Enter to select this option. 8. A window showing the various parameters required to configure NPort Express opens up, with configurable parameters enclosed in square brackets. 9. Use the keyboard arrow keys to position the cursor over the first digit of the IP address.
3 3 NPort Management Suite NPort Management Suite consists of five programs—Configurator, Real COM Installer, NPort Monitor, NPort Batch Configurator (Windows and Linux versions), and Uninstall NPort Management Suite—that are designed to make it easy to configure and manage your NPorts.
2. Click on Next when the Welcome! window opens to proceed with the installation. 3. Select the NPort Management Suite utilities that you would like to install. 4. Click on Next to install program files in the default directory, or click on Browse to select an alternative location.
5. Click on Next to proceed with the installation. 6. The Installing window reports the progress of the installation. 7. If you select Later, you can always run Configurator or Real COM Installer later from under the Windows Start button (see the appropriate sections below for details).
Configurator Configurator is a comprehensive Windows GUI that can be used to conveniently configure and maintain multiple NPorts. It is designed to provide you with instantaneous control of all your NPorts, regardless of location. Configurator provides the following useful utilities: Broadcast Search Locate all NPorts that are connected to the PC host’s LAN. Search by IP address Locate a specific NPort by IP address, even if the NPort is located outside the PC host’s LAN.
under the appropriate menu—Locate Server, Firmware, Configuration, View, or Help—or by clicking on an active utility icon. Configurator is very intuitive and quite easy to use. However, you can always refer to Configurator’s help file by selecting Help Topics under Help as shown below. Once the Help window opens, click on the topic that you wish to view. Broadcast Search The Broadcast Search function is used to locate all NPorts that are connected to the same LAN as your computer.
The Broadcast Search window will open and display the Model, IP Address, MAC Address, and Progress (of the search for that particular device). When the search is complete, the Broadcast Search window closes, and the NPorts that were located are displayed in the left pane of the Configurator window. Click on a server name in the left pane to display key information related to that server in the right pane.
The Broadcast Search window will open and display key information and the progress of the search for that particular NPort. If an NPort with the specified IP Address cannot be located, consult with your network administrator to get the correct IP address. If the search is successful, the Broadcast Search window closes, and key information related to the server is displayed in the right pane.
The Configuration window opens to the Network Settings page. To modify items, select or deselect the item by clicking in the checkbox next to the item. Click on the OP_Mode, Serial Settings, Access Control, or Password tabs to modify the settings of other parameters. NOTE Detailed information about these configuration parameters is given in Chapter 5, Firmware Configuration. Unlock Server The Unlock Server function is used to open a password protected NPort so that the user can modify its configuration.
blank The NPort is not password protected, and “Broadcast Search” was used to locate it. Fixed The NPort is not password protected, and “Search by IP address” was used to locate it. Locked Fixed The NPort is password protected, “Search by IP address” was used to locate it, and the password has not yet been entered from within the current Configurator session.
Next, use the Look in drop down menu to navigate to the folder where you want to store the configuration, type a file name in the File name input box, and then click on Open. When you see the Export configuration to file OK message, click OK to return to the Configurator window.
Import Configuration The Import Configuration function is used to import an NPort configuration from a file into one or more of the same model NPort. To import a configuration, first select the target servers (use the left mouse button to select servers; simply hold down the Ctrl key when selecting the second, third, etc. server).
At this point, the Configuration window will open to give you the option to select or deselect configuration items. This step is a very important part of the Import Configuration process. For example, when importing the same configuration to multiple servers, you will probably at least want to deselect Server Name and IP Address.
Upgrade Firmware To upgrade the firmware of one or more of the same model NPort, first select the servers whose firmware you wish to upgrade (use the left mouse button to select servers; simply hold down the Ctrl key when selecting the second, third, etc. server). Use the Look in dropdown menu to navigate to the folder containing the *.ROM firmware file for the model of NPort you have selected.
NPort Monitor NPort Monitor is used to monitor the ports of NPorts. To start NPort Monitor, click on Start NPort Management Suite Monitor. After the NPort Server Monitor window opens, you can access the help file to learn how to monitor the ports of your NPorts. The help file contains complete information on how to use NPort Monitor. NPort Batch Configurator NPort Batch Configurator is a command line program that performs the following special functions. 1.
NPort Batch Configurator provides the following useful runtime options: change The change option is used to change the IP addresses of one or more NPort that are connected to the PC host’s LAN. setting Modify the configurations of one or more of the same model NPort. export Export the configuration of one NPort to a file on the PC host. list List all NPorts that are currently connected to the same LAN as your computer.
Linux Version (npbc.tgz) NPort Batch Configurator for Linux, npbc.tgz, has the same functions as the Windows version. NOTE To install NPort Batch Configurator for Linux, find the file npbc.tgz, which is located on the NPort Software CD in the following directory: nport\software\linux\i386\npconfig You may also refer to the readme file on the software CD for information about: 1. IP and MAC address configuration 2. Export Configuration Table 3. Import Configuration to multiple NPorts.
4 4 Real COM Installer In this chapter, we discuss the basic tasks involved in configuring your NPort, and discuss the various operation modes that are available. This chapter includes the following sections: Add Server Wizard Reassigning COM Numbers The main purpose of Real COM Installer is to set up your host computer to communicate with particular NPorts configured for Host Based / Driver Mode. The Add Server Wizard utility is used to carry out this procedure.
Add Server Wizard Follow the steps given below to set up your host computer to communicate with NPorts configured for Host Based / Driver Mode. 1. To start Real COM Installer, click on Start Programs NPort Managemen t Suite COM Port Mapping Real COM Installer. 2. When the Real COM Installer window opens, select Add Server Wizard. 3. Make sure you have connected the NPort to the network, and then click on Next to proceed.
4. You can select Automatically search the LAN or Manually enter IP address. The second option allows you to search for NPorts that are not connected directly to your host’s LAN. 5. Click on the Model of the server you would like to add, and then click on Next to continue.
6. The NPort’s serial ports are mapped sequentially, starting from the smallest available COM number. Higher COM numbers that are already assigned to other ports will be skipped. NOTE After you install an NPort, you can use Real COM Installer’s Map Port function to reassign COM numbers to the server’s serial ports. 7. Click on Next to save the settings to your host computer and the NPort.
8. Select whether or not you would like to enable the COM ports that were just assigned, and then click on Finish. 9. If you are currently running programs that access the newly added NPort’s serial port(s), be sure to shut down those programs before clicking on Yes in the following window. 10. Real COM Installer will now display the NPort and ports that were just added to your host computer. Reassigning COM Numbers Follow the instructions given below to reassign COM numbers to NPort ports. 1.
2. The Port Properties window will open, at which time you will be able to view the COM number currently assigned to the port (COM3 for this example). Transmission Mode: Hi-performance mode is the default for Tx mode. If the driver completes sending data out to the NPort, the driver will respond “Tx Empty” to the program. Under classical mode, the driver will not notify the user’s program that Tx is completed until all Tx data has been sent out from the NPort; this mode will cause lower throughput.
Fast Flush (only flush local buffer) (1) We have added one optional “Fast Flush” function in our new NPort Real COM driver. NPort Management Suite for 1 G NPort adds this function after version 3.2. (2) For some applications, the user’s program will use the Win32 “PurgeComm()” function before it reads or writes data. With our design, after the program uses this PurgeComm() function, the NPort driver will keep querying NPort firmware buffer, rather than just flushing the local buffer.
5. Make sure that any programs currently accessing the COM ports are shut down, and then click Yes to accept the change, and restart the NPort.
5 5 Firmware Configuration In this chapter, we discuss the basic tasks involved in configuring your NPort, and discuss the various operation modes that are available.
Server Configuration The following figures show the basic parameters that must be set up before you can begin using your NPort. Refer to the table on the next page to see details of the meaning of each parameter. Console Management NOTE Click on the Password tab to modify the NPort’s password.
Setting Server Model Server Name Serial Number IP Configuration Ethernet Status MAC Address (Static) IP Address Netmask Gateway Password Server Configuration Value Comments DE-xxx Set at the factory. This option is useful for specifying the location or alpha-numeric application of different servers. alpha-numeric Set at the factory. Static IP Choose one of the four DHCP values at the left to DHCP/BOOTP determine how the IP address will be configured.
Choosing the Proper Operation Mode In this section, we describe the various NPort operation modes. The options include an operation mode that uses a driver installed on the host computer, operation modes that rely on TCP/IP socket programming concepts, and operation modes that typically involve communication between pairs of appropriately configured NPorts.
Figure 3.1 illustrates a Host Based / Driver Mode topology that consists of two hosts that share access to two NPorts. The NPort Server Pro unit is connected to several serial devices, with half of the ports Fig. 3.1: Host Based / Driver Mode relegated to Host A, and the other half to Host B. The NPort Server Lite unit is connected to two serial devices, and can be configured so that one or both of the hosts are allowed access to these two devices.
Host Based / Driver Mode Notes Necessity The TCP port through which data TCP data port 950 Required is sent. TCP command The TCP port through which 966 Required commands are sent. port Once the NPort receives both Delimiter 1 ASCII code for delimiters through its serial port, Optional the 1st delimiter it immediately packs all data (Hex) currently in its buffer and sends it out the NPort’s Ethernet port. Delimiter 2 ASCII code for Note: Delimiter 2 is optional.
Figure 3.2 illustrates a Pair Connection Mode topology that consists of two NPorts used to provide access to a serial device (in this case, the PLC). This example illustrates that access to the serial device can be provided to non-PC hosts, such as the Fig. 3.2: Pair Connection Mode Writer shown in the figure. The following figures show the additional parameters that can be configured for Pair Connection Mode. Refer to the tables below the figures to see details of the meaning of each parameter.
Pair Connection (Master) Value Notes Necessity IP address of another NPort, configured for Pair Connection (Slave), with Remote IP address valid IP Required which this NPort can request a connection. TCP connection is never 0 closed by this device. TCP connection is Optional TCP alive check time automatically closed by this 1 – 99 min. device if there is no TCP activity for the given time. Setting Pair Connection (Slave) Value Notes Allows contact with only the valid IP specified remote IP address.
also means that your application software acts as a Client, in that it can actively poll remote serial devices. Figure 3.3 illustrates a TCP Server Mode topology that consists of one NPort connected by a serial cable to a router’s console port. Working from the notebook computer, the user can request that the NPort open a port, and in this way access the router’s serial console utility. Fig. 3.
TCP Server Setting Value Notes Necessity The TCP port that other devices must use to contact this device. To TCP port valid port number avoid conflicts with standard TCP Required ports, the default is set to 4001. Allows contact with only the Destination IP valid IP specified remote IP address. Optional Allows contact with any remote addr blank networked device.
Figure 3.4 illustrates a TCP Client Mode topology that consists of one NPort connected by a serial cable to a Card Reader. The NPort can be configured so that when someone swipes their card, the device server requests a connection from the computer, after which the card’s data is sent over the Ethernet connection. Fig. 3.4: TCP Client Note that the Destination IP address is a required option. This means that the device can only be set up to request service from one remote networked device.
TCP Client Setting Notes Necessity Allows connection with only the Destination IP addr valid IP Required specified remote IP address. Specific TCP port through which valid port the remote IP address listens TCP port Required number over the TCP connection. Attempts to establish a TCP connection as soon as the NPort Startup is powered on. Required TCP connect Attempts to establish a TCP Any connection as soon as the NPort Character starts receiving serial data.
UDP Server/Client The UDP Server/Client operation mode is designed for applications that need speedier data transmission, or that make use of UDP’s broadcast and multi-cast capabilities. Keep in mind that UDP differs from TCP in that a UDP transmission does not first require a connection to be opened before sending data, and the receiving party does not issue acknowledgements to the sender. Figure 3.
The following figures show the additional parameters that can be configured for UDP Server/Client Mode. Refer to the table below the figures to see details of the meaning of each parameter.
Server/Client Setting Value Notes Necessity (serial to LAN) Dest. IP addr 1 Dest. IP addr 2 Dest. IP addr 3 Dest. IP addr 4 A host or a Data is sent from the NPort to group of hosts. these remote IP addresses. Required Optional Optional Optional (LAN to serial) Src. IP addr 1 Src. IP addr 2 Src. IP addr 3 Src. IP addr 4 Optional Allows receipt of data from only Optional A host or a these specified remote IP group of hosts. addresses.
Ethernet Modem Mode (NPort Express ONLY) The Ethernet Modem operation mode is designed for use with legacy operating systems, such as MS-DOS, that do not support TCP/IP Ethernet. By connecting a 1-port NPort’s (applies to models DE-211/311/311M) serial port to the MS-DOS computer’s serial port, it is possible to use legacy software originally designed to transmit data via modem, but now transmit the data over the Ethernet. Figure 3.
Using Ethernet Modem Dial-in NPort Express listens for a TCP/IP connection request from the remote Ethernet modem or host. NPort Express’s response depends on the ATS0 value, as outlined below. ATS0=0 (default): NPort Express will temporarily accept the TCP connection and then send the “RING” signal out through the serial port. The serial controller must reply with “ATA” within 2.5 seconds to accept the connection request, after which NPort Express enters data mode.
Disconnection request from remote site After the TCP connection has been shut down by the remote Ethernet modem or PC, NPort Express will send the “NO CARRIER” signal via the serial port and then return to command mode. The following figures show the additional parameters that can be configured for TCP Client Mode. Refer to the table below the figures to see details of the meaning of each parameter.
AT Commands NPort Express supports the following common AT commands used with a typical modem: No. AT command 1 ATA 2 ATD : 3 ATE 4 5 6 7 8 9 10 11 12 13 14 15 16 17 Description Remarks Answer manually Dial up the IP address : Port No.
18 19 20 21 22 AT&G AT&R AT&S AT&V AT&W Select guard time Serial port RTS option command Serial port DSR control View settings Write current settings to flash for next boot up reply “OK” only reply “OK” only reply “OK” only S Registers No.
Serial Settings You should access Console Manager’s Serialport page, or Configurator’s Serial Settings page to modify a port’s Baud Rate, Parity, Data Bits, Stop Bit, Flow Control, and UART FIFO. Console Management Configurator Access Control Configurator’s Access Control page allows you to add or remove host access to the NPort. Access to NPorts is controlled by IP address. That is, if a host’s IP address is in the server’s access table, then the host will be allowed access to the server.
Granting Access by IP Address Use the grant access control by IP Address method if you wish to grant access to a host with a particular IP address. Note that the top IP address belongs to the NPort, and the IP address(es) below that are for hosts that have been granted access. By clicking on the various IP addresses and ports to highlight them, you can easily see the types of functions (Add IP, Add Port, etc.) that are allowed.
Inputting IP Addresses There are two options to choose from when inputting IP addresses. The Single Host option is easy to understand. Simply enter the IP address of the host that is being granted access to the NPort. The meaning of the A Group of Host option is a little bit more complicated. In this case, you must enter both an IP Address and Netmask. When written in binary form, the 1-digits in the Netmask determine that part of the IP address for which all IP addresses in the Group are the same.
A A Document Edition 3 rd Revision History Revision Date Revision Details November 15, 2002 This version of the manual represents a major revision from the previous version. 1. All NPort related software is installed when the user installs NPort Management Suite. 2. NPort Manager has been renamed Real COM Installer. 3. Host Based Mode has been renamed Host Based / Driver Mode. 4. The firmware version discussed in this manual no longer supports Single Host Mode. 5.
4th May 12, 2004 1. Updated the edition of this manual on the title page. 2. Changed the new Moxa logo on the title page. 3. p. 4-7 Added descriptions on newly-added function “Fast Flush”.
