NE-4100 Series User’s Manual Seventh Edition, September 2006 www.moxa.com/product MOXA Technologies Co., Ltd. Tel: +886-2-8919-1230 Fax: +886-2-8919-1231 Web: www.moxa.com MOXA Technical Support support@moxa.com Worldwide: support@usa.moxa.
NE-4100 Series User’s Manual 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 © 2006 MOXA Technologies Co., Ltd. All rights reserved. Reproduction without permission is prohibited. Trademarks MOXA is a registered trademark of The MOXA Group. All other trademarks or registered marks in this manual belong to their respective manufacturers.
Table of Contents Chapter 1. Introduction ...............................................................................................1-1 Overview .............................................................................................................................. 1-2 Package Checklist................................................................................................................. 1-2 Product Features ..............................................................................
Chapter 6. Web Console Configuration .....................................................................6-1 Opening Your Browser ......................................................................................................... 6-2 Web Console Navigation ...................................................................................................... 6-3 Basic Settings .......................................................................................................................
Hardware Setup ............................................................................................................ 8-2 Installing Linux Real TTY Driver Files ....................................................................... 8-2 Mapping TTY Ports...................................................................................................... 8-3 Removing Mapped TTY Ports...................................................................................... 8-3 Removing Linux Driver Files .
Read Multiple DIO .............................................................................................................. D-4 Command .................................................................................................................... D-4 Response...................................................................................................................... D-4 C Code Example:........................................................................................................
1 Chapter 1. Introduction The NE-4100 Series embedded device server is a line of compact modules that act as network enablers. NE-4100 Series modules can be installed in or on a serial device to connect it to an Ethernet network, allowing you to gain network access to any electronic device that has a serial port. All NE-4100 Series modules come equipped with built-in TCP/IP protocols for fast integration, saving you time and energy on programming. The following topics are covered in this chapter.
NE-4100 Series User’s Manual Introduction Overview NE-4100 Series modules are a type of embedded device server or network enabler. An NE-4100 Series module may be installed in or attached to a serial device to make it accessible from a network. There are three types of module offered: drop-in (NE-4100T), RJ45 (NE-4110S, NE-4110A), and pin header (NE-4120S, NE-4120A). The last letter of the model number indicates the serial signal supported by the module.
NE-4100 Series User’s Manual Introduction Product Specifications NE-4100T NE-4110S, NE-4110A NE-4120S, NE-4120A System CPU 16-bit MCU RAM 1 MB Flash 2 MB LAN Ethernet 10/100 Mbps, pin headers Protection 10/100 Mbps, RJ45 10/100 Mbps, pin headers built-in transformer with 1.
NE-4100 Series User’s Manual NE-4100T Introduction NE-4110S, NE-4110A NE-4120S, NE-4120A Environmental Operating Temperature Storage Temperature 0°C to 70°C (32°F to 158°F), 5% to 95%RH -20°C to 85°C (-4°F to 185°F), 5% to 95%RH Regulatory Approvals EMC FCC Class A, CE Class A Warranty 5 years 1-4
2 Panel Layout and Pin Assignments Chapter 2. This chapter includes information about the panel layouts and pin assignments for NE-4100 Series modules. The layouts and reference circuit diagrams for the evaluation boards are also covered. The evaluation boards are used for evaluation and development of applications for NE-4100 Series modules.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4100T, NE-4100-ST The NE-4100T is a TTL-to-Ethernet drop-in module. It measures 45 × 36 mm, and has a dual-in-line, 26-pin design, making it easy to integrate with your serial devices. The NE-4100-ST is the evaluation board for testing NE-4100T modules and developing your own applications. Panel Layout NE-4100T Pin #1 45.00 mm 36.00 mm Pin #14 NE-4100-ST 149.00 mm Ethernet Port 99.
NE-4100 Series User’s Manual LED Name DIO0 DIO1 DIO2 DIO3 TXD0 RXD0 DTR0 CTS0 DSR0 DCD0 RTS0 TXD1 RXD1 Panel Layout and Pin Assignments LED Color red red red red red red red red red red red red red LED Function Indicates that DIO is in “low” (0) status. Indicates that DIO is in “low” (0) status. Indicates that DIO is in “low” (0) status. Indicates that DIO is in “low” (0) status. Indicates that TXD0 has a signal. Indicates that RXD0 has a signal. Indicates that DTR0 has a signal.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4100-ST Serial Port Pinouts (DB9 Male) Debug Serial Port for Serial Console Pin Signal 2 3 5 RXD TXD GND RS-232 Port for Connecting Serial Devices Pin Signal 1 2 3 4 5 6 7 8 DCD RXD TXD DTR GND DSR RTS CTS 5 3 2 5 4 3 2 1 DIO Terminal Block D0 D1 D2 D3 Block Diagrams +5 VDC 1 MB SDRAM Customer's Device 2 MB Flash 80186 CPU 10/100M Ethernet PHY TTL Serial data UART0 (Tx, Rx, RTS, CTS, DTR, DSR, DCD) MAC Transformer 1.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4110S, NE-4110A, NE-4110-ST The NE-4110S is an RS-232-to-Ethernet server, and the NE-4110A is an RS-422/485-to-Ethernet server. Both models use an RJ45 connection and measure 57 × 40 mm. The NE-4110-ST is the evaluation board for testing NE-4100S and NE-4110A modules and developing your own applications. Panel Layout NE-4110S 1 2 57.00 mm 2 10 1 9 40.00 mm J1 14 13 J2 NE-4110A 1 2 57.00 mm 2 10 1 9 40.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4110-ST LED Indicators LED Name Power LED Color red green Ready steady off DIO0 DIO1 DIO2 DIO3 TXD0 RXD0 DTR0 CTS0 DSR0 DCD0 RTS0 TXD1 RXD1 red red red red red red red red red red red red red LED Function Indicates the power is on. Steady on: Power is on and NE-4110 is functioning normally. Blinking: NE-4110 has been located by Network Enabler Administrator. y Power is off, or power error condition exists.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments ATTENTION For the 2-wire RS-485 interface, pin 3 is for Data+ (B) and pin 4 is for Data- (A).
NE-4100 Series User’s Manual Panel Layout and Pin Assignments Block Diagrams NE-4110S Block Diagram +5 VDC 1 MB SDRAM 2 MB Flash Serial data (Tx, Rx, RTS, CTS, DTR, DSR, DCD) 10/100 M Ethernet PHY Customer's device 80186 CPU UART0 MAC Transformer 1.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4120S, NE-4120A, NE-4120-ST The NE-4120S is an RS-232-to-Ethernet server, and the NE-4120A is an RS-422/485-to-Ethernet server. Both models use pin headers instead of RJ45 connectors. The NE-4120-ST is the evaluation board for testing NE-4120S and NE-4120A modules and developing your own applications. ATTENTION The NE-4120-ST is the same board as the NE-4110-ST but with an RJ45 jack and pin headers.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4120-ST Jumper 7 (J7) Jumper 9 (J9) 149.00 mm 1 2 Ethernet Port 5 3 3 9 10 1 2 2 Power Jack 1 99.00 mm 13 14 Jumper 10 (J10) Interface Selector Jumpers ON 1 DIP 2 3 4 DI/O Selector Jumpers DI/O Signal Setting Switches Reset Button Debug Serial COM Port Serial Port (RS-232) DI/O Terminal Block * JP2 is used to select RS-232 or RS-422/485 operation.
NE-4100 Series User’s Manual Panel Layout and Pin Assignments Pin Assignments NE-4120S Serial Header Pinouts (J1) NC CTS0 DSR0 DTR0 RxD0 10 8 6 4 2 9 7 5 3 1 NC RTS0 GND TxD0 DCD0 NE-4120A Serial Header Pinouts (J1) NC NC NC RxDTxD+ 10 8 6 4 2 9 7 5 3 1 NC NC GND RxD+ TxD- ATTENTION The symbols “B” and “A” are often used in place of “+” and “-”, respectively. ATTENTION For the 2-wire RS-485 interface, pin 3 is for Data+ (B) and pin 4 is for Data- (A).
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4120-ST Pinouts Debug Serial Port for Serial Console Pin Signal 2 3 5 RXD TXD GND RS-232 Port for Serial Devices 5 3 2 Pin Signal 1 2 3 4 5 6 7 8 DCD RXD TXD DTR GND DSR RTS CTS 5 4 3 2 1 8 7 6 Serial and DIO Terminal Blocks TXD+ TXD- RXD+ RXD- SGND D0 D1 D2 D3 Data+ Data- Block Diagrams NE-4120S Block Diagram +5 VDC 1 MB SDRAM 2 MB Flash Serial data (Tx, Rx, RTS, CTS, DTR, DSR, DCD) 10/100 M Ethernet PHY 80186 CPU UAR
NE-4100 Series User’s Manual Panel Layout and Pin Assignments NE-4120A Block Diagram +5 VDC 1 MB SDRAM 2 MB Flash RS-422/485 Signal 10/100 M Ethernet PHY 80186 CPU UART0 MAC Transformer 1.
3 Chapter 3. Getting Started This chapter includes information about installation of NE-4100 Series modules for development and testing.
NE-4100 Series User’s Manual Getting Started Wiring Precautions This section describes some important safety precautions that you should pay attention to before proceeding with any installation. ATTENTION Be sure to disconnect the power cord before installing or wiring the evaluation board. ATTENTION Determine the maximum possible current in each power wire and common wire. Observe all electrical codes dictating the maximum current allowable for each wire size.
NE-4100 Series User’s Manual Getting Started Installing the NE-4100T onto the NE-4100-ST Before using the NE-4100-ST evaluation board with the module, disconnect the power supply, network, and serial device. In the center of the evaluation board, there is a square with one white inverted triangle (shown as black in the figure) on one of its sides, and 2 rows of female sockets on the other two sides. The NE-4100T module also has a white inverted triangle on one of its sides.
NE-4100 Series User’s Manual Getting Started Installing the NE-4120S, NE-4120A onto the NE-4120-ST The NE-4120S and NE -4120A modules are attached to the NE-4120-ST board using mounting screws that are provided with the board. When attaching the module to the board, make sure that the module is oriented so that the jumper banks on the module and the board are aligned as shown below.
NE-4100 Series User’s Manual Getting Started Note that the RS-485 interface is selected on the evaluation board for the NE-4110A and NE-4120A modules, even when the module is operating in RS-422 mode. Please refer to Chapter 2 - Panel Layout and Pin Assignments for additional details. Circuit Pad for External Connection A circuit pad is provided on the right side of each evaluation board for the development of additional application circuits. 5V 3.
NE-4100 Series User’s Manual Getting Started Connecting to the Network To connect to the network for testing and development purposes, the module should be installed onto its evaluation board. Make sure that the module is correctly installed onto the evaluation board, then plug the Ethernet cable into the RJ45 jack. For models NE-4100T, NE-4120S, and NE-4120A, the RJ45 jack is located on the evaluation board; for models NE-4110S and NE-4110A, the RJ45 jack is located on the module itself.
NE-4100 Series User’s Manual Getting Started DI/O Selectable Jumper DI/O Mode DI DO 0 1 2 3 Digital Input 0 1 2 3 ON 1 DIP 2 3 ON: Low OFF: High Digital Input Signal Setting Switch 4 Digital Output DO0 DO1 DO2 DO3 Digital Output LEDs : Low : High DO0 DO1 DO2 DO3 DI/O Terminal Block DI/O Mode jumpers 0 through 3 correspond with DIO channels 0 through 3. The jumper’s position determines whether the corresponding channel is linked to a DIP switches or to an LED.
NE-4100 Series User’s Manual Getting Started For channels in digital output mode, “Low” and “High” status is controlled from within the web console. When using a Digital Output LED as your output device, “Low” status will be expressed by the LED lighting up, and “High” status will be expressed by the LED turning off. Digital Output DO0 DO1 DO2 DO3 : Low : High Digital Output LEDs Digital Output LED Circuit Design The figure shown below is the digital output LED circuit design.
4 Chapter 4. Choosing the Proper Operation Mode In this section, we describe the various operation modes of NE-4100 Series modules. Depending on your intended use, the operation mode will determine how serial communication is handled by the network. There is an operation mode for COM port mapping from the host computer as well operation modes for TCP/IP protocols. After choosing the proper operating mode in this chapter, please refer to subsequent chapters for details on configuration parameters.
NE-4100 Series User’s Manual Choosing the Proper Operation Mode Overview NE-4100 Series modules act as a bridge to connect your serial devices to the Ethernet. The built-in TCP/IP stack means less time spent on programming networking protocols. With one step you may choose the proper operation mode, then use your computer to access, manage, and configure your serial device from anywhere in the world over the Internet.
NE-4100 Series User’s Manual Choosing the Proper Operation Mode TCP Client Mode In TCP Client mode, the module can actively establish a TCP connection to a pre-defined host computer when serial data arrives. After the data has been transferred, the module can automatically disconnect from the host computer by using the “TCP alive check time” or “Inactivity time” settings. Please refer to the following chapters for more details. As illustrated in the figure, data transmission proceeds as follows: 1.
NE-4100 Series User’s Manual Choosing the Proper Operation Mode Real COM Mode Real COM mode allows users to continue using software that was written for pure serial communications applications. Each module comes equipped with COM drivers for Windows systems (95 and above). The serial module’s serial port is mapped by the driver to an IP address and port number. The driver intercepts data sent to the host’s COM port, packs it into a TCP/IP packet, and then redirects it through the host’s Ethernet card.
5 Chapter 5. Initial IP Address Configuration When setting up your NE-4100 Series module for the first time, the first thing you should do is configure the IP address. This chapter introduces the methods that can be used to configure the module’s IP address. For more details about network settings, please refer to the Network Settings section from Chapter 6 - Web Console Configuration. This chapter includes the following sections: Static vs.
NE-4100 Series User’s Manual Initial IP Address Configuration Static vs. Dynamic IP Address Determine whether the module will use a Static IP or Dynamic IP (either DHCP or BOOTP application). z z If the module is used in a Static IP environment, you will configure the IP address directly. If the module is used in a Dynamic IP environment, you will configure the module to obtain an IP address dynamically with DHCP, DHCP/BOOTP, or BOOTP.
NE-4100 Series User’s Manual Initial IP Address Configuration To configure the IP address using ARP, follow these instructions: 1. Obtain a valid IP address for the module from your network administrator. 2. Obtain the module’s MAC address from the label on the module. 3. Execute the ‘arp -s’ command from your computer’s MS-DOS prompt by typing: arp –s 00-90-E8-xx-xx-xx For example, arp –s 192.168.200.100 00-90-E8-00-00-00 In the example above, 192.168.200.
NE-4100 Series User’s Manual Initial IP Address Configuration 3. Select Network settings by pressing 2 and then Enter. 4. Select IP address by pressing 1 and then Enter. 5. Use the Backspace key to erase the current IP address, then type in the new IP address and press Enter.
NE-4100 Series User’s Manual Initial IP Address Configuration 6. Press any key to continue. 7. Press M and then Enter to return to the main menu. 8. Press S and then Enter to Save/Restart the system. 9. Press Y and then Enter to save the new IP address and restart the module.
NE-4100 Series User’s Manual Initial IP Address Configuration be used for this purpose, although you are free to choose among other terminal emulators that are widely available. PComm Lite may be downloaded at www.moxa.com. The following instructions show the procedure using PComm Lite. If you are using another utility, the instructions may vary slightly. 1.
6 Chapter 6. Web Console Configuration The web console is the most user-friendly way to configure your NE-4100 Series module. This chapter introduces the web console function groups and function definitions.
NE-4100 Series User’s Manual Web Console Configuration Opening Your Browser 1. Open your browser with the cookie function enabled. (To enable your browser for cookies, right click on your desktop Internet Explorer icon, select Properties, click on the Security tab, and then select the three Enable options as shown in the figure below.) 2. Type 192.168.127.254 in the Address box (use the correct IP address if different from the default), and then press Enter.
NE-4100 Series User’s Manual 3. Web Console Configuration The web console will open. On this page, you can see a brief description of the web console’s eleven function groups. Note: “Serial Command Mode” is supported in firmware version 3.0 and above. ATTENTION If you can’t remember the password, the ONLY way to configure the module is to load factory defaults by using the reset button located near the DB9 male serial port on the evaluation board.
NE-4100 Series User’s Manual Web Console Configuration Basic Settings Note: “Serial Command Mode” is supported in firmware version 3.0 and above. Server name Setting Factory Default Necessity 1 to 39 characters NP[model name]_[Serial No.] Optional This option can be used to specify the location or application of the module, which may be useful when managing more than one module on the network. Time The module has a built-in Real-Time Clock for time calibration functions.
NE-4100 Series User’s Manual Web Console Configuration Time server Setting Factory Default IP or domain address (E.g., 192.168.1.1, time.stdtime.gov.tw, or None time.nist.gov) NE-4100 Series modules use SNTP (RFC-1769) for auto time calibration. Necessity Optional Enter the Time Server IP address or domain address. When the Time Server IP address is provided, the module will request time information from the Time Server every 10 minutes.
NE-4100 Series User’s Manual Web Console Configuration IP configuration Method Static DHCP Function Definition User defined IP address, Netmask, Gateway. DHCP Server assigned IP address, Netmask, Gateway, DNS, and Time Server DHCP Server assigned IP address, Netmask, Gateway, DNS, and Time DHCP/BOOTP Server, or BOOTP Server assigned IP address BOOTP BOOTP Server assigned IP address IP configuration is a required field. The default setting is Static.
NE-4100 Series User’s Manual Web Console Configuration DNS server 1 / DNS sever 2 Setting Factory Default Necessity E.g., 192.168.1.1 None Optional (IP addresses of the form x.x.x.0 and x.x.x.255 are invalid.) Domain Name System (DNS) is how Internet domain names are identified and translated into IP addresses. A domain name is an alphanumeric name, such as moxa.com, that it is usually easier to remember.
NE-4100 Series User’s Manual z z Web Console Configuration Install Network Enabler Administrator and use the built-in IP Address Report function. Develop software that parses the IP address report data. Please refer to Appendix C for details on how to parse the module’s IP address report data. Auto report to IP Setting Factory Default Necessity E.g., 192.168.1.1 or URL None Optional (IP addresses of the form x.x.x.0 and x.x.x.255 are invalid.) If left blank, auto IP reporting is disabled.
NE-4100 Series User’s Manual Web Console Configuration Port Alias Setting 1 to 15 characters (E.g., PLC-No.1) Factory Default Necessity None Optional This function is designed for future use. You may enter a string to help in the module’s serial port from other serial ports. Serial Parameters ATTENTION Refer to the serial communication parameters in your serial device’s user’s manual. The module’s serial parameters should be the same as the parameters used by your serial device.
NE-4100 Series User’s Manual Web Console Configuration Operating Settings TCP Server Mode Note: “Serial Command Mode” is supported in firmware version 3.0 and above. TCP alive check time Setting Factory Default 0 to 99 min 7 min 0 min: The TCP connection is not closed due to an idle TCP connection. Necessity Optional 1 to 99 min: The module automatically closes the TCP connection if there is no TCP activity for the given time.
NE-4100 Series User’s Manual Web Console Configuration Max connection Setting Factory Default Necessity 1, 2, 3, 4 1 Required Max connection is used when the user needs to receive data from different hosts simultaneously. The factory default only allows 1 connection at a time. Max. connection 1: The module will only allow 1 host to open the TCP connection to the specific serial port.
NE-4100 Series User’s Manual Web Console Configuration The Force transmit field is typically used in conjunction with the Delimiter fields to specify how data in the module’s buffer is packed for network transmission. When delimiters are used, the module accumulates data in its buffer as it waits to receive a delimiter. If there is a break in communication, data will be held in the buffer as the module continues to wait for a delimiter.
NE-4100 Series User’s Manual Web Console Configuration Max connection Setting Factory Default Necessity 1, 2, 3, 4 1 Required Max connection is used when the user needs to receive data from different hosts simultaneously. The factory default only allows 1 connection at a time. When Max Connection is set to 1, the Real COM driver on the specific host has full control. Max. connection 1: The module will only allow 1 host’s Real COM driver to open a connection to the module’s serial port.
NE-4100 Series User’s Manual Web Console Configuration the module will also pack data for network transmission if the next byte of data is not received within the Force transmit time. ATTENTION Do not enable Delimiter 2 if Delimiter 1 has been disabled. The delimiter function will not work properly if Delimiter 2 is enabled without Delimiter 1. Force transmit Setting 0 to 65535 ms 0: The force transmit timeout is disabled.
NE-4100 Series User’s Manual Web Console Configuration TCP Client Mode Note: “Serial Command Mode” is supported in firmware version 3.0 and above. TCP alive check time Setting Factory Default 0 to 99 min 7 min 0 min: The TCP connection is not closed due to an idle TCP connection. Necessity Optional 1 to 99 min: The module automatically closes the TCP connection if there is no TCP activity for the given time. After the connection is closed, the module starts listening for another host’s TCP connection.
NE-4100 Series User’s Manual Web Console Configuration ATTENTION The Inactivity time should be longer than the Force transmit timeout. To prevent the unintended loss of data due a session getting disconnected, it is strongly recommended that this value is set large enough so that the intended data transfer is completed. ATTENTION Inactivity time is only active when TCP connect on is set to Any Character.
NE-4100 Series User’s Manual Web Console Configuration module accumulates data in its buffer as it waits to receive a delimiter. If there is a break in communication, data will be held in the buffer as the module continues to wait for a delimiter. The Force transmit field allows you to specify the maximum amount of time that the module will wait for data.
NE-4100 Series User’s Manual Web Console Configuration UDP Mode Note: “Serial Command Mode” is supported in firmware version 3.0 and above. Delimiter 1 Setting 00 to FF Factory Default “0” for None Necessity Optional Delimiter 2 Setting Factory Default Necessity 00 to FF “0” for None Optional The Delimiter fields are used to specify a character or 2-character sequence which will act as a marker to control packing of serial data.
NE-4100 Series User’s Manual Web Console Configuration Force transmit Setting 0 to 65535 ms 0: The force transmit timeout is disabled. Factory Default 0 ms Necessity Optional 1 to 65535: If the module does not receive the next byte of data within the time specified, it will packed the data in its buffer into the same data frame for network transmission.
NE-4100 Series User’s Manual Web Console Configuration Accessible IP Settings Note: “Serial Command Mode” is supported in firmware version 3.0 and above. The module uses an IP address based filtering method to control access. Accessible IP Settings allows you to specify a list of IP addresses or IP address ranges that are authorized to access the module. To allow access to a specific IP address Enter the IP address in the corresponding field; enter 255.255.255.255 for the netmask.
NE-4100 Series User’s Manual Web Console Configuration Auto Warning Settings E-mail and SNMP Trap Note: “Serial Command Mode” is supported in firmware version 3.0 and above. Mail server Mail server Setting IP or Domain Name Factory Default None Necessity Optional Factory Default None Necessity Optional Factory Default None Necessity Optional Factory Default NE_[Serial No.
NE-4100 Series User’s Manual Web Console Configuration SNMP trap server SNMP trap server IP or domain name Setting IP or Domain Name Factory Default None Necessity Optional Event Type Note: “Serial Command Mode” is supported in firmware version 3.0 and above. On the Event Type page, you may configure how administrators are notified of certain system, network, and configuration events. Depending on the event, different options for automatic notification are available, as shown above.
NE-4100 Series User’s Manual Web Console Configuration DCD changed, DSR changed DCD (Data Carrier Detect) and DSR (Data Set Ready) signals indicate serial communication status. Administrators can receive e-mail and SNMP trap warnings when there is a status change to the serial port. For example, a DCD change to high also means “Connected” between local modem and remote modem. If the DCD signal changes to low, it also means that the connection line is down.
NE-4100 Series User’s Manual Web Console Configuration DIO Monitor The DIO Monitor page polls and displays the mode and status of each DIO channel. You may use this page to verify changes that were made in the DIO Settings page. Note: “Serial Command Mode” is supported in firmware version 3.0 and above. Serial Command Mode Serial command mode is a special mode for configuring the module through the serial device itself. It is supported in firmware version 3.0 and above.
NE-4100 Series User’s Manual Web Console Configuration Load Factory Defaults To load the factory default settings, click on Load Factory Default in the navigation panel and then click on Submit. All previous modifications will be lost. Note: “Serial Command Mode” is supported in firmware version 3.0 and above. Save/Restart Click on Save/Restart in the navigation panel to save all submitted changes and restart the module.
7 Chapter 7. Network Enabler Administrator Network Enabler Administrator is a Windows utility that can be used to configure NE-4100 Series modules. In this chapter, we will discuss how to install and use Network Enabler Administrator.
NE-4100 Series User’s Manual Network Enabler Administrator Overview NE-4100 Series modules are shipped with an integrated software suite that bundles Network Enabler Administrator and the IP Serial Library. The suite provides everything you need to remotely manage, monitor, and modify the module—hassle free. Network Enabler Administrator organizes commands into logical groups to simplify the installation process. It allows off-line COM mapping and provides monitoring and IP location server functions.
NE-4100 Series User’s Manual Network Enabler Administrator 4. Click Install to install program files in the default directory. 5. The Installing window will report the progress of the installation. 6. Click Finish to complete the installation of Network Enabler Administrator.
NE-4100 Series User’s Manual Network Enabler Administrator Network Enabler Administrator Navigation The Network Enabler Administrator-Configuration window is divided into four parts. z The top section is the menu and help area. Please note that the help file is not compatible with Windows NT The left panel is the navigation panel and lists the available types of functions. The same list is shown in the Function menu on the menu bar. The right panel is the module list.
NE-4100 Series User’s Manual Network Enabler Administrator Configuration Functions Configuration functions are where module parameters may be viewed and changed. All parameters available in the web console are also available here. In addition, a module’s configuration may be imported or exported and the firmware may be updated. Note that the module list must be manually updated every time Configuration functions are accessed.
NE-4100 Series User’s Manual Network Enabler Administrator 2. A Searching window will open, showing that the program is searching for NE-4100 Series modules connected to this network. You may click Stop as soon as the desired module is found. 3. After the search is finished, all modules that were found will be shown in the Configuration module list. Select the desired module to begin using other functions with it.
NE-4100 Series User’s Manual Network Enabler Administrator refer to Pin Assignments in Chapter 2 for information on which pin is associated with the “Ready” LED. Click Stop to turn off the Locate function. Unlock Unlock is used to enter the password of locked modules in order to view and changes settings.
NE-4100 Series User’s Manual Network Enabler Administrator 1. Select Unlock from the Configuration context menu. Note that this menu may also be opened by right-clicking Configuration in the navigation panel, or by right-clicking the selected module. 2. After entering the correct password, the following window will open. After a module has been unlocked, it remains unlocked for the duration of the Network Enabler Administrator session, even if a new password is assigned.
NE-4100 Series User’s Manual Network Enabler Administrator Configure Configure is used to change the selected module’s settings. All web console settings are available here 1. Select Configure from the Configuration context menu. Note that this menu may also be opened by right-clicking Configuration in the navigation panel, or by right-clicking the selected module. 2. The next window shows that the module’s configuration is being processed.
NE-4100 Series User’s Manual 3. Network Enabler Administrator After the processing is done, the following window will open. Note: “Serial Command Mode” is supported in firmware version 3.0 and above. The module’s parameters are divided into ten tabs—Basic, Network, Serial, Operating Mode, Accessible IPs, Auto Warning, IP Address Report, Password, Digital IO, and Serial CMD. To make changes to any settings, the Modify box must be checked.
NE-4100 Series User’s Manual Network Enabler Administrator Upgrade Firmware Upgrade Firmware is used to upload new firmware to the selected module. 1. Select Upgrade Firmware from the Configuration context menu. Note that this menu may also be opened by right-clicking Configuration in the navigation panel, or by right-clicking the selected module. 2. Select the ROM file to be downloaded to the module. You may download the latest firmware at www.moxa.com. 3.
NE-4100 Series User’s Manual Network Enabler Administrator ATTENTION You may simultaneously upgrade the firmware of multiple modules as long as the modules are all the same model. To select multiple modules in the module list, hold down the Ctrl key while selecting each module, or hold down the Shift key to select a block of modules.
NE-4100 Series User’s Manual Network Enabler Administrator ATTENTION You can simultaneously import the same configuration file into multiple modules as long as the modules are all the same model. To select multiple modules in the module list, hold down the Ctrl key while selecting each module, or hold down the Shift key to select a block of modules. Monitor Functions Monitor functions allow the monitoring of the selected module’s connection and other basic settings over the network.
NE-4100 Series User’s Manual 2. 3. Network Enabler Administrator There are three options for adding a module: y If the module already shows up, you may select it with a check mark and then click OK. y If the module does not show up, you may do a broadcast search for the module by clicking Rescan. y You may manually specify the IP address of the module by selecting Input manually and entering the address. Once the target has been selected, it will show up on the list in the Monitor module list.
NE-4100 Series User’s Manual Network Enabler Administrator Settings Settings is used to determine what items of information are monitored, how often the information is refreshed, and how notification of events will occur. Select Settings in the Monitor context menu. Note that this menu may also be opened by right-clicking Monitor in the navigation panel or by right-clicking the desired module. Monitor Items In the Monitor Items tab, you may select which items of information will be monitored.
NE-4100 Series User’s Manual Network Enabler Administrator Advanced Settings In the Advanced Settings tab, you may enable an alarm to warn you of monitor events. You may choose an audible alarm as well as a pop-up warning message. Go and Stop Go and Stop are used to activate and deactivate monitoring of the modules in the module list. Monitoring is not active until Go has been selected in the Monitor context menu.
NE-4100 Series User’s Manual Network Enabler Administrator The list in the monitor window will now be live, and the selected items will be refreshed as configured. If a monitored module loses its connection with Network Enabler Administrator, a warning message will appear and an audible alarm will sound, as configured in the Monitor settings. If the module’s connection is restored, another message will be displayed, as configured in the Monitor settings.
NE-4100 Series User’s Manual Network Enabler Administrator Port Monitor Functions Port Monitor functions are very similar to Monitor functions, but with many additional items that can be monitored, as shown below. In addition, individual COM ports in the module list may be selected or deselected for monitoring. COM Mapping Functions Network Enabler Administrator is installed with Real COM drivers that work with Windows 95 and above.
NE-4100 Series User’s Manual Network Enabler Administrator COM Settings COM Settings is used to assign the local COM port number to the selected module, adjust the module’s serial settings, and adjust some advanced settings. Select COM Settings in the COM Mapping context menu. Note that this menu may also be opened by right-clicking COM Mapping in the navigation panel or by right-clicking the desired module in the module list. Multiple modules may be selected for configuration at the same time.
NE-4100 Series User’s Manual Network Enabler Administrator Advanced Settings In the Advanced Settings tab, you may configure how serial data is transmitted over the network. When Tx Mode is set to Hi-Performance, the Real COM driver sends a “Tx Empty” signal to the host as soon as it sends serial data over the network to the selected module. In Hi-performance mode, the driver will not verify that the module has successfully received and passed the data to the serial device.
NE-4100 Series User’s Manual Network Enabler Administrator Serial Parameters In the Serial Parameters tab, you may configure the selected module’s baud rate, parity, data bits, stop bits, and flow control. The parameters shown below are the default settings. Enable and Disable Enable and Disable are used to activate or deactivate the selected module’s COM mapping settings. Note that this menu may also be opened by right-clicking COM Mapping in the navigation panel or by right-clicking the desired module.
NE-4100 Series User’s Manual Network Enabler Administrator Note that in order for a PC running Network Enabler Administrator to receive IP address reports from a module, the module must set the PC’s IP address as the destination. In addition, the module and the PC’s designated port number for IP address reports should match. Please refer to the Network Settings section in Chapter 6 for additional information on configuring a module to send IP address reports.
8 Chapter 8. Linux and UNIX Configuration NE-4100 Series modules can be configured to work with Linux and UNIX operating systems. Drivers are included on the CD that comes with the module.
NE-4100 Series User’s Manual Linux and UNIX Configuration Linux Real TTY Drivers Basic Procedures The basic procedures to map a Linux host’s tty port to the module’s serial port are as follows: 1. Set up the module. After verifying that the IP configuration works and you can access the module (by using ping, telnet, etc.), configure the module’s serial port to Real COM mode. 2. Install the Linux Real tty driver files on the host 3.
NE-4100 Series User’s Manual Linux and UNIX Configuration Mapping TTY Ports Make sure that you set the operation mode of the module’s serial port to Real COM mode. After logging in as a super user, enter the directory /usr/lib/npreal2/driver and then execute mxaddsvr to map the module’s serial port to the host tty ports. The syntax of mxaddsvr is as follows: mxaddsvr [Module’s IP Address] [Total Ports] ([Data port] [Cmd port]) The mxaddsvr command performs the following actions: 1. Modifies npreal2d.cf.
NE-4100 Series User’s Manual Linux and UNIX Configuration Removing Linux Driver Files A utility is included that will remove all driver files, mapped tty ports, and unload the driver. To do this, you only need to enter the directory /usr/lib/npreal2/driver, and then execute mxuninst to uninstall the driver. This program will perform the following actions: 1. Unload the driver. 2. Delete all files and directories in /usr/lib/npreal2 3. Delete directory /usr/lib/npreal2 4.
NE-4100 Series User’s Manual Linux and UNIX Configuration Configuring the UNIX Driver Modify the configuration The configuration used by the moxattyd program is defined in the text file moxattyd.cf, which is in the same directory that contains the program moxattyd. You may use vi, or any text editor to modify the file, as follows: ttyp1 192.168.1.1 950 For more configuration information, view the file moxattyd.cf, which contains detailed descriptions of the various configuration parameters.
9 Chapter 9. Serial Command Mode Serial command mode allows configuration of the module through serial commands received directly through the serial port. It is available on NE-4100 Series modules with firmware version 3.
NE-4100 Series User’s Manual Serial Command Mode Overview Serial command mode allows the module’s parameters to be retrieved or configured through the serial port, rather than through the console port or over the network. This is done through the use of specially parsed commands sent to the module through the serial port. Device manufacturers can take advantage of serial command mode to add local configuration capability to their products.
NE-4100 Series User’s Manual Serial Command Mode Reply Structure Descriptor R-Head Bytes 1 Character “<” Reply Code 1 “Y”, “1” to “5”, “E’ OP Code Parameter Tail 2 varies 1 (varies) (varies) CR Comments <: fixed value (0x3C) Y: command was executed successfully 1: command not supported 2: OP code not supported 3: invalid command encapsulation 4: invalid parameter 5: invalid return value E: enter serial command mode carriage return character, no line feed For example, the following sequence of c
NE-4100 Series User’s Manual Serial Command Mode Accessible IP OP Code Parameter 0: disable AS 1: enable xxx.xxx.xxx.xxx AA (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AB (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AC (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AD (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AE (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AF (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AG (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AH (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AI (e.g., 192.168.127.1) xxx.xxx.xxx.xxx AJ (e.g., 192.168.
NE-4100 Series User’s Manual Serial Command Mode OP Code Parameter xxx.xxx.xxx.xxx Ae (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Af (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Ag (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Ah (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Ai (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Aj (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Ak (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Al (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Am (e.g., 255.255.255.0) xxx.xxx.xxx.xxx An (e.g., 255.255.255.0) xxx.xxx.xxx.xxx Ao (e.g., 255.
NE-4100 Series User’s Manual Serial Command Mode OP Code Parameter ASCII character in hex code TY (i.e., “A1” for character 0xA1) ASCII character in hex code TZ (i.e., “A1” for character 0xA1) TF 0 – 65535 (ms) Comments character to use for delimiter 1 character to use for delimiter 2 force transmit time Real COM Mode OP Code Parameter RM 1–4 RT 0 – 99 (minutes) 0: no delimiter RX 1: enable 1-character delimiter 2: enable 2 character delimiter ASCII character in hex code RY (i.e.
NE-4100 Series User’s Manual Serial Command Mode OP Code Parameter ASCII character in hex code CY (i.e., “A1” for character 0xA1) ASCII character in hex code CZ (i.e., “A1” for character 0xA1) CF 0 – 65535 (ms) Comments character to use for delimiter 1 character to use for delimiter 2 force transmit time UDP Mode OP Code Parameter UL 0 – 65535 xxx.xxx.xxx.xxx UA (e.g., 192.168.1.1) xxx.xxx.xxx.xxx UB (e.g., 192.168.1.1) xxx.xxx.xxx.xxx UC (e.g., 192.168.1.1) xxx.xxx.xxx.xxx UD (e.g., 192.168.1.1) xxx.
NE-4100 Series User’s Manual Serial Command Mode Digital IO OP Code Parameter bytes 1 and 2 (DIO #) 00: DIO 0 01: DIO 1 02: DIO 2 03: DIO 3 DM DS Comments set DIO mode (e.g., “000” sets DIO 0 to input mode) byte 3 (DIO mode) 0: input 1: output bytes 1 and 2 (DIO #) 00: DIO 0 01: DIO 1 02: DIO 2 03: DIO 3 set DIO status (e.g.
NE-4100 Series User’s Manual Serial Command Mode Operation Flow Chart HW Trigger Poll DIO 0 Status DIO 0 High (HW Trigger “Off”) Check Serial Command Mode Trigger Normal Serial-to-Ethernet Function DIO 0 Low (HW Trigger “On”) SW Trigger Normal Data Detected Check Serial Port Data 3-character Trigger Detected Enter Serial Command Process Command Exit Serial Command Mode and Restart ATTENTION This flowchart represents a continual process.
NE-4100 Series User’s Manual Serial Command Mode Network Enabler Administrator To use Network Enabler Administrator to configure the trigger type, you will need to find the module and open its configuration window. Please refer to Chapter 7 for additional details. The trigger type will be configured under the Serial CMD tab. Check the Modify box in order to make changes to the settings. Enable must be checked in order to configure the trigger type.
NE-4100 Series User’s Manual Serial Command Mode Select Activated by Character to trigger serial command mode through the serial port. In this case, you will also need to enter the three characters (in HEX code) that will be used as the trigger characters. When the trigger has been configured, click OK to save and restart the module with the new settings. ATTENTION The default setting is HW Trigger Enabled.
NE-4100 Series User’s Manual Serial Command Mode Telnet Console Please refer to Chapter 5 for information on opening the Telnet console. Press 5 and the Enter key to select Serial Command Mode setting. From the Serial Command Mode setting menu, select 1 in order to select and enable the trigger type (hardware or software). If software triggering is selected, the three trigger characters may be configured using option 2.
NE-4100 Series User’s Manual Serial Command Mode Web Console Please refer to Chapter 6 for information on opening the web console. Click on the Serial Command Mode folder in the navigation panel. Modify the settings as needed, and then click on Submit. Remember that you will need to save the configuration and restart the module for any changes to effect.
NE-4100 Series User’s Manual Serial Command Mode Entering Serial Command Mode Trigger Type The module can enter serial command mode through either a hardware trigger or a software trigger, depending on how it has been configured. Please refer to the previous section for details on how to configure the trigger type. Hardware Trigger z z Set up a hardware trigger with the DIO 0 channel. Use the trigger to pull DIO 0 to low in order to enter serial command mode.
NE-4100 Series User’s Manual Serial Command Mode Comments When first entering serial command mode, the module will respond with the string “
NE-4100 Series User’s Manual Serial Command Mode Determining the Active Mode If you need to verify whether or not the module is operating in serial command mode, there are two methods available: by Network Enabler Administrator or by serial console. In Network Enabler Administrator, you may open a module’s configuration window and determine if it is in serial command mode in the Information panel. In the example above, the status is Data Mode, which indicates normal data transmission.
NE-4100 Series User’s Manual Serial Command Mode Serial Command Examples For the following examples, the module should be installed onto the evaluation board, and the evaluation board’s serial port (P0) should be connected to a COM port on your PC. ATTENTION When using a terminal emulator program such as PComm Terminal, make sure that the Enter key is configured to send CR only, rather than CR + LF.
NE-4100 Series User’s Manual Serial Command Mode Example 3: Get IP Mode Using SW Trigger STEP 1: STEP 2: STEP 3: STEP 4: STEP 5: STEP 6: STEP 7: STEP 8: Verify that the software trigger is enabled for serial command mode, and check the three trigger characters. For this example, assume the trigger is “2B 2B 2B”. Check the module’s serial port settings. Start Windows HyperTerminal and make sure that the PC’s serial port settings match the module’s settings.
A Appendix A. Well Known Port Numbers This appendix is included for your reference. Listed below are port numbers that already have a well-established use. These port numbers should be avoided when assigning a port number to your NE-4100 Series module; otherwise you may experience network problems. Refer to the RFC 1700 standard for Well Known Port Numbers or refer to the following introduction from IANA.
NE-4100 Series User’s Manual Well Known Port Numbers TCP Socket Application Service 43 Whois (nickname) 49 (Login Host Protocol) (Login) 53 Domain Name Server (domain) 79 Finger protocol (Finger) 80 World Wide Web HTTP 119 Network News Transfer Protocol (NNTP) 123 Network Time Protocol 213 IPX 160 – 223 Reserved for future use UDP Socket Application Service 0 reserved 2 Management Utility 7 Echo 9 Discard 11 Active Users (systat) 13 Daytime 35 Any private printer server
B Appendix B. NECI Library NECI (Network Enabler Configuration Interface) is a set of APIs that run on Windows systems (95 and above) to search, locate, and configure NE-4100 Series modules over the network. The NE-4100 Series library can be found in the folder .\NECI_ LIB\ on the Documentation and Software CD included with each module. For more information, refer to NECI.chm in that directory as well as examples located in .\NECI_LIB\VC\ConsoleExample.
C Appendix C. Auto IP Report Protocol There are several ways to configure the IP address of an NE-4100 Series module. One of them is DHCP Client. When you set up the module to use DHCP Client for IP address configuration, it will automatically send a DHCP request over the network to find the DHCP server. The DHCP server will then send an available IP address to the module with an expiration time. The module will use this IP address until the expiration time has been reached.
NE-4100 Series User’s Manual Auto IP Report Protocol IP Address Report Structure The first 4 bytes of the module’s IP address report are the characters “MOXA”. The rest of the report is composed of 9 items, with each item preceded by a 2-byte header indicating the item ID and item length.
D Appendix D. DIO Commands In this appendix, we provide information on sending commands to the module’s DIO channels over an Ethernet network. Digital I/O commands and responses are accessed using a specific TCP port (default 5001) on the module. Each command is initiated by the host and is followed by a response from the module. A utility on the CD-ROM can be used to test the DIO access commands. Overview Each DIO command and response consists of a 4-byte header and up to 255 bytes of data.
NE-4100 Series User’s Manual DIO Commands } DIOHeaderStruct, *pDIOHeaderStruct; //define DIO Packet format //Used for Command and ACK packet typedef struct _DIO_Packet_Struct { DIOHeaderStruct header; char data[255]; } DIOPacketStruct, *pDIOPacketStruct; Read Single DIO Command Byte # Descriptor Value Description 1 Header 1 command #, fixed 2 Header 2 version, fixed 3 Header (any) this byte is only used in the module’s response 4 Header 1 data length, fixed 5 Data 0, 1, 2, 3 desired DIO channel # For exa
NE-4100 Series User’s Manual DIO Commands Write Single DIO Command Byte # 1 2 3 4 5 Descriptor Header Header Header Header Data Value 2 2 (any) 3 0,1,2,3 Description command number, fixed version, fixed this byte is only used in the module’s response data length, fixed desired DIO channel number 0: set to input mode 6 Data 0, 1 1: set to output mode this byte is ignored for input mode 7 Data 0, 1 0: set to low 1: set to high For example, the 7-byte command sequence 2-2-0-3-0-0-0 requests that DIO 0 be
NE-4100 Series User’s Manual DIO Commands packet.
NE-4100 Series User’s Manual Byte # Descriptor DIO Commands Value Description 3rd requested DIO channel, optional 0: channel status is low 1: channel status is high 10 Data 0, 1 4th requested DIO channel, optional 0: channel is in input mode 1: channel is in output mode 11 Data 0, 1 4th requested DIO channel, optional 0: channel status is low 1: channel status is high 12 Data 0, 1 For example, the 10-byte response 5-2-0-6-0-0-1-1-0-1 indicates that DIO 0 is in input mode and “low” status, DIO 1 is in out
NE-4100 Series User’s Manual DIO Commands Byte # Descriptor Value Description 2nd DIO channel to be written 9 Data 0,1 0: set to input mode 1: set to output mode 2nd DIO channel to be written 10 Data 0,1 0: set to low 1: set to high 3rd DIO channel to be written, optional 11 Data 0,1 0: set to input mode 1: set to output mode 3rd DIO channel to be written, optional 12 Data 0,1 0: set to low 1: set to high 4th DIO channel to be written, optional 0: set to input mode 13 Data 0,1 1: set to output mode 4th
NE-4100 Series User’s Manual Byte # Descriptor DIO Commands Value Description 2nd requested DIO channel 0, 1 0: channel status has been changed to low 8 Data 1: channel status has been changed to high 3rd requested DIO channel, optional 0: channel has been changed to input mode 1: channel has been changed to output mode 9 Data 0, 1 3rd requested DIO channel, optional 0: channel status has been changed to low 1: channel status has been changed to high 10 Data 0, 1 4th requested DIO channel, optional 0: ch
E Appendix E. SNMP Agent with MIB II & RS-232 Like Group NE-4100 Series modules have built-in SNMP (Simple Network Management Protocol) agent software. It supports SNMP Trap, RFC1317 RS-232 like group and RFC 1213 MIB-II. The following table lists the standard MIB-II groups, as well as the variable implementations for NE-4100 Series modules.
NE-4100 Series User’s Manual System MIB SNMP Agent with MIB II & RS-232 Like Group Interfaces MIB IP MIB ICMP MIB ifOutErrors ipAdEntIfIndex IcmpOutEchoReps ifOutQLen ipAdEntNetMask IcmpOutTimestamps ifSpecific ipAdEntBcastAddr IcmpOutTimestampReps ipAdEntReasmMaxSize IcmpOutAddrMasks IpNetToMediaIfIndex IcmpOutAddrMaskReps IpNetToMediaPhysAddress IpNetToMediaNetAddress IpNetToMediaType IpRoutingDiscards UDP MIB TCP MIB SNMP MIB UdpInDatagrams tcpRtoAlgorithm snmpInPkts UdpNoPorts
F Appendix F. Service Information This appendix contains information on how to obtain information or service from MOXA for your NE-4100 Series embedded device server and other MOXA products.
NE-4100 Series User’s Manual Service Information MOXA Internet Services Customer satisfaction is our top priority. 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 Technical Support E-mail Address support@moxa.com Website for Product Information http://www.moxa.
NE-4100 Series User’s Manual Service Information Problem Report Form MOXA NE-4100 Series Embedded Device Server Customer name: Company: Tel: Fax: Email: Date: Select Product Model NE-4100T NE-4110S NE-4110A NE-4120S NE-4120A NE-4100T-P NE-4110S-P NE-4110A-P NE-4120S-P NE-4120A-P Serial Number:____________________________________________________________________________ Problem Description Please describe the symptoms of the problem as clearly as possible, including any error mess
NE-4100 Series User’s Manual Service Information Product Return Procedure For product repair, exchange, or refund, the customer must: z z z z Provide evidence of original purchase. Obtain a Product Return Agreement (PRA) from the sales representative or dealer. Fill out the Problem Report Form (PRF). Include as much detail as possible for a shorter product repair time. Carefully pack the product in an anti-static package and send it, pre-paid, to the dealer.