MiiNePort E2/E3 Series User Manual
Version 10.1, July 2022

www.moxa.com/products© 2022 Moxa Inc. All rights reserved.

MiiNePort E2/E3 Series User Manual
The software described in this manual is furnished under a license agreement and may be used only in accordancewith the terms of that agreement.

Copyright Notice© 2022 Moxa Inc. All rights reserved.

Trademarks
The MOXA logo is a registered trademark of Moxa Inc.
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/orchanges 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 assumes noresponsibility 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 periodicallymade to the information herein to correct such errors, and these changes are incorporated into new
editions of the publication.

Technical Support Contact Informationwww.moxa.com/support

Table of Contents
1.

2.

3.

4.

5.

6.

7.

Introduction ......................................................................................................................................... 5
Overview .............................................................................................................................................. 5
Package Checklist .................................................................................................................................. 5
Product Features ................................................................................................................................... 6
Module Dimensions ................................................................................................................................ 9
Panel Layout and Pin Assignments ......................................................................................................... 11
Evaluation Board Layout................................................................................................................ 11
Pin Assignments ........................................................................................................................... 12
LED Indicators ..................................................................................................................................... 14
Getting Started ................................................................................................................................... 15
Wiring Precautions ............................................................................................................................... 15
Installing the MiiNePort module onto the MiiNePort Evaluation Board.......................................................... 16
Selecting the Serial Interface ................................................................................................................ 16
Connecting the Power .......................................................................................................................... 17
Connecting to the Network.................................................................................................................... 17
Connecting to a Serial Device ................................................................................................................ 17
Digital I/O Channel Settings .................................................................................................................. 18
Schematic Design Guide ....................................................................................................................... 18
Choosing the Proper Operation Mode ................................................................................................. 19
Overview ............................................................................................................................................ 19
Real COM Mode ................................................................................................................................... 19
TCP Server Mode ................................................................................................................................. 20
TCP Client Mode .................................................................................................................................. 21
RFC2217 Mode .................................................................................................................................... 22
UDP Mode ........................................................................................................................................... 23
Ethernet Modem Mode.......................................................................................................................... 23
MCSC Mode (MiiNePort E2 Only) ............................................................................................................ 24
Choosing the Configuration Tool ......................................................................................................... 25
Utility Console ..................................................................................................................................... 25
Web Console ....................................................................................................................................... 26
Telnet Console .................................................................................................................................... 26
SCM (Serial Command Mode) ................................................................................................................ 27
Initial IP Address Configuration ......................................................................................................... 28
Static vs. Dynamic IP Address ............................................................................................................... 28
Factory Default IP Address .................................................................................................................... 28
ARP.................................................................................................................................................... 28
Telnet Console .................................................................................................................................... 29
Utility Console and Driver Installation ................................................................................................ 34
Device Search Utility (DSU) .................................................................................................................. 34
Installing the Device Search Utility ................................................................................................. 34
Device Search Utility Configuration ................................................................................................. 37
NPort Windows Driver Manager ............................................................................................................. 38
Installing NPort Windows Driver Manager ........................................................................................ 38
Using NPort Windows Driver Manager ............................................................................................. 40
Command Line Installation/Removal ............................................................................................... 42
The Linux Real TTY Driver ..................................................................................................................... 44
Mapping TTY Ports ........................................................................................................................ 44
Removing Mapped TTY Ports .......................................................................................................... 45
Removing Linux Driver Files........................................................................................................... 45
The UNIX Fixed TTY Driver .................................................................................................................... 45
Installing the UNIX Driver.............................................................................................................. 45
Configuring the UNIX Driver .......................................................................................................... 46
Web Console Configuration ................................................................................................................. 47
Opening Your Brower ........................................................................................................................... 47
Web Console Fundamentals .................................................................................................................. 48
Basic Settings ..................................................................................................................................... 48
Network Settings.......................................................................................................................... 48
Serial Port Settings ....................................................................................................................... 50

8.

9.

A.

B.
C.

D.

E.
F.

Operation Modes .......................................................................................................................... 52
Advanced Settings ............................................................................................................................... 70
Accessible IP List .......................................................................................................................... 70
SNMP Agent................................................................................................................................. 71
DIO Settings ................................................................................................................................ 72
Serial Command Mode (SCM) ........................................................................................................ 72
Miscellaneous .............................................................................................................................. 73
Maintenance ....................................................................................................................................... 75
Console Settings .......................................................................................................................... 75
Firmware Upgrade ........................................................................................................................ 75
Configuration Tools....................................................................................................................... 75
Change Password ......................................................................................................................... 77
NetEZ Technologies ............................................................................................................................ 78
EZPower ............................................................................................................................................. 78
SCM (Serial Command Mode) ................................................................................................................ 78
AutoCFG (Auto Configuration) ............................................................................................................... 79
MCSC (Multiple Channel Serial Communication) ....................................................................................... 81
Command Packets ........................................................................................................................ 83
SCM (Serial Command Mode) under MCSC ...................................................................................... 85
EZPage ............................................................................................................................................... 85
How to Clean up EZPage in MiiNePort.............................................................................................. 87
Android API Instructions .................................................................................................................... 88
Overview ............................................................................................................................................ 88
How to Start MxNPortAPI .............................................................................................................. 89
MxNPortAPI Function Groups ................................................................................................................. 90
Example Program ................................................................................................................................ 90
Introduction to SCM (Serial Command Mode) Command Set ..............................................................91
Command/Reply Format ....................................................................................................................... 91
Command Code for Getting the Configuration.......................................................................................... 92
Command Code for Setting the Configuration ........................................................................................ 104
Command Code for Retrieving Running Configuration ............................................................................. 116
Command Code for Viewing the Status ................................................................................................. 129
Control Command Code ...................................................................................................................... 129
Well-Known Port Numbers ............................................................................................................... 131
Auto IP Report Protocol .................................................................................................................... 133
IP Address Report Structure ................................................................................................................ 133
Example ........................................................................................................................................... 134
DIO Commands................................................................................................................................. 135
Overview .......................................................................................................................................... 135
C Code Example ................................................................................................................................ 135
Read Single DIO ................................................................................................................................ 136
Command ................................................................................................................................. 136
Response .................................................................................................................................. 136
C Code Example ......................................................................................................................... 136
Write Single DIO................................................................................................................................ 137
Command ................................................................................................................................. 137
Response .................................................................................................................................. 137
C Code Example ......................................................................................................................... 137
Read Multiple DIOs ............................................................................................................................ 138
Command ................................................................................................................................. 138
Response .................................................................................................................................. 138
C Code Example ......................................................................................................................... 139
Write Multiple DIOs ............................................................................................................................ 139
Command ................................................................................................................................. 139
Response .................................................................................................................................. 140
C Code Example ......................................................................................................................... 141
SNMP Agent with MIB II and RS-232 Like Groups ............................................................................ 142
NECI Library ..................................................................................................................................... 143

1. Introduction

The MiiNePort series of embedded device servers is compact drop-in modules that can be integrated withyour serial devices to enable connectivity to an Ethernet network. All MiiNePort Series modules comeequipped with built-in TCP/IP protocols and other easy-to-use network enabling tools for fast integration,
allowing you to provide network access to any electronic device that has a serial port.

Overview
Moxa’s MiiNePort E2/E3 embedded device servers are designed for manufacturers who want to add
sophisticated network connectivity to their serial devices, but with minimal integration effort. The MiiNePort
E2/E3 is empowered by the MiiNe, Moxa’s second generation SoC, which supports 10/100 Mbps Ethernet
and up to 921.6 Kbps serial baudrate. The MiiNePort E2/E3 comes with a versatile selection of ready-to-use
operation modes and requires only a small amount of power. By using Moxa’s innovative NetEZ technology,
the MiiNePort E2/E3 can be used to convert any device that has a standard serial interface to an Ethernet
enabled device in no time. In addition, compared with other products of this type, the MiiNePort E2/E3 has avery compact size, making it easy to fit the MiiNePort E2/E3 into virtually any existing serial device.

Package Checklist
MiiNePort E2 Module Package (one of the following)•

MiiNePort E2: 0 to 55°C operating temp., 50 bps to 230.4 Kbps baudrate•

MiiNePort E2-H: 0 to 55°C operating temp., 50 bps to 921.6 Kbps baudrate•

MiiNePort E2-T: -40 to 85°C operating temp., 50 bps to 230.4 Kbps baudrate•

MiiNePort E2-H-T: -40 to 85°C operating temp., 50 bps to 921.6 Kbps baudrate

MiiNePort E2 Starter Kit Package•

MiiNePort E2 module (MiiNePort E2 or MiiNePort E2-H only)•

MiiNePort E2 evaluation board•

Universal power adapter•

2 power cords•

Null modem serial cable•

Crossover Ethernet cable•

Document and software CD•

Quick installation guide (printed)•

Warranty card

MiiNePort E2/E3 Series User Manual5

MiiNePort E3 Module Package (one of the following)•

MiiNePort E3: 0 to 55°C operating temp., 50 bps to 230.4 Kbps baudrate•

MiiNePort E3-H: 0 to 55°C operating temp., 50 bps to 921.6 Kbps baudrate•

MiiNePort E3-T: -40 to 85°C operating temp., 50 bps to 230.4 Kbps baudrate•

MiiNePort E3-H-T: -40 to 85°C operating temp., 50 bps to 921.6 Kbps baudrate

MiiNePort E3 Starter Kit Package•

MiiNePort E3 module (MiiNePort E3 or MiiNePort E3-H only)•

MiiNePort E3 evaluation board•

Universal power adapter•

2 power cords•

Null modem serial cable•

Crossover Ethernet cable•2 flat cables•

1 screw and spacer pack•

Document and software CD•

Quick installation guide (printed)•

Warranty card

NOTE
Please notify your sales representative if any of the above items is missing or damaged.

Product Features
All MiiNePort E2/E3 Series modules have the following general features:•

MiiNePort NetEZ Technology makes integration incredibly easy•

Moxa’s second generation MiiNe SOC optimizes reliability•

A versatile choice of operation modes to meet application needs•

Optional RJ45 package for specific requirements•

Extremely low power consumption for green design•

802.3af compliant PoE pass-through (E3 model)•

Compact embedded device module

Moxa’s NetEZ technology is designed to give serial device manufacturers a range of powerful tools for
integrating Ethernet capability into serial devices.

Each of MiiNePort supports the NetEZ features below.
EZPower
SCM
EZPageAutoCFGMCSC

MiiNePort E2/E3 Series User Manual

MiiNePort E2






MiiNePort E3




–

6

EZPower is an automatic power selector for the 3.3 VDC or 5 VDC power system input.

SCM (Serial Command Mode) can be used to easily configure the MiiNePort E2/E3 via a serial
communication interface, even after it’s installed in the serial device.

EZPage: Do you eed a module that allows direct communication with the attached serial device? Use the
MiiNePort E2/E3’s EZPage with Java Applet to create a visual web page for configuring and communicatingwith the attached serial device.

MiiNePort E2/E3 Series User Manual7AutoCFG (Auto Configuration) saves time and effort when setting up the MiiNePort E2/E3 one by one
during the device production process.

MCSC (Multiple Channel Serial Communication) provides dual connections and dual channels so yourdevice can act as a server and client at the same time.

MiiNePort E2/E3 Series User Manual8Module Dimensions
MiiNePort E2
Unit: mm (inch)

MiiNePort E2/E3 Series User Manual9

MiiNePort E3
Unit: mm (inch)

MiiNePort E2/E3 Series User Manual10Panel Layout and Pin Assignments
Evaluation Board Layout
MiiNePort E2
1
2
3
4
5
6
7
8
9
10
11
12
13

Ethernet RJ45 Connector
MiiNePort E2 Module Location
Serial Interface Jumper
Power Switch
Power JackPower & Ready LED
DB9 Male Connector
Serial Port Status LED
Digital IO Terminal Block
Digital Output LED
Digital Input/Output Mode
Digital Input Switch
Circuit Pad

MiiNePort E3

1
2
3
4
5
6
7
8
9
10
11
12
13

PoE Pin
MiiNePort E3 Module Location
Serial Interface Jumper
Power Switch
Power JackPower & Ready LED
DB9 Male Connector
Serial Port Status LED
Digital IO Terminal Block
Digital Output LED
Digital Input/Output Mode
Digital Input Switch
Circuit Pad

MiiNePort E2/E3 Series User Manual

11Pin Assignments
MiiNePort E2 Module Pin Assignment
Bottom Panel of the MiiNePort E2 Module

JP1
Pin
1
2
3
4

Signal Name
Ethernet Tx+
Ethernet TxEthernet Rx+
Ethernet Rx-

Function
Ethernet Transmit Data+
Ethernet Transmit DataEthernet Receive Data+
Ethernet Receive Data-

Signal Name
100M LED
10M LED
LRXD
LTXD
LDCD
RS485_EN
LRTS
LDTR
LDSR
LCTS

Function
Ethernet 100M LED
Ethernet 10M LED
Receive Serial Data
Transmit Serial Data
Data Carrier Detect
RS-485 Enable
Request To Send
Data Terminal Ready
Data Set Ready
Clear To Send

Signal Name
DIO0
DIO2
DIO3
DIO1
Reserved
Reserved
SW Reset
GND
Ready LED
VCC

Function
Programmable Input/Output
Programmable Input/Output
Programmable Input/Output
Programmable Input/Output
N/A
N/A
Reset To Factory Default
Circuit Ground
System is Ready LED
Power Supply

JP2
Pin
1
2
3
4
5
6
7
8
9
10

JP3
Pin
1
2
3
4
5
6
7
8
9
10

MiiNePort E2/E3 Series User Manual12

MiiNePort E3 Module Pin Assignment

Ethernet Pins (JP2)
Pin
1
2
3
4
5
6
7
8

Signal Name
Reserve
Reserve
Reserve
Reserve
PoE signal pair 1
PoE spare pair 1
PoE signal pair 2
PoE spare pair 2

Function
N/A
N/A
N/A
N/A
PoE power from Tx signal
PoE power from RJ45 4, 5 pin
PoE power from Rx signal
PoE power from RJ45 7, 8 pin

Serial Pins and Power Pins (JP4)
Pin
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Signal Name
Serial Rx
Ready LED
Serial Tx
GPIO
DCD
GPIO
RS485_EN0
GPIO
RTS
GPIO
DTR
Reserve
DSR
Reserve
CTS
SW_Reset
Reserve
Reserve
GND
VCC

MiiNePort E2/E3 Series User Manual

Function
Receive Serial Data
System to Ready LED
Transmit Serial Data
Programmable I/O, DIO0
Receive Line Signal Detector
Programmable I/O, DIO2
RS-485 Enabled
Programmable I/O, DIO3
Request to Send
Programmable I/O, DIO1
Data Terminal Ready
N/A
Data Set Ready
N/A
Clear to Send
Reset to Factory Default
N/A
N/A
Circuit Ground
Power Supply

13

Evaluation Board Ethernet Port Pin Assignment
RJ45

Pin
1
2
3
6

Signal
Tx+
TxRx+
Rx-

Evaluation Board Serial Port Pin Assignment
DB9 Male

Pin
1
2
3
4
5
6
7
8
9

RS-232
DCD
RxD
TxD
DTR
GND
DSR
RTS
CTS
–

RS-485-2W
–
–
D+
DGND
–
–
–
–

LED Indicators
MiiNePort Evaluation Board

LED Name
Power

Ready

TXD / LED D3
RXD / LED D4
DTR / LED D5
CTS / LED D6
DSR / LED D7
DCD / LED D8
RTS / LED D9
DO0 / LED D10
DO1 / LED D11
DO2 / LED D12
DO3 / LED D13

Color

Description
1. Power is off
Off
2. A power error condition exists
3. System error
Green, Steady On
Indicates that the power is on.
1. The device server has been located by NPort search utility’s
Green,
location function.
Blinking every 1 sec.
2. Auto Config complete.
Green,
Indicates a LAN IP conflict, or the DHCP or BOOTP server did not
Blinking every 0.5 sec. respond properly.
Red
Indicates that TXD has a signal.
Red
Indicates that RXD has a signal.
Red
Indicates that DTR has a signal.
Red
Indicates that CTS has a signal.
Red
Indicates that DSR has a signal.
Red
Indicates that DCD has a signal.
Red
Indicates that RTS has a signal.
Red
Indicates that DO0 is in “low” (0) status.
Red
Indicates that DO1 is in “low” (0) status.
Red
Indicates that DO2 is in “low” (0) status.
Red
Indicates that DO3 is in “low” (0) status.

MiiNePort E2/E3 Series User Manual142. Getting Started

This chapter includes information about how to install MiiNePort Series modules for development andtesting.

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 electricalcodes dictating the maximum current allowable for each wire size. If the current goes above the maximum
ratings, the wiring could overheat, causing serious damage to your equipment.

ATTENTION
Take care when handling the evaluation board. When plugged in, the evaluation board’s internal
components generate heat, and consequently the board may feel too hot to the touch.
You should also pay attention to the following:•

Do not run signal or communication wiring and power wiring in the same wire conduit. To avoid
interference, wires with different signal characteristics should be routed separately. Separate paths
should be used to route wiring for power and devices. You can use the type of signal transmitted
through a wire to determine which wires should be kept separate. The rule of thumb is that wires
sharing similar electrical characteristics may be bundled together.

•

Keep input wiring and output wiring separate.

•

If power wiring and device wiring paths must cross paths, make sure the wires are perpendicular at theintersection point.

•

All wiring should be clearly labeled.

MiiNePort E2/E3 Series User Manual

15Installing the MiiNePort module onto the
MiiNePort Evaluation Board
Before using the MiiNePort evaluation board with themodule, be sure to disconnect the power supply,
network, and serial device. A profile of the MiiNePort isshown in the center of the evaluation board near the top.
The profile indicates where you should install the module
onto the evaluation board (refer to the figure at theright). When attaching the module to the evaluation
board, make sure the module is securely installed on theevaluation board. After the module is installed, connect
the power supply, network, and serial device to theevaluation board.

MiiNePort E2

Selecting the Serial Interface
The MiiNePort module uses a standard TTL serial signal input. However, to make the evaluation moreconvenient, the evaluation board has built-in RS-232 and RS-485 interfaces. Use a 6-pin jumper to selectwhich serial interface is active.
•

RS-232: short the 6-pin jumper to JP13•

RS-485: short the 6-pin jumper to JP14

MiiNePort E2/E3 Series User Manual16Connecting the Power
Connect the 12-48 VDC power line with the evaluation board’s power jack. If the power is properly supplied,the power LED on the evaluation board (D14) will show a solid green color until the system is ready.
When the system is ready, the ready LED on the module will show a solid green color.

Connecting to the Network
To connect to the network for testing and development purposes, plug the Ethernet cable into the RJ45 jackon the evaluation board. If the cable is properly connected, the LED will indicate a valid connection to the
Ethernet as follows:
LED

Color

Left

Amber

Right

Green

Meaning
10BASE-T Link Activity(does not blink when not transmitting; blinks when transmitting)
100BASE-TX Link Activity(does not blink when not transmitting; blinks when transmitting)

When using a private IP address (192.168.xxx.xxx), be sure the netmask and IP address are configured toallow hosts on the private network to access the module. Note that by default, the module is configured touse a private IP address.

Connecting to a Serial Device
To connect to a serial device for testing and development purposes, the module should be installed on theevaluation board. Be sure to select the serial interface you would like to use before you connect theevaluation board to the serial device. (Refer to the Selecting the Serial Interface section above when you
are using jumper blocks to select the serial interface on the evaluation board.) The module’s serial signals
are routed to and from the RS-232 or RS-485 COM port on the evaluation board. Use a serial data cable toconnect the serial device to the COM port on the evaluation board.

MiiNePort E2/E3 Series User Manual

17

Digital I/O Channel Settings
Each module has four digital I/O (DIO) channels. (Refer to the Pin Assignment section in Chapter 1 for themodule’s configurable DIO pin descriptions. Refer to the Evaluation Board Layout section in Chapter 1 toselect corresponding settings on the evaluation board.) All four DIO channels can be configured by software.
A DI channel is a channel that operates in digital input mode; a DO channel is a channel that operates indigital output mode. You can use the evaluation board’s Digital Output LEDs and Digital Input DIP switches
as the digital input and output devices, or you can connect digital input/output devices to the DIO Terminal
Block.

ATTENTION
When using a digital input device connected to the DIO Terminal Block, the corresponding Digital Input DIP
switch must be set to OFF or High. Setting the DIP switch to ON or Low will interfere with the signal fromyour digital input device.
For channels in digital output mode, the Low versus High setting is controlled from the web console. Whenusing a Digital Output LED as your output device, the LED will be on to indicate that the status is Low andthe LED will be off to indicate that the status is High.

Schematic Design Guide
For guidance and suggestions on integrating your device’s hardware with the MiiNePort, refer to the
MiiNePort Schematic Design Guide in the Document and software CD.

MiiNePort E2/E3 Series User Manual183. Choosing the Proper Operation Mode

The MiiNePort modules support operation modes for COM mapping and TCP/IP. After choosing the proper
operation mode for your application, refer to subsequent chapters for configuration details.

Overview
The MiiNePort acts as a bridge for connecting serial devices to Ethernet networks. After choosing the best
operation mode for your application, you can use your computer to access, manage, and configure yourserial devices from anywhere in the world over the Internet.
Traditional SCADA and data collection systems rely on serial ports (RS-232/422/485) to collect data fromvarious kinds of instruments. Since MiiNePort modules convert between serial and Ethernet signals, you will
be able to access your SCADA and data collection system from hosts connected to a standard TCP/IP
network, regardless of whether the devices are used locally or at a remote site.
The MiiNePort modules support Real COM mode and six different socket modes—TCP Server, TCP Client,
Ethernet Modem, RFC2217, UDP, and MCSC. The main difference between the TCP and UDP protocols is thatTCP guarantees delivery of data by requiring the recipient to send an acknowledgement to the sender. UDP
does not require this kind of verification, and consequently UDP is faster than TCP.

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
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. At the other end of the connection, the module accepts the Ethernet frame, unpacks the TCP/IP
packet, and then transparently sends the data to the attached serial device. In other words, a PC host cantreat networked devices as though the devices were connected directly to the PC.

MiiNePort E2/E3 Series User Manual

19TCP Server Mode
In TCP Server mode, the module is assigned a unique IP address and port number on the TCP/IP network.
The module waits passively to be contacted by the host computer, allowing the host computer to establish aconnection with and obtain data from the serial device. TCP Server mode supports up to four simultaneousconnections so that multiple hosts can collect data from the same serial device—at the same time. Datatransmission proceeds as follows:1.

The host connects to the module configured for TCP Server mode.

2.

Once the connection is established, data can be transmitted in both directions—from the host to themodule, and from the module to the host.

MiiNePort E2/E3 Series User Manual

20TCP Client Mode
In TCP Client mode, the module can actively establish a TCP connection to a predefined host computer whenserial data arrives. After the data has been transferred, the module can be automatically disconnected fromthe host computer by using the TCP alive check time or Inactivity time settings. Refer to subsequent
chapters for details. Data transmission proceeds as follows:1.

The module actively establishes a connection based on the conditions set in the firmware. You may let
the module connect to a remote host on startup, or connect later when data from the serial device
arrives.

2.

Once the connection is established, data can be transmitted in both directions—from the host to themodule, and from the module to the host.

MiiNePort E2/E3 Series User Manual21

RFC2217 Mode
RFC2217 is an industrial public protocol for sharing serial devices over TCP/IP Ethernet networks. RFC2217
is similar to Moxa’s proprietary Real COM mode in that it 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 module’s serial port is mapped by the driver to an IP address andport number. The driver intercepts data sent to the host’s COM port, packs it into a TCP/IP packet, and thenredirects it through the host’s Ethernet card.

MiiNePort E2/E3 Series User Manual22UDP Mode
UDP is similar to TCP but is faster and more efficient. Although data can be broadcast to or received frommultiple network hosts, UDP does not support data verification, and consequently is not suitable forapplications for which data integrity is critical. UDP would, however, be suitable for message display
applications.

ATTENTION
The Real COM driver comes with NPort Windows Driver Manager, which is included on the CD-ROM shippedwith the MiiNePort Starter kit.

ATTENTION
Real COM mode allows several hosts to simultaneously access to the MiiNePort module. The driver controls
host access to attached serial devices by checking the host’s IP address against the Accessible IP list. Use
the Accessible IP table to restrict access to the module when a public IP address is required for yourapplication.

Ethernet Modem Mode
Ethernet Modem Mode is designed for use with legacy operating systems, such as MS-DOS, that do notsupport TCP/IP Ethernet. By connecting the MiiNePort evaluation board’s serial ports to an 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.

MiiNePort E2/E3 Series User Manual

23

MCSC Mode (MiiNePort E2 Only)
MCSC (Multiple Channel Serial Communication) was developed for multiple serial-to-Ethernet applications
that use only one serial port. For example, if you need your device to act as a TCP Server and TCP Client at
the same time (as illustrated below), you can use MCSC.

For details on MCSC’s functionality and configuration, refer to Chapter 8: NetEZ Technologies’ MCSC.
MCSC is only supported on the MiiNePort E2.

MiiNePort E2/E3 Series User Manual24

4. Choosing the Configuration Tool

The MiiNePort supports several tools for configuring the module. In this chapter, we briefly describe theoptions available and appropriate situations for using those options.

Utility Console
Device Search Utility
You can find the Device Search Utility on the CD-ROM that came with your product. NPort Search Utility isdesigned for Windows and is mainly used to search for the MiiNePort modules and for assigning IP
addresses. Refer to the Web Console for additional configuration information.

NPort Windows Driver Manager
NPort Windows Driver Manager is intended for use with Real COM mode. The software manages theinstallation of drivers that allow you to map unused COM ports on your PC to serial ports on the MiiNePort.

Refer to Chapter 6: Utility Console and Driver Installation for details on how to use the Device Search
Utility and NPort Windows Driver Manager.

MiiNePort E2/E3 Series User Manual25Web Console
After locating a MiiNePort with the Device Search Utility, you may configure the MiiNePort using a standard
web browser. Refer to Chapter 7: Web Console Configuration for details on how to access and use the
MiiNePort web console.

Telnet ConsoleYour MiiNePort can be configured over the network with Telnet, which requires that the module has a
network connection and an IP address. We briefly discuss Telnet console configuration in Chapter 5: Initial
IP Address Configuration. All Telnet console commands are introduced in Chapter 7: Web Console
Configuration.

MiiNePort E2/E3 Series User Manual26

SCM (Serial Command Mode)
The MiiNePort’s SCM (Serial Command Mode) allows the module’s parameters to be retrieved andconfigured through the serial port. This is accomplished using specially parsed commands sent to themodule through the serial port.
SCM is often used when your device has already been used in a real application and a configuration change,such as changing the device’s IP address with the device’s key pad, is required.
Refer to Chapter 7: Web Console Configuration for details on how to access and use the MiiNePort’s
SCM. Refer to Appendix A: Introduction to SCM (Serial Command Mode) for the SCM command set
instructions.

MiiNePort E2/E3 Series User Manual27

5. Initial IP Address Configuration

When setting up your MiiNePort 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, refer to the Network Settings section in Chapter 7: Web Console
Configuration.

Static vs. Dynamic IP Address
You should first determine whether the module will be assigned a Static IP or Dynamic IP (either DHCP or
BOOTP application).
•If the module is used in a Static IP environment, you need to configure the IP address directly.

•

If the module is used in a Dynamic IP environment, you need to configure the module to obtain an IP
address dynamically with DHCP, DHCP/BOOTP, BOOTP, or AUTOIP.

ATTENTION
Consult your network administrator on how to reserve a fixed IP address for the module in the MAC-IP
mapping table when using a DHCP Server or BOOTP Server. For most applications, you should assign afixed IP address to the module.

Factory Default IP Address
The MiiNePort module is configured with the following default private 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 todirectly 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. Applications that require sending
data over a public network, such as the Internet, require setting up the server with a valid public IP
address, which can be leased from a local ISP.

ARP
You can use the ARP (Address Resolution Protocol) command to set up the module’s IP address. The ARP
command tells your computer to associate the module’s MAC address with the intended IP address. You
must then use Telnet to access the module, at which point the module’s IP address will be reconfigured.

ATTENTION
In order to use ARP, both your computer and the module must be connected to the same LAN. You may
also use a crossover Ethernet cable to connect the module directly to your computer’s Ethernet port. Your
module must be configured with the factory default IP address before executing the ARP command.

MiiNePort E2/E3 Series User Manual28

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 <new IP address> 00-90-E8-tt-tt-tt
For example,
arp –s 192.168.200.100 00-90-E8-00-00-00
In this example, 192.168.200.100 is the new IP address and 00-90-E8-00-00-00 is the module’s MAC
address, as obtained in steps 1 and 2.

4.

Execute a special Telnet command by typing:telnet <new IP address> 6000
For example,
telnet 192.168.200.100 6000

After issuing this command, a Connect failed message will appear. After the module reboots, its IP address
will be updated to the new address, and you can reconnect the module using the utility, web, or Telnet
console to verify that the update was successful.

Telnet Console
Depending on how your computer and network are configured, you may find it convenient to use network
access to set up your module’s IP address. This can be done using Telnet, which requires that the module
has a network connection and an IP address.
1.

From the Windows desktop, click Start and then select Run.

2.

Telnet to the module’s current IP address. If this is the first time configuring the module, you will telnet
to the default IP address by typing telnet 192.168.127.254 in the Open text box. Click OK toproceed.

3.

You will be asked to enter a password to access to the device. The default password for MiiNePort E2/E3
is moxa.

MiiNePort E2/E3 Series User Manual

29

4.

Select Network settings by pressing 0 and then press Enter.

5.

Select IP address by pressing 1 and then press Enter.

MiiNePort E2/E3 Series User Manual

30

6.

Use the backspace key to erase the current IP address. Type in the new IP address and then press
Enter.

7.

Press any key to continue.

MiiNePort E2/E3 Series User Manual

31

8.

Press M and then Enter to return to the main menu.

9.

Press S and then Enter to Save/Restart the system.

MiiNePort E2/E3 Series User Manual3210. Press Y and then Enter to save the new IP address and restart the module.

MiiNePort E2/E3 Series User Manual33

6. Utility Console and Driver Installation

This chapter teaches you how to install the MiiNePort’s utilities, use the utilities to perform simple
configurations, and install the drivers.

Device Search Utility (DSU)
Installing the Device Search Utility
1.

Click the INSTALL UTILITY button in the MiiNePort Installation CD to install the Device Search Utility.
Once the program starts running, click Yes to proceed.

2.

Click Next when the Welcome screen opens to proceed with the installation.

MiiNePort E2/E3 Series User Manual

34

3.

Click Browse to select an alternate location and then click Next to install program files to the directory
displayed in the input box.

4.

Select the additional tasks you would like to set up to be performed while installing the DSU; then, click
Next.

MiiNePort E2/E3 Series User Manual

35

5.

The installer will display a summary of the installation options. Click Install to begin the installation.
The setup window will report the progress of the installation. To change the installation settings, click
Back and navigate to the previous screen.

6.

Click Finish to complete the installation of the Device Search Utility.

MiiNePort E2/E3 Series User Manual36Device Search Utility Configuration
The Broadcast Search function is used to locate all MiiNePort modules that are connected to the same LAN
as your computer. After locating a MiiNePort, you will be able to change its IP address. Since the Broadcast
Search function searches by MAC address and not IP address, all MiiNePort modules connected to the LAN
will be located, regardless of whether or not they are part of the same subnet as the host.
1.

Start the Device Search Utility and then click the Search icon.

2.

Note: Users running Windows Vista and Windows 7 will see a User Account Control pop-up andshould allow the program.

3.

The Searching window indicates the progress of the search.

4.

When the search is complete, all MiiNePort modules that were located will be displayed in the Device
Search Utility window.

5.

To modify the configuration of the highlighted MiiNePort, click the Console icon to open the web
console. This will take you to the web console, where you can make configuration changes. Refer to
Chapter 7: Web Console Configuration for information on how to use the web console.

ATTENTION
If you are looking for information related to TCP Server, TCP Client, Ethernet Modem, RFC2217, or UDP
modes, you can ignore the following Driver sections, including NPort Windows Driver Manager and Linux
Real TTY Driver, and instead jump directly to Chapter 7: Web Console Configuration for additionalsettings.

MiiNePort E2/E3 Series User Manual37

NPort Windows Driver Manager
Installing NPort Windows Driver Manager
The NPort Windows Driver Manager is intended for use with serial ports that are set to Real COM mode. The
software manages the installation of drivers that allow you to map unused COM ports on your PC to yourdevice through the MiiNePort’s serial port. When the drivers are installed and configured, devices that areembedded with the MiiNePort will be treated as if they are attached to your PC’s own COM ports.
1.

Click the INSTALL COM Driver button in the MiiNePort Installation CD to install the NPort Windows
Driver. Once the installation program starts running, click Yes to proceed.

2.

Click Next when the Welcome screen opens to proceed with the installation.

3.

Click Browse to select the destination directory and then click Next to install program files to thedirectory displayed in the input box.

MiiNePort E2/E3 Series User Manual

38

4.

Click Next to install the program’s shortcuts in the appropriate Start Menu folder.

5.

The installer will display a summary of the installation options. Click Install to begin the installation.
The setup window will report the progress of the installation. To change the installation settings, click
Back and navigate to the previous screen.

6.

Click Finish to complete the installation of NPort Windows Driver Manager.

MiiNePort E2/E3 Series User Manual39

Using NPort Windows Driver Manager
After you have installed the NPort Windows Driver Manager, you can set up the MiiNePort’s serial port,
which is connected to your device’s main board, as remote COM ports for your PC host. Make sure that theserial port on your MiiNePort is already set to Real COM mode when mapping COM ports with the NPort
Windows Driver Manager.

NOTE
Refer to Chapter 7: Web Console Configuration to learn how to configure your MiiNePort to Real COM
mode.
1.

Go to Start ( NPort Windows Driver Manager ( NPort Windows Driver Manager to start the COM
mapping utility.

2.

Click the Add icon.

NOTE
Users running Windows Vista and Windows 7 will see a User Account Control pop-up and should allow
the program.
3.

Click Search to search for the MiiNePort modules. From the list that is generated, select the server towhich you will map COM ports, and then click OK.

MiiNePort E2/E3 Series User Manual

40

4.

Alternatively, you can select Input Manually and then manually enter the MiiNePort module’s IP
Address, 1st Data Port, 1st Command Port, and Total Ports to which COM ports will be mapped.
Click OK to proceed to the next step. Note that the Add NPort page supports FQDN (Fully Qualified
Domain Name), in which case the IP address will be filled in automatically.

5.

COM ports and their mappings will appear in blue until they are activated. Activating the COM ports
saves the information in the host system registry and makes the COM port available for use. The hostcomputer will not have the ability to use the COM port until the COM ports are activated. Click Yes toactivate the COM ports at this time, or click No to activate the COM ports later.

6.

Ports that have been activated will appear in black.

MiiNePort E2/E3 Series User Manual41

Command Line Installation/Removal
The NPort Windows Driver Manager v1.19 and above comes with a command-line script tool – npcli.exe for
installation, removal of the driver, and configuring NPort driver functions.
After successfully installing the NPort Windows Driver Manager v1.19 (or above), the default file path is
C:\Program Files\NPortDrvManager as shown below. The main files that support the NPort commandline tool are npcli.exe and GIdMap.dat. You may move these two files to your preferred location.

Once the NPort Windows Driver Manager v1.19 (or above) is installed, call up the cmd screen on yourcomputer. Change the directory to the drive where you place the above two files.

Type npcli /? to get detailed information of what command lines are supported and the function
descriptions.

The usage instructions will show up for user’s reference.

MiiNePort E2/E3 Series User Manual42-----------------------------------------------------------------------------NPort Command-Line Interface Ver2.0 Build 16052400-----------------------------------------------------------------------------Usage:
1. NPort Driver operation:
npcli /driver [/install | /uninstall | /upgrade] [PATH_NAME]/install/uninstall/upgrade
PATH_NAME

Install specified driver to host.
Uninstall current installed driver from host.
Upgrade specified driver without modifying the mapped ports.
Specify the installer file of NPort Driver Manager to installor upgrade.

2. RealCOM port operation:
npcli /driver /add IP_ADDR /port PORT_NO /com COM_NO [/txmode [hiperf |classical]] [/fifo [enable | disable]] [/flush [fast | normal]]
npcli /driver /remove /com [COM_NO | all]
/add
/port
/com
/txmode/fifo/flush/remove

Add a RealCOM with a valid IP address (IP_ADDR).
Specify the NPort port number (PORT_NO) to add.
Specify the COM number to add or remove (COM_NO).
Set the TX mode as hi-performance (hiperf) or classical. The
default is hiperf.
Set the FIFO as enable or disable. The default is enable.
Set to enable fast flush(fast) or disable fast flush(normal).
The default is fast.
Remove specified COM number (COM_NO) or all RealCOM ports.

3. NPort devices operation:
npcli /devicd /search
npcli /device /set ID /network [/ip IP_ADDR] [/mask SUBNET][/gateway IP_ADDR] [/password CIPHER]
npcli /device /apply ID [/password CIPHER]/search/set/port/password/network/ip/mask/gateway/applySearch the NPort and store the list to the memory.
Specify the ID to set. Users must specify one of the searched
NPorts for further operations. The default is 1.
Specify the NPort port number (PORT_NO) to set.
Specify the password (CIPHER) if the NPort has one.
Set to change the network settings.
Change the IP address (IP_ADDR) of NPort.
Change the subnet mask (SUBNET) of NPort.
Change the IP address (IP_ADDR) of gateway.
Specify the ID to save changes and restart the NPort.

4. Examples
npcli /driver /install D:\Users\drvmgr_setup_Ver1.19.0_Build_15122492
npcli /driver /uninstall
npcli /driver /add 192.168.127.254 /port 1 /com 3
npcli /driver /add 192.168.127.254 /port 2 /com 4 /flush normal
npcli /device /search
npcli /device /set 1 /network /ip 192.168.10.7 /mask 255.255.255.0/password moxa
npcli /device /apply 1
Note:
Npcli.exe requires an administrator privilege to change device settings.
It support only IPv4 and it must be run under Windows XP and later versions.

MiiNePort E2/E3 Series User Manual

43

The Linux Real TTY Driver1.

Obtain the driver file from the included CD-ROM or the Moxa website, at http://www.moxa.com.

2.

Log in to the console as a super user (root).

3.

Execute cd / to go to the root directory.

4.

Copy the driver file npreal2xx.tgz to the / directory.

5.

Execute tar xvfz npreal2xx.tgz to extract all files into the system.

6.

Execute /tmp/moxa/mxinst.
For RedHat AS/ES/WS and Fedora Core1, append an extra argument as follows:# /tmp/moxa/mxinst SP1
The shell script will install the driver files automatically.

7.

After installing the driver, you will be able to see several files in the /usr/lib/npreal2/driver folder:> mxaddsvr (Add Server, mapping tty port)> mxdelsvr (Delete Server, un-mapping tty port)> mxloadsvr (Reload Server)> mxmknod (Create device node/tty port)> mxrmnod (Remove device node/tty port)> mxuninst (Remove tty port and driver files)

At this point, you will be ready to map the MiiNePort serial port to the system tty port.

Mapping TTY Ports
Be sure to set the operation mode of the serial port of the MiiNePort to Real COM mode. After logging in asa super user, enter the directory /usr/lib/npreal2/driver and then execute mxaddsvr to map the target
MiiNePort serial port to the host tty ports. The syntax of mxaddsvr is as follows:
mxaddsvr [MiiNePort IP Address] [Total Ports] ([Data port] [Cmd port])
The mxaddsvr command performs the following actions:1.

Modifies npreal2d.cf.

2.

Creates tty ports in directory /dev with major and minor number configured in npreal2d.cf.

3.

Restarts the driver.

Mapping tty ports automatically
To map tty ports automatically, execute mxaddsvr with just the IP address and number of ports, as in thefollowing example:# cd /usr/lib/npreal2/driver# ./mxaddsvr 192.168.3.4 16
In this example, 16 tty ports will be added, all with IP 192.168.3.4, with data ports from 950 to 965 andcommand ports from 966 to 981.

Mapping tty ports manually
To map tty ports manually, execute mxaddsvr and manually specify the data and command ports, as in thefollowing example:# cd /usr/lib/npreal2/driver# ./mxaddsvr 192.168.3.4 16 4001 966
In this example, 16 tty ports will be added, all with IP 192.168.3.4, with data ports from 4001 to 4016 andcommand ports from 966 to 981.

MiiNePort E2/E3 Series User Manual44Removing Mapped TTY Ports
After logging in as root, enter the directory /usr/lib/npreal2/driver and then execute mxdelsvr todelete a server. The syntax of mxdelsvr is:
mxdelsvr [IP Address]
Example:# cd /usr/lib/npreal2/driver# ./mxdelsvr 192.168.3.4
The following actions are performed when executing mxdelsvr:
1.

npreal2d.cf is modified.

2.

Relevant tty ports in directory /dev are removed.

3.

The driver is restarted.

If the IP address is not provided in the command line, the program will list the installed servers and total
ports on the screen. You will need to choose a server for deletion from the list.

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 thedriver. The following actions will be performed:
1.

The driver is unloaded.

2.

All files and directories in /usr/lib/npreal2 are deleted.

3.

The directory /usr/lib/npreal2 is deleted.

4.

The script file that initializes the system is modified.

The UNIX Fixed TTY Driver
Installing the UNIX Driver1.

Log in to UNIX and create a directory for the Moxa TTY. To create a directory named /usr/etc, executethe command:# mkdir –p /usr/etc

2.

Copy moxattyd.tar to the directory you created. If you created the /usr/etc directory above, you
would execute the following commands:# cp moxattyd.tar /usr/etc# cd /usr/etc

3.

Extract the source files from the tar file by executing the command:# tar xvf moxattyd.tar
The following files will be extracted:
README.TXT
moxattyd.cmoxattyd.cf
Makefile
VERSION.TXT
FAQ.TXT

4.

--- source code--- an empty configuration file--- makefile--- fixed tty driver version

Compile and Link
For SCO UNIX:# make sco
For UnixWare 7:# make svr5

MiiNePort E2/E3 Series User Manual45

For UnixWare 2.1.x, SVR4.2:# make svr42

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 thesame 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 thevarious configuration parameters.

NOTE
The “Device Name” depends on the OS. See the Device Naming Rule section in README.TXT for more
information.
Start the moxattyd daemon that you configured in moxattyd.cf. If you would like to set the connection
timeout, you can add a “-t min” parameter to specify the connection timeout value in minutes. For example:# /usr/etc/moxattyd/moxattyd -t 1

NOTE
You will now be able to use tty, which is configured in moxattyd.cf.
To start the moxattyd daemon after system bootup, add an entry into /etc/inittab, with the tty name you
configured in moxattyd.cf, as in the following example:
ts:2:respawn:/usr/etc/moxattyd/moxattyd –t 1

Device naming rule
For UnixWare 7, UnixWare 2.1.x, and SVR4.2, use:
pts/[n]For all other UNIX operating systems, use:ttyp[n]Adding an additional server
Modify the text file moxattyd.cf to add an additional server. You may use vi or any text editor to modify
the file. For more configuration information, look at the file moxattyd.cf, which contains detailed
descriptions of the various configuration parameters.
Find the process ID (PID) of the program moxattyd.
# ps -ef | grep moxattyd
Update the configuration of the moxattyd program.
# kill -USR1 [PID](e.g., if moxattyd PID = 404, kill -USR1 404)
Execute the moxattyd program again to activate the new settings, as follows:# /usr/etc/moxattyd/moxattyd -t 1
This completes the process of adding an additional server.

MiiNePort E2/E3 Series User Manual46

7. Web Console Configuration

The web console is the most user-friendly way to configure your MiiNePort Series module. This chapter
introduces the web console function groups and function definitions.

Opening Your Brower
1.

Open your browser with the cookie function enabled. (To enable your Internet Explorer for cookies,
right click on your desktop Internet Explorer icon, select Properties, click on the Security tab, andthen 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. You will be asked to enter a password to access the device. The default password
for MiiNePort E1 is moxa.

ATTENTION
If you use other web browsers, remember to enable the functions to allow cookies that are stored onyour computer or allow per-session cookies. MiiNePort modules only use cookies for password
transmission.

ATTENTION
Refer to Chapter 5: Initial IP Address Configuration for instructions on IP configuration.

MiiNePort E2/E3 Series User Manual

47

3.

The web console will open. On this page, you can see a brief description of the web console’s functiongroups in the left part of the page. You can also see a configuration overview of your MiiNePort module.

Web Console Fundamentals
In the web console, the left panel is the navigation panel. It contains an expandable menu tree fornavigating among the various settings and categories. When you click on a menu item in the navigation
panel, the main window will display the corresponding options for that item.
Configuration changes can then be made in the main window. For example, if you click on Basic Settings( Network Settings in the navigation panel, the main window will show a page of network settings thatyou can configure.
You must click on the Submit button to keep your configuration changes. The Submit button will be locatedat the bottom of every page that has configurable settings. If you navigate to another page without clicking
the Submit button, your settings will not be retained.
Changes will not take effect until they are saved and the module is restarted! You may complete this in one
step by clicking on Save/Restart after you submit a change. If you restart the module without saving yourconfiguration, the module will discard all submitted changes.

Basic Settings
Network Settings

MiiNePort E2/E3 Series User Manual48You must assign a valid IP address to the module before it will work in your network environment. Your
network system administrator should provide you with an IP address and related settings for your network.
The IP address must be unique within the network; otherwise the module will not have a valid connection to
the network. First-time users can refer to Chapter 5: Initial IP Address Configuration for more
information.
Device name
Setting
1 to 39 characters

Factory Default[model name]_[Serial No.]

Necessity
OptionalThis option can be used to specify the location or application of the module, which may be useful whenmanaging more than one module on the network.
IP configuration
MethodStatic
DHCP
DHCP/BOOTP
BOOTP
AUTOIP

Function Definition
User defined IP address, Netmask, Gateway.
DHCP Server assigned IP address, Netmask, Gateway, DNS
DHCP Server assigned IP address, Netmask, Gateway, DNS, or BOOTP Server
assigned IP address
BOOTP Server assigned IP address
AUTOIP protocols automatically negotiate and assign IP in 169.254/16 network

IP configuration is a required field. The default setting is Static.

ATTENTION
In Dynamic IP environments, the module will attempt to obtain an IP address from the DHCP or BOOTP
server 3 times at 30-second intervals. The timeout for the first try will be 1 second, the second try will be
3 seconds, and the last try will be 5 seconds.
If the DHCP/BOOTP Server is unavailable, the module will use the default IP address (192.168.127.254),
netmask, and gateway settings.
IP Address
SettingE.g., 192.168.1.1(IP addresses of the form x.x.x.0
and x.x.x.255 are invalid.)

Description

Factory Default

192.168.127.254

Required

An IP address is a number assigned to a network device, such as a computer, as a permanent address on
the network. Computers use the IP address to identify and talk to each other over the network. Choose aproper IP address that is unique and valid in your network environment.
Netmask
SettingE.g., 255.255.255.0

Factory Default
255.255.255.0

Necessity
RequiredA subnet mask represents all the network hosts at one geographic location, in one building, or on the same
local area network. When a packet is sent out over the network, the module will use the subnet mask tocheck whether the host specified in the packet is on a local network segment. If the address is on the same
network segment as the module, a connection is established directly from the module. Otherwise, theconnection is established through the default gateway.
Gateway
SettingE.g., 192.168.1.1

Factory Default
None

Necessity
Optional

A gateway acts as an entrance to another network. Usually, the computers that control traffic within the
network or at the local Internet service provider are gateway nodes. The module needs to know the IP
address of the default gateway computer in order to communicate with the hosts outside the local network
environment. For correct gateway IP address information, consult your network administrator.

MiiNePort E2/E3 Series User Manual49

DNS server 1 / DNS server 2
SettingE.g., 192.168.1.1 (IPaddresses of the form
x.x.x.0 and x.x.x.255
are invalid)

Factory Default

Necessity

None

Optional

The Domain Name System (DNS) is used to identify and translate Internet domain names into IP addresses.
A domain name is an alphanumeric name, such as moxa.com, that is usually easier to remember. A DNS
server is a host that translates the text-based domain name into the corresponding numeric IP address,
which is used to establish a TCP/IP connection. When the user enters a website address, the computer asksa DNS server for the website’s IP address to connect to the web server.
When a DNS server is specified, the module acts as a DNS client and will allow domain names instead of IP
addresses to be used on the web console. The following web console fields support the use of domainnames: TCP Client-Destination IP Address, and IP Address Report Server. Two DNS servers can be specified,
DNS

Serial Port Settings

Port Alias
Setting
1 to 15 characters(E.g., PLC-No.1)

Factory Default

Necessity

None

OptionalThis function is designed for future use. You may enter a string to help in the module’s serial port fromother serial ports.

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.
Baudrate
Setting
Factory Default
50 bps to 921.6 Kbps
(supports non-standard 115.2 Kbps
baudrates)

MiiNePort E2/E3 Series User Manual

Necessity
Required50

The MiiNePort supports the Any Baudrate (non-standard baudrate) feature. If your baudrate is notlisted, select Other from the drop-down list and type the baudrate in the input box.
The MiiNePort will use the closest baudrate that is supported.

Data Bits
Setting
5, 6, 7, 8

Factory Default
8

Necessity
Required

Factory Default
1

Necessity
RequiredStop Bits
Setting
1, 1.5, 2

Stop Bits will be set to 1.5 when Data Bits is set to 5 bits.
ParitySettingNone, Even, Odd,
Space, Mark

Factory Default

Necessity

None

Required

Factory Default

Necessity

RTS/CTS

Required

Factory Default
EnableNecessity
RequiredFlow control
SettingNone, RTS/CTS,
DTR/DSR, XON/XOFF
FIFOSetting
Enable, Disable

Each module’s serial port provides a 128-byte FIFO both in the Tx and Rx directions. Disable the FIFO
setting when your serial device does not have a FIFO to prevent data loss during communication.
Interface
Setting
RS-232/422/485

Description
RS-232, RS-422/485

MiiNePort E2/E3 Series User Manual

Necessity
Required51

Operation Modes

Before reading this section, refer to Chapter 3: Choosing the Proper Operation Mode to select theoperation mode that best fits your device application.
Click Operation Modes, located under the Main Menu, to display the operating settings for the MiiNePort’s
two serial ports.

Disable Mode

When Mode is set to Disable, that particular port will be disabled.

Real COM Mode

ATTENTION
To use Real COM mode, refer to Chapter 6: Utility Console and Driver Installation for instructions on
how to install the Real COM driver on Windows or Linux machines.

MiiNePort E2/E3 Series User Manual52

TCP alive check time
Setting
0 to 99 min

Factory Default
7 min

Necessity
Optional

0 min: The TCP connection is not closed due to an idle TCP connection.
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.
Max connection
Setting
1, 2, 3, 4

Factory Default
1

Necessity
Required

Max connection is used when the device needs to receive data from different hosts simultaneously.
The factory default only allows one 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 one host’s Real COM driver to open a connection to themodule’s serial port.
Max connections 2 to 4: When set to 2 or higher, Real COM drivers for up to the specified number ofhosts may open this port at the same time. When Real COM drivers for multiple hosts open the port at thesame time, the COM driver only provides a pure data tunnel with no control ability. The serial port
parameters will use firmware settings instead of your application program (AP) settings.
Application software that is based on the COM driver will receive a driver response of “success” when thesoftware uses any of the Win32 API functions. The firmware will only send data back to the driver on thehost. Data will be sent first-in,-first-out when data is received by the MiiNePort from the Ethernet interface.

ATTENTION
When Max connection is greater than one, the MiiNePort module will use a multiple connection application(i.e., two to four hosts are allowed access to the port at the same time). When using a multi-connection
application, the module will use the serial communication parameters as defined here in the web console,and all hosts connected to the port must use identical serial settings. If one of the hosts opens the COM
port with different serial settings, data will not be transmitted properly.
Ignore jammed IP
Setting
Enable, Disable

Factory Default
DisableNecessity
Required when Max connection is greater than 1

This option determines how the port will proceed if multiple hosts are connected and one or more of thehosts stops responding as the port is transmitting data. If you select Disable, the port will wait until thedata has been transmitted successfully to all hosts before transmitting the next group of data. If you selectEnable, the port will ignore the host that stopped responding and continue data transmission to the otherhosts.

NOTE
Ignore Jammed IP is only active when Max connection is greater than 1.
Allow driver control
Setting
Enable, Disable

Factory Default
EnableNecessity
Required when Max connection is greater than 1

This option determines how the port will proceed if driver control commands are received from multiple
hosts that are connected to the port. If Disable is selected, driver control commands will be ignored. If
Enable is selected, control commands will be accepted, with the most recent command received taking
precedence.

MiiNePort E2/E3 Series User Manual

53

NOTE
Allow driver control is only active when Max connection is greater than one.
Packet length
Setting
0 to 1024 bytes

Factory Default
0 byteNecessity
Required

The Packet length setting refers to the maximum amount of data that is allowed to accumulate in theserial port buffer before sending. When packet length is set to 0 (the default), a maximum amount is not
specified and data in the buffer will be sent as specified by the delimiter settings or when the buffer is full.
When a packet length between 1 and 1024 bytes is specified, data in the buffer will be sent as soon as itreaches the specified length.
Delimiter 1
Setting
00 to FF

Factory Default“0” for None

Necessity
Optional

Factory Default“0” for None

Necessity
Optional

Delimiter 2
Setting
00 to FF

The delimiter fields are used to specify a one-character or two-character sequence that acts as a marker tocontrol packing of serial data. By default, delimiter characters are not defined, so the module transmits data
as soon as it is received. When a delimiter character or characters are defined, the module will hold data in
its buffer until it receives the delimiter character or two-character sequence. When the delimiter is received,
the module will pack the data into its buffer and send it out through the Ethernet port.
Use Delimiter 1 to define the first delimiter character in hex. If only one delimiter character is used,
Delimiter 2 should be set to “0”. If the delimiter is a two-character sequence, use Delimiter 2 to define thesecond character. To disable the use of delimiters, set both Delimiter 1 and Delimiter 2 to “0”.
Note that data packing is controlled not only by the delimiter but is also influenced by the module’s buffer
size and the Force transmit field. If the delimiter has not been received by the time the 1K buffer is full, themodule will pack the data for network transmission and clear the buffer. In addition, the module will also
pack data for network transmission if the next byte of data is not received within the Force transmit time.

ATTENTION
Delimiter 2 is optional. If left blank, then Delimiter 1 alone trips clearing of the buffer. If the size of theserial data received is greater than 1 KB, the MiiNePort will automatically pack the data and send it to the
Ethernet. However, to use the delimiter function, you must at least enable Delimiter 1. If Delimiter 1 is left
blank and Delimiter 2 is enabled, the delimiter function will not work properly.
Delimiter process
Setting
Do Nothing,
Delimiter+1,
Delimiter+2,
Strip Delimiter

Factory Default

Necessity

Do Nothing (only effective when Delimiter is enabled)

Optional

The Delimiter process field determines how the data is handled when a delimiter is received. Delimiter 1
must be enabled for this field to have effect. If Delimiters 1 and 2 are both enabled, both characters must
be received for the delimiter process to take place.
[Do Nothing]: Data in the buffer will be transmitted when the delimiter is received.
[Delimiter + 1] or [Delimiter + 2]: The data will be transmitted when an additional byte (for Delimiter+1), or an additional two bytes (for Delimiter +2) of data is received after receiving the delimiter.
[Strip Delimiter]: When the delimiter is received, the delimiter is deleted (i.e., stripped), and theremaining data is transmitted.

MiiNePort E2/E3 Series User Manual54Force transmit
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0: The force transmit timeout is disabled.
1 to 65535: If the module does not receive the next byte of data within the time specified, it will pack thedata in its buffer into the same data frame for network transmission.
The Force transmit field is typically used in conjunction with the delimiter fields to specify how data in themodule’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 thebuffer 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. With Force transmit enabled, the module willautomatically pack the data in the buffer for network transmission if no data is received for the specified
time.
When set to 0, Force transmit is disabled, which means there is no time limit for how long the module will
wait to receive data. When set between 1 and 65535, the module will pack data if serial data is not received
in the specified time.
The optimal Force transmit time depends on your application, but it should be larger than one characterinterval within the specified baudrate to have any effect. For example, assume that the serial port is set to1200 bps, 8 data bits, 1 stop bit, and no parity. In this case, the total number of bits needed to send one
character is 10 bits, and the time required to transfer one character is(10 bits / 1200 bits/s) × 1000 ms/s = 8.3 ms.
Since it requires about 9 ms to send one character, the Force transmit should be 10 ms or more to have any
effect. At 9 ms or less, the module will simply pack every character as it is received, which would be thesame as if delimiter characters or a Force transmit time were not specified.

RFC 2217 Mode

TCP alive check time
Setting
0 to 99 min

Factory Default
7 min

Necessity
Optional

0 min: TCP connection is not closed due to an idle TCP connection.
1 to 99 min: The MiiNePort automatically closes the TCP connection if there is no TCP activity for the given
time. After the connection is closed, the MiiNePort starts listening for another host’s TCP connection.
Local TCP port
Setting
1 to 65535

Factory Default
4001

Necessity
Required

The Local TCP port is the TCP port that the MiiNePort uses to listen to connections, and that other devices
must use to contact the MiiNePort. To avoid conflicts with well-known TCP ports, the default is set to 4001.
Packet length
Setting
0 to 1024

Factory Default
0

MiiNePort E2/E3 Series User Manual

Necessity
Optional

55

The Packet length setting refers to the maximum amount of data that is allowed to accumulate in the serial
port buffer before sending. When packet length is set to 0 (the default), a maximum amount is not specified
and data in the buffer will be sent as specified by the delimiter settings or when the buffer is full. When apacket length between 1 and 1024 bytes is specified, data in the buffer will be sent as soon as it reaches
the specified length.
Delimiter 1
Setting
00 to FF

Factory Default
None

Necessity
Optional

Factory Default
None

Necessity
Optional

Delimiter 2
Setting
00 to FF

The delimiter fields are used to specify a one-character or two-character sequence that acts as a marker tocontrol packing of serial data. By default, delimiter characters are not defined, so the module transmits data
as soon as it is received. When a delimiter character or characters are defined, the module will hold data in
its buffer until it receives the delimiter character or two-character sequence. When the delimiter is received,
the module will pack the data into its buffer and send it out through the Ethernet port.
Use Delimiter 1 to define the first delimiter character in hex. If only one delimiter character is used,
Delimiter 2 should be set to “0”. If the delimiter is a two-character sequence, use Delimiter 2 to define thesecond character. To disable the use of delimiters, set both Delimiter 1 and Delimiter 2 to “0”.
Note that data packing is controlled not only by the delimiter but is also influenced by the module’s buffer
size and the Force transmit field. If the delimiter has not been received by the time the 1K buffer is full, themodule will pack the data for network transmission and clear the buffer. In addition, the module will also
pack data for network transmission if the next byte of data is not received within the Force transmit time.
Delimiter process
Setting
Do Nothing,
Delimiter +1,
Delimiter +2,
Strip Delimiter

Factory Default

Necessity

Do Nothing

Optional

Thedelimiter process field determines how the data is handled when a delimiter is received. Delimiter 1
must be enabled for this field to have effect. If Delimiters 1 and 2 are both enabled, both characters must
be received for the delimiter process to take place.
[Do Nothing]: Data in the buffer will be transmitted when the delimiter is received.
[Delimiter + 1] or [Delimiter + 2]: The data will be transmitted when an additional byte (for Delimiter+1), or an additional two bytes (for Delimiter +2) of data is received after receiving the delimiter.
[Strip Delimiter]: When the delimiter is received, the delimiter is deleted (i.e., stripped), and theremaining data is transmitted.
Force transmit
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0: The force transmit timeout is disabled.
1 to 65535: If the module does not receive the next byte of data within the time specified, it will pack thedata in its buffer into the same data frame for network transmission.
The Force transmit field is typically used in conjunction with the delimiter fields to specify how data in themodule’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 thebuffer 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. With Force transmit enabled, the module willautomatically pack the data in the buffer for network transmission if no data is received for the specified
time.
When set to 0, Force transmit is disabled, which means there is no time limit for how long the module will
wait to receive data. When set between 1 and 65535, the module will pack data if serial data is not received
in the specified time.

MiiNePort E2/E3 Series User Manual

56

The optimal force transmit time depends on your application, but it should be larger than one characterinterval within the specified baudrate to have any effect. For example, assume that the serial port is set to1200 bps, 8 data bits, 1 stop bit, and no parity. In this case, the total number of bits needed to send one
character is 10 bits, and the time required to transfer one character is(10 bits / 1200 bits/s) × 1000 ms/s = 8.3 ms.
Since it requires about 9 ms to send one character, the Force transmit should be 10 ms or more to have any
effect. At 9 ms or less, the module will simply pack every character as it is received, which would be thesame as if a delimiter character or Force transmit time were not specified.

ATTENTION
If you want to send a series of characters in the same packet, the serial device attached to the MiiNePortshould send that series of characters during a time interval less than the Force transmit timeout for the
MiiNePort, and the total length of data must be less than or equal to the MiiNePort’s internal buffer size.
The serial communication buffer size for the MiiNePort is 1 KB per port.

TCP Server Mode

TCP alive check time
Setting
0 to 99 min

Factory Default
7 min

Necessity
Optional

0 min: TCP connection is not closed due to an idle TCP connection.
1 to 99 min: The MiiNePort automatically closes the TCP connection if there is no TCP activity for the given
time. After the connection is closed, the MiiNePort starts listening for another host’s TCP connection.
Inactivity time
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0 ms: TCP connection is not closed due to an idle serial line.
0-65535 ms: The MiiNePort automatically closes the TCP connection if there is no serial data activity forthe given time. After the connection is closed, the MiiNePort starts listening for another host’s TCP
connection.
This parameter defines the maintenance status as Closed or Listen for the TCP connection. The connection isclosed if there is no incoming or outgoing data through the serial port during the specific Inactivity time.

MiiNePort E2/E3 Series User Manual57

If the Inactivity time is set to 0, the current TCP connection is kept active until a connection close request is
received. Although Inactivity time is disabled, the MiiNePort will check the connection status between the
MiiNePort and the remote host by sending “keep alive” packets periodically. If the remote host does not
respond to the packet, the MiiNePort assumes that the connection was closed unintentionally. The MiiNePort
will then force the existing TCP connection to close.

ATTENTION
The Inactivity time should be greater than the Force transmit timeout. To prevent the unintended loss ofdata due to the session being disconnected, it is highly recommended that this value is set large enoughso that the intended data transfer is completed.

ATTENTION
Inactivity time is ONLY active when TCP connect on is set to Any character.
Max connection
Setting
1, 2, 3, 4

Factory Default
1

Necessity
Required

Max connection is used when the device 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 one host’s Real COM driver to open a connection to themodule’s serial port.
Max connections 2 to 4: When set to two or higher, Real COM drivers for up to the specified number ofhosts may open this port at the same time. When Real COM drivers for multiple hosts open the port at thesame time, the COM driver only provides a pure data tunnel with no control ability. The serial port
parameters will use firmware settings instead of your application program (AP) settings.
Application software that is based on the COM driver will receive a driver response of “success” when thesoftware uses any of the Win32 API functions. The firmware will only send data back to the driver on thehost. Data will be sent first-in,first-out when data is received by the MiiNePort from the Ethernet interface.
Ignore jammed IP
Setting
Enable, Disable

Factory Default
DisableNecessity
OptionalThis option determines how the port will proceed if multiple hosts are connected, and one or more of thehosts stops responding as the port is transmitting data. If you select Disable, the port will wait until thedata has been transmitted successfully to all hosts before transmitting the next group of data. If you selectEnable, the port will ignore the host that stopped responding and continue data transmission to the otherhosts.

NOTE
Ignore Jammed IP is only active when Max connection is greater than 1.
Allow driver control
Setting
Enable, Disable

Factory Default
DisableNecessity
OptionalThis option determines how the port will proceed if driver control commands are received from multiple
hosts that are connected to the port. If Disable is selected, driver control commands will be ignored. If
Enable is selected, control commands will be accepted, with the most recent command received taking
precedence.

MiiNePort E2/E3 Series User Manual

58

NOTE
Allow driver control is only active when Max connection is greater than one.
Local TCP port
Setting
1 to 65535

Factory Default
4001

Necessity
Required

The Local TCP port is the TCP port that the MiiNePort uses to listen to connections and that other devices
must use to contact the MiiNePort. To avoid conflicts with well-known TCP ports, the default is set to 4001.
Command port
Setting
1 to 65535

Factory Default
966

Necessity
Optional

The Command port is a “listen TCP port” for IP-Serial Lib commands from the host. In order to prevent a
TCP port conflict with other applications, the user can set the Command port to another port if needed. IPSerial Lib will automatically check the Command Port on the MiiNePort so that the user does not need toconfigure the program.
Packet length
Setting
0 to 1024

Factory Default
0

Necessity
Optional

The Packet length setting refers to the maximum amount of data that is allowed to accumulate in theserial port buffer before sending. When packet length is set to 0 (the default), a maximum amount is not
specified and data in the buffer will be sent as specified by the delimiter settings or when the buffer is full.
When a packet length between 1 and 1024 bytes is specified, data in the buffer will be sent as soon as itreaches the specified length.
Delimiter 1
Setting
00 to FF

Factory Default
None

Necessity
Optional

Factory Default
None

Necessity
Optional

Delimiter 2
Setting
00 to FF

The delimiter fields are used to specify a one-character or two-character sequence that acts as a marker tocontrol packing of serial data. By default, delimiter characters are not defined, so the module transmits data
as soon as it is received. When a delimiter character or characters are defined, the module will hold data in
its buffer until it receives the delimiter character or two-character sequence. When the delimiter is received,
the module will pack the data into its buffer and send it out through the Ethernet port.
Use Delimiter 1 to define the first delimiter character in hex. If only one delimiter character is used,
Delimiter 2 should be set to “0”. If the delimiter is a two-character sequence, use Delimiter 2 to define thesecond character. To disable the use of delimiters, set both Delimiter 1 and Delimiter 2 to “0”.
Note that data packing is controlled not only by the delimiter but is also influenced by the module’s buffer
size and the Force transmit field. If the delimiter has not been received by the time the 1K buffer is full, themodule will pack the data for network transmission and clear the buffer. In addition, the module will also
pack data for network transmission if the next byte of data is not received within the Force transmit time.

ATTENTION
Delimiter 2 is optional. If left blank, then Delimiter 1 alone trips clearing of the buffer. If the size of theserial data received is greater than 1 KB, the MiiNePort will automatically pack the data and send it to the
Ethernet. However, to use the delimiter function, you must at least enable Delimiter 1. If Delimiter 1 is left
blank and Delimiter 2 is enabled, the delimiter function will not work properly.

MiiNePort E2/E3 Series User Manual59Delimiter process
Setting
Do Nothing,
Delimiter + 1,
Delimiter + 2,
Strip Delimiter

Factory Default

Necessity

Do Nothing

Optional

The Delimiter process field determines how the data is handled when a delimiter is received. Delimiter 1
must be enabled for this field to have effect. If Delimiters 1 and 2 are both enabled, both characters must
be received for the delimiter process to take place.
[Do Nothing]: Data in the buffer will be transmitted when the delimiter is received.
[Delimiter + 1] or [Delimiter + 2]: The data will be transmitted when an additional byte (for Delimiter+1), or an additional 2 bytes (for Delimiter +2) of data is received after receiving the delimiter.
[Strip Delimiter]: When the delimiter is received, the delimiter is deleted (i.e., stripped), and theremaining data is transmitted.
Force transmit
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0: The force transmit timeout is disabled.
1 to 65535: If the module does not receive the next byte of data within the time specified, it will pack thedata in its buffer into the same data frame for network transmission.
The Force transmit field is typically used in conjunction with the delimiter fields to specify how data in themodule’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 thebuffer 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. With Force transmit enabled, the module willautomatically pack the data in the buffer for network transmission if no data is received for the specified
time.
When set to 0, Force transmit is disabled, which means there is no time limit for how long the module will
wait to receive data. When set between 1 and 65535, the module will pack data if serial data is not received
in the specified time.
The optimal force transmit time depends on your application, but it should be larger than one characterinterval within the specified baudrate to have any effect. For example, assume that the serial port is set to1200 bps, 8 data bits, 1 stop bit, and no parity. In this case, the total number of bits needed to send one
character is 10 bits, and the time required to transfer one character is(10 bits / 1200 bits/s) × 1000 ms/s = 8.3 ms.
Since it requires about 9 ms to send one character, the Force transmit should be 10 ms or more to have any
effect. At 9 ms or less, the module will simply pack every character as it is received, which would be thesame as if delimiter characters or a Force transmit time were not specified.

ATTENTION
If you want to send a series of characters in the same packet, the serial device attached to the MiiNePortshould send that series of characters during a time interval less than the Force transmit timeout for the
MiiNePort, and the total length of data must be less than or equal to the MiiNePort’s internal buffer size.
The serial communication buffer size for the MiiNePort is 1 KB per port.

MiiNePort E2/E3 Series User Manual60

TCP Client Mode

TCP alive check time
Setting
0 to 99 min

Factory Default
7 min

Necessity
Optional

0 min: The TCP connection is not closed due to an idle TCP connection.
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.
Inactivity time
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0 ms: TCP connection is not closed due to an idle serial line.
0-65535 ms: The MiiNePort automatically closes the TCP connection if there is no serial data activity forthe given time. After the connection is closed, the MiiNePort starts listening for another host’s TCP
connection.
This parameter defines the maintenance status as Closed or Listen for the TCP connection. The connection isclosed if there is no incoming or outgoing data through the serial port during the specific Inactivity time.
If the Inactivity time is set to 0, the current TCP connection is kept active until a connection close request is
received. Although Inactivity time is disabled, the MiiNePort will check the connection status between the
MiiNePort and the remote host by sending “keep alive” packets periodically. If the remote host does not
respond to the packet, the MiiNePort assumes that the connection was closed unintentionally. The MiiNePort
will then force the existing TCP connection to close.

ATTENTION
The Inactivity time should be greater than the Force transmit timeout. To prevent the unintended loss ofdata due to the session being disconnected, it is highly recommended that this value is set large enoughso that the intended data transfer is completed.

MiiNePort E2/E3 Series User Manual61

ATTENTION
Inactivity time is ONLY active when TCP connect on is set to Any character.
Ignore jammed IP
Setting
Enable, Disable

Factory Default
DisableNecessity
OptionalThis option determines how the port will proceed if multiple hosts are connected and one or more of thehosts stops responding as the port is transmitting data. If you select Disable, the port will wait until thedata has been transmitted successfully to all hosts before transmitting the next group of data. If you selectEnable, the port will ignore the host that stopped responding and continue data transmission to the otherhosts.

NOTE
Ignore Jammed IP is only active when Max connection is greater than one.
Packet length
Setting
0 to 1024

Factory Default
0

Necessity
Optional

The Packet length setting refers to the maximum amount of data that is allowed to accumulate in theserial port buffer before sending. When packet length is set to 0 (the default), a maximum amount is not
specified and data in the buffer will be sent as specified by the delimiter settings or when the buffer is full.
When a packet length between 1 and 1024 bytes is specified, data in the buffer will be sent as soon as itreaches the specified length.
Delimiter 1
Setting
00 to FF

Factory Default“00” for None

Necessity
Optional

Factory Default“00” for None

Necessity
Optional

Delimiter 2
Setting
00 to FF

The delimiter fields are used to specify a one-character or two-character sequence that acts as a marker tocontrol packing of serial data. By default, delimiter characters are not defined, so the module transmits data
as soon as it is received. When a delimiter character or characters are defined, the module will hold data in
its buffer until it receives the delimiter character or two-character sequence. When the delimiter is received,
the module will pack the data into its buffer and send it out through the Ethernet port.
Use Delimiter 1 to define the first delimiter character in hex. If only one delimiter character is used,
Delimiter 2 should be set to “0”. If the delimiter is a two-character sequence, use Delimiter 2 to define thesecond character. To disable the use of delimiters, set both Delimiter 1 and Delimiter 2 to “0”.
Note that data packing is controlled not only by the delimiter but is also influenced by the module’s buffer
size and the Force transmit field. If the delimiter has not been received by the time the 1K buffer is full, themodule will pack the data for network transmission and clear the buffer. In addition, the module will also
pack data for network transmission if the next byte of data is not received within the Force transmit time.

ATTENTION
Delimiter 2 is optional. If left blank, then Delimiter 1 alone trips clearing of the buffer. If the size of theserial data received is greater than 1 KB, the MiiNePort will automatically pack the data and send it to the
Ethernet. However, to use the delimiter function, you must at least enable Delimiter 1. If Delimiter 1 is left
blank and Delimiter 2 is enabled, the delimiter function will not work properly.

MiiNePort E2/E3 Series User Manual62Delimiter process
Setting
Do Nothing,
Delimiter + 1,
Delimiter + 2,
Strip Delimiter

Factory Default

Necessity

Do Nothing

Optional

The Delimiter process field determines how the data is handled when a delimiter is received. Delimiter 1
must be enabled for this field to have effect. If Delimiters 1 and 2 are both enabled, both characters must
be received for the delimiter process to take place.
[Do Nothing]: Data in the buffer will be transmitted when the delimiter is received.
[Delimiter + 1] or [Delimiter + 2]: The data will be transmitted when an additional byte (for Delimiter+1), or an additional 2 bytes (for Delimiter +2) of data is received after receiving the delimiter.
[Strip Delimiter]: When the delimiter is received, the delimiter is deleted (i.e., stripped), and theremaining data is transmitted.
Force transmit
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0: The Force transmit timeout is disabled.
1 to 65535: If the module does not receive the next byte of data within the time specified, it will pack thedata in its buffer into the same data frame for network transmission.
The Force transmit field is typically used in conjunction with the delimiter fields to specify how data in themodule’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 thebuffer 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. With Force transmit enabled, the module willautomatically pack the data in the buffer for network transmission if no data is received for the specified
time.
When set to 0, Force transmit is disabled, which means there is no time limit for how long the module will
wait to receive data. When set between 1 and 65535, the module will pack data if serial data is not received
in the specified time.
The optimal force transmit time depends on your application, but it should be larger than one characterinterval within the specified baudrate to have any effect. For example, assume that the serial port is set to1200 bps, 8 data bits, 1 stop bit, and no parity. In this case, the total number of bits needed to send one
character is 10 bits, and the time required to transfer one character is(10 bits / 1200 bits/s) × 1000 ms/s = 8.3 ms.
Since it requires about 9 ms to send one character, the Force transmit should be 10 ms or more to have any
effect. At 9 ms or less, the module will simply pack every character as it is received, which would be thesame as if delimiter characters or a Force transmit time were not specified.
Destination IP address 1/2/3/4
Setting
IP address or Domain Name
(E.g., 192.168.1.1)

Factory Default

Necessity

None

Required

Up to four Destination IP addresses (or domain names) can be specified. The MiiNePort will be able toactively connect to each of these remote addresses.

ATTENTION
The connection speed or throughput may be slow if one of the four connections is slow, since the one slow
connection will slow down the other three connections.

MiiNePort E2/E3 Series User Manual63

ATTENTION
Both IP address and Domain Name can be used in the Destination IP address field.
Designated Local Port 1/2/3/4
Setting
TCP Port No.

Factory Default
5011 (Port 1)
5012 (Port 2)5013 (Port 3)5014 (Port 4)

Necessity
RequiredConnection control
SettingStartup/None, Any Character/None,
Any Character/Inactivity Time,DSR ON/DSR OFF, DSR ON/None,
DCD ON/DCD OFF, DCD ON/None

Factory Default

Necessity

Startup/None

Required

The meaning of each of the above settings is given in the following table. In general, both the Connect
condition and Disconnect condition are given.
Connect/Disconnect
Startup / None(default)

Description
A TCP connection will be established on startup and will remain active
indefinitely.
A TCP connection will be established when any character is received from the
Any Character / None
serial interface and will remain active indefinitely.
Any Character / Inactivity A TCP connection will be established when any character is received from theTimeserial interface and will be disconnected when the Inactivity time out is reached.
A TCP connection will be established when a DSR “On” signal is received and will
DSR On / DSR Off
be disconnected when a DSR “Off” signal is received.
A TCP connection will be established when a DSR “On” signal is received and will
DSR On / Noneremain active indefinitely.
A TCP connection will be established when a DCD “On” signal is received and will
DCD On / DCD Off
be disconnected when a DCD “Off” signal is received.
A TCP connection will be established when a DCD “On” signal is received and will
DCD On / Noneremain active indefinitely.

UDP Mode

MiiNePort E2/E3 Series User Manual64Destination IP address 1
Setting

Factory Default

IP address range
E.g., Begin: 192.168.1.1
End: 192.168.1.10

Begin: Empty
End:

Empty

Port:

4001

Necessity
Required

Destination IP address 2/3/4
Setting

Factory Default

IP address range
E.g., Begin: 192.168.1.11
End: 192.168.1.20

Begin: Empty
End:

Empty

Port:

4001

Necessity
Optional

Local listen port
Setting
1 to 65535

Factory Default
4001

Necessity
Required

The Local listen port is the UDP port that the MiiNePort listens to, and that other devices must use tocontact the MiiNePort. To avoid conflicts with well-known UDP ports, the default is set to 4001.
Packet length
Setting
0 to 1024

Factory Default
0

Necessity
Optional

The Packet length setting refers to the maximum amount of data that is allowed to accumulate in theserial port buffer before sending. When packet length is set to 0 (the default), a maximum amount is not
specified and data in the buffer will be sent as specified by the delimiter settings or when the buffer is full.
When a packet length between 1 and 1024 bytes is specified, data in the buffer will be sent as soon as itreaches the specified length.
Delimiter 1
Setting
00 to FF

Factory Default“00” for None

Necessity
Optional

Factory Default“00” for None

Necessity
Optional

Delimiter 2
Setting
00 to FF

The delimiter fields are used to specify a one-character or two-character sequence that acts as a marker tocontrol packing of serial data. By default, delimiter characters are not defined, so the module transmits data
as soon as it is received. When a delimiter character or characters are defined, the module will hold data in
its buffer until it receives the delimiter character or two-character sequence. When the delimiter is received,
the module will pack the data into its buffer and send it out through the Ethernet port.
Use Delimiter 1 to define the first delimiter character in hex. If only one delimiter character is used,
Delimiter 2 should be set to “0”. If the delimiter is a two-character sequence, use Delimiter 2 to define thesecond character. To disable the use of delimiters, set both Delimiter 1 and Delimiter 2 to “0”.
Note that data packing is controlled not only by the delimiter but is also influenced by the module’s buffer
size and the Force transmit field. If the delimiter has not been received by the time the 1K buffer is full, themodule will pack the data for network transmission and clear the buffer. In addition, the module will also
pack data for network transmission if the next byte of data is not received within the Force transmit time.

ATTENTION
Delimiter 2 is optional. If left blank, then Delimiter 1 alone trips clearing of the buffer. If the size of theserial data received is greater than 1 KB, the MiiNePort will automatically pack the data and send it to the
Ethernet. However, to use the delimiter function, you must at least enable Delimiter 1. If Delimiter 1 is left
blank and Delimiter 2 is enabled, the delimiter function will not work properly.

MiiNePort E2/E3 Series User Manual65Delimiter process
Setting
Do Nothing,
Delimiter + 1,
Delimiter + 2,
Strip Delimiter

Factory Default

Necessity

Do Nothing

Optional

The Delimiter process field determines how the data is handled when a delimiter is received. Delimiter 1
must be enabled for this field to have effect. If Delimiters 1 and 2 are both enabled, both characters must
be received for the delimiter process to take place.
[Do Nothing]: Data in the buffer will be transmitted when the delimiter is received.
[Delimiter + 1] or [Delimiter + 2]: The data will be transmitted when an additional byte (for Delimiter+1), or an additional two bytes (for Delimiter +2) of data is received after receiving the delimiter.
[Strip Delimiter]: When the delimiter is received, the delimiter is deleted (i.e., stripped), and theremaining data is transmitted.
Force transmit
Setting
0 to 65535 ms

Factory Default
0 ms

Necessity
Optional

0: The force transmit timeout is disabled.
1 to 65535: If the module does not receive the next byte of data within the time specified, it will pack thedata in its buffer into the same data frame for network transmission.
The Force transmit field is typically used in conjunction with the Delimiter fields to specify how data in themodule’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 thebuffer 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. With Force transmit enabled, the module willautomatically pack the data in the buffer for network transmission if no data is received for the specified
time.
When set to 0, Force transmit is disabled, which means there is no time limit for how long the module will
wait to receive data. When set between 1 and 65535, the module will pack data if serial data is not received
in the specified time.
The optimal force transmit time depends on your application, but it should be larger than one characterinterval within the specified baudrate to have any effect. For example, assume that the serial port is set to1200 bps, 8 data bits, 1 stop bit, and no parity. In this case, the total number of bits needed to send one
character is 10 bits, and the time required to transfer one character is(10 bits / 1200 bits/s) × 1000 ms/s = 8.3 ms.
Since it requires about 9 ms to send one character, the Force transmit should be 10 ms or more to have any
effect. At 9 ms or less, the module will simply pack every character as it is received, which would be thesame as if delimiter characters or a Force transmit time were not specified.

ATTENTION
If you want to send a series of characters in the same packet, the serial device attached to the MiiNePortshould send that series of characters during a time interval less than the Force transmit timeout for the
MiiNePort, and the total length of data must be less than or equal to the MiiNePort’s internal buffer size.
The serial communication buffer size for the MiiNePort is 1 KB per port.

MiiNePort E2/E3 Series User Manual66Ethernet Modem Mode

Dial-in
The MiiNePort listens for a TCP/IP connection request from the remote Ethernet modem or host. The
MiiNePort’s response depends on the ATS0 value, as outlined below.

ATS0=0 (default)
The MiiNePort will temporarily accept the TCP connection and then send the RING signal out through theserial port. The serial controller must reply with ATA within 2.5 seconds to accept the connection request,
after which the MiiNePort enters data mode. If the ATA command is not received, the MiiNePort will
disconnect after sending three RING signals.

ATS0≧1The MiiNePort will accept the TCP connection immediately and then send the CONNECT <baud> commandto the serial port, in which <baud> represents the baudrate of the MiiNePort’s serial port. Subsequently, theMiiNePort will immediately enter data mode.

Dial-out
The MiiNePort accepts the AT command ATD <IP>:<TCP port> from the serial port and then requests a
TCP connection from the remote Ethernet Modem or PC. This is where <IP> is the IP address of the remote
Ethernet modem or PC, and <TCP port> is the TCP port number of the remote Ethernet modem or PC. Oncethe remote unit accepts this TCP connection, the MiiNePort will send out the CONNECT <baud> signal via
the serial port and then enter data mode.

Disconnection request from local site
When the MiiNePort is in data mode, the user can drive the DTR signal to OFF, or send +++ from the local
serial port to the MiiNePort. The MiiNePort will enter command mode and return NO CARRIER via the serial
port, and then input ATH to shut down the TCP connection after one second.

NOTE
The +++ command cannot be divided. The “+” character can be changed in register S2, and the guardtime, that prefixes and suffixes the +++ in order to protect the raw data can be changed in register S12.

Disconnection request from remote site
After the TCP connection has been shut down by the remote Ethernet modem or PC, the MiiNePort will send
the NO CARRIER signal via the serial port and then return to command mode.

MiiNePort E2/E3 Series User Manual67

AT Commands
The MiiNePort supports the following common AT commands used with a typical modem:
No.
1
2

AT command
ATA
ATD <IP>:<Port>

3

ATE

4

ATH

5
6
7
8
9
10
11
12

ATI, ATI0, ATI1, ATI2
ATL
ATM
ATO
ATP, ATT
ATQ0, ATQ1
ATSr=n
ATSr?

13

ATV

14

ATZ

15

AT&C

16

AT&D

17
18
19
20
21
22

AT&F
AT&G
AT&R
AT&S
AT&V
AT&W

Description
Answer manually
Dial up the IP address: Port No.
ATE0=Echo OFF
ATE1=Echo ON (default)
ATH0=On-hook (default)
ATH1=Off-hook
Modem version
Speaker volume option
Speaker control option
Online command
Set Pulse/Tone Dialing mode
Quiet command (default=ATQ0)
Change the contents of S register
Read the contents of S register
Result code type
ATV0 for digit code
ATV1 for text code
0=OK
1=connect (default)
2=ring3=No carrier
4=errorReset (disconnect, enter command mode and restore
the flash settings)
Serial port DCD control AT&C0=DCD always on
AT&C1=DTE detects connection by DCD on/off(default)
Serial port DTR control AT&D0=recognize DTE always
ready AT&D1, AT&D2=reply DTE when DTR On(default)
Restore manufacturer’s settings
Select guard time
Serial port RTS option command
Serial port DSR control
View settings
Write current settings to flash for next boot-up

Remarks

reply “OK” only
reply “OK” only
reply “OK” only
reply “OK” only
See “S registers”
See “S registers”

reply “OK” only
reply “OK” only
reply “OK” only

S Registers
No.
1
2
3
4
5
6
7
8
9
10
11
12

S Register
S0
S1
S2
S3
S4
S5
S6
S7
S8
S9
S10
S11

13

S12

Description & default value
Ring to auto-answer (default=0)
Ring counter (always=0)
Escape code character (default=43 ASCII “+”)
Return character (default=13 ASCII)
Line feed character (default=10 ASCII)
Backspace character (default= 8 ASCII)
Wait time for dial tone (always=2, unit=sec)
Wait time for carrier (default=3, unit=sec)
Pause time for dial delay (always=2, unit=sec)
Carrier detect response time (always=6, unit 1/10 sec)
Delay for hang up after carrier (always=14, unit 1/10 sec)
DTMF duration and spacing (always=100 ms)
Escape code guard time (default=50, unit 1/50 sec), to control
the idle time for “+++”MiiNePort E2/E3 Series User Manual

Remarks
no action applied

no action applied
no action applied
no action applied
no action applied
no action applied

68

TCP alive check time
Setting
0 to 99 min

Factory Default
7 min

Necessity
Required

0 min: The TCP connection is not closed due to an idle TCP connection.
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.
Local TCP port
Setting
1 to 65535

Factory Default
4001

Necessity
Required

The Local TCP port is the TCP port that the MiiNePort uses to listen to connections, and that other devices
must use to contact the MiiNePort. To avoid conflicts with well-known TCP ports, the default is set to 4001.

MCSC Mode

After selecting MCSC mode, you will be able to configure Channel 1 and Channel 2. MCSC mode is designed
so that the two channels work independently. Click the Modify button of a channel to update the channel’s
configuration.
We use Channel 1 to illustrate.

All of the configuration items shown in the above screenshot have been discussed earlier in this chapter.
Use the Mode drop-down list to select the operation mode for the channel, and then update theconfiguration items. When you click Submit, the following confirmation window will appear.

MiiNePort E2/E3 Series User Manual69

Click the Close button to return to the initial Operation Modes configuration screen (shown below). At thispoint you can click the Modify button for Channel 2 to configure the settings for that channel. The
configuration settings for Channel 1 will be shown, but you are free to update each configuration item.
When you click Submit, the configuration will be saved to the MiiNePort’s memory and will not be erased
until the next time you change the configuration.

Click Modify to configure Channel 2. For example, if you want to set Channel 2 to Real COM mode, youneed to finish your Real COM settings and then click Submit.

When the confirmation screen appears, choose either Save/Restart to activate the changes you’ve madeor Close to do other configurations.
For details on MCSC’s functionality and configuration, refer to Chapter 8: NetEZ Technologies’ MCSC.
MCSC is only supported on the MiiNePort E2.

Advanced Settings
Accessible IP List

MiiNePort E2/E3 Series User Manual70

The Accessible IP List allows you to configure the following types of accessibility:•

To allow access to a specific IP address•

To allow access to hosts on a specific subnet

Enter the IP address in the corresponding field; enter 255.255.255.255 for the netmask.
For both the IP address and netmask, use 0 for the last digit (e.g., 192.168.1.0 and 255.255.255.0).
•

To allow unrestricted accessDeselect the Enable the accessible IP list option.

Refer to the following table for more configuration examples.
Allowed Hosts
Any host
192.168.1.120
192.168.1.1 to 192.168.1.254
192.168.0.1 to 192.168.255.254
192.168.1.1 to 192.168.1.126
192.168.1.129 to 192.168.1.254

Entered IP address/Netmask
Disable192.168.1.120 / 255.255.255.255
192.168.1.0 / 255.255.255.0
192.168.0.0 / 255.255.0.0
192.168.1.0 / 255.255.255.128
192.168.1.128 / 255.255.255.128

SNMP AgentTo enable the SNMP agent function, click the Enable option located to the right of SNMP under
Configuration.

Community string
Setting
1 to 39 characters(E.g., support, 88689191230 #300)

Factory Default

Necessity

PublicOptional

A community name is a plain-text password mechanism that is used to authenticate queries to agents ofmanaged network devices.
Contact Name
Setting
1 to 39 characters(E.g., support, 88689191230 #300)

Factory Default

Necessity

None

Optional

The SNMP contact information usually includes an emergency contact name and telephone or pager number.
Location
Setting
1 to 39 characters(E.g., floor 1, office 2)

Factory Default

Necessity

None

Optional

Enter a location string for SNMP agents. This string is usually set to the street address where the module isphysically located.

MiiNePort E2/E3 Series User Manual71

DIO Settings
The DIO channel is configured on the DIO Settings page. DIO commands can be used to control and obtaindata from the module’s DIO channels. When digital input operation is selected, the channel’s status iscontrolled by an external digital switch. When digital output operation is selected, the channel transmits ahigh or low signal. Refer to Appendix D: DIO Commands for additional information.

DIO number ( Mode
Select Input or Output under Mode to specify digital input or digital output operation.
DIO number ( State
Select Low or High under State to specify a high or low state for digital output channels. Note that when
Mode is set to Input (as shown in the above screenshot), the State option is deactivated.
DIO Command ( TCP port
Select an appropriate TCP port under DIO Command to indicate the port number that will be reserved for
DIO commands.

Serial Command Mode (SCM)
SCM (Serial Command Mode) uses serial communication between the MiiNePort and your device’s main
system to configure the MiiNePort. The configuration is usually done while the device is operating. For moredetails about SCM commands, see Chapter 8: NetEZ Technologies.

Way to enter serial command mode
Setting
Disable,H/W control pin (DIO1),
Activate by characters,
Activate by break signal

Factory Default

Necessity

Activate by characters (Only at boot up)

Required

There are three ways to access SCM:
H/W control pin (DIO 1): Access SCM by pulling JP3 Pin4, the DIO1, to ”low.”
Activate by characters: Access SCM by sending the MiiNePort’s configurable three characters from yourdevice’s main system. Check the Only at boot up checkbox if you would like this action to only be effective
when the MiiNePort is booting up.

MiiNePort E2/E3 Series User Manual72Activate by break signal: Break signals are created by sending continuous Spacing values (i.e., no Start
or Stop bits). The absence of an electric signal on the data circuit is interpreted as a Break signal. The Breaksignal must be of duration longer than the time it takes to send a complete byte plus Start, Stop, and Parity
bits.

Miscellaneous
PHY Speed, Gratuitous ARP, and Auto IP Report are configured in the Miscellaneous section under
Advanced Settings.

PHY Speed
PHY Speed
Setting
Auto

Factory Default
Auto

Necessity
Required

Factory Default

Necessity

StatusSetting
100 Mbps Full Duplex,
100 Mbps Half Duplex,
10 Mbps. Full Duplex,
10 Mbps Half Duplex

Required

You can set PHY speed to Auto, 100 Mbps Full Duplex, 100 Mbps Half Duplex, 10 Mbps Full Duplex, or 10
Mbps Half Duplex.

MiiNePort E2/E3 Series User Manual73Gratuitous ARP
For some applications, you may want the MiiNePort to send broadcast packets to update the ARP table on
the server. If you enable this function, the MiiNePort will send broadcast packets periodically based on thespecified time interval.

Auto IP Report
When the MiiNePort is used in a dynamic IP environment, additional time must be spent on IP managementtasks. For example, when a module is operating as a server (TCP Server or UDP operation modes), a PC
operating as a client will need to know the module’s IP address. If the DHCP server assigns a new IP
address to the module, the PC must have some way of obtaining the module’s new IP address. The IP
Address report fields are used to set up periodic reporting of the module’s IP address when the module’s IP
address is assigned by a server. The IP address report is sent automatically at regular intervals to the IP
address and TCP port number that you specify. Auto IP Report allows you to view the module’s IP address
report on a PC:
To develop software that parses the IP address report data, see Appendix C: Auto IP Report Protocol for
details.
Auto report toSettingE.g., 192.168.1.1 or URL (IPaddresses of the form x.x.x.0 andx.x.x.255 are invalid.)

Factory Default

Necessity

None

Optional

Auto report to TCP port
SettingE.g., 4001

Factory Default
4002

Necessity
Optional

If left blank, auto IP reporting is disabled. If an IP address is entered along with a TCP port number, the IP
address reports will be sent to the specified address and port number.
Auto report period
SettingTime interval (in seconds)

Factory Default
10

Necessity
Optional

The Auto report period field specifies how often the module will report its IP address. For example, if the
auto report period is set to 10 seconds, an IP address report will be sent every 10 seconds.

ATTENTION
The module will send IP address reports only when assigned an IP address from a DHCP or BOOTP server.
If a connection to a DHCP or BOOTP server is not available, IP address reports will not be sent.

MiiNePort E2/E3 Series User Manual74

MaintenanceConsole Settings
You can enable or disable the Web, Telnet, and Utility console functions on the Console Settings page. In
addition, you can configure the port numbers for the web Telnet servers.

Firmware Upgrade
The MiiNePort’s firmware can be upgraded though the web console, or through the Device Search utility. If
you have made any changes to your configuration, remember to save the configuration first before
upgrading the firmware. Refer to the Save Configuration section in this chapter for more information. Any
unsaved changes will be discarded when the firmware is upgraded.
To upgrade the firmware, simply enter the file name and click Submit. The latest firmware can be
downloaded from Moxa’s website at www.moxa.com.

Configuration Tools
The MiiNePort’s Auto Configuration, Configuration Import, and Configuration Export functions from
the Maintenance ( Configuration Tool sub-menu.

MiiNePort E2/E3 Series User Manual75Auto Configuration
You can enable or disable AutoCFG from the Auto Configuration page. AutoCFG is designed for enabling
automatic network configuration during the production of your device. AutoCFG allows you to realize true
device mass production without needing to set up the network modules one by one.

For more information about AutoCFG, refer to Chapter 8: NetEZ Technologies.

Configuration Import
The MiiNePort E2/E3 Series can share or back up its configuration by exporting all settings to a file, which
can then be imported into another MiiNePort E2/3. The passwords in exported file will be encrypted by acipher key assigned by the user, which will be asked again when importing back to the MiiNePort E2/E3
module. The Configuration Import utility allows you to choose whether to import the IP configuration at thesame time.

Configuration Export
Configuration Export allows you to export the current configuration to a text file. You will be asked to
input an user defined cipher key for encrypting the passwords in the configuration file prior to clicking thedownload button. The exported configuration file, named MiiNePortE2.txt (or MiiNePortE2-H.txt,
MiiNePortE3.txt, MiiNePortE3-H.txt) by default, can be imported into another MiiNePort module laterwith the Configuration Import utility. It can also be used with AutoCFG for mass configuration deployment
during your device’s mass production stage.

MiiNePort E2/E3 Series User Manual76Change Password
Click on Change Password in the navigation panel to display the Change Password window.

Enter the old password and new password (twice) and then click Submit. The default password for
MiiNePort device is moxa.

Load Factory Default
To load the factory default settings, click on Load Factory Default in the navigation panel and then click
Submit. All previous modifications will be lost, but you can choose to keep the IP settings by checking the
Keep IP settings checkbox.

MiiNePort E2/E3 Series User Manual77

8. NetEZ Technologies

This chapter introduces EZPower, SCM (Serial Command Mode), AutoCFG (Auto Configuration), andEZPage, the four innovative functions of the NetEZ technology family.

EZPower

The EZPower function makes it easy to configure the MiiNePort’s input voltage. Use EZPower to configure
the MiiNePort’s system power input to either 3.3 VDC or 5 VDC.

SCM (Serial Command Mode)
The MiiNePort’s SCM (Serial
Command Mode) utility allows themodule’s parameters to be retrievedor configured through the serial port,
rather than over the network. This isdone through the use of speciallyparsed commands sent to the module
through its serial port.

SCM is often used when your device
has already been used in actual
applications and you need to change
the MiiNePort’s configuration, such aschanging the device’s IP address byusing your device’s key pad.

Refer to Chapter 7: Web Console Configuration for the most appropriate way to use SCM for yourapplication.
Refer to Appendix A: Introduction to SCM (Serial Command Mode) Command Set for detailed
instructions on using SCM commands.

MiiNePort E2/E3 Series User Manual78

AutoCFG (Auto Configuration)
The MiiNePort’s AutoCFG function isdesigned to allow users to realize
true mass production. With AutoCFG,
you no longer need to configure
network modules one by one during
the device manufacturing process.
To use AutoCFG, follow the steps
described below:

NOTE
AutoCFG is enabled by default. If you want to disable AutoCFG, see the Maintenance > Configuration
Tool > Auto Configuration in Chapter 7: Web Console Configuration.
Step 1:

Export the configuration (see the Configuration > Maintenance > Configuration Tool >Configuration Export section in Chapter 7: Web Console). After you have exported yourconfiguration, save the configuration to MiiNePort.txt, which contains all of the MiiNePort module’s
settings.

Step 2:

Set up a TFTP server on the network. The TFTP server is used to handle the AutoCFG task on yourdevice production line. Set your TFTP server’s IP address to 169.254.x.x/16. Next, save thepreviously saved MiiNePort.txt file under the root directory of the TFTP server. At this point, theAutoCFG working environment should be ready.

NOTE
Many freeware programs for creating TFTP servers can be found on the Internet.
Step 3:

AutoIP protocol will automatically assign a temporary IP address to your MiiNePort modules.

Step 4:Your MiiNePort modules will actively send out a broadcast packet asking if there is a TFTP serveron the same subnet that has a file named MiiNePortE2.txt (the file name will reflect the device
module in use, e.g. MiiNePortE2-H.txt or MiiNePortE3.txt).

Step 5:

Step 5: Your TFTP server will respond to the broadcast packet and your MiiNePort modules willautomatically download the MiiNePortE2.txt from the TFTFP server.

Step 6:Your MiiNePort modules will import and save the configuration. Once the MiiNePort finishes theself-configuration process; the MiiNePort’s ready LED on your design board will blink. When you
see the LED blinking, the AutoCFG task is complete and you can restart or power off your device.
LED Name
Ready

Step 7:

Color
Green, Blinking every 1 sec.

Description
Auto Config complete.

When you need to change the configuration, complete the revised configuration, export the new
MiiNePortE2.txt, and save the file to the TFTP server. Choose to replace the originalMiiNePortE2.txt located in the root directory. Your MiiNePort modules will then be able toretrieve the revised configuration file.

MiiNePort E2/E3 Series User Manual79

ATTENTION
Check the following if AutoCFG is not working properly on your device:
1.
2.
3.

Make sure the AutoCFG function is enabled (the function is enabled by default).
Check to see if the TFTP Server is working properly.
Make sure the specific configuration filename is correct: MiiNePortE2.txt, or whichever is appropriate
for your device.

ATTENTION
There is no theoretical limit to the number of MiiNePort E2 modules that can be connected at the sametime to one subnet for conducting an AutoCFG task.

ATTENTION
Even if you do not want to use the auto configuration function, the module will still go through the processof searching for the MiiNePort E2.txt file on the network every time it starts up if you do not disable the
AutoCFG function on your MiiNePort E2. The MiiNePort E2 will resume normal operation if it cannot findwhich network TFTP server the file is stored on. On average, it will take less than five seconds to conduct asearch. Your MiiNePort E2 will work properly with its original configuration even if it does not complete the
AutoCFG task.

ATTENTION
If you do not want the AutoCFG function to remain active after you’ve successfully finished the autoconfiguration, we suggest that you DISABLE the AutoCFG function when you are creating yourMiiNePortE2.txt file, since doing so will prevent the AutoCFG activity from occurring the next time yourdevice is powered on. Refer to Chapter 7: Web Console Configuration for configuration details.

MiiNePort E2/E3 Series User Manual

80

MCSC (Multiple Channel Serial Communication)NOTE
MCSC is only supported in the MiiNePort E2.

The Motivation Behind MCSC
An embedded device server only provides a limited number of physical serial ports to communicate with thedevice’s main system. As a result, users with one physical serial port are generally limited to a single
application. If you want to implement multiple serial-to-Ethernet applications (keep in mind that the
MiiNePort E2 has only one physical serial port), additional physical serial ports will be needed.
Unfortunately, providing additional physical serial ports increases hardware costs.
Moxa’s MiiNePort E2’s MCSC is designed tosolve this dilemma. MCSC (Multiple
Channel Serial Communication) is alightweight, pure software solution thatenables multiple serial-to-Ethernet
applications all through one physical serial
port, without any incremental hardware
costs. In short, MCSC allows multiple
application channels to share a single
physical serial port at the same time.

Communication Model
In traditional serial communication models, communication is accomplished by connecting two devices overa single serial channel. At the embedded device server end, Operating Mode (OP Mode) enables the otherend of the serial channel to transmit or receive data from the network. However, only one application, TCP
Server transportation, TCP Client transportation, or UDP transportation is supported at a time. The
communication model is depicted in the figure below.

NOTE
Refer to Chapter 3: Choosing the Proper Operation Mode for an introduction to the operation modes
supported by the MiiNePort E2.

MiiNePort E2/E3 Series User Manual81

Although there are UARTs and even an OS and driver stacks between the TCP Server Application andController Application, the applications are considered to be connected by a logical bidirectional channel
indicated in red in the following figure:

When using MCSC, an MCSC “command encoding and decoding software module” is attached to each end of
the serial communication line. The software module, which is used primarily for UART applications,compresses the data transmitted by the application through the single physical serial channel anddispatches the data received from the physical serial channel to the appropriate applications. With the helpof the MCSC modules, the two applications at opposite ends are still connected to a logical bidirectional
channel, but two or more application pairs can also be connected by separate channels to the same physicalserial channel. The communication model is depicted in the following figure:

The MCSC module is built into the MiiNePort E2. To enable MCSC, you need to set your MiiNePort E2 serial
port operation mode to MCSC mode and then set the channels’ operation modes individually according to
your application. In addition, you also need to implement the MCSC module in your device’s main system.

MiiNePort E2/E3 Series User Manual82The following basic principles apply to all MCSC module implementations.
1.

MCSC uses a command-based stream protocol. That is, transmissions that do not fit the MCSC
command format are treated as application data. All MCSC commands begin with ASCII DLE characters.
For the detailed command format, refer to the Command Packets section in following section.

2.

Other than dealing with MCSC commands, an MCSC module simply transfers application data from theupper application channel to the underlying physical serial channel, and vice versa.

3.

As with traditional serial applications, MCSC modules are logically connected to a bidirectional channel.
To use the serial bandwidth more effectively, MCSC modules separate it into two unidirectional
channels. Each MCSC module maintains its transmission application channel and reception application
channel. That is, the transmission channel of one end is the reception channel of another.

4.

Although logically all upper application channels share one physical serial port, to prevent confusion
only one channel can be connected to the physical serial port. That is, the application channel connectedto the transmission channel is called the active transmission channel, which transmits data to the serial
channel. The application channel connected to the reception channel is called the active reception
channel, which receives data from the serial channel.

5.

An MCSC module decides which channel will be the active transmission channel. In other words, theactive reception channel is determined by the other MCSC module on the other end of the serial
communication channel.

6.

To avoid data loss, we recommend that you activate serial communication flow control when using
MCSC.

Command Packets
An MCSC control packet begins with an ASCII DLE (Data Link Escape, 0x10) character. One end of the serial
communication line (normally, an MCSC module) treats the DLE it receives as a special delimiter thatindicates the other end of the serial communication line (normally, another MCSC module) that attempts toquery or change the MCSC behavior.
If a serial communication end wants to send a 0x10 (DLE) data byte, it sends two DLEs, one after the other.
The receiving end decodes these two DLEs into a single 0x10 byte.
Currently, 4four kinds of control packets are defined under MCSC:

Channel Switch Command
DLE

SOH

CHN

0x10

0x01

0x??

This command is used for an end to switch its active transmission channel. The CHN field indicates the newchannel number. Note that the CHN index is zero based, so you will need to use 0x00 for CHN to switch tochannel 1, 0x01 to switch to channel 2, and so on. For safety reasons, if one serial communication end
receives a Channel Switch Command that switches to a channel it does not support, it will simply discard it
after the data has been transmitted.
Note that when you begin using MCSC, both active communication channels are assumed to be channel 1.
After serial communication has ended, data is transferred without directing Channel Switch Command to thechannel 1 application.
In the MiiNePort E2, SCM will always be enabled when MCSC is enabled. A special channel indexed as 0xFF
in MCSC is dedicated for SCM. For more information, refer to the Serial Command Mode section in thischapter.
Example
A>
B>
A>
B>

10
55

01

01

11

22

33
10

01

01

33

22

11

01

00

66

55

44

44

10

01

55

66

00

44

66
11

22

33

10

This example shows that end A sends three bytes of data (11, 22, 33) using channel 1 and three bytes ofdata (44, 55, 66) using channel 2. On the other side, end B sends six bytes of data (33, 22, 11, 11, 22, 33)
using channel 1 and six bytes of data (66, 55, 44, 44, 55, 66) using channel 2.

MiiNePort E2/E3 Series User Manual83Channel Enquiry Command
DLE

ENQ

0x10

0x05

This command is used for an end to query for its active reception channel. By receiving this command, theother end will resend a Channel Switch Command to indicate the active transmission channel it is dealing
with, which is the active reception channel the initiator of Channel Enquiry Command deals with.
ExampleThis examples shows that end A queries for the active transmission channel of end B, and end B replies forchannel 2 and then continues to sending three bytes of data (11, 22, 33) using channel 2.
A>
B>

10

05
10

01

01

11

22

33

Data Escape Command
DLE

DLE

0x10

0x10

Although this is not actually an MCSC command, since the DLE character is used by MCSC to escape its
commands, a pair of DLEs will be transmitted to indicate a single 0x10 character of data.
ExampleThis examples shows end A sending 10 bytes of data (00, 02, 04, 06, 08, 0A, 0C, 0E, 10, 12) using
channel 1.
A>
B>

10

01

00

00

02

04

06

08

0A

0C

0E

10

10

12

Abnormal Packets
DLE

OTHER

0x10

???

Once the MiiNePort E2 receives a data stream with a header DLE character, followed by characters that are
not SOH, ENG, or DLE characters, the MiiNePort E2 will see this as an abnormal data packet caused bycommunication problems and will drop this data packet without sending data out through the Ethernet port.
The MiiNePort E2 will return the channel inquiry command (10 05) to the main serial system through theserial channel, helping the main system to detect and troubleshoot the problem.

MiiNePort E2/E3 Series User Manual84

SCM (Serial Command Mode) under MCSC
When MCSC is enabled, a special application channel indexed as 0xFF (channel 256) is dedicated for Moxa
SCM without additional configuration required. SCM enables the controlling system to configure, monitor, or
control the attached embedded device server. For more information about what SCM can do, refer to
Chapter 3: Choosing the Configuration Tool.
With MCSC, normal network communication continues uninterrupted when the controlling system ismonitoring or diagnosing the embedded device server with SCM, providing SCM with greater flexibility.

EZPageThe MiiNePort’s EZPage is designed for creating a customized web page to match specific control/monitor
requirements of the serial device via web browser. The MiiNePort creates a built-in web server running withJava applet support that can be used to develop customized web pages on the MiiNePort.
EZPage is a java applet based program and you can refer or modify Moxa’s web console example to develop
specified web console easily. The main entry point of this program is in “src\jar\EZPage.java”. EZPage
utilizes Moxa’s proprietary NECI protocol to control and modify the configurations.
•

To browse a customized web console, you need to upload your own EZPage to the MiiNePort. Detailed
steps are given in the following section.

•

The hyperlink http://Device’s IP/index.htm specifies the location of EZPage content, and it is the firstentry point for users to access the MiiNePort’s web console. MiiNePort will redirect the Moxa default web
consoles to http://Device’s ip/moxa/home.htm. If a customized web page does not exist, theMiiNePort’s default web console will be shown.

ATTENTION
1.
2.

EZPage supports a maximum packed file size of 512 KB.
The EZPage example is compiled with JDK V1.6. If necessary, you should recompile this example withanother version of JDK.

Step 1: Compile EZPage
You can compile all *.java files in the src\jar directory one-by-one, or use src\jar\compile.bat to complete
the task.

Execute compile.bat. If you experience any problems compiling this example, make sure the version of thecompiler you are using is correct.

MiiNePort E2/E3 Series User Manual85

Step 2: Pack EZPage
1.

You could pack all *.class files in the src\jar directory to a .jar file or use src\jar\pack.bat to pack all*.class files as EZpage.jar.

ATTENTION
In order to reserve EZPage space for more useful applications, do not pack the source code into the .jar
file.
2.

To delete all *.class files after packing them, issue the following command: src\jar\clean.bat.

Execute src\jar\clean.bat to delete all *.class files.

ATTENTION
You need to assign the correct target jar file on index.htm

3.

Execute the EZPageTool command with the makefs parameter to pack all files in command prompt
mode.
Usage: EZPageTool /makefs [file path] [file name]Example: EZPageTool /makefs c:\jar ezpage

MiiNePort E2/E3 Series User Manual

86

4.

You will see the following message if the packing process is executed successfully and the packed filecan be found in the same directory.

Step 3. Upload EZPage to the MiiNePort
There are three ways to upload EZPage to the MiiNePort.
•

EZPageTool:
Execute the EZPageTool command updatefs parameter to upload EZPage to the MiiNePort in commandprompt mode.
Usage: EZPageTool /updatefs [file to upload] [device IP]
Example: updatefs ezpage 192.168.35.101
You will see the following message if the upload is successful.

•

Combine EZPage and MiiNePort’s firmware in one file and upload it via the NPort Search
Utility:
Execute the EZTool command with combine parameter to combine EZPage and firmware in thecommand prompt mode.
Usage: /combine [file name of EZPage] [file name of firmware] [file name after combination]
Example: /combine ezpage E2.rom e2_ezpage.rom
You will see the following message if the combine process executes successfully.

The file can be found in the same directory.

Execute the NPort Search Utility and select the combined firmware file to upload to the MiiNePort.
•

Combine EZPage and MiiNePort’s firmware as one file and upload it via the MiiNePort’s web
console:Log in to the MiiNePort’s web console and upgrade the firmware by using combined firmware.

How to Clean up EZPage in MiiNePort
Execute the EZPageTool command with the cleanfs parameter to clean up the EZPage of specified MiiNePort
modules in command prompt mode
Usage: /cleanfs [device IP]
Example: /cleanfs 192.168.35.101
You will see the following message if the cleanup process is executed successfully.

MiiNePort E2/E3 Series User Manual879. Android API Instructions

Overview
If you want to remote control your serial devices on an Android platform, then the MxNPortAPI is a simple
application programming tool that you can use. The MxNPortAPI helps programmers develop an Android
application to access the device server by TCP/IP.
The MxNPortAPI provides frequently used serial command sets like port control, input/output, etc., and thestyle of developed Android application is similar to MOXA Driver Manager. For more details of the provided
functions, please refer to the “MxNPortAPI Function Groups” section.
This MxNPortAPI is layered between the Android application and Android network manager framework. This
Android library is compatible with Java 1.7, Android 3.1 (Honeycomb - API version 12), and later versions.

MiiNePort E2/E3 Series User Manual88How to Start MxNPortAPI
You can download the MxNPortAPI from MOXA website at http://www.moxa.com, and develop theapplication program in popular OSs, such as Windows, Linux, or Mac.
(You can refer the Android studio website to see the system requirements for development environment:
https://developer.android.com/studio/index.html?hl=zh-tw#Requirements).
To start your application program, please unzip the MxNPortAPI file and refer to the index (.html) under the
Help directory.

For more details about the installation, please refer to the Overview section.

MiiNePort E2/E3 Series User Manual89

MxNPortAPI Function Groups
The supported functions in this API are listed below:
Port Control
open
close
setIoctlMode
setFlowCtrl
setBaud
setRTS
setDTRflush

Input/Output
read
write

Port Status Inquiry
getBaud
getFlowCtrl
getIoctlMode
getLineStatus
getModemStatus
getOQueue

Miscellaneous
setBreakExample Program
To make sure this API is workable with the device server on an Android platform, see the example program
below:
Thread thread = new Thread(){@Override
public void run() {/* Enumerate and initialize NPorts on system */List<MxNPort> NPortList = MxNPortService.getNPortInfoList();if(NPortList!=null){MxNPort.IoctlMode mode = new MxNPort.IoctlMode();mode.baudRate = 38400;
mode.dataBits = MxNPort.DATA_BITS_8;
mode.parity = MxNPort.PARITY_NONE;
mode.stopBits = MxNPort.STOP_BITS_1;
MxNPort mxNPort = NPortList.get(0); /* Get first NPort device */try {byte[] buf = {'H','e','l','l','o',' ','W','o','r','l','d'};mxNPort.open(); /*open port*/
mxNPort.setIoctlMode(mode); /*serial parameters setting*/
mxNPort.write(buf, buf.length); /*write data*/
mxNPort.close(); /*close port*/} catch (MxException e){/*Error handling*/}}}};
thread.start();MiiNePort E2/E3 Series User Manual90

A. Introduction to SCM (Serial CommandMode) Command Set

Command/Reply Format
Single Line Command Format
Head
1 byteOp
1 byteCmd
2 bytesParameters
0 to n bytes

Tail
1 or 2 bytes

Cmd
2 bytesParameters
0 to n bytes

Tail
1 or 2 bytes

Single Line Reply Format
Head
1 byteOp
1 byteHead and TailHead
1 byteTail
1 or 2 bytes

Command

?

CR
LF
CR-LF

Reply

!

LF

Operation CodeOperation Code
G
S
R
V
C

Meaning
Get configuration from MiiNePort’s RAM
Set configuration to MiiNePort’s RAM
Retrieve running configuration
View status
ControlStatus Codes
Status Code
E
0
1
2
3
4
5

MeaningEnter Serial Command Mode
Command was executed successfully
Unrecognized format
Operation is not valid
Command is not valid
Parameter is incorrect
Parameter is too long

Restriction
The total number of parameters in a single command cannot exceed 1024 characters.

MiiNePort E2/E3 Series User Manual91Command Code for Getting the Configuration
Device Name
Command code: BN
Command parameters: N/A
Reply parameters: MiiNePort’s name.
?GBN
!GBN0MiiNePort_E2_9527 

System requests configured device name for this MiiNePort.
MiiNePort reports device name as ‘MiiNePort_E2_9527’

Console Password
Command code: BP
Command parameters: N/A
Reply parameters: MiiNePort’s console password.
?GBP!GBP01234

System requests console password for this MiiNePort.
MiiNePort reports console password as ‘1234’.

Web console
Command code: BH
Command parameters: N/A
Reply parameters: 1 and web console TCP port separated by a semicolon (;) if web console is enabled, or a
0 if it is disabled.
?GBH
!GBH01;80

System requests http console setting for this MiiNePort.
MiiNePort reports http console as ‘Enable’ and http port as ‘80’.

Telnet console
Command code: BT
Command parameters: N/A
Reply parameters: 1 and telnet console TCP port separated by a semicolon (;) if telnet console is enabled,or a 0 if it is disabled.
?GBT
!GBT01;23

System requests telnet console setting for this MiiNePort.
MiiNePort reports telnet console as ‘Enable’ and telnet port as ‘23’.

Auto configuration
Command code: BA
Command parameters: N/A
Reply parameters: 1 if Auto configuration is enabled, 0 otherwise.
?GBA
!GBA01

System requests Auto configuration setting for this MiiNePort.
MiiNePort reports Auto configuration as ‘Enable’.

NECI (utility accessibility)
Command code: BU
Command parameters: N/A
Reply parameters: 1 if NECI is enabled, 0 otherwise.
?GBU
!GBU01

MiiNePort E2/E3 Series User Manual

System requests NECI setting for this MiiNePort.
MiiNePort reports NECI as ‘Enable’.

92

IP configuration
Command code: NC
Command parameters: N/A
Reply parameters: MiiNePort’s IP configuration index as follows.
0
1
2
3
4

Static
DHCP
DHCP/BOOTP
BOOTP
AUTOIP?GNC
!GNC00

System requests IP configuration for this MiiNePort.
MiiNePort reports IP configuration as ‘Static’.

IP address
Command code: NI
Command parameters: N/A
Reply parameters: MiiNePort’s IP address.
?GNI
!GNI0192.168.127.254

System requests IP address for this MiiNePort.
MiiNePort reports IP address as ‘192.168.127.254’.

NetmaskCommand code: NM
Command parameters: N/A
Reply parameters: MiiNePort’s Netmask address.
?GNM
!GNM0255.255.255.0

System requests Netmask address for this MiiNePort.
MiiNePort reports netmask as ‘255.255.255.0’.

Gateway
Command code: NG
Command parameters: N/A
Reply parameters: MiiNePort’s Gateway address.
?GNG
!GNG0255.255.255.255

System requests Gateway address for this MiiNePort.
MiiNePort reports Gateway address as ‘255.255.255.255’.

DNS
Command code: ND
Command parameters: The index (1 or 2) of DNS server.
Reply parameters: MiiNePort’s DNS address.
?GND1
!GND0192.168.1.2

MiiNePort E2/E3 Series User Manual

System requests DNS server 1 address for this MiiNePort.
MiiNePort reports DNS server 1 address as ‘192.168.1.2’.

93

PHY Speed
Command code: NS
Command parameters: N/A
Reply parameters: MiiNePort’s PHY speed as follows:
0
10
11
100
101

PHY auto negotiation is enabled.
PHY speed is forced to 10Mbps with half duplex
PHY speed is forced to 10Mbps with full duplex
PHY speed is forced to 100Mbps with half duplex
PHY speed is forced to 100Mbps with full duplex?GNS
!GNS00

System requests PHY speed setting for this MiiNePort.
MiiNePort reports PHY speed determined by PHY auto negotiation function.

Enable/Disable SNMP
Command code: MS
Command parameters: N/A
Reply parameters: 1 (Enable) or 0 (Disable) MiiNePort’s SNMP agent.
?GMS
!GMS01

System requests Enable/Disable SNMP agent for this MiiNePort.
MiiNePort reports SNMP agent as ‘Enable’.

Community String
Command code: MU
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Community string.
?GMU
!GMU0public

System requests SNMP community string for this MiiNePort.
MiiNePort reports SNMP community string as ‘public’.

Contact Name
Command code: MN
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Contact Name.
?GMN
!GMN0s_name

System requests SNMP contact name for this MiiNePort.
MiiNePort reports SNMP contact name as ‘s_name’.

Location
Command code: ML
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Location.
?GML
!GML0s_location

MiiNePort E2/E3 Series User Manual

System requests SNMP location for this MiiNePort.
MiiNePort reports SNMP location as ‘s_location’.

94

Enable/Disable Accessible IP List
Command code: AS
Command parameters: N/A
Reply parameters: Enable (1) or Disable (0) MiiNePort’s accessible IP list.
?GAS!GAS01

System requests Enable/Disable accessible IP list for this MiiNePort.
MiiNePort reports accessible IP list as ‘Enable’.

Accessible IP List
Command code: AI
Command parameters: The index of accessible IP list (from 1 to 16)
Reply parameters: Return format Mode;IP;Netmask in the accessible IP list. If mode equals to 1, it is active,
otherwise it is inactive.
?GAI1
System requests first accessible IP list for this MiiNePort.
!GAI01;192.168.1.2;255.255.25 MiiNePort reports first accessible IP list as ‘Active’, IP address as
5.0
‘192.167.1.2’, and Netmask as ‘255.255.255.0’.

Auto IP Report
Command code: NR
Command parameters: N/A
Reply parameters: MiiNePort’s auto IP report setting.
?GNR
!GNR0192.168.1.250:4000;50

System requests auto IP report for this MiiNePort.
MiiNePort reports Auto IP report server as ‘192.168.1.250’ and port as‘4000’, and report period as ‘50’.

Port alias
Command code: SA
Command parameters: Port index.
Reply parameters: MiiNePort’s Port alias.
?GSA1
!GSA0port1

System requests port 1 alias for this MiiNePort.
MiiNePort reports Port alias as ‘port1’.

Baudrate
Command code: SB
Command parameters: Port index.
Reply parameters: MiiNePort’s Baudrate.
?GSB1
!GSB0115200

System requests port 1’s Baudrate for this MiiNePort.
MiiNePort reports Baudrate as ‘115200’.

Data bits
Command code: SD
Command parameters: Port index.
Reply parameters: MiiNePort’s Data bits.
?GSD1
!GSD08

MiiNePort E2/E3 Series User Manual

System requests port 1’s Data bits for this MiiNePort.
MiiNePort reports Data bits as ‘8’.

95

Stop bits
Command code: SS
Command parameters: Port index.
Reply parameters: MiiNePort’s stop bits index.
Stop Bits Index Table:
01
2Stop bits is 1
Stop bits is 1.5
Stop bits is 2

?GSS1
!GSS00

System requests port 1’s Stop bits for this MiiNePort.
MiiNePort reports Stop bits as ‘1’.

ParityCommand code: SP
Command parameters: Port index.
Reply parameters: MiiNePort’s Parity index as follows.
0
1
2
3
4

None
Odd
Even
Mark
Space

?GSP1
!GSP00

System requests port 1’s Parity for this MiiNePort.
MiiNePort reports Parity as ‘None’.

Flow control
Command code: SL
Command parameters: Port index.
Reply parameters: MiiNePort’s Flow control index as follows.
0
1
2
3

None
RTS/CTS
XON/XOFFDTR/DSR?GSL1
!GSL01

System requests port 1’s Flow control for this MiiNePort.
MiiNePort reports Flow control as ‘RTS/CTS’.

FIFOCommand code: SF
Command parameters: Port index.
Reply parameters: 1 (Enable) or 0 (Disable) MiiNePort’s FIFO.
?GSF1
!GSF01

MiiNePort E2/E3 Series User Manual

System requests port 1’s FIFO for this MiiNePort.
MiiNePort reports FIFO as ‘Enable’.

96

Interface
Command code: SI
Command parameters: Port index.
Reply parameters: 0 (RS232) or 1 (RS485-2wire) MiiNePort’s Interface.
?GSI1↲

System requests for port 1’s interface for this MiiNePort.

!GSI01↲

MiiNePort reports interface is ‘RS485-2wire’.

Operation Mode
Command code: OM
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For the port itself, channel index is 0.
Reply parameters: MiiNePort’s operation mode index as shown in the following table.
0
1
2
3
4
5
6
7

DisableReal COM
RFC2217
TCP server
TCP clientUDP
e-modem
MCSC (This value is unavailable for MCSC channels.)?GOM1;0↲System requests for port 1’s Operation Mode for this MiiNePort.

!GOM04↲MiiNePort reports Operation Mode is ‘TCP client’.

?GOM1;2↲

When port 1 is set to MCSC, system requests for the operation mode forchannel 2 of port 1.

!GOM02↲

MiiNePort reports operation mode is ` RFC2217’.

Data Packing LengthCommand code: OL
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s data packing length as follows.
?GOL1;0!GOL0256
?GOL1;2!GOL0128

System requests port 1’s data packing length for this MiiNePort.
MiiNePort reports data packing length as ‘256’.
When port 1 is set to MCSC, system requests the data packing length forchannel 2 of port 1.
MiiNePort reports data packing length as `128’.

Delimiter
Command code: OD
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s delimiter setting. (delimiter1 enable/disable; hex1; delimiter2
enable/disable; hex2)?GOD1;0
!GOD01;10;1;13

MiiNePort E2/E3 Series User Manual

System requests port 1’s delimiter setting for this MiiNePort.
MiiNePort reports delimiter 1 as ‘Enable’ and hex code as ‘10’, delimiter 2
as ‘Enable’ and hex code as ‘13’.

97

Delimiter Process
Command code: OT
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s delimiter process.
0
1
2
3

Do nothing
Delimiter+1
Delimiter+2
Strip Delimiter?GOT1;0!GOT02

System requests port 1’s delimiter process for this MiiNePort.
MiiNePort reports delimiter process as ‘Delimiter+2’.

Force Transmit
Command code: OF
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s force transmit timeout.
?GOF1;0
!GOF00

System requests port 1’s force transmit timeout for this MiiNePort.
MiiNePort reports force transmit timeout as ‘0’ sec.

Real COM TCP alive check time
Command code: RA
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s TCP alive check time.
?GRA1;0!GRA05

System requests port 1’s TCP alive check time for port 1.
MiiNePort reports TCP alive check time as ‘5’ min.

Real COM max connection
Command code: RM
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s TCP maximum connection number.
?GRM1;1
!GRM04

System requests maximum connection number for port 1 and channel 1.
MiiNePort reports maximum connection number as ‘4’.

Real COM Ignores Jammed IP
Command code: RJ
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable)?GRJ1;2
!GRJ01

MiiNePort E2/E3 Series User Manual

System requests jammed IP policy for port 1’s channel 2.
MiiNePort reports ignore jammed IP as ‘Enable’.

98Real COM Allows Driver Control
Command code: RD
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable)?GRD1;0
!GRD01

System requests allow driver control policy for port1.
MiiNePort reports allow driver control as ‘Enable’.

RFC2217 TCP alive check time
Command code: FA
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?GFA1;0↲System requests for alive check time for port1.

!GFA07↲

MiiNePort reports alive check time is ‘7’.

RFC2217 local listen port
Command code: FP
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: local listen port
?GFP1;0↲System requests for RFC2217 local listen port for port 1.

!GFP01234↲

MiiNePort reports RFC2217 local listen port is ‘1234’.

TCP Server Connection Control
Command code: TS
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP server connection control as shown in the following table.
0
1

Always accept
Accept with DSR on?GTS1;0
!GTS00

System requests TCP server connection control for port 1.
MiiNePort reports incoming policy as ‘Always accept’.

TCP Alive Check Time
Command code: TA
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP alive check time
?GTA1;0
!GTA05

MiiNePort E2/E3 Series User Manual

System requests TCP alive check time for port 1.
MiiNePort reports TCP alive check time as ‘5’ minutes.

99

TCP Port
Command code: TP
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP port
?GTP1;0!GTP04100

System requests TCP port for port 1.
MiiNePort reports TCP port as ‘4100’.

TCP command port
Command code: TO
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP port
?GTO1;0↲System requests for TCP command port for port 1.

!GTO0966↲

MiiNePort reports TCP command port is ‘966’.

TCP server Allow Driver Control
Command code: TD
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?GTD1;0↲System requests for allow driver control policy for port1.

!GTD01↲

MiiNePort reports allow driver control is ‘Enable’.

TCP Client Connection Control
Command code: TC
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled ports, the MCSC channel index is 0.
Reply parameters: TCP client connection control index as shown in the following table
0
1
2
3
4
5
6

Start up / None
Any character / None
Any character / Inactivity time
DSR On / DSR OFFDSR On / None
DCD On / DCF OFF
DCD On / None

?GTC1;0
!GTC01

MiiNePort E2/E3 Series User Manual

System requests TCP client connection control for port 1.
MiiNePort for TCP client connection control as ‘Any character / None’.

100TCP destination address
Command code: TI
Command parameters: Three numbers separated by a semicolon (;) denote port index, MCSC channel
index, and destination address index. For an MCSC-disabled port, the channel index is 0. The destination
address index is as follows:0
1
2
3

Destination address
Alternated address 1
Alternated address 2
Alternated address 3

Reply parameters: TCP destination address and port
?GTI1;0;0
!GTI0192.168.1.2:4001

System requests destination address for port 1.
MiiNePort reports destination address as ‘192.168.1.2’ and port as ‘4001’.

TCP max connection
Command code: TM
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s TCP maximum connection number.
?GTM1;1
!GTM04

System requests maximum connection number for port 1 and channel 1.
MiiNePort reports maximum connection number as ‘4’.

TCP ignore jammed IP
Command code: TJ
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable)?GTJ1;2
!GTJ01

System requests jammed IP policy for port 1’s channel 2.
MiiNePort reports ignore jammed IP as ‘Enable’.

TCP client local port
Command code: TL
Command parameters: Three numbers separated by semicolons (;) denote port index, MCSC channel index,
and local port index. For MCSC-disabled ports, the channel index is 0.
Reply parameters: TCP port.
?GTL1;0;0↲!GTL05002

System requests for TCP client local port setting for port 1.
MiiNePort reports TCP client local port is 5002.

TCP inactivity time
Command code: TV
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP inactivity time.
?GTV1;0
!GTV00

MiiNePort E2/E3 Series User Manual

System requests inactivity time for port 1.
MiiNePort reports inactivity time as ‘0’.

101

UDP destination address
Command code: UD
Command parameters: Three numbers separated by a semicolon (;) denote port index, MCSC channel
index, and destination address index from 1 to 4. For an MCSC-disabled port, the channel index is 0.
Reply parameters: Begin address – End address: port
?GUD1;0;3
!GUD0192.168.1.3192.168.1.8:4001

System requests UDP destination address 3 for port 1.
MiiNePort reports UDP destination address is from ‘192.168.1.3’ to‘192.168.1.8’ and port as ‘4001’.

UDP local listen port
Command code: UP
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: local listen port
?GUP1;0!GUP04001

System requests UDP local listen port for port 1.
MiiNePort reports UDP local listen port as ‘4001’.

E-modem alive check time
Command code: EA
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP alive check time
?GEA1;0↲System requests for TCP alive check time for port 1.

!GEA05↲

MiiNePort reports TCP alive check time is ‘5’ minutes.

E-modem local listen port
Command code: EP
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: local listen port
?GEP1;0↲System requests UDP local listen port for port 1.

!GEP04001↲

MiiNePort reports UDP local listen port is ‘4001’.

DIO initial mode
Command code: PM
Command parameters: DIO port index. For the MiiNePort E2, the index is as follows:
Index
0
1
2
3

DIO port
DIO0
DIO1
DIO2
DIO3

MiiNePort E2 PIN number
JP3 - PIN1
JP3 - PIN4
JP3 - PIN2
JP3 - PIN3

Reply parameters: 1 (output) or 0 (input); note that for the MiiNePort E2, this configuration is available if a
specific PIN function is set to DIO.
?GPM1
!GPM01

MiiNePort E2/E3 Series User Manual

System requests DIO1’s initial mode for this MiiNePort.
MiiNePort reports DIO1’s initial mode as ‘output’.

102

DIO initial state
Command code: PS
Command parameters: DIO port index. For the MiiNePort E2, the index is as follows:
Index
0
1
2
3

DIO port
DIO0
DIO1
DIO2
DIO3

MiiNePort E2 PIN number
JP3 - PIN1
JP3 - PIN4
JP3 – PIN2
JP3 - PIN3

Reply parameters: 1 (high) or 0 (low), note that this function is configuration only if specific DIO port is set
to initial output.
?GPS0↲

System requests DIO0’s initial state for this MiiNePort.

!GPS00↲MiiNePort reports DIO0’s initial state is ‘low’.

Serial command mode trigger
Command code: CT
Command parameters: N/A
Reply parameters: serial command mode trigger index as shown in the following table.
012
3DisableH/W control pin(DIO1)
Activated by characters
Activated by break signal

Note that this configuration is valid only if port 1’s operation mode is not set to MCSC.
?GCT
!GCT01

System requests serial command mode trigger method for this MiiNePort.
MiiNePort reports serial command mode is triggered by DIO1.

Serial command mode trigger characters
Command code: CC
Command parameters: N/A
Reply parameters: serial command mode trigger characters, in hex, separated by a semicolon (;).
Note that this configuration is valid only if the serial command mode trigger method is set to Activated bycharacters.
?GCC
!GCC058;58;58

System requests serial command mode trigger characters for thisMiiNePort.
MiiNePort reports serial command mode triggered by `XXX’ (0x585858).

Serial command mode triggered only at boot up
Command code: CB
Command parameters: N/A
Reply parameters: 0 if serial command mode can be triggered at any time, or 1 if it can only be triggered atboot up.
Note that this configuration is valid only if the serial command mode trigger method is set to Activated bycharacters.
?GCB
!GCB01

MiiNePort E2/E3 Series User Manual

System requests serial command mode for this MiiNePort.
MiiNePort reports serial command mode can only be triggered bycharacters at boot up.

103

Gratuitous ARP
Command code: VA
Command parameters: N/A.
Reply parameters: 1 and send period if gratuitous ARP is enabled; otherwise, reply 0.
?GVA
!GVA01;300

System requests gratuitous ARP status for alert mail server.
MiiNePort reports gratuitous ARP as ‘Enable’ and send period as ‘300’ sec.

Command Code for Setting the Configuration
Device Name
Command code: BN
Command parameters: The new device name for the MiiNePort.
Reply parameters: N/A?SBNMiiNePort@Office!SBN0

System sets the device name as ‘MiiNePort@Office’.
MiiNePort reports command executed successfully.

Password
Command code: BP
Command parameters: MiiNePort’s console password
Reply parameters: N/A?SBP1234
!SBP0

System sets console password as ‘1234’ for this MiiNePort.
MiiNePort reports command executed successfully.

Web console
Command code: BH
Command parameters: 1 and web console TCP port to enable web console, or 0 to disable it.
Reply parameters: N/A?SBH1;80
!SBH0

System sets http console as ‘Enable’ and http port as ‘80’ for thisMiiNePort.
MiiNePort reports command executed successfully.

Telnet console
Command code: BT
Command parameters: 1 and telnet console TCP port to enable telnet console, or 0 to disable it.
Reply parameters: N/A?SBT1;23
!SBT0

MiiNePort E2/E3 Series User Manual

System sets telnet console as ‘Enable’ and telnet port as ‘23’ for thisMiiNePort.
MiiNePort reports command executed successfully.

104

Auto configuration
Command code: BA
Command parameters: 1 if Auto configuration is enabled, 0 otherwise.
Reply parameters: N/A?SBA1
!SBA0

System sets auto configuration as ‘Enable’ for this MiiNePort.
MiiNePort reports command executed successfully.

NECI (utility accessibility)
Command code: BU
Command parameters: 1 if NECI is enabled, 0 otherwise.
Reply parameters: N/A?SBU1
!SBU0

System sets NECI setting as ‘Enable’ for this MiiNePort.
MiiNePort reports command executed successfully.

IP configuration
Command code: NC
Command parameters: MiiNePort’s IP configuration index as shown in the following table
Reply parameters: N/A
0
1
2
3
4

Static
DHCP
DHCP/BOOTP
BOOTP
AutoIP?SNC0
!SNC0

System sets IP configuration as ‘Static’.
MiiNePort reports command executed successfully.

IP address
Command code: NI
Command parameters: MiiNePort’s IP address.
Reply parameters: N/A?SNI192.168.1.2
!SNI0

System sets IP address as ‘192.168.1.2’.
MiiNePort reports command executed successfully.

NetmaskCommand code: NM
Command parameters: MiiNePort’s Netmask address.
Reply parameters: N/A?SNM255.255.255.0
!SNM0

MiiNePort E2/E3 Series User Manual

System sets Netmask as ‘255.255.255.0’.
MiiNePort reports command executed successfully.

105

Gateway
Command code: NG
Command parameters: MiiNePort’s Gateway address.
Reply parameters: N/A?SNG192.168.1.254
!SNG0

System sets Gateway as ‘192.168.1.254’.
MiiNePort reports command executed successfully.

DNS
Command code: ND
Command parameters: The index (1,2) and DNS server address, separated by a semicolon (;).
Reply parameters: N/A?SND1;192.168.1.123
!SND0

System sets DNS1 as ‘192.168.1.123’.
MiiNePort reports command executed successfully.

PHY Speed
Command code: NS
Command parameters: N/A
Reply parameters: MiiNePort’s PHY speed as follows:
0
10
11
100
101

PHY auto negotiation is enabled.
PHY speed is forced to 10Mbps with half duplex
PHY speed is forced to 10Mbps with full duplex
PHY speed is forced to 100Mbps with half duplex
PHY speed is forced to 100Mbps with full duplex?SNS10
!SNS0

System forces PHY speed to 10Mbps with half duplex.
MiiNePort reports command executed successfully.

Enable/Disable SNMP
Command code: MS
Command parameters: 1 (Enable) or 0 (Disable) MiiNePort’s SNMP agent.
Reply parameters: N/A?SMS1
!SMS0

System sets SNMP agent as ‘Enable’.
MiiNePort reports command executed successfully.

Community String
Command code: MU
Command parameters: MiiNePort’s SNMP Community string.
Reply parameters: N/A?SMUpublic
!SMU0

MiiNePort E2/E3 Series User Manual

System sets SNMP community string as ‘public’.
MiiNePort reports command executed successfully.

106

Contact Name
Command code: MN
Command parameters: MiiNePort’s SNMP contact name.
Reply parameters: N/A?SMNcontact
!SMN0

System sets SNMP contact name as ‘contact’.
MiiNePort reports command executed successfully.

Location
Command code: ML
Command parameters: MiiNePort’s SNMP location.
Reply parameters: N/A?SMLlocation
!SML0

System sets SNMP contact name as ‘location’.
MiiNePort reports command executed successfully.

Enable/Disable Accessible IP List
Command code: AS
Command parameters: 1 (Enable) or 0 (Disable) MiiNePort’s accessible IP list.
Reply parameters: N/A?SAS1
!SAS0

System sets accessible IP list as ‘Enable’.
MiiNePort reports command executed successfully.

Accessible IP List
Command code: AI
Command parameters: format is “index;mode;IP;Netmask”, where index ranges from 1 to 16, mode is 1 if
activated and 0 if not activated.
Reply parameters: N/A?SAI1;1;192.168.1.2;255.255.2 System sets accessible IP 1 as ‘active’, IP address as ‘192.168.1.2’ and55.0
netmask as ‘255.255.255.0’.
!SAI0
MiiNePort reports command executed successfully.

Auto IP Report
Command code: NR
Command parameters: Auto IP report destination and report period.
Reply parameters: N/A?SNR192.168.1.123:4000;50
!SNR0

System sets auto report IP as ‘192.168.1.123’, UDP port as ‘4000’ andreport period as ‘50’ sec.
MiiNePort reports command executed successfully.

Port alias
Command code: SA
Command parameters: Port index and port alias, separated by a semicolon (;).
Reply parameters: N/A?SSA1;port 1
!SSA0

MiiNePort E2/E3 Series User Manual

System sets port 1’s alias name as ‘port 1’.
MiiNePort reports command executed successfully.

107

Baudrate
Command code: SB
Command parameters: Port index and baudrate separated by a semicolon (;).
Reply parameters: N/A?SSB1;115200
!SSB0

System sets port 1’s baudrate as ‘115200’.
MiiNePort reports command executed successfully.

Data bits
Command code: SD
Command parameters: Port index and data bits separated by a semicolon (;).
Reply parameters: N/A?SSD1;8
!SSD0

System sets port 1’s data bits as ‘8’.
MiiNePort reports command executed successfully.

Stop bits
Command code: SS
Command parameters: Port index and stop bits separated by a semicolon (;). MiiNePort’s Stop bits index asshown in the following table:
01
2Stop bits is 1
Stop bits is 1.5
Stop bits is 2

Reply parameters: N/A?SSS1;0
!SSS0

System sets port 1’s stop bits as ‘1’.
MiiNePort reports command executed successfully.

ParityCommand code: SP
Command parameters: Port index and parity separated by a semicolon (;). MiiNePort’s Parity index asshown in the following table:
0
1
2
3
4

None
Odd
Even
Mark
Space

Reply parameters: N/A?SSP1;0!SSP0

MiiNePort E2/E3 Series User Manual

System sets port 1’s parity bit as ‘None’.
MiiNePort reports command executed successfully.

108

Flow control
Command code: SL
Command parameters: Port index and flow control separated by a semicolon (;). MiiNePort’s Flow control
index as shown in the following table:
0
1
2
3

None
RTS/CTS
XON/XOFFDTR/DSR

Reply parameters: N/A?SSL1;1
!SSL0

System sets port 1’s flow control as ‘RTS/CTS’.
MiiNePort reports command executed successfully.

FIFO
Command code: SF
Command parameters: Port index and FIFO setting separated by a semicolon (;). FIFO setting is 1 (Enable)
or 0 (Disable).
Reply parameters: N/A.
?SSF1;1
!SSF0

System sets port 1’s FIFO as ‘Enable’.
MiiNePort reports command executed successfully.

Interface
Command code: SI
Command parameters: Port index.
Reply parameters: 0 (RS232) or 1 (RS485-2wire) MiiNePort’s Interface.
?SSI1;0↲System sets port1’s interface as ‘RS232’.

!SSI0↲

MiiNePort reports command executed successfully.

Operation Mode
Command code: OM
Command parameters: Port index, MCSC channel index, and operation mode to set. Every parameter isseparated by semicolon (;). For MCSC-disabled port, channel index shall be 0. The operation mode is asfollowing:
0
1
2
3
4
5
6
7

DisableReal COM
RFC2217
TCP Server
TCP ClientUDP
e-modem
MCSC

Reply parameters: N/A?SOM1;0;2↲

System sets port 1’s operation mode as ‘RFC2217’.

!SOM0↲

MiiNePort reports command executed successfully.

MiiNePort E2/E3 Series User Manual109Data Packing LengthCommand code: OL
Command parameters: Port index, MCSC channel index, and data packing length to set. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?SOL1;0;256
!SOL0

System sets port 1’s data packing length as ‘256’.
MiiNePort reports command executed successfully.

Delimiter
Command code: OD
Command parameters: Port index, MCSC channel index, delimiter1 enable/disable, delimiter character 1 byhex, delimiter 2 enable/disable, and delimiter character 2 by hex. Parameters are separated by a semicolon(;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?SOD1;2;1;10;1;13
!SOD0

System sets channel 2 of port 1’s delimiter 1 as ‘Enable’ and hex code as‘10’. Delimiter 2 as ‘Enable’ and hex code as ‘13’.
MiiNePort reports command executed successfully.

Delimiter Process
Command code: OT
Command parameters: N/A
Reply parameters: Port index, MCSC channel index, and delimiter process. Parameters are separated by asemicolon (;). For an MCSC-disabled port, the channel index is 0.
?SOT1;0;2
!SOT0

System sets port 1’s delimiter process as ‘Delimiter+2’.
MiiNePort reports command executed successfully.

Force Transmit
Command code: OF
Command parameters: Port index, MCSC channel index, and force transmit timeout. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?SOF1;0;5
!SOF0

System sets port 1’s force transmit timeout as ‘5’.
MiiNePort reports command executed successfully.

Real COM TCP alive check time
Command code: RA
Command parameters: Port index, MCSC channel index, and TCP alive check time. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A.
?SRA1;0;5
!SRA0

MiiNePort E2/E3 Series User Manual

System sets port 1’s TCP alive check time as ‘5’ for port 1.
MiiNePort reports command executed successfully.

110Real COM max connection
Command code: RM
Command parameters: Port index, MCSC channel index, and maximum connection number. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?SRM1;1;4
!SRM0

System sets maximum connection number as ‘4’ for port 1 and channel 1.
MiiNePort reports command executed successfully.

Real COM ignore jammed IP
Command code: RJ
Command parameters: Port index, MCSC channel index, and ignore jammed IP setting. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0. Ignore jammed IP setting
is 1 (Enable) or 0 (Disable).
Reply parameters: N/A?SRJ1;2;0
!SRJ0

System sets ignore jammed IP policy as ‘Disable’ for port 1’s channel 2.
MiiNePort reports command executed successfully.

Real COM allow Driver Control
Command code: RD
Command parameters: Port index, MCSC channel index, and allow driver control setting. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0. Allow driver control is 1
(Enable) or 0 (Disable).
Reply parameters: N/A?SRD1;0;0
!SRD0

System sets allow driver control policy as ‘Disable’ for port 1.
MiiNePort reports command executed successfully.

RFC2217 TCP alive check time
Command code: FA
Command parameters: Port index, and MCSC channel index. Every parameter is separated by semicolon (;).
For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A.
?SRD1;0!SFA0↲

System sets port 1’s TCP alive check time as ‘5’ for port 1.
MiiNePort reports command executed successfully.

RFC2217 local listen port
Command code: FP
Command parameters: Port index, MCSC channel index, and TCP local port. Every parameter is separated
by semicolon (;). For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A?SFP1;0;4100↲

System sets TCP port as ‘4100’ for port 1.

!SFP0↲

MiiNePort reports command executed successfully.

MiiNePort E2/E3 Series User Manual111

TCP alive check time
Command code: TA
Command parameters: Port index, MCSC channel index, and TCP alive check time. Parameters are
separated by a semicolon (;).
Reply parameters: N/A?STA1;0;5
!STA0

System sets port 1’s TCP alive check time to `5’ minutes.
MiiNePort reports command executed successfully.

TCP port
Command code: TP
Command parameters: Port index, MCSC channel index, and TCP local port. Every parameter is separated
by semicolon (;). For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A?STP1;0;4100↲

System sets TCP port as ‘4100’ for port 1.

!STP0↲

MiiNePort reports command executed successfully.

Command code: TO
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP port
?STO1;0;966↲

System sets TCP command port as ‘966’ for port 1.

!STO0↲

MiiNePort reports command executed successfully.

Command code: TD
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?STD1;0;1↲

System sets allow driver control policy as ‘enable’ for port1.

!STD0↲

MiiNePort reports command executed successfully.

TCP client connection control
Command code: TC
Command parameters: Port index, MCSC channel index, and client connection control setting. Every
parameter is separated by semicolon (;). For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A
0
1
2
3
4
5
6

Start up / None
Any character / None
Any character / Inactivity time
DSR On / DSR OFFDSR On / None
DCD On / DCF OFF
DCD On / None

?STC1;0;1↲!STC0↲

MiiNePort E2/E3 Series User Manual

System sets TCP client connection control as ‘Any character / None’ forport 1.
MiiNePort reports command executed successfully.

112

TCP destination address
Command code: TI
Command parameters: Port index, MCSC channel index, destination address index (0 for destination
address and 1 to 3 for alternated addresses). Parameters are separated by a semicolon (;). For an MCSCdisabled port, the channel index is 0.
Reply parameters: N/A?STI1;0;0;192.168.1.2:4001
!STT0

System sets destination address as ‘192.168.1.2’ and port as ‘4001’ forport 1.
MiiNePort reports command executed successfully.

TCP Client local port
Command code: TL
Command parameters: Port index, MCSC channel index, local port index, and TCP local port. Every
parameter is separated by semicolon (;). For MCSC-disabled port, MCSC channel index shall be 0.
Reply parameters: N/A?STL1;2;0;5002↲!STL0↲

System sets TCP client local port as ‘5002’ for port 1’s channel 2 (MCSC
enabled).
MiiNePort reports command executed successfully.

TCP max connection
Command code: TM
Command parameters: Port index, MCSC channel index, and maximum connection number. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?STM1;1;3
!STM0

System sets maximum connection number as ‘3’ for port 1 and channel 1.
MiiNePort reports command executed successfully.

TCP ignore jammed IP
Command code: TJ
Command parameters: Port index, MCSC channel index, and ignore jammed IP setting (0 for disable and 1
for enable). Parameters are separated by a semicolon (;). For an MCSC-disabled port, the channel index is0.
Reply parameters: N/A?STJ1;2;0
!STJ0

System sets ignore jammed IP policy as ‘Disable’ for port 1’s channel 2.
MiiNePort reports command executed successfully.

TCP inactivity time
Command code: TV
Command parameters: Port index, MCSC channel index, and inactivity timeout setting. Parameters are
separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?STV1;0;10
!STV0

MiiNePort E2/E3 Series User Manual

System sets inactivity time as ‘10’ ms for port 1.
MiiNePort reports command executed successfully.

113

UDP destination address
Command code: UD
Command parameters: Port index, MCSC channel index, destination address index (1 to 4), and destination
addresses. Parameters are separated by a semicolon (;). For an MCSC-disabled port, the channel index is 0.
The destination addresses is formatted as Begin address – End address: UDP port.
Reply parameters: N/A?SUD1;0;3;192.168.1.3192.168.1.8:4001
!SUD0

System sets UDP destination address 3 is from ‘192.168.1.3’ to‘192.168.1.8’ and port as ‘4001’ for port 1.
MiiNePort reports command executed successfully.

UDP local listen port
Command code: UP
Command parameters: Port index, MCSC channel index, and local UDP port. Parameters are separated by asemicolon (;). For an MCSC-disabled port, the channel index is 0.
Reply parameters: N/A?SUP1;0;4001
!SUP0

System sets UDP local listen port as ‘4001’ for port 1.
MiiNePort reports command executed successfully.

E-modem TCP alive check time
Command code: EA
Command parameters: Port index, MCSC channel index, and TCP alive check time. Every parameter isseparated by semicolon (;). For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A.
?SEA1;0;5↲

System sets port 1’s TCP alive check time as ‘5’ for port 1.

!SEA0↲

MiiNePort reports command executed successfully.

E-modem local listen port
Command code: EP
Command parameters: Port index, MCSC channel index, and TCP local port. Every parameter is separated
by semicolon (;). For MCSC-disabled port, channel index shall be 0.
Reply parameters: N/A?SEP1;0;4100↲

System sets TCP port as ‘4100’ for port 1.

!SEP0↲

MiiNePort reports command executed successfully.

DIO initial mode
Command code: PM
Command parameters: DIO port index and initial mode (0 for input and 1 for output), separated bysemicolon (;). For MiiNePort E2, the index is as following:
Index
0
1
2
3

DIO port
DIO 0
DIO 1
DIO 2
DIO 3

MiiNePort E2 PIN number
PIN 15
PIN 16
PIN 17
PIN 18Note that this configuration is valid only if the related PIN function is set to DIO.
Reply parameters: N/A?SPM0;1↲

System sets dio0 mode as ‘output’ for this MiiNePort.

!SPM0↲

MiiNePort reports command executed successfully.

MiiNePort E2/E3 Series User Manual

114

DIO initial state
Command code: PS
Command parameters: DIO port index and initial output state (0 for low and 1 for high).
Note that this configuration is valid only if DIO initial mode is set to output.
Reply parameters: N/A?SPS0;1
!SPS0

System sets dio0 state as ‘high’ for this MiiNePort.
MiiNePort reports command executed successfully.

Serial command mode trigger
Command code: CT
Command parameters: serial command mode trigger index as shown in the following table
Note that this configuration is valid only if port 1’s operation mode is not set to MCSC.
Reply parameters: N/A
0
1
2
3

DisableH/W control pin(DIO1)
Activated by characters
Activated by break signal?SCT2
!SCT0

System sets serial command mode as ‘Activate by characters’.
MiiNePort reports command executed successfully.

Serial command mode trigger characters
Command code: CC
Command parameters: serial command mode trigger characters, in hex, separated by a semicolon (;).
Note that this configuration is valid only if serial command mode trigger method is set to `Activated bycharacters’.
Reply parameters: N/A?SCC45;66;67
!SCC0

System sets serial command mode trigger characters as `ABC’(0x656667).
MiiNePort reports command executed successfully.

Serial command mode trigger only at boot up
Command code: CB
Command parameters: 0 if serial command mode can be triggered at any time, or 1 if it can only be
triggered at boot up.
Note that this configuration is valid only if serial command mode trigger method is set to `Activated bycharacters’.
Reply parameters: N/A?SCB1
!SCB0

MiiNePort E2/E3 Series User Manual

System sets serial command mode can only be triggered by characters atboot up.
MiiNePort reports command executed successfully.

115

Gratuitous ARP
Command code: VA
Command parameters: 1 and send period if gratuitous ARP is enable; otherwise, 0.
Reply parameters: N/A?SVA1;300
!SVA0

System sets gratuitous ARP as ‘Enable’ and send period as ‘300’ sec forthis MiiNePort.
MiiNePort reports command executed successfully.

Command Code for Retrieving Running
Configuration
Device Name
Command code: BN
Command parameters: N/A
Reply parameters: MiiNePort’s name.
?RBN
!RBN0MiiNePort_9527

System requests configured device name for this MiiNePort.
MiiNePort reports device name as ‘MiiNePort_9527’.

Console Password
Command code: BP
Command parameters: N/A
Reply parameters: MiiNePort’s console password.
?RBP!RBP01234

System requests console password for this MiiNePort.
MiiNePort reports console password as ‘1234’.

Web console
Command code: BH
Command parameters: N/A
Reply parameters: 1 and web console TCP port separated by a semicolon (;) if web console is enabled, or a
0 if it is disabled.
?RBH!RBH01;80

System requests http console setting for this MiiNePort.
MiiNePort reports http console as ‘Enable’ and http port as ‘80’.

Telnet console
Command code: BT
Command parameters: N/A
Reply parameters: 1 and telnet console TCP port separated by a semicolon (;) if telnet console is enabled,or a 0 if it is disabled.
?RBT!RBT01;23

MiiNePort E2/E3 Series User Manual

System requests telnet console setting for this MiiNePort.
MiiNePort reports telnet console as ‘Enable’ and telnet port as ‘23’.

116

Auto configuration
Command code: BA
Command parameters: N/A
Reply parameters: 1 if Auto configuration is enabled, 0 otherwise.
?RBA!RBA01

System requests Auto configuration setting for this MiiNePort.
MiiNePort reports Auto configuration as ‘Enable’.

NECI (utility accessibility)
Command code: BU
Command parameters: N/A
Reply parameters: 1 if NECI is enabled, 0 otherwise.
?RBU!RBU01

System requests NECI setting for this MiiNePort.
MiiNePort reports NECI as ‘Enable’.

IP configuration
Command code: NC
Command parameters: N/A
Reply parameters: MiiNePort’s IP configuration index as follows.
0
1
2
3
4

Static
DHCP
DHCP/BOOTP
BOOTP
AutoIP?RNC
!RNC00

System requests IP configuration for this MiiNePort.
MiiNePort reports IP configuration as ‘Static’.

IP address
Command code: NI
Command parameters: N/A
Reply parameters: MiiNePort’s IP address.
?RNI
!RNI0192.168.127.254

System requests IP address for this MiiNePort.
MiiNePort reports IP address as ‘192.168.127.254’.

NetmaskCommand code: NM
Command parameters: N/A
Reply parameters: MiiNePort’s Netmask address.
?RNM
!RNM0255.255.255.0

MiiNePort E2/E3 Series User Manual

System requests Netmask address for this MiiNePort.
MiiNePort reports netmask as ‘255.255.255.0’.

117

Gateway
Command code: NG
Command parameters: N/A
Reply parameters: MiiNePort’s Gateway address.
?RNG
!RNM0255.255.255.255

System requests Gateway address for this MiiNePort.
MiiNePort reports Gateway address as ‘255.255.255.255’.

DNS
Command code: ND
Command parameters: The index (1 or 2) of DNS server.
Reply parameters: MiiNePort’s DNS address.
?RND1
!RND0192.168.1.2

System requests DNS server 1 address for this MiiNePort.
MiiNePort reports DNS server 1 address as ‘192.168.1.2’.

PHY Speed
Command code: NS
Command parameters: N/A
Reply parameters: MiiNePort’s PHY speed as follows:
0
10
11
100
101

PHY auto negotiation is enabled.
PHY speed is forced to 10Mbps with half duplex
PHY speed is forced to 10Mbps with full duplex
PHY speed is forced to 100Mbps with half duplex
PHY speed is forced to 100Mbps with full duplex?RNS!RNS00

System requests PHY speed setting for this MiiNePort.
MiiNePort reports PHY speed is determined by PHY auto negotiation
function.

Enable/Disable SNMP
Command code: MS
Command parameters: N/A
Reply parameters: 1 (Enable) or 0 (Disable) MiiNePort’s SNMP agent.
?RMS
!RMS01

System requests Enable/Disable SNMP agent for this MiiNePort.
MiiNePort reports SNMP agent as ‘Enable’.

Community String
Command code: MU
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Community string.
?RMU
!RMU0public

MiiNePort E2/E3 Series User Manual

System requests SNMP community string for this MiiNePort.
MiiNePort reports SNMP community string as ‘public’.

118

Contact Name
Command code: MN
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Contact Name.
?RMN
!RMN0s_name

System requests SNMP contact name for this MiiNePort.
MiiNePort reports SNMP contact name as ‘s_name’.

Location
Command code: ML
Command parameters: N/A
Reply parameters: MiiNePort’s SNMP Location.
?RML!RML0s_location

System requests SNMP location for this MiiNePort.
MiiNePort reports SNMP location as ‘s_location’.

Enable/Disable Accessible IP List
Command code: AS
Command parameters: N/A
Reply parameters: Enable (1) or Disable (0) MiiNePort’s accessible IP list.
?RAS
!RAS01

System requests Enable/Disable accessible IP list for this MiiNePort.
MiiNePort reports accessible IP list as ‘Enable’.

Accessible IP List
Command code: AI
Command parameters: The index of accessible IP list (from 1 to 16)
Reply parameters: Return format Mode;IP;Netmask in the accessible IP list. If mode equals 1 it’s active,
otherwise it’s inactive.
?RAI1
System requests first accessible IP list for this MiiNePort.
!RAI01;192.168.1.2;255.255.25 MiiNePort reports first accessible IP list as ‘Active’, IP address as
5.0
‘192.167.1.2’, and Netmask as ‘255.255.255.0’ .

Auto IP Report
Command code: NR
Command parameters: N/A
Reply parameters: MiiNePort’s auto IP report setting.
?RNR
!RNR0192.168.1.250:4000;50

System requests auto IP report for this MiiNePort.
MiiNePort reports Auto IP report server as ‘192.168.1.250’ and port as‘4000’, and report period as ‘50’.

Port alias
Command code: SA
Command parameters: N/A
Reply parameters: MiiNePort’s Port alias.
?RSA1
!RSA0port1

MiiNePort E2/E3 Series User Manual

System requests Port alias for this MiiNePort.
MiiNePort reports Port alias as ‘port1’.

119

Baudrate
Command code: SB
Command parameters: Port index.
Reply parameters: MiiNePort’s Baudrate.
?RSB1
!RSB0115200

System requests port 1’s Baudrate for this MiiNePort.
MiiNePort reports Baudrate as ‘115200’.

Data bits
Command code: SD
Command parameters: Port index.
Reply parameters: MiiNePort’s Data bits.
?RSD1
!RSD08

System requests port 1’s Data bits for this MiiNePort.
MiiNePort reports Data bits as ‘8’.

Stop bits
Command code: SS
Command parameters: Port index.
Reply parameters: MiiNePort’s stop bits index.
Stop Bits Index Table0
1
2

Stop bits is 1
Stop bits is 1.5
Stop bits is 2

?RSS1
!RSS00

System requests port 1’s Stop bits for this MiiNePort.
MiiNePort reports Stop bits as ‘1’.

ParityCommand code: SP
Command parameters: Port index
Reply parameters: MiiNePort’s Parity index as follows.
0
1
2
3
4

None
Odd
Even
Mark
Space

?RSP1
!RSP00

MiiNePort E2/E3 Series User Manual

System requests port 1’s Parity for this MiiNePort.
MiiNePort reports Parity as ‘None’.

120

Flow control
Command code: SL
Command parameters: Port index.
Reply parameters: MiiNePort’s Flow control index as follows.
0
1
2
3

None
RTS/CTS
XON/XOFFDTR/DSR?RSL1
!RSL01

System requests port 1’s Flow control for this MiiNePort.
MiiNePort reports Flow control as ‘RTS/CTS’.

FIFOCommand code: SF
Command parameters: Port index.
Reply parameters: 1 (Enable) or 0 (Disable) MiiNePort’s FIFO.
?RSF1
!RSF01

System requests port 1’s FIFO for this MiiNePort.
MiiNePort reports FIFO as ‘Enable’.

Interface
Command code: SI
Command parameters: Port index.
Reply parameters: 0 (RS232) or 1 (RS485-2wire) MiiNePort’s Interface.
?RSI1;0↲System sets port1’s interface as ‘RS232’.

!RSI0↲

MiiNePort reports command executed successfully.

Operation Mode
Command code: OM
Command parameters: numbers separated by a semicolon (;) denotes port index and MCSC channel index.
For port itself, channel index shall be 0.
Reply parameters: MiiNePort’s operation mode index as following table.
0
1
2
3
4
5
6
7

DisableReal COM
RFC2217
TCP Server
TCP Client
UDP
EMODEMMCSC (This value is unavailable for MCSC channels.)?ROM1;0↲System requests for port 1’s Operation Mode for this MiiNePort.

!ROM04↲MiiNePort reports Flow control is ‘TCP client’.
When port 1 is set to MCSC, system requests for operation mode forchannel 2 of port 1.
MiiNePort reports operation mode is ` RFC2217’.

?ROM1;2↲!ROM02↲

MiiNePort E2/E3 Series User Manual121Data Packing LengthCommand code: OL
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s data packing length as follows.
?ROL1;0
!ROL0256

System requests port 1’s data packing length for this MiiNePort.
MiiNePort reports data packing length as ‘256’.

Delimiter
Command code: OD
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s delimiter setting. (delimiter1 enable/disable;hex1;delimiter2
enable/disable;hex2)?ROD1;0
!ROD01;10;1;13

System requests port 1’s delimiter setting for this MiiNePort.
MiiNePort reports delimiter 1 as ‘Enable’ and hex code as ‘10’, delimiter 2
as ‘Enable’ and hex code as ‘13’

Delimiter Process
Command code: OT
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s delimiter process.
0
1
2
3

Do nothing
Delimiter+1
Delimiter+2
Strip Delimiter?ROT1;0
!ROT02

System requests port 1’s delimiter process for this MiiNePort.
MiiNePort reports delimiter process as ‘Delimiter+2’.

Force Transmit
Command code: OF
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s force transmit timeout.
?ROF1;0
!ROF00

System requests port 1’s force transmit timeout for this MiiNePort.
MiiNePort reports force transmit timeout as ‘0’ sec.

Real COM TCP alive check time
Command code: RA
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s TCP alive check time.
?RRA1;0
!RRA05

MiiNePort E2/E3 Series User Manual

System requests port 1’s TCP check alive time for port 1.
MiiNePort reports TCP alive check time as ‘5’ min.

122

Real COM max connection
Command code: RM
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: MiiNePort’s TCP maximum connection number.
?RRM1;1
!RRM03

System requests maximum connection number for port 1 and channel 1.
MiiNePort reports maximum connection number as ‘3’.

Real COM ignore jammed IP
Command code: RJ
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable)?RRJ1;2
!RRJ01

System requests jammed IP policy for port 1’s channel 2.
MiiNePort reports ignore jammed IP as ‘Enable’.

Real COM Allow Driver Control
Command code: RD
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable)?RRD1;0
!RRD01

System requests allow driver control policy for port1.
MiiNePort reports allow driver control as ‘Enable’.

RFC2217 TCP alive check time
Command code: FA
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?RFA1;0↲System requests for alive check time for port1.

!RFA01↲

MiiNePort reports alive check time is ‘1’.

RFC2217 local listen port
Command code: FP
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: local listen port
?RFP1;0↲System requests for RFC2217 local listen port for port 1.

!RFP01234↲

MiiNePort reports RFC2217 local listen port is ‘1234’.

MiiNePort E2/E3 Series User Manual

123

TCP alive check time
Command code: TA
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP alive check time.
?RTA1;0!RTA05

System requests TCP alive check time for port 1.
MiiNePort reports TCP alive check time as ‘5’ minutes.

TCP port
Command code: TP
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP port.
?RTP1;0!RTP04100

System requests TCP port for port 1.
MiiNePort reports TCP port as ‘4100’.

TCP command port
Command code: TO
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP port
?RTO1;0↲System requests for TCP command port for port 1.

!RTO0966↲

MiiNePort reports TCP command port is ‘966’.

TCP server Allow Driver Control
Command code: TD
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?RTD1;0↲System requests for allow driver control policy for port1.

!RTD01↲

MiiNePort reports allow driver control is ‘Enable’.

TCP client connection control
Command code: TC
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP client connection control index as following table
0
1
2
3
4
5
6

Start up / None
Any character / None
Any character / Inactivity time
DSR On / DSR OFFDSR On / None
DCD On / DCF OFF
DCD On / None

?RTC1;0↲System requests for TCP client connection control for port 1.

!RTC01↲

MiiNePort reports TCP client connection control is ‘Any character / None’.

MiiNePort E2/E3 Series User Manual

124TCP destination address
Command code: TI
Command parameters: Three numbers separated by a semicolon (;) denotes port index, MCSC channel
index, and destination address index. For MCSC-disabled port, channel index shall be 0. The destination
address index is as following:
0
1
2
3

Destination address
Alternated address 1
Alternated address 2
Alternated address 3

Reply parameters: TCP destination address and port
?RTI1;0;1↲

System requests for destination address 1 for port 1.

!RTI0192.168.1.2:4001↲

MiiNePort reports destination address is ‘192.168.1.2’ and port is ‘4001’.

TCP client local port
Command code: TL
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: TCP port.
?RTL1;0↲System requests for TCP client local port setting for port 1.

!RTL05002

MiiNePort reports TCP client local port is 4001.

TCP max connection
Command code: TM
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
?RTM1;1
!RTM04

System requests maximum connection number for port 1 and channel 1.
MiiNePort reports maximum connection number as ‘4’.

TCP ignore jammed IP
Command code: TJ
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: 1 (Enable) or 0 (Disable).
?RTJ1;2
!RTJ01

System requests jammed IP policy for port 1’s channel 2.
MiiNePort reports ignore jammed IP as ‘Enable’.

TCP inactivity time
Command code: TV
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: TCP inactivity time.
?RTV1;0!RTV00

MiiNePort E2/E3 Series User Manual

System requests inactivity time for port 1.
MiiNePort reports inactivity time as ‘0’.

125

UDP destination address
Command code: UD
Command parameters: Three numbers separated by a semicolon (;) denote port index, MCSC channel
index, and destination address index from 1 to 4. For an MCSC-disabled port, the channel index is 0.
Reply parameters: Begin address – End address: port
?RUD1;0;3
!RUD0192.168.1.3192.168.1.8:4001

System requests UDP destination address 3 for port 1.
MiiNePort reports UDP destination address is from ‘192.168.1.3’ to‘192.168.1.8’ and port as ‘4001’.

UDP local listen port
Command code: UP
Command parameters: Two numbers separated by a semicolon (;) denote port index and MCSC channel
index. For an MCSC-disabled port, the channel index is 0.
Reply parameters: local listen port.
?RUP1;0
!RUP04001

System requests UDP local listen port for port 1.
MiiNePort reports UDP local listen port as ‘4001’.

E-modem TCP alive check time
Command code: EA
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: 1 (Enable) or 0 (Disable)?REA1;0↲System requests for alive check time for port1.

!REA05↲

MiiNePort reports alive check time is ‘5’.

E-modem local listen port
Command code: EP
Command parameters: Two numbers separated by a semicolon (;) denotes port index and MCSC channel
index. For MCSC-disabled port, channel index shall be 0.
Reply parameters: local listen port
?REP1;0↲System requests for E-modem local listen port for port 1.

!REP01234↲

MiiNePort reports E-modem local listen port is ‘1234’.

DIO initial mode
Command code: PM
Command parameters: DIO port index. For MiiNePort E2, the index is as following:
Index
0
1
2
3

DIO port
DIO0
DIO1
DIO2
DIO3

MiiNePort E2 PIN number
JP3 - PIN1
JP3 - PIN4
JP3 – PIN2
JP3 - PIN3

Reply parameters: 1 (output) or 0 (input) , note that for MiiNePort E2, this configuration is available if
specific PIN function is set to DIO.
?RPM1↲

System requests DIO1’s initial mode for this MiiNePort.

!RPM01↲

MiiNePort reports DIO1’s initial mode is ‘output’.

MiiNePort E2/E3 Series User Manual126

DIO initial state
Command code: PS
Command parameters: DIO port index. For the MiiNePort E2, the index is as follows:
Index
0
1
2
3

DIO port
DIO0
DIO1
DIO2
DIO3

MiiNePort E2 PIN number
JP3 - PIN1
JP3 - PIN4
JP3 – PIN2
JP3 - PIN3

Reply parameters: 1 (high) or 0 (low) , note that this function is configuration only if specific DIO port is set
to initial output.
?RPS0
!RPS00

System requests DIO0’s initial state for this MiiNePort.
MiiNePort reports DIO0’s initial state as ‘low’.

Serial command mode trigger
Command code: CT
Command parameters: N/A
Reply parameters: serial command mode trigger index as shown in the following table.
012
3DisableH/W control pin(DIO1)
Activated by characters
Activated by break signal

Note that this configuration is valid only if port 1’s operation mode is not set to MCSC.
?RCT!RCT01

System requests serial command mode trigger method for this MiiNePort.
MiiNePort reports serial command mode is triggered by DIO1.

Serial command mode trigger characters
Command code: CC
Command parameters: N/A
Reply parameters: serial command mode trigger characters, in hex, separated by a semicolon (;).
Note that this configuration is valid only if serial command mode trigger method is set to `Activated bycharacters’.
?RCC
!RCC058;58;58

System requests serial command mode trigger characters for thisMiiNePort.
MiiNePort reports serial command mode triggered by `XXX’ (0x585858).

Serial command mode trigger only at boot up
Command code: CB
Command parameters: N/A
Reply parameters: 0 if serial command mode can be triggered at any time, or 1 if it can only be triggered atboot up.
Note that this configuration is valid only if serial command mode trigger method is set to `Activated bycharacters’.
?RCB!RCB01

MiiNePort E2/E3 Series User Manual

System requests serial command mode for this MiiNePort.
MiiNePort reports serial command mode can only be triggered bycharacters at boot up.

127

Gratuitous ARP
Command code: VA
Command parameters: N/A.
Reply parameters: 1 and send period if gratuitous ARP is enable; otherwise, reply 0.
?RVA
!RVA01;300

System requests gratuitous ARP status for alert mail server.
MiiNePort reports gratuitous ARP as ‘Enable’ and send period as ‘300’ sec.

Serial Number
Command code: @S
Command parameters: N/A
Reply parameters: MiiNePort’s serial number, in digit notation.
?R@S
!R@S09527

System requests MiiNePort’s serial number.
MiiNePort reports serial number is 9527.

Firmware Version
Command code: @V
Command parameters: N/A
Reply parameters: MiiNePort’s firmware version. Version parts are separated by a single dot, with at least
two parts (major.minor) and at most three parts (major.minor.rev).
?R@V!R@V01.0

System requests MiiNePort’s firmware version.
MiiNePort’s firmware version is v1.0.

Firmware Build Number
Command code: @B
Command parameters: N/A
Reply parameters: MiiNePort’s firmware build number, eight digits.
?R@B
!R@B009021208

System requests MiiNePort’s firmware build number.
MiiNePort reports build number is 09021208.

MAC address
Command code: @M
Command parameters: N/A
Reply parameters: MiiNePort’s MAC address.
?R@M
!R@M000:90:E8:71:00:10

MiiNePort E2/E3 Series User Manual

System requests MiiNePort’s firmware build number.
MiiNePort reports MAC address is 00:90:E8:71:00:10.

128Command Code for Viewing the Status
Ethernet Speed and Duplex
Command code: NS
Command parameters: N/A
Reply parameters: The speed and duplex status of the Ethernet. Possible values are 0(Unlink), 10H(10Mbps
Half Duplex), 10F(10Mbps Full Duplex), 100H(100Mbps Half Duplex), 100F(100Mbps Full Duplex).
?VNS!VNS0100F

System requests current Ethernet status.
MiiNePort reports the Ethernet is current in 100Mbps Full Duplex mode.

DIO mode
Command code: PM
Command parameters: DIO port index and IO mode (0 for input and 1 for output), separated by semicolon(;). For MiiNePort E2, the index is as following:
Index
0
1
2
3

DIO port
DIO 0
DIO 1
DIO 2
DIO 3

MiiNePort E2 PIN number
JP3 - PIN1
JP3 - PIN4
JP3 – PIN2
JP3 - PIN3

Note that this function works only if related PIN function is set to DIO.
Reply parameters: N/A?VPM2↲

System requests for DIO running mode of DIO port 2.

!VPM01↲

MiiNePort reports DIO port is in output.

DIO state
Command code: PS
Command parameters: DIO port index and output state (0 for low and 1 for high).
Note that this function works only if DIO mode is set to output.
Reply parameters: N/A?VPS2↲

System requests for DIO state of DIO port 2.

!VPS01↲

MiiNePort reports DIO port is in high state.

Control Command Code
PING
Command code: NP
Command parameters: Target host name or IP address.
Reply parameters: A single minus symbol indicates the target host did not reply in 1000 milliseconds.
Otherwise, one decimal number indicating the reply latency in milliseconds is returned.
?CNPwww.moxa.com
!CNP010
?CNP192.168.1.1
!CNP0-

MiiNePort E2/E3 Series User Manual

System requests to PING www.moxa.com.
Target host replies in 10 milliseconds.
System requests to PING 192.168.1.1.
Target host did not reply in 1000 milliseconds.

129

DIO mode
Command code: PM
Command parameters: DIO port index. For MiiNePort E2, the index is as following:
Index
0
1
2
3

DIO port
DIO0
DIO1
DIO2
DIO3

MiiNePort E2 PIN number
PIN15
PIN16
PIN17
PIN18

Reply parameters: 1 (output) or 0 (input), note that for MiiNePort E2, this configuration is available if
specific PIN function is set to DIO.
?CPM1;0↲System sets DIO 1’s mode as ‘input’ for this MiiNePort.

!CPM0↲

MiiNePort reports command executed successfully.

DIO state
Command code: PS
Command parameters: DIO port index.
Reply parameters: If the DIO port is in output mode, a 0 denotes it is outputting a low signal, or 1 for ahigh signal. If the DIO port is in input mode, a 0 denotes it receives a low signal, and 1 for a high signal.
?CPS0;1↲

System sets DIO 0’s state to ‘high’.

!CPS0↲

MiiNePort reports command executed successfully.

Save & Restart
Command code: SR
Command parameters:’1’ for “Save & Restart”, ‘0’ for “Restart only”.
Reply parameters: N/A?CSR1
!CSR0

System requests to save configuration and restart.
Your configuration is saved, and restart MiiNePort server now.

Load Factory Default
Command code: LD
Note that this command is not applied to the configuration until you save & restart the MiiNePort.
Command parameters: ‘1’ for “All setting”, ‘0’ for “Keep IP setting”.
Reply parameters: N/A?CLD0
!CLD0

MiiNePort E2/E3 Series User Manual

System requests to load factory default.
System loads factory default successfully.

130

B. Well-Known Port Numbers

This appendix is included for your reference. Listed below are port numbers that already have a wellestablished use. These port numbers should be avoided when assigning a port number to your MiiNePort E2
Series module; otherwise you may experience network problems. Refer to the RFC 1700 standard for WellKnown Port Numbers or refer to the following introduction from IANA.
•

The port numbers are divided into three ranges: the Well-Known Ports, the Registered Ports, and the
Dynamic and/or Private Ports.

•

The Well-Known Ports are those from 0 through 1023.

•

The Registered Ports are those from 1024 through 49151.

•

The Dynamic and/or Private Ports are those from 49152 through 65535.

The Well-Known Ports are assigned by IANA, and on most systems, can only be used by system processes
or by programs executed by privileged users. The following table shows famous port numbers among thewell-known port numbers. For more details, visit the IANA website at
http://www.iana.org/assignments/port-numbers.
TCP Socket
0
1
2
7
9
11
13
15
20
21
23
25
37
42
43
49
53
79
80
119
123
213
160 – 223

Application Service
reserved
TCP Port Service Multiplexor
Management Utility
Echo
Discard
Active Users (systat)
Daytime
Netstat
FTP data port
FTP CONTROL port
TelnetSMTP (Simple Mail Transfer Protocol)
Time (Time Server)
Host name server (names server)
Whois (nickname)(Login Host Protocol) (Login)
Domain Name Server (domain)
Finger protocol (Finger)
World Wide Web HTTP
Network News Transfer Protocol (NNTP)
Network Time Protocol
IPX
Reserved for future use

MiiNePort E2/E3 Series User Manual131

UDP Socket
0
2
7
9
11
13
35
39
42
43
49
53
69
70
79
80
107
111
119
123
161
162
213

Application Service
reserved
Management Utility
Echo
Discard
Active Users (systat)
DaytimeAny private printer server
Resource Location Protocol
Host name server (names server)
Whois (nickname)(Login Host Protocol) (Login)
Domain Name Server (domain)
Trivial Transfer Protocol (TETP)
Gopler Protocol
Finger Protocol
World Wide Web HTTP
Remote Telnet Service
Sun Remote Procedure Call (Sunrpc)
Network news Tcanster Protocol (NNTP)
Network Time protocol (nnp)
SNMP (Simple Network Mail Protocol)
SNMP Traps
IPX (Used for IP Tunneling)

MiiNePort E2/E3 Series User Manual132

C. Auto IP Report Protocol

There are several ways to configure the IP address of an MiiNePort Series module. One way is with DHCP
Client. When you set up the module to use DHCP Client for IP address configuration, it will automaticallysend 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. When the expiration time has been reached, the process will repeat, and module
will send another DHCP request to the DHCP server. Therefore, a module may end up using more than one
IP address while it is connected to the network.
The module has a built-in IP address report function that will send its IP data to a specific IP address andport number when it is not using a Static or fixed IP address. The IP address report parameters may be
configured in the Network Settings in the web console. Enter the IP address and the port number of the PC
that is to receive this information as shown below:

IP Address Report Structure
The first four bytes of the module’s IP address report are the characters MOXA. The rest of the report iscomposed of nine items, with each item preceded by a two-byte header indicating the item ID and item
length.
Header(Item ID)
(none)
1
2

Header(Item Length)(none)(varies)
2

3

6

4
5
6
7
8
9

4
4
4
4
4
4

MiiNePort E2/E3 Series User Manual

Item“Moxa” (text string)
server name (text string)hardware ID (little endian, see table below)
MAC address (00-90-E8-01-02-03 would be sent in sequence as 0x00,
0x90, 0xE8, 0x01, 0x02, 0x03)
serial number (little endian DWORD)
IP address
Netmask
default gateway
firmware version (little endian DWORD, Version 4.3.1= 0x04030100)
AP ID (little endian DWORD, see table below)

133

Example

MiiNePort E2/E3 Series User Manual

item length

hardwareID
0x4119item ID

item length

HEX
4D 4F 58 41 01 04
ASCII “M” “O” “X” “A”

server name“TEST”

item ID

item length

report header“Moxa”

item ID

The following example shows the first 22 bytes of a typical IP address report:

MAC address
00-90-E8-01-02-03

54 45 53 54 02 02 19 41 03 06 00 90 E8 01 02 03“T” “E” “S” “T”

134

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 themodule. A utility on the CD-ROM can be used to test the DIO access commands.

Overview
Each DIO command and response consists of a four-byte header and up to 255 bytes of data. The first byteof the header indicates the command. The second byte indicates the version, which is “2” for current
firmware versions. The third byte is a code that is used by the module to report errors. The fourth byte is
the number of bytes that follows the header, and will depend on the command or response.
In the event of an error, the module will return the entire command as its response, but with the third bytechanged according to the following status/error codes:
1:
2:
3:
4:
5:
6:
0xFF:

Command error; may be unknown
Version error; not supported by this version
Length error; the length member does not match the attached data
Operation error; invalid status or invalid mode
“Packet too short” error
DIO number error; might not support requested DIO number
other unknown error

ATTENTION
DIO command data is transmitted as values rather than text strings. A value of 1 would be transmitted as
0x01.

C Code Example//define DIO Header format
typedef struct _DIO_Header_Struct {char command;char version; /* This specification is version 2 */char status;char length;} DIOHeaderStruct, *pDIOHeaderStruct;//define DIO Packet format//Used for Command and ACK packet
typedef struct _DIO_Packet_Struct {DIOHeaderStruct header;Char data[ 255];} DIOPacketStruct, *pDIOPacketStruct;

MiiNePort E2/E3 Series User Manual

135

Read Single DIO
Command
Byte #
1
2
3
4
5

Descriptor
HeaderHeaderHeaderHeader
Data

Value
1
2
(any)
1
0, 1, 2, 3

Descriptioncommand #, fixedversion, fixed
this byte is only used in the module’s response
data length, fixeddesired DIO channel #For example, the 5-byte command sequence 1-2-0-1-0 requests the status of DIO 0.

Response
Byte #
1
2

Descriptor
HeaderHeader3

Header4
5

Header
Data

Value
1
2
0, 1, 2, 3,
4, 5, 6,0xFF
30, 1, 2, 3

6

Data

0, 1

7

Data

0, 1

Descriptioncommand #, fixedversion, fixedcommand status/error code (0 = okay)
data length, fixeddesired DIO channel #0: channel is in input mode
1: channel is in output mode
0: channel status is low
1: channel status is highFor example, the seven-byte response sequence 1-2-0-3-0-0-0 indicates that DIO 0 is in input mode.

C Code Example
BOOL ReadSingleDIO(int port, int *mode, int *status){
DIOPacketStruct packet;
packet.header.command = 1; // read single DIO command
packet.header.version = 2; // DIO protocol version
packet.header.length = 1; // data length
packet.data[0] = (char)port; // Number of the DIO
send(SocketFd, (char *)&packet, sizeof(DIOHeaderStruct)+1, 0);//Send TCP Packet// Process the returned data here.
return TRUE;}

MiiNePort E2/E3 Series User Manual136

Write Single DIO
Command
Byte #
1
2
3
4
5

Descriptor
HeaderHeaderHeaderHeader
Data

Value
2
2
(any)
3
0, 1, 2, 3

6

Data

0, 1

7

Data

0, 1

Descriptioncommand number, fixedversion, fixed
this byte is only used in the module’s response
data length, fixeddesired DIO channel number
0: set to input mode
1: set to output mode
this byte is ignored for input mode
0: set to low
1: set to highFor example, the seven-byte command sequence 2-2-0-3-0-0-0 requests that DIO 0 be set to digital input
mode.

Response
Byte #
1
2

Descriptor
HeaderHeader3

Header4
5

Header
Data

Value
2
2
0, 1, 2, 3,
4, 5, 6,0xFF
30, 1, 2, 3

6

Data

0, 1

7

Data

0, 1

Descriptioncommand number, fixedversion, fixedcommand status/error code (0 = okay)
data length, fixeddesired DIO channel #0: channel has been changed to input mode
1: channel has been changed to output mode
this byte is ignored for input mode
0: channel status has been changed to low
1: channel status has been changed to highFor example, the seven-byte response sequence 2-2-0-3-0-0-0 indicates that DIO 0 has been changed to
input mode.

C Code Example
void WriteSingleDIO(int port, int mode, int status){
DIOPacketStruct packet;
packet.header.command = 2; // write single DIO command
packet.header.version = 2; // DIO protocol version
packet.header.length = 3; // data length
packet.data[0] = (char)port; // number of the DIO
packet.data[1] = (char)mode; // DIO mode
packet.data[2] = (char)status; // DIO status;
send(SocketFd, (char *)&packet, sizeof(DIOHeaderStruct)+3, 0);//Send TCP packet//Process the returned data here}

MiiNePort E2/E3 Series User Manual

137

Read Multiple DIOs
Command
Byte #
12
3
4
5
6

Descriptor
HeaderHeaderHeaderHeader
Data
Data

Value
5
2
(any)
2
0, 1, 2
1, 2, 3

Descriptioncommand number, fixedversion, fixed
this byte is only used in the module’s response
data length, fixedstarting DIO channel number
ending DIO channel numberThis command requests the status of a range of DIO channels, specified in bytes 5 and 6. For example, thesix-byte command sequence 5-2-0-2-0-2 requests the status of DIO channels 0 through 2.

Response
Byte #
1
2

Descriptor
HeaderHeaderValue
5
20, 1, 2, 3,
4, 5, 6,0xFF

3Header4

Header4, 6, 8

5

Data

0, 1

6

Data

0, 1

7

Data

0, 1

8

Data

0, 1

9

Data

0, 1

10

Data

0, 1

11

Data

0, 1

12

Data

0, 1

Descriptioncommand number, fixedversion, fixedcommand status/error code (0 = okay)
data length, depends on the number of DIO channels
requested
1st requested DIO channel
0: channel is in input mode
1: channel is in output mode
1st requested DIO channel
0: channel status is low
1: channel status is high
2nd requested DIO channel
0: channel is in input mode
1: channel is in output mode
2nd requested DIO channel
0: channel status is low
1: channel status is high
3rd requested DIO channel, optional
0: channel is in input mode
1: channel is in output mode
3rd requested DIO channel, optional
0: channel status is low
1: channel status is high
4th requested DIO channel, optional
0: channel is in input mode
1: channel is in output mode
4th requested DIO channel, optional
0: channel status is low
1: channel status is highFor 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 output mode and “high” status, and DIO 2 is in input mode and “high” status.

MiiNePort E2/E3 Series User Manual138

C Code Example
BOOL ReadMultipleDIO(int start, int end, int *mode, int *status){
DIOPacketStruct packet;
packet.header.command = 5; // Read Multiple DIO Commands
packet.header.version = 2; // DIO protocol command version
packet.header.length = 2; // data length
packet.data[0] = start; // start of the DIO number
packet.data[1] = end; // end of the DIO number
send(SocketFd, (char *)&packet, sizeof(DIOHeaderStruct)+2, 0);//Send TCP packet//Process the returned data here
return TRUE;}

Write Multiple DIOs
Command
Byte #
1
2
3

Descriptor
HeaderHeaderHeader

Value
6
2
(any)

4

Header6, 8, 10

5
6

Data
Data

0, 1, 2
1, 2, 3

7

Data

0,1

8

Data

0, 1

9

Data

0, 1

10

Data

0, 1

11

Data

0, 1

12

Data

0, 1

13

Data

0, 1

MiiNePort E2/E3 Series User Manual

Descriptioncommand number, fixedversion, fixed
this byte is only used in the module’s response
data length, depends on the number of channels being
written (6 bytes for 2 channels, 8 bytes for 3channels, 10 bytes for 4 channels)
starting DIO channel number
ending DIO channel number
1st DIO channel to be written
0: set to input mode
1: set to output mode
1st DIO channel to be written
0: set to low
1: set to high2nd DIO channel to be written
0: set to input mode
1: set to output mode
2nd DIO channel to be written
0: set to low
1: set to high3rd DIO channel to be written, optional
0: set to input mode
1: set to output mode
3rd DIO channel to be written, optional
0: set to low
1: set to high4th DIO channel to be written, optional
0: set to input mode
1: set to output mode

139

Byte #

Descriptor

Value

14

Data

0, 1

Description
4th DIO channel to be written, optional
0: set to low
1: set to highThis command writes the status of a range of DIO channels, specified in bytes 5 and 6. The length of thecommand depends on the number of channels to be written. For example, the 10-byte command 6-2-0-6-01-0-0-1-1 requests DIO 0 be set to digital input mode and “low” status and DIO 1 be set to digital output
mode and “high” status. If you wanted to include a change of DIO 2 to digital output mode and “low” status,
the 12-byte command sequence would be 6-2-0-8-0-2-0-0-1-1-1-0.

Response
Byte #
1
2

Descriptor
HeaderHeaderValue
6
20, 1, 2, 3,
4, 5, 6,0xFF

3Header4

Header4, 6, 8

5

Data

0, 1

6

Data

0, 1

7

Data

0, 1

8

Data

0, 1

9

Data

0, 1

10

Data

0, 1

11

Data

0, 1

12

Data

0, 1

Descriptioncommand number, fixedversion, fixedcommand status/error code (0 = okay)
data length, depends on the number of DIO channels
requested
1st requested DIO channel, 0: channel has beenchanged to input mode, 1: channel has been changed
to output mode
1st requested DIO channel, 0: channel status has
been changed to low, 1: channel status has beenchanged to high
2nd requested DIO channel, 0: channel has beenchanged to input mode, 1: channel has been changed
to output mode
2nd requested DIO channel, 0: channel status has
been changed to low, 1: channel status has beenchanged to high
3rd requested DIO channel, optional, 0: channel has
been changed to input mode, 1: channel has beenchanged to output mode
3rd requested DIO channel, optional, 0: channel
status has been changed to low, 1: channel status has
been changed to high
4th requested DIO channel, optional, 0: channel has
been changed to input mode, 1: channel has beenchanged to output mode
4th requested DIO channel, optional, 0: channel
status has been changed to low, 1: channel status has
been changed to highFor example, the eight-byte response 6-2-0-4-0-0-1-1 indicates that DIO 0 has been changed to input
mode and “low” status and DIO 1 has been changed to output mode and “high” status.

MiiNePort E2/E3 Series User Manual140

C Code Example
void WriteMultipleDIO(int start, int end, int* mode, int* status){
DIOPacketStruct packet;
packet.header.command = 6; // Write Multiple DIO Command Codes
packet.header.version = 2; // DIO protocol version
packet.header.length = (end-start+1)*2+2; // data length
packet.data[0] = start; // start DIO number
packet.data[1] = end; // end DIO number
int i, len;for ( i=0; i<(end-start+1);i++ ) {packet.data[i+2] = mode[i];packet.data[i+3] = status[i];}send(SocketFd, )(char*)&packet,(end-start+1)*2+2+sizeof(DIOHeaderStruct), 0);//Send TCP packet//Process the returned data here}

MiiNePort E2/E3 Series User Manual141

E. SNMP Agent with MIB II and RS-232
Like Groups

MiiNePort Series modules have SNMP (Simple Network Management Protocol) agent software built in. The
software supports RFC1317 RS-232 like groups and RFC 1213 MIB-II. The following table lists the standard
MIB-II groups, as well as the variable implementations for the MiiNePort Series modules.

RFC1 213 MIB-II supported SNMP variables:
System MIB
SysDescr
SysObjectID
SysUpTime
SysContact
SysName
SysLocation
SysServices

Interfaces MIB
itNumber
ifIndex
ifDescr
ifType
ifMtu
ifSpeed
ifPhysAddress
ifAdminStatus
ifOperStatus
ifLastChange
ifInOctets
ifInUcastPkts
ifInNUcastPkts
ifInDiscards
ifInErrors
ifInUnknownProtos
ifOutOctets
ifOutUcastPkts
ifOutNUcastPkts
ifOutDiscards
ifOutErrors
ifOutQLen
ifSpecific

IP MIB
ipForwarding
ipDefaultTTL
ipInreceives
ipInHdrErrors
ipInAddrErrors
ipForwDatagrams
ipInUnknownProtos
ipInDiscards
ipInDelivers
ipOutRequests
ipOutDiscards
ipOutNoRoutes
ipReasmTimeout
ipReasmReqds
ipReasmOKs
ipReasmFails
ipFragOKs
ipFragFails
ipFragCreates
ipAdEntAddr
ipAdEntIfIndex
ipAdEntNetMask
ipAdEntBcastAddr
ipAdEntReasmMaxSize
IpNetToMediaIfIndex
IpNetToMediaPhysAddress
IpNetToMediaNetAddress
IpNetToMediaType
IpRoutingDiscards

UDP MIB
UdpInDatagrams
UdpNoPorts
UdpInErrors
UdpOutDatagrams
UdpLocalAddress
UdpLocalPort

TCP MIB
tcpRtoAlgorithm
tcpRtoMin
tcpRtoMax
tcpMaxConn
tcpActiveOpens
tcpPassiveOpens
tcpAttempFails
tcpEstabResets
tcpCurrEstab
tcpInSegs
tcpOutSegs

SNMP MIB
Address Translation MIB
snmpInPkts
AtIfIndex
snmpOutPkts
AtPhysAddress
snmpInBadVersions
AtNetAddress
snmpInBadCommunityNames
snmpInASNParseErrs
snmpInTooBigs
snmpInNoSuchNames
snmpInBadValues
snmpInReadOnlys
snmpInGenErrs
snmpInTotalReqVars

MiiNePort E2/E3 Series User Manual

ICMP MIB
IcmpInMsgs
IcmpInErrors
IcmpInDestUnreachs
IcmpInTimeExcds
IcmpInParmProbs
IcmpInSrcQuenchs
IcmpInRedirects
IcmpInEchos
IcmpInEchoReps
IcmpInTimestamps
IcmpTimestampReps
IcmpInAddrMasks
IcmpOutMsgs
IcmpOutErrors
IcmpOutDestUnreachs
IcmpOutTimeExcds
IcmpOutParmProbs
IcmpOutSrcQuenchs
IcmpOutRedirects
IcmpOutEchos
IcmpOutEchoReps
IcmpOutTimestamps
IcmpOutTimestampReps
IcmpOutAddrMasks
IcmpOutAddrMaskReps

142

F. NECI Library

NECI (Network Enabler Configuration Interface) is a set of APIs that run on Windows systems (95 andabove) to search, locate, and configure MiiNePort Series modules over the network. The MiiNePort 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 locatedin .\NECI_LIB\VC\ConsoleExample.

MiiNePort E2/E3 Series User Manual143