Moxa Technologies NE-4100 Series User manual

NE-4100 Series
Serial Command Mode User’s Guide
www.moxa.com/product
First Edition, September 2004
Moxa Technologies Co., Ltd.
Tel: [phone]
Fax: [phone]
www.moxa.com
[email protected] (Worldwide)
[e-mail] (The Americas)
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series
Serial Command Mode User’s 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 The Moxa Group.
All other trademarks or registered marks in this manual belong to their respective manufacturers.
Disclaimer
Information in this document is subject to change without notice and does not represent a commitment on the
part of Moxa.
Moxa provides this document “as is,” without warranty of any kind, either expressed or implied, including, but
not limited to, its particular purpose. Moxa reserves the right to make improvements and/or changes to this
manual, or to the products and/or the programs described in this manual, at any time.
Information provided in this manual is intended to be accurate and reliable. However, Moxa Technologies
assumes no responsibility for its use, or for any infringements on the rights of third parties that may result from
its use.
This product might include unintentional technical or typographical errors. Changes are periodically made to the
information herein to correct such errors, and these changes are incorporated into new editions of the
publication.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

Table of Contents
Chapter 1 Introduction .....................................................................................................1
Chapter 2 Serial Command Format and Command Set ................................................2
Chapter 3 Operation Flow Chart...................................................................................... 7
Chapter 4 Configuring Serial Command Mode by Entering Trigger Type .................. 8
Network Enabler Administrator........................................................................................8
Telnet Console ................................................................................................................10
Web Console...................................................................................................................11
Serial Console.................................................................................................................12
Chapter 5 Entering Serial Command Mode..................................................................13
Trigger Type ...................................................................................................................13
Serial Port Parameters.....................................................................................................14
Comments.......................................................................................................................14
Chapter 6 Exiting Serial Command Mode ....................................................................15
Chapter 7 Determining the Active Mode....................................................................... 16
By Network Enabler Administrator ................................................................................16
By Text via the Serial Port..............................................................................................17
Chapter 8 SW Reset Function ....................................................................................... 18
Chapter 9 Factory Defaults ............................................................................................ 19
Serial Port Defaults.........................................................................................................19
Ethernet Port Defaults ....................................................................................................19
Default Operation Mode.................................................................................................19
Default Trigger Method ..................................................................................................19
Chapter 10 Demonstration/Testing Environment ..........................................................20
Example 1: Get Model Name using HW Trigger ...........................................................21
Example 2: Change IP Address using HW Trigger.........................................................21
Example 3: Get IP Mode using SW Trigger ...................................................................22
Example 4: Change TCP Port Number using SW Trigger..............................................22
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 1
1
1
Chapter 1 Introduction
The Serial Command Mode function described in this User’s Guide is built into the firmware of
the Command Mode models of Moxa’s NE-4100 Series of Embedded Network Enablers. All five
models, which are listed below, support auto-detecting 10/100 Mbps Ethernet.
!NE-4100T-CMD Serial (TTL) to Ethernet
— Drop-in type
!NE-4110S-CMD Serial (RS-232) to Ethernet
— RJ45 type
!NE-4110A-CMD Serial (RS-422/485) to Ethernet
— RJ45 type
!NE-4120S-CMD Serial (RS-232) to Ethernet
— Pin-header type
!NE-4120A-CMD Serial (RS-422/485) to Ethernet
— Pin-header type
Serial Command Mode serial commands are used to retrieve or configure parameters stored in
NE-4100 Series products’ flash memory. Since the commands are sent via the module’s serial port
(P0), Serial Command Mode gives serial device manufacturers the option to add local
configuration capability to their products. For example, card reader manufacturers can use the card
reader’s number pad to configure network settings (IP address, netmask, etc.) and serial settings
(baud rate, data bits, etc.), allowing end-users to configure the device on-site, without the need to
carry around and set up a notebook computer.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 2
2
2
Chapter 2 Serial Command Format and
Command Set
In this chapter, we describe the structure of the data frames used to issue commands and receive
replies to and from the device. The basic Command Frame Format and Reply Frame Format are:
Command Frame Format
Descriptor C-Head (>) Command Code OP Code Parameter Tail (CR)
Length (bytes) 1 1 2 Variable 1
Reply Frame Format
Descriptor R-Head (<) Reply Code OP Code Parameter Tail (CR)
Length (bytes) 1 1 2 Variable 1
The possible settings of each descriptor are given below. All Command Code, OP Code, and
Return Code values must be in upper case. Note that “OP Code” and “Parameter” are described
together, since they come as a pair. That is, the length and meaning of the Parameter descriptor
depends on which OP Code value is used.
C-Head
Settings Comments
> Fixed value (HEX = 3Eh)
R-Head
Settings Comments
< Fixed value (HEX = 3Ch)
Tail
Settings Comments
CR Fixed value (HEX = 0Dh)
Command Code
Settings Comments
R Get Network Enabler parameter
W Set Network Enabler parameter
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 3
Reply Code
Settings Comments
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
OP Code / Parameter
OP Code
Settings Parameter Device setting
Basic Commands
BS read only Serial Number
BV read only Firmware Version
BN alphanumeric
(Max. 15 bytes)
Device Name
BW 0: Disable
1: Enable
Web Console
BT 0: Disable
1: Enable
Telnet Console
BP alphanumeric
(Max. 10 bytes)
Password
BR 1: Restart only
2: Save & Restart (Write
Only)
Save and Restart
NC 0: Static
1: DHCP
IP Configuration Method
NP xxx.xxx.xxx.xxx
(e.g., 192.168.127.254)
IP Address
NM xxx.xxx.xxx.xxx
(e.g., 255.255.0.0)
Netmask Address
NG xxx.xxx.xxx.xxx
(e.g., 192.168.1.254)
Gateway Address
NA Read only
(e.g., 00:90:e8:09:44:fe)
MAC Address
Accessible IP
AS 0: Disable
1: Enable
Enable IP Filter
AA
|
AP
xxx.xxx.xxx.xxx
|
xxx.xxx.xxx.xxx
(e.g., 192.168.127.1)
Accessible IP Address 01
|
Accessible IP Address 16
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 4
OP Code
Settings Parameter Device setting
Aa
|
Ap
xxx.xxx.xxx.xxx
|
xxx.xxx.xxx.xxx
(e.g., 255.255.255.0)
Accessible Netmask 01
|
Accessible Netmask 16
Operation Mode
OM 0: Real COM
1: TCP Server
2: TCP Client
3: UDP Mode
Operation Mode
TCP Server Mode
TM 1 – 4 Max. number of connections
TL 0 – 65535 Local List Port
TT 0 – 99 (minutes) TCP Alive Check Timeout
TI 0 – 65535 (ms) Inactivity Timeout
TX 0: Disable
1: Enable 1 character
2: Enable 2 characters
Number of delimiters
TY ascii character
(e.g., ‘a1’)
Delimiter 1
TZ ascii character
(e.g., ‘a1’)
Delimiter 2
TF 0 – 65535 (ms) Force Tx Timeout
Real COM Mode
RM 1 – 4 Max. number of connections
RT 0 – 99 (minutes) TCP Alive Check Timeout
RX 0: Disable
1: Enable 1 character
2: Enable 2 characters
Number of delimiters
RY ascii character
(e.g., ‘a1’)
Delimiter 1
RZ ascii character
(e.g., ‘a1’)
Delimiter 2
RF 0 – 65535 (ms) Force Tx Timeout
TCP Client Mode
CM 0: Startup
1: Any character
Connect Mode
CA xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Destination Host IP 1
CB xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Destination Host IP 2
CC xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Destination Host IP 3
CD xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Destination Host IP 4
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 5
OP Code
Settings Parameter Device setting
C1 0 – 65535 Client Port 1
C2 0 – 65535 Client Port 2
C3 0 – 65535 Client Port 3
C4 0 – 65535 Client Port 4
CT 0 – 99 (minutes) TCP Alive Check Timeout
CI 0 – 65535 (ms) Inactivity Timeout
CX 0: Disable
1: Enable 1 character
2: Enable 2 characters
Number of delimiters
CY ascii character
(e.g., ‘a1’)
Delimiter 1
CZ ascii character
(e.g., ‘a1’)
Delimiter 2
CF 0 – 65535 (ms) Force Tx Timeout
UDP Mode
UL 0 – 65535 Local Listen Port
UA xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
First IP of range 1
UB xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
First IP of range 2
UC xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
First IP of range 3
UD xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
First IP of range 4
Ua xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Last IP of range 1
Ub xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Last IP of range 2
Uc xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Last IP of range 3
Ud xxx.xxx.xxx.xxx
(e.g., 192.168.1.1)
Last IP of range 4
U1 0 – 65535 UDP Port 1
U2 0 – 65535 UDP Port 2
U3 0 – 65535 UDP Port 3
U4 0 – 65535 UDP Port 4
UX 0: Disable
1: Enable 1 character
2: Enable 2 characters
Number of delimeters
UY ascii character
(e.g., ‘a1’)
Delimiter 1
UZ ascii character
(e.g., ‘a1’)
Delimiter 2
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 6
OP Code
Settings Parameter Device setting
UF 0 – 65535 (ms) Force Tx Timeout
Digital IO
DM bytes 1 and 2 (DIO #):
0: DIO_0
1: DIO_1
2: DIO_2
3: DIO_3
byte 3 (DIO Mode)
0: input
1: output
DIO Mode
(e.g., ‘000’ sets DIO_0 to input mode)
DS bytes 1 and 2 (DIO #)
0: DIO_0
1: DIO_1
2: DIO_2
3: DIO_3
byte 3 (DIO Status)
0: low
1: high
DIO Status
(e.g., ‘011’ sets DIO_1 to high)
Serial Command Mode
ES 0: Disable
1: Enable HW Trigger
2: Enable SW Trigger
Enable Serial Command Mode
EC 3 4-byte characters Enter Command Mode Characters
(in HEX format; e.g., 2A EE 5F)
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 7
3
3
Chapter 3 Operation Flow Chart
NOTE 1. This flowchart represents a continual process. You can start trace out a logical flow by
starting anywhere on the chart.
2. Diamonds represent decision points. Only one path leading out of any diamond can be
followed.
Check Serial
Command
Mode Trigger
Normal
Serial-to-Ethernet
Function
Poll DIO 0
Status
Check Serial
Port Data
Enter Serial
Command
Process Command Exit Command Mode and Restart
DIO 0 Low
(HW Trigger Enabled)
3-characte
r
Trigger
Detected
DIO 0 High
(HW Trigger
Disabled)
Normal Data
Detected
HW Trigger SW Trigger
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 8
4
4
Chapter 4 Configuring Serial Command Mode by
Entering Trigger Type
In this chapter, we explain how to configure the type of trigger (hardware or software) that will
activate Serial Command Mode. The trigger type can configured over the network with Network
Enabler Administrator, Telnet Console, or Web Console, or through the serial console port by
Serial Console.
Network Enabler Administrator
Network Enabler Administrator 2.6 provides a convenient way to configure NE-4100-CMD.
1. After installing Network Enabler Administrator 2.6, double click on the shortcut icon on
your Windows desktop to start the program.
2. Use Broadcast Search or Search by IP to locate the NE-4100-CMD you wish to configure.
Keep in mind that Broadcast Search will locate all Network Enabler products connected to
the same LAN as your PC. Search by IP can be used to locate Network Enablers that are
NOT connected to the LAN. However, if you use Search by IP to locate a Network Enabler
connected to the same LAN as your PC, the Network Enabler and PC must be on the same
subnet.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 9
3. Once the NE-4100-CMD is located, click on the product’s Model to highlight it, and then
click the right mouse button. Select the Configuration option.
4. Check the Modify box to change the configuration. If the Enable box is not checked, then
Serial Command Mode is disabled. There are two Enable options:
HW Trigger
SW Trigger
Select H/W Control Pin (Use DIO 0)
to tri
gg
er Command Mode b
y
hardware.
Select Activated by Character to
trigger Command Mode by software. In
this case, you will also need to enter the
three characters (in HEX format) that
will be used as the trigger characters.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 10
NOTE 1. The default setting is HW Trigger Enabled.
2. Only one of the two trigger types (HW or SW) can be set at the same time.
Telnet Console
The Telnet Console provides a convenient text-based utility to configure your NE-4100-CMD.
Keep in mind that if you are using Telnet to access a Network Enabler connected to the same LAN
as your PC, the Network Enabler and PC must be on the same subnet.
1. From the DOS command prompt, type telnet 192.168.127.254 (use the correct IP address if
different from the default), and then press enter to access NE-4100-CMD’s telnet console.
2. The Telnet Console is easy to use. To select an option, type the character next to the option
and then press Enter. For example, type 5to select Serial Command Mode setting.
3. Once all configurations have been made, return to the main Telnet menu, and then type sto
save the configuration and restart the NE-4100-CMD. If you quit without saving, any
changes you made to the configuration will be lost.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 11
Web Console
The Network Enabler Web Console provides ready access to NE-4100-CMD via web browser. To
access the Web Console, open your browser, type the NE-4100-CMD’s IP address in the Address
field (default = 192.168.127.254), and then press Enter.
1. The NE-4100-CMD homepage will open.
2. Click on the Serial Command Mode folder under the left Main Menu.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 12
3. Modify the Trigger Setting and SW Trigger Character as needed, and then click on
Submit.
Serial Console
To access NE-4100-CMD’s Serial Console utility, connect the Network Enabler Starter Kit’s
serial console port (P1) to your PC’s serial port, and then use a terminal emulator program (such as
Moxa PComm Terminal Emulator) to enter the Console Utility. The serial console port settings are
“19200, no, 8, 1”. Details of how to connect via the serial console port can be found in the
NE-4100 Series User’s Manual. The text-based configuration utility works exactly the same as if
connecting by Telnet Console. See the Telnet Console section above for details.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 13
5
5
Chapter 5 Entering Serial Command Mode
In this chapter, we explain how to enter Serial Command Mode.
Trigger Type
There are two types of trigger, HW (Hardware) and SW (Software).
HW Trigger
!HW Trigger is passed through the GPIO 0 pin.
!Pull GPIO 0 as low to trigger (the pin will normally pull high).
Note that the low level trigger must persist for more than 200 ms to qualify as a valid trigger.
SW Trigger
!The Trigger is activated when 3 user-defined characters are detected.
!See the previous chapter for an explanation of how to configure the SW trigger characters.
1. The time interval between characters must be less than 20 ms.
2. When the SW Trigger is enabled, the highest achievable data transmission rate will be
reduced from 234000 bps to 55000 bps. This is because all data received through serial
port 0 will be parsed. In other words, the system must continuosly check the serial port
data for the SW Trigger characters.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 14
Serial Port Parameters
The serial port paramters for port P0 can be obtained from Network Enabler Administrator, or
Network Enabler Console. For example, from Network Enabler Administrator, open the NE’s
Confiuration panel, click on the Serial tab, click on the port’s information line to highlight it, and
then click on Settings to open the Serial Settings window.
Comments
1. When entering serial command mode, the string “ <E \r ” will be sent out from the serial
port.
2. All data communication will cease when the device is in serial command mode.
!Any open TCP connection will be closed, for both the client and the server.
!No new TCP connections can be establed.
!UDP data communication will be disabled.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 15
6
6
Chapter6 Exiting Serial Command Mode
There are three ways to exit Serial Command Mode. All settings made while in command mode
will be stored in RAM. After excuting Save / Restart, the settings will be saved in the flash
memory.
1. Power Off
Configuration will not take effect after powering back on, since the modifications were not
saved.
2. Exit by Command (OP Code: BR)
There are two possible exit behaviors
!Save & Restart
!Restart only (modifications will not be saved)
3. Auto Restart
If 5 minutes elapses without inputting a valid command, then the NE unit will auto-restart
without saving modifications.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 16
7
7
Chapter 7 Determining the Active Mode
There are two ways to check if NE-4100-CMD is in Command Mode or Communication Mode.
By Network Enabler Administrator
Network Enabler Administrator displays clearly the active operation mode in the Configuration
panel’s left Information column. In the example shown below, Status is listed as Data Mode,
which indicates normal data transmission.
Data Mode
Data Mode implies normal data transmission. All data communication and configuration functions
are activate, and running in full-duplex.
Command Mode
Command Mode implies that the NE module is being configured. In this case, Ethernet data
communication will cease. All data from the serial port will be parsed, and valid commands will
be used to change the configuration.
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx

NE-4100 Series Serial Command Mode User’s Guide
Page 17
By Text via the Serial Port
If the NE module is in serial command mode, it will respond with a short message after receiving
the serial command end character 0x0d, allowing the user to send a specific string or character to
check if it is in serial command mode.
Serial Device to NE module command NE Module return code
0x0d (C language: ‘\r’) 0x3c 0x45 0x0d (“<E\r”)
0x0a, 0x0d (C language: ‘\n’ or Enter key) 0x3c 0x45 0x0d (“<E\r”)
Error command 0x3c 0x33 0x0c (“<3\r”)
RSPSupply - 1-888-532-2706 - www.RSPSupply.com
http://www.RSPSupply.com/p-9775-Moxa-NE-4120-ST.aspx