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