Microhard Systems IPN4G Operating Manual
Add to My manuals193 Pages
Microhard Systems IPN4G is an industrial grade IP Ethernet Bridge/Serial Gateway that combines the functions of a serial device server with an Ethernet bridge. IPN4G enables data acquisition and control to and from remote serial devices using Ethernet/IP networks. This LTE based gateway communicates with serial devices using RS-232/422/485 ports or optional USB host adapters supporting a range of protocols.
advertisement
Operating Manual
IPn4G / IPn4Gb
IPn4G LTE Ethernet Bridge/Serial Gateway
Document: IPn4G Operating Manual.v1.4.pdf
FW: v1.1.0 Build1084-16
May 2015
150 Country Hills Landing NW
Calgary, Alberta
Canada T3K 5P3
Phone: (403) 248-0028
Fax: (403) 248-2762 www.microhardcorp.com
Important User Information
Warranty
Microhard Systems Inc. warrants that each product will be free of defects in material and workmanship for a period of one (1) year for its products. The warranty commences on the date the product is shipped by Microhard Systems Inc. Microhard Systems Inc.’s sole liability and responsibility under this warranty is to repair or replace any product which is returned to it by the Buyer and which Microhard Systems Inc. determines does not conform to the warranty. Product returned to Microhard Systems Inc. for warranty service will be shipped to Microhard Systems Inc. at Buyer’s expense and will be returned to Buyer at Microhard Systems Inc.’s expense. In no event shall Microhard Systems Inc. be responsible under this warranty for any defect which is caused by negligence, misuse or mistreatment of a product or for any unit which has been altered or modified in any way. The warranty of replacement shall terminate with the warranty of the product.
Warranty Disclaims
Microhard Systems Inc. makes no warranties of any nature of kind, expressed or implied, with respect to the hardware, software, and/or products and hereby disclaims any and all such warranties, including but not limited to warranty of non-infringement, implied warranties of merchantability for a particular purpose, any interruption or loss of the hardware, software, and/or product, any delay in providing the hardware, software, and/ or product or correcting any defect in the hardware, software, and/or product, or any other warranty. The Purchaser represents and warrants that Microhard Systems Inc. has not made any such warranties to the Purchaser or its agents MICROHARD SYSTEMS INC. EXPRESS WARRANTY TO BUYER CONSTITUTES MICROHARD
SYSTEMS INC. SOLE LIABILITY AND THE BUYER’S SOLE REMEDIES. EXCEPT AS THUS PROVIDED, MICROHARD
SYSTEMS INC. DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING ANY WARRANTY OF MER-
CHANTABILITY OR FITNESS FOR A PARTICULAR PROMISE.
MICROHARD SYSTEMS INC. PRODUCTS ARE NOT DESIGNED OR INTENDED TO BE USED IN
ANY LIFE SUPPORT RELATED DEVICE OR SYSTEM RELATED FUNCTIONS NOR AS PART OF
ANY OTHER CRITICAL SYSTEM AND ARE GRANTED NO FUNCTIONAL WARRANTY.
Indemnification
The Purchaser shall indemnify Microhard Systems Inc. and its respective directors, officers, employees, successors and assigns including any subsidiaries, related corporations, or affiliates, shall be released and discharged from any and all manner of action, causes of action, liability, losses, damages, suits, dues, sums of money, expenses (including legal fees), general damages, special damages, including without limitation, claims for personal injuries, death or property damage related to the products sold hereunder, costs and demands of every and any kind and nature whatsoever at law.
IN NO EVENT WILL MICROHARD SYSTEMS INC. BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL,
INCIDENTAL, BUSINESS INTERRUPTION, CATASTROPHIC, PUNITIVE OR OTHER DAMAGES WHICH MAY BE
CLAIMED TO ARISE IN CONNECTION WITH THE HARDWARE, REGARDLESS OF THE LEGAL THEORY BEHIND
SUCH CLAIMS, WHETHER IN TORT, CONTRACT OR UNDER ANY APPLICABLE STATUTORY OR REGULATORY
LAWS, RULES, REGULATIONS, EXECUTIVE OR ADMINISTRATIVE ORDERS OR DECLARATIONS OR OTHERWISE,
EVEN IF MICROHARD SYSTEMS INC. HAS BEEN ADVISED OR OTHERWISE HAS KNOWLEDGE OF THE POSSIBIL-
ITY OF SUCH DAMAGES AND TAKES NO ACTION TO PREVENT OR MINIMIZE SUCH DAMAGES. IN THE EVENT
THAT REGARDLESS OF THE WARRANTY DISCLAIMERS AND HOLD HARMLESS PROVISIONS INCLUDED ABOVE
MICROHARD SYSTEMS INC. IS SOMEHOW HELD LIABLE OR RESPONSIBLE FOR ANY DAMAGE OR INJURY, MI-
CROHARD SYSTEMS INC.'S LIABILITY FOR ANYDAMAGES SHALL NOT EXCEED THE PROFIT REALIZED BY MI-
CROHARD SYSTEMS INC. ON THE SALE OR PROVISION OF THE HARDWARE TO THE CUSTOMER.
Proprietary Rights
The Buyer hereby acknowledges that Microhard Systems Inc. has a proprietary interest and intellectual property rights in the Hardware, Software and/or Products. The Purchaser shall not (i) remove any copyright, trade secret, trademark or other evidence of Microhard Systems Inc.’s ownership or proprietary interest or confidentiality other proprietary notices contained on, or in, the Hardware, Software or Products, (ii) reproduce or modify any Hardware, Software or Products or make any copies thereof, (iii) reverse assemble, reverse engineer or decompile any Software or copy thereof in whole or in part, (iv) sell, transfer or otherwise make available to others the Hardware, Software, or Products or documentation thereof or any copy thereof, except in accordance with this Agreement.
© Microhard Systems Inc. 2
Important User Information (continued)
About This Manual
It is assumed that users of the products described herein have either system integration or design experience, as well as an understanding of the fundamentals of radio communications.
Throughout this manual you will encounter not only illustrations (that further elaborate on the accompanying text), but also several symbols which you should be attentive to:
Caution or Warning
Usually advises against some action which could result in undesired or detrimental consequences.
Point to Remember
Highlights a key feature, point, or step which is noteworthy. Keeping these in mind will simplify or enhance device usage.
Tip
An idea or suggestion to improve efficiency or enhance usefulness.
Information
Information regarding a particular technology or concept.
© Microhard Systems Inc. 3
Important User Information (continued)
Regulatory Requirements
WARNING
To satisfy FCC RF exposure requirements for mobile transmitting devices, a separation distance of 23cm or greater for the IPn4G utilizing a 3dBi antenna, or 3.5m or greater for the IPn4G utilizing a 34dBi antenna, should be maintained between the antenna of this device and persons during device operation. To ensure compliance, operations at closer than this distance is not recommended. The antenna being used for this transmitter must not be co-located in conjunction with any other antenna or transmitter.
WARNING
This device can only be used with Antennas approved for this device. Please contact
Microhard Systems Inc. if you need more information or would like to order an antenna.
WARNING
MAXIMUM EIRP
FCC Regulations allow up to 36dBm Effective Isotropic Radiated Power (EIRP).
Therefore, the sum of the transmitted power (in dBm and not to exceed +30dBm)), the cabling loss, and omnidirectional antenna gain cannot exceed 36dBm.
© Microhard Systems Inc. 4
CSA Class 1 Division 2 Option
CSA Class 1 Division 2 is Available Only on Specifically Marked Units
If marked this for Class 1 Division 2 – then this product is available for use in Class 1, Division 2, in the indicated Groups on the product.
In such a case the following must be met:
The transceiver is not acceptable as a stand-alone unit for use in hazardous locations. The transceiver must be mounted within a separate enclosure, which is suitable for the intended application. Mounting the units within an approved enclosure that is certified for hazardous locations, or is installed within guidelines in accordance with CSA rules and local electrical and fire code, will ensure a safe and compliant installation.
Do not connect or disconnect equipment unless power has been switched off or the area is known to be non-hazardous.
Installation, operation and maintenance of the transceiver should be in accordance with the transceiver’s installation manual, and the National Electrical Code.
Tampering or replacement with non-factory components may adversely affect the safe use of the transceiver in hazardous locations, and may void the approval.
The wall adapters supplied with your transceivers are NOT Class 1 Division 2 approved, and therefore, power must be supplied to the units using the screw-type or locking type connectors supplied from Microhard Systems Inc. and a Class 1 Division 2 power source within your panel.
If you are unsure as to the specific wiring and installation guidelines for Class 1 Division 2 codes, contact CSA International.
© Microhard Systems Inc. 5
Revision History
1.2
1.21
1.22
1.23
1.24
1.3
1.31
1.4
Revision
1.0
1.1
Description
Initial Release based on firmware v1_1_0-r1010.bin
Initials
PEH
Date
Dec 2012
Mar 2013 Updated Network > LAN (Add Interface), Updated SMS Commands,
Added SMS Alerts, Updated Wireless Config (Virtual Interfaces), AP
Isolation, Updated COM IP Protocol Config (C12.22, GPS), Updated
GPS (UDP Report, GpsGate, Recorder, Load Recorder), Updated Firewall, Updated VPN (Gateway Type etc), Added Modbus, Updated misc screen shots, misc formatting. Etc. Based on Firmware v1.1.0r1028.bin
PEH
Misc formatting, updates. Updated WiFi antenna to RP-SMA Female. PEH
Corrected LTE Band Spec
Added PoE information
PEH
PEH
Mar 2013
Apr 2013
Apr 2013
Added/Corrected Digital I/O pins location
Corrected enclosure drawings
Firmware v1.1.0-r1060
Misc Corrections
Firmware v1.1.0-r1084-16
PEH
PEH
PEH
PEH
PEH
Apr 2013
Nov 2013
Dec 2013
Oct 2014
May 2015
© Microhard Systems Inc. 6
Table of Contents
1.1 Performance Features ................................................................................................... 10
1.2 Specifications ................................................................................................................ 11
2.3.1 Setting up WiFi .................................................................................................... 17
2.3.1 Connecting to WiFi .............................................................................................. 18
3.1.1 IPn4G Mechanical Drawings ................................................................................ 21
3.1.2 IPn4G Connectors & Indicators ............................................................................ 22
3.1.2.1 Front ...................................................................................................... 22
3.1.2.2 Rear ...................................................................................................... 23
4.0.1 Logon Window ..................................................................................................... 25
4.1.1 Summary ............................................................................................................. 26
4.1.2 Settings ............................................................................................................... 27
Host Name .......................................................................................................... 27
Syslog Settings .................................................................................................... 28
Date/Time ............................................................................................................ 29
NTP Server Settings ............................................................................................ 29
HTTP/HTTPS Port Settings.................................................................................. 30
4.1.3 Access Control (Users/Passwords) ...................................................................... 31
4.1.4 Services .............................................................................................................. 33
4.1.5 Maintenance ........................................................................................................ 35
Version Information .............................................................................................. 35
Firmware Upgrade ............................................................................................... 35
Reset to Default ................................................................................................... 36
Backup & Restore Configurations ........................................................................ 36
4.1.6 Logout ................................................................................................................. 37
4.1.7 Reboot ................................................................................................................. 38
4.2.1 Status .................................................................................................................. 39
4.2.2 LAN ..................................................................................................................... 40
DHCP .................................................................................................................. 42
MAC Binding........................................................................................................ 44
4.2.3 WIFI .................................................................................................................... 45
4.2.4 Routes ................................................................................................................. 46
4.2.5 GRE .................................................................................................................... 48
4.2.6 SNMP .................................................................................................................. 51
4.2.7 sdpServer ............................................................................................................ 54
4.2.8 Local Monitor ....................................................................................................... 55
4.2.9 Port (Ethernet) ..................................................................................................... 56
© Microhard Systems Inc. 7
Table of Contents
4.3.1 Status .................................................................................................................. 57
4.3.2 Settings ............................................................................................................... 58
IP-Passthrough .................................................................................................... 59
APN (Access Point Name) ................................................................................... 60
4.3.3 Keepalive............................................................................................................. 62
4.3.4 Traffic Watchdog.................................................................................................. 63
4.3.5 Dynamic DNS ...................................................................................................... 64
4.3.6 SMS Config/Alerts ............................................................................................... 65
4.3.7 SMS .................................................................................................................... 68
4.3.8 Data Usage ......................................................................................................... 69
4.4.1 Status .................................................................................................................. 72
4.4.2 Radio1 ................................................................................................................. 73
Radio Phy Configuration ...................................................................................... 73
802.11 Mode........................................................................................................ 73
Channel Frequency ............................................................................................. 73
Radio Virtual Interface ......................................................................................... 74
Operating Mode ................................................................................................... 75
TX Rate ............................................................................................................... 75
TX Power............................................................................................................. 76
SSID .................................................................................................................... 76
AP Isolation ......................................................................................................... 76
Encryption Type ................................................................................................... 77
4.4.3 Hotspot ................................................................................................................ 78
4.5.1 Status .................................................................................................................. 81
4.5.2 COM0/1 Settings ................................................................................................. 82
Data Baud Rate ................................................................................................... 83
IP Protocol Config ................................................................................................ 86
TCP Client ...................................................................................................... 86
TCP Server ..................................................................................................... 86
TCP Client/Server ........................................................................................... 87
UDP Point-to-Point .......................................................................................... 87
UDP Point-to-Multipoint (P) ............................................................................. 87
UDP Point-to-Multipoint (MP) .......................................................................... 88
UDP Multipoint-to-Multipoint ............................................................................ 88
SMTP Client .................................................................................................... 89
PPP ................................................................................................................ 90
GPS Transparent Mode .................................................................................. 91
4.6.1 Status .................................................................................................................. 92
4.6.2 Output ................................................................................................................. 93
4.7.1 Location ............................................................................................................... 94
4.7.2 Settings ............................................................................................................... 95
4.7.3 GPS Report ......................................................................................................... 96
4.7.4 GpsGate .............................................................................................................. 98
4.7.5 Recorder.............................................................................................................. 101
4.7.6 Load Record ........................................................................................................ 102
© Microhard Systems Inc. 8
Table of Contents
4.8.1 Status .................................................................................................................. 103
4.8.2 General ............................................................................................................... 104
4.8.3 Rules ................................................................................................................... 105
4.8.4 Port Forwarding ................................................................................................... 107
DMZ .................................................................................................................... 108
4.8.5 MAC-IP List ......................................................................................................... 109
MAC List Configuration ........................................................................................ 109
IP List Configuration............................................................................................. 110
4.8.6 Reset ................................................................................................................... 111
4.9.1 Summary ............................................................................................................. 112
4.9.2 Gateway to Gateway............................................................................................ 113
4.9.3 Client to Gateway (L2TP Client) ........................................................................... 118
4.9.4 VPN Client Access ............................................................................................... 120
4.9.5 Certificate Management ....................................................................................... 121
4.9.6 Cisco VPN Client ................................................................................................. 122
4.10.1 Discovery ........................................................................................................... 123
4.10.2 Netflow ............................................................................................................... 124
4.10.3 NMS Settings ..................................................................................................... 126
4.10.4 Event Report ...................................................................................................... 130
4.10.4.1 Configuration ....................................................................................... 130
4.10.4.2 Message Structure ............................................................................... 131
4.10.4.3 Message Payload................................................................................. 132
4.10.5 Modbus .............................................................................................................. 133
4.10.5.1 TCP Modbus ........................................................................................ 133
4.10.5.2 Serial (COM) Modbus........................................................................... 135
4.10.5.3 Modbus Data Map ................................................................................ 136
4.10.6 Websocket ......................................................................................................... 137
4.10.7 Site Survey ........................................................................................................ 139
4.10.8 Ping ................................................................................................................... 140
4.10.9 TraceRoute ........................................................................................................ 141
5.1 AT Command Overview .............................................................................................. 142
5.1.1 Serial Port .......................................................................................................... 142
5.1.2 Telnet................................................................................................................. 143
5.2 AT Command Syntax .................................................................................................. 144
5.3 Supported AT Commands .......................................................................................... 145
Appendix A: Serial Interface .................................................................................................. 177
Appendix B: IP-Passthrough Example ................................................................................... 178
Appendix C: Port Forwarding Example .................................................................................. 180
Appendix D: VPN (Site to Site) Example ............................................................................... 182
Appendix E: Firewall Rules Example ..................................................................................... 184
Appendix F: GRE Example ................................................................................................... 186
Appendix G: Firmware Recovery Procedure .......................................................................... 189
Appendix H: Troubleshooting ................................................................................................ 190
© Microhard Systems Inc. 9
1.0 Overview
© Microhard Systems Inc.
The IPn4G is a high-performance 4G LTE Cellular Ethernet & Serial Gateway with 802.11 b/g
WiFi capability, RJ45 Ethernet Port, Digital I/O, and two serial communication ports, one a fully complimented RS232/485/422 serial port.
The IPn4G utilizes the cellular infrastructure to provide network access to wired and wireless devices anywhere cellular coverage is supported by a cellular carrier. The IPn4G supports up to 100Mbps when connected to a LTE enabled carrier, or global fallback to 3G/Edge networks for areas without 4G LTE.
Providing reliable wireless Ethernet bridge functionality as well gateway service for most equipment types which employ an RS232, RS422, or RS485 interface, the IPn4G can be used in a limitless number and types of applications such as:
High-speed backbone
IP video surveillance
Voice over IP (VoIP)
Ethernet wireless extension
WiFi Hotspot
Legacy network/device migration
SCADA (PLC’s, Modbus,
Hart)
Facilitating internetwork wireless communications
1.1 Performance Features
Key performance features of the IPn4G include:
Fast 4G LTE Link to Wireless Carrier
Up to 100Mbps Downlink / 50 Mbps Uplink
Fast Data Rates to 802.11b/g WiFi Devices
Digital I/O - 1 Input, 1 Output
DMZ and Port Forwarding
10/100 Ethernet Port (WAN/LAN)
Integrated GPS (TCP Server/UDP Reporting)
User interface via local console, telnet, web browser
communicates with virtually all PLCs, RTUs, and serial devices through either
RS232, RS422, or RS485 interface
Local & remote wireless firmware upgradable
User configurable Firewall with IP/MAC ACL
IP/Sec secure VPN and GRE Tunneling
10
1.0 Overview
1.2 Specifications
For detailed specifications, please see the specification sheets available on the Microhard website @ http:///www.microhardcorp.com for your specific model.
Electrical/General
Cellular:
Supported Bands:
Data Features:
SIM Card:
WiFi:
Frequency:
Spread Method:
Data Rates:
TX Power:
Data Encryption:
General:
Input Voltage:
Current Consumption:
(@12VDC & 20dB WiFi)
Serial Baud Rate:
Ethernet:
4G LTE B4/B17 (1700/2100/700 MHz)
Global Fallback to:
HSPA+/UMTS 850/AWS/1900/2100 MHz
GPRS 850/900/1800/1900 MHz
4G LTE
Up to 100 Mbps downlink
Up to 50 Mbps uplink
1.8 / 3.0 V
2.4 GHz
(CCK) QPSK/BPSK
(OFDM) BPSK, QPSK, QAM16, QAM32, QAM64
802.11b/g
WEP, WPA(PSK), WPA2(PSK), WPA+WPA2 (PSK)
(Subject to Export Restrictions)
9 - 30 VDC
Cellular
On
On
Off
IPn4G
Adjustable / Up to 30dBm
Power over Ethernet: Passive PoE on Ethernet Port
WiFi
LTE FDD (Bands 1-5,7,8,13,17,18,19,20)
UMTS | DC-HSPA+ (Bands 1,2,4,5,8)
GSM | GPRS | EDGE (Bands 2,3,5,8)
3GPP Protocol Stack Release 9
LTE: DL 100 Mbps, UL 50 Mbps
HSPA+: DL 21 Mbps, UL 5.7 Mbps
WCDMA: DL/UL 384 kbps
EDGE Class 33: DL/UL 236.8 kbps
GPRS Class 33: DL/UL 85.6kbps
Table 1-2-1: IPn4G Current Consumption
300bps to 921kbps
On
Off
On
Idle (mA)
350
280
270
10/100 BaseT, Auto - MDI/X, IEEE 802.3
IPn4Gb
Typical (mA)
390
320
320
© Microhard Systems Inc. 11
1.0 Overview
1.2 Specifications (Continued)
Network Protocols:
Operating Modes:
Management:
Diagnostics:
Digital I/O:
TCP, UDP, TCP/IP, TFTP, ARP, ICMP, DHCP, HTTP,
HTTPS*, SSH*, SNMP, FTP, DNS, Serial over IP
Access Point, Client/Station, Repeater, Mesh Point
Local Serial Console, Telnet, WebUI, SNMP, FTP &
Wireless Upgrade
Status LED’s, RSSI, Ec/No, Temperature, Remote Diagnostics,
Watchdog, UDP Reporting
1 Inputs / 1 Outputs
Environmental
Operation Temperature: -40 o F(-40 o C) to 185 o F(85 o C)
Humidity: 5% to 95% non-condensing
Mechanical
Dimensions:
2.25” (57mm) X 3.85” (98mm) X 1.5” (45mm)
Weight:
Approx. 250 grams
Connectors:
Antenna: Wi-Fi: RP-SMA Female
Cellular: 2x SMA Female (Main, DIV)
GPS Uses Diversity Antenna
Data: RS232 COM1: DB-9 Female (Digital I/O)
RS232 Data: DB-9 Female
RS485: SMT: 6-Pin Micro MATE-N-LOK AMP 3-794618-6
Mating Connector: 6-Pin Micro MATE-N-LOK AMP 794617-6
Ethernet : RJ-45
PWR, Misc: Power: SMT: 4-Pin Micro MATE-N-LOK AMP 3-794618-4
Mating Connector: 4-Pin Micro MATE-N-LOK AMP 794617-4
© Microhard Systems Inc. 12
2.0 Quick Start
To reset to factory defaults, press and hold the CFG button for 8 seconds with the
IPn4G powered up.
The LED’s will flash quickly and the IP4G will reboot with factory defaults.
Use the MHS-supplied power adapter or an equivalent power source.
The unit can also be powered via PoE using a
MHS PoE injector.
This QUICK START guide will walk you through the setup and process required to access the WebUI configuration window and to establish a basic wireless connection to your carrier.
Note that the units arrive from the factory with the Local Network setting configured as ‘Static’ (IP Address 192.168.168.1, Subnet Mask 255.255.255.0, and Gateway
192.168.168.1), in DHCP server mode. (This is for the LAN Ethernet Adapter on the back of the IPn4G unit.
2.1 Installing the SIM Card
Before the IPn4G can be used on a cellular network a valid SIM Card for your
Wireless Carrier must be installed. Insert the SIM Card into the slot as shown below.
SIM Card Slot
2.2 Getting Started with Cellular
Connect the Antenna’s to the applicable ANTENNA jack’s of the IPn4G.
Cellular
Antenna’s
WiFi Antenna
Connect the power connector to the power adapter and apply power to the unit, the RF & SGNL LED’s will flash during boot-up, once they stop, proceed to the next step.
Out In
Vin- Vin+
GND
GND
Tx-
9-30VDC
Rx-
Tx+ Rx+
© Microhard Systems Inc. 13
2.0 Quick Start
The factory default network settings:
IP: 192.168.168.1
Subnet: 255.255.255.0
Gateway: 192.168.168.1
Connect A PC configured for DHCP directly to the ETHERNET port of the IPn4G, using an Ethernet Cable. If the PC is configured for DHCP it will automatically acquire a IP Address from the IPn4G.
Open a Browser Window and enter the IP address 192.168.168.1 into the address bar.
192.168.168.1
The IPn4G will then ask for a Username and Password. Enter the factory defaults listed below.
The factory default login:
User name: admin
Subnet: admin
It is always a good idea to change the default admin login for future security.
The Factory default login:
User name: admin
Password: admin
© Microhard Systems Inc. 14
2.0 Quick Start
Once successfully logged in, the System Summary page will be displayed.
Auto APN: Introduced in firmware version v1.1.0r1038, the IPn4G will attempt to detect the carrier based on the SIM card installed and cycle through a list of commonly used APN’s to provide quick network connectivity.
As seen above under Carrier Status, the SIM card is installed, but an APN has not been specified. Setting the APN to auto (default) may provide quick network connectivity, but may not work with some carriers, or with private APN’s. To set or change the APN, click on the Carrier > Settings tab and enter the APN supplied by your carrier in the APN field. Some carriers may also require a Username and Password.
Once the APN and any other required information is entered to connect to your carrier, click on “Submit”. Return to the System > Summary tab.
© Microhard Systems Inc. 15
2.0 Quick Start
On the Carrier > Status Tab, verify that a WAN IP Address has been assigned by your carrier. It may take a few minutes, so try refreshing the page if the WAN
IP Address doesn’t show up right away. The Activity Status should also show
“Connected”.
If you have set a static IP on your PC, you may need to add the DNS Servers shown in the Carrier Status Menu to you PC to enable internet access.
Congratulations! Your IPn4G is successfully connected to your Cellular Carrier.
The next section gives a overview on enabling and setting up the WiFi Wireless features of the modem giving 802.11 devices network access.
To access devices connected to IPn4G remotely, one or more of the following must be configured: IP-Passthrough, Port Forwarding, DMZ. Another option would be to set up a VPN.
© Microhard Systems Inc. 16
2.0 Quick Start
2.3 Getting Started with WiFi
This Quick Start section walks users through setting up a basic WiFi AP (Access
Point). For additional settings and configuration considerations, refer to the appropriate sections in the manual. This walkthrough assumes all setting are in the factory default state.
802.11b/g
4G LTE
Cell Tower
2.3.1 Setting up WiFi
Use Section 2.2 Getting Started with Cellular to connect, power up and log in and configure the Carrier in a IPn4G.
Click on the Wireless > Radio1 Tab to setup the WiFi portion of the IPn4G.
In Radio1 Phy Configuration, ensure the mode is set for 802.11BG.
In the Radio1 Virtual Interface, ensure that the Mode is set for Access
Point.
Enter a name for the Wireless Network under SSID. This example uses
MyNetwork
(Optional) Set a password for the WiFi, this example uses MyPassword
Click Submit.
© Microhard Systems Inc. 17
2.0 Quick Start
2.3.2 Connecting to WiFi
Now that the IPn4G has connection to the Cellular Carrier (See Section 2.2) and the WiFI has been set up (See Section 2.3), WiFi devices should be able to detect and connect to the IPn4G.
On a WiFi enabled PC/Device, the SSID of MyNetwork, that was created in the last example should be visible. Connect to that SSID and enter the password.
Once connected the status should change to connected, and network access should be enabled.
© Microhard Systems Inc. 18
2.0 Quick Start
The status of the WiFi connection should also be visible in the Wireless > Status tab in the WebUI as seen below.
© Microhard Systems Inc. 19
3.0 Hardware Features
© Microhard Systems Inc.
3.1 IPn4G
The IPn4G is a fully-enclosed unit ready to be interfaced to external devices.
Image 3-1 : Front View of IPn4G
Image 3-2 : Rear View of IPn4G
Any IPn4G may be configured as an Access Point, Station/Client, Repeater or Mesh Node. This versatility is very convenient from a ’sparing’ perspective, as well for convenience in becoming very familiar and proficient with using the device: if you are familiar with one unit, you will be familiar with all units.
The IPn4G features:
Standard Connectors for:
1 Ethernet Ports (RJ45)
COM0 Data Port (RS232/DB9)
COM1 Console Port (RS232/DB9)
4-Pin: MATE-N-LOK Type Connector for Power
6-Pin: MATE-N-LOK Type Connector for RS485 Data
Cellular Antenna (SMA Female Antenna Connection x2)
WiFi Antenna (RP-SMA Female Antenna Connection) (Optional)
Status/Diagnostic LED’s for STATUS, RF, SGNL, RSSI x 3
CFG Button for factory default / firmware recovery operations
Mounting Holes
20
3.0 Hardware Features
3.1.1 Mechanical Drawings
5.60
5.40
11.53
119.70
52.20
32.07
R3.50
Ø7.00
8.60
11.00
5.40
97.70
108.50
Drawing 3-1: IPn4G Top View Dimensions
97.70
56.20
69.81
5.60
© Microhard Systems Inc.
34.60
37.20
2.60
119.70
Drawing 3-2: IPn4G Front View Dimensions
97.70
11.00
O I
119.70
Drawing 3-3: IPn4G Rear View Dimensions
2.60
37.20
Note: All dimension units: Millimeter
21
3.0 Hardware Features
3.1.2 Connectors and Indicators
3.1.2.1 Front
On the front of the IPn4G is the COM1 port, CONFIG Button, RSSI, STATUS, RF and SGNL LED’s as described below:
Caution: Using a power supply that does not provide proper voltage may damage the IPn4G unit.
Drawing 3-4: IPn4G Front View
The COM1 port (RS232) is used for:
AT Command Interface at 115.2kbps and
HyperTerminal (or equivalent).
User data (RS232 - RxD, TxD, and SG)
CONFIG (Button) - Holding this button depressed while
powering-up the IPn4G will boot the unit into FILE SYS-
TEM RECOVERY mode. The default IP address for system
recovery (only - not for normal access to the unit) is static:
192.168.1.39.
Signal
Name
RXD
TXD
SG
PIN
#
2
3
5
Input or
Output
O
I
Table 3-1: COM1 Port RS232 Pin Assignment
If the unit has been powered-up for some time (>1 minute), depressing the CFG Button for 8 seconds will result in FACTORY DEFAULTS being restored, including a static IP address of 192.168.168.1. This IP address is useable in a Web Browser for accessing the Web User Interface.
RF(Red)/SGNL(Green) LED’s - When the unit is equipped with WiFi, the RF/SGNL LED’s indicate WiFi activity. In units not equipped with WiFi, the RF/SGNL LED’s indicate carrier (cellular) traffic. Also, during system bootup, the RF & SGNL LED’s will flash.
Receive Signal Strength Indicator (RSSI) (3x
Green) - As the received signal strength increases, starting with the furthest left, the number of active
RSSI LEDs increases.
STATUS LED (Red) - The Status LED indicates that power has been applied to the module.
SIM Card - This slot is used to install a SIM card provided by the cellular carrier to enable communication to their cellular network. Ensure the SIM card is installed properly by paying attention to the diagram printed above the SIM card slot.
Signal Level
(dBm)
(-85, 0]
(-90, -85]
(-95, -90]
(-100, -95] ON
(-105, -100] ON
(-109, -105] FLASH
Other
RSSI1
(Left)
ON
ON
ON
RSSI2
(Mid)
ON
ON
ON
FLASH
OFF
OFF
RSSI3
(Right)
ON
FLASH
OFF
OFF
OFF
OFF
SCANNING SCANNING SCANNING
Table 32: RSSI LED’s
© Microhard Systems Inc. 22
3.0 Hardware Features
3.1.2 Connectors and Indicators
3.1.2.2 Rear
On the back of the IPn4G is the Data (COM0) port, RS485/422 interface, as well as the power connections.
The unit also has the SMA(F) connectors for the Main (TX/RX), the Diversity (RX) antenna’s, and a RP-
SMA Female connector for the optional WiFi antenna.
O I
Caution: Using a power supply that does not provide proper voltage may damage the modem.
The DATA (RS232 Port (COM0)) on the rear of the circuit board is used for:
RS232 serial data (300-921kbps)
Name
DCD
RXD
Data Port
1
2
Input or
Output
O
O
The RS422/485 Port is used to interface the IPn4G to a DTE with the same interface type. Either the RS232 or RS422/485 interface can be used for data traffic, not both.
Vin+/Vin – is used to power the unit. The input Voltage range is
9-30 Vdc.
TXD
DTR
SG
DSR
RTS
CTS
RING
3
4
5
6
7
8
9
I
I
O
I
O
O
Table 3-3: Data RS232 Pin Assignment
Out In
Vin- Vin+
GND
GND
TxRx-
Tx+ Rx+
Digital I/O – The IPn4G has 1 input / 1 output. Inputs have a small wetting
Name
Tx+
Tx1
Rx+
Input or
Output
O
O
I
Rx- I current (Vin) used to detect a contact closure, and prevent false readings by any noise or intermittent signals, it has a threshold sensitivity of 1.8V.
Maximum recommended load for the output pin is 150mA @ 30 Vdc (Vin).
PoE
– The IPn4G can also be powered using Passive PoE on the Ethernet
Port, via a PoE injector.
Vin -
Vin +
Out
I
O
In I
Ethernet RJ45 Connector Pin Number
Table 3-4: Data RS422/485,
Vin, Digital I/O Pin Assignment
Source
Voltage
1 2 3 4 5 6 7 8
9 - 30 Vdc Data Data Data DC+ DC+ Data DC- DC-
© Microhard Systems Inc.
Drawing 3-5: IPn4G Rear View
Table 3-5: Ethernet PoE Connections
23
4.0 Configuration
4.0 Web User Interface
© Microhard Systems Inc.
Image 4-0-1: WebUI
Initial configuration of an IPn4G using the Web User (Browser) Interface (Web UI) method involves the following steps:
configure a static IP Address on your PC to 192.168.168.10 (or any address on the
192.168.168.X subnet other than the default IP of 192.168.168.1)
connect the IPn4G ETHERNET port to PC NIC card using an Ethernet cable
apply power to the IPn4G and wait approximately 60 seconds for the system to load
open a web browser and enter the factory default IP address of the unit: 192.168.168.1
logon window appears; log on using default Username: admin Password: admin
use the web browser based user interface to configure the IPn4G as required.
refer to Section 2.0: Quick Start for step by step instructions.
In this section, all aspects of the Web Browser Interface, presented menus, and available configuration options will be discussed.
24
4.0 Configuration
For security, do not allow the web browser to remember the User Name or Password.
It is advisable to change the login Password. Do not FORGET the new password as it cannot be recovered.
4.0.1 Logon Window
Upon successfully accessing the IPn4G using a Web Browser, the Logon window will appear.
Image 4-0-2: Logon Window
The factory default User Name is:
The default password is:
admin
admin
Note that the password is case sensitive. It may be changed (discussed further along in this section), but once changed, if forgotten, may not be recovered.
When entered, the password appears as ’dots’ as shown in the image below. This display format prohibits others from viewing the password.
The ‘Remember my password’ checkbox may be selected for purposes of convenience, however it is recommended to ensure it is deselected - particularly once the unit is deployed in the field - for one primary reason: security.
© Microhard Systems Inc.
Image 4-0-3: Logon Window : Password Entry
25
4.0 Configuration
4.1 System
The main category tabs located at the top of the navigation bar separate the configuration of the
IPn4G into different groups based on function. The System Tab contains the following sub menu’s:
Summary
Settings
Access Control
Services
Maintenance
Reboot
Logout
-
-
-
-
-
-
-
Status summary of entire radio including network settings, version information, and radio connection status.
Host Name, Default System Mode (Bridge or Router),
System Time/Date, HTTP Port for the WebUI,
Change passwords, create new users
Enable/Disable RSSI LED’s, SSH and Telnet services
Version information, firmware Upgrades, reset to defaults, configuration backup and restore.
Remotely reboot the system.
Logout of the current browser session.
4.1.1 System > Summary
The System Summary screen is displayed immediately after initial login, showing a summary and status of all the functions of the IPn4G in a single display. This information includes System
Status, Carrier Status, 4G & LAN network information, version info and WiFi radio status as seen below.
© Microhard Systems Inc.
Image 4-1-1: System Info Window
26
4.0 Configuration
4.1.2 System > Settings
System Settings
Options available in the System Settings menu allow for the configuration of the Host Name.
The Host Name must not be confused with the Network
Name (SSID) (Wireless
Configuration menu).
Image 4-1-2: System Settings > System Settings
Host Name
The Host Name is a convenient identifier for a specific IPn4G unit. This feature is most used when accessing units remotely: a convenient crossreference for the unit’s WAN IP address. This name appears when logged into a telnet session, or when the unit is reporting into
Microhard NMS System.
Values (characters)
IPn4G +wifi (varies)
Description
The description field is a general purpose text field that can be used to provide additional information about the device such as a secondary identifier, address or phone number for a contact person.
Values (characters)
IPn4G +wifi (varies)
© Microhard Systems Inc. 27
4.0 Configuration
System Log Server IP/Name
The modem can be configured to report system level events to a third party Syslog server, as shown below. Syslog data can then be filtered and depending on the features of the Syslog server application, alerts can be generated accordingly.
The screenshot below shows a sample from a simple Syslog Server application.
Values
0.0.0.0
© Microhard Systems Inc.
Image 4-1-3: System Settings > Syslog Server Example
System Log Server Port
Enter the UDP port number on the Syslog Server where the actual service is running. Consult with the documentation of your chosen
Syslog Server for the correct port number. The most common port is
514, which has been set as the default.
Values (UDP Port #)
514
28
4.0 Configuration
Time Settings
The IPn4G can be set to use a local time source, thus keeping time on its own, or it can be configured to synchronize the date and time via a NTP Server. The options and menus available will change depending on the current setting of the Date and Time Setting Mode, as seen below.
Network Time Protocol (NTP) can be used to synchronize the time and date or computer systems with a centralized, referenced server. This can help ensure all systems on a network have the same time and date.
Image 4-1-3: System Settings > Time Settings
Date and Time Setting Mode
Select the Date and Time Setting Mode required. If set for ‘Use Local
Time’ the unit will keep its own time and not attempt to synchronize with a network server. If ‘Synchronize Date And Time Over Network’ is selected, a NTP server can be defined.
Values (selection)
Use Local Time Source
Synchronize Date And Time
Over Network
Date
The calendar date may be entered in this field. Note that the entered value is lost should the IPn4G lose power for some reason. (Only displayed if set to ‘Use Local Time Source’)
Values
(yyyy-mm-dd)
2014.12.17 (varies)
Time
The time may be entered in this field. Note that the entered value is lost should the VIP Series lose power for some reason. (Only displayed if set to ‘Use Local Time Source’)
Values
(hh:mm:ss)
13:27:28 (varies)
If connecting to a NTP time server, specify the timezone from the dropdown list.
© Microhard Systems Inc.
Timezone
Values
(selection)
(varies)
29
4.0 Configuration
This displays the POSIX TZ String used by the unit as determined by the timezone setting.
POSIX TZ String
Values
(read only)
(varies)
By default the modem only synchronizes the time and date during system boot up (default: 0), but it can be modified to synchronize at a regular interval. This process does consume data and should be set accordingly.
NTP Client Interval
Values
(seconds)
0
Enter the IP Address or domain name of the desired NTP time server.
Enter the IP Address or domain name of the desired NTP time server.
NTP Server
Values
(address)
pool.ntp.org
NTP Port
Values
(port#)
123
Web Configuration Settings
The last section of the System Setting menu allows the configuration of the HTTP and HTTPS
Ports used for the web server of the WEBUI.
Image 4-1-4: System Settings > Web Configuration Settings
Select the type of web protocol used for the WebUI configuration.
Select between HTTP (basic) and HTTPS (SSL, secure), or Both that are running on the modem.
Web Protocol
Values
(port#)
HTTP / HTTPS / BOTH
© Microhard Systems Inc.
The default web server ports for the web based configuration tools for
HTTP is TCP:80 and for HTTPS is TCP:443. If changes are required, keep in mind it must be specified in a internet browser to access the unit. (example: http://192.168.168.1:8080).
It may be required to configure Firewall rules to allow modified port numbers that have been changed from the defaults.
HTTP / HTTPS Port
Values
(port#)
HTTP: 80
HTTPS:443
30
4.0 Configuration
4.1.3 System > Access Control
Password Change
The Password Change menu allows the password of the user ‘admin’ to be changed. The
‘admin’ username cannot be deleted, but additional users can be defined and deleted as required as seen in the Users menu below.
Image 4-1-5: Access Control > Password Change
Enter a new password for the ‘admin’ user. It must be at least 5 characters in length. The default password for ‘admin’ is ‘admin’.
New Password
Values (characters) admin min 5 characters
The exact password must be entered to confirm the password change, if there is a mistake all changes will be discarded.
Confirm Password
Values (characters) admin min 5 characters
© Microhard Systems Inc. 31
4.0 Configuration
4.1.3 System > Access Control
Users
Different users can be set up with customized access to the WebUI. Each menu or tab of the
WebUI can be disabled on a per user basis as seen below.
© Microhard Systems Inc.
Image 4-1-6: Access Control > Users
Enter the desired username. Minimum or 5 character and maximum of
32 character. Changes will not take effect until the system has been restarted.
Username
Values (characters)
(no default)
Min 5 characters
Max 32 characters
Password / Confirm Password
Passwords must be a minimum of 5 characters. The Password must be re-entered exactly in the Confirm Password box as well.
Values (characters)
(no default) min 5 characters
32
4.0 Configuration
4.1.4 System > Services
Available Services
Certain services in the IPn4G can be disabled or enabled for either security considerations or resource/power considerations. The Enable/Disable options are applied after a reboot and will take affect after each start up. The Start/Restart/Stop functions only apply to the current session and will not be retained after a power cycle.
Image 4-1-7: System > Services
The IPn4G has the ability to turn off the RSSI LED’s. The RSSI value can still be read from the unit, but the status will not be visible on the unit itself .
RSSI LED
Values (selection)
Start / Restart / Stop
For testing purposes the IPn4G has an internal iperf server that can be used to test unit performance. The user must install a iperf client to use this functionality.
Throughput Test Server
Values (selection)
Start / Restart / Stop
Using the SSH Service Enable/Disable function, you can disable the
SSH service (Port 22) from running on the IPn4G.
SSH Service
Values (selection)
Start / Restart / Stop
© Microhard Systems Inc. 33
4.0 Configuration
Using the Telnet Service Enable/Disable function, you can disable the
Telnet service (Port 23) from running on the IPn4G.
Telnet Service
Values (characters)
Start / Restart / Stop
Using the FTP Service Enable/Disable function, you can disable the
FTP service (Port 21) from running on the IPn4G. This port is reserved for internal use / future use.
FTP Server
Values (selection)
Start / Restart / Stop
Custom SSH Port. Reserved for internal use.
Microhard Sh
Values (selection)
Start / Restart / Stop
© Microhard Systems Inc. 34
4.0 Configuration
4.1.5 System > Maintenance
Version Information
Detailed version information can be found on this display. The Product Name, Firmware
Version, Hardware Type, Build Version, Build Date and Build Time can all be seen here, and may be requested from Microhard Systems to provide technical support.
Image 4-1-8: Maintenance > Version Information / Firmware Upgrade
Firmware Upgrade
Occasional firmware updates may be released by Microhard Systems which may include fixes and/or new features. The firmware can be updated wirelessly using the WebUI.
Erase Current Configuration
Check this box to erase the configuration of the IPn4G unit during the upgrade process. This will upgrade, and return the unit to factory defaults, including the default IP Addresses and passwords. Not checking the box will retain all settings during a firmware upgrade procedure.
Values (check box) unchecked
Use the Browse button to find the firmware file supplied by Microhard
Systems. Select “Upgrade Firmware” to start the upgrade process.
This can take several minutes.
Firmware Image
Values (file)
(no default)
© Microhard Systems Inc. 35
4.0 Configuration
4.1.5 System > Maintenance
Reset to Default
The IPn4G may be set back to factory defaults by using the Reset to Default option under
System > Maintenance > Reset to Default. *Caution* - All settings will be lost!!!
© Microhard Systems Inc.
Image 4-1-9: Maintenance > Reset to Default / Backup & Restore Configuration
Backup & Restore Configuration
The configuration of the IPn4G can be backed up to a file at any time using the Backup
Configuration feature. The file can the be restored using the Restore Configuration feature. It is always a good idea to backup any configurations in case of unit replacement. The configuration files cannot be edited offline, they are used strictly to backup and restore units.
Name this Configuration / Backup Configuration
Use this field to name the configuration file. The .config extension will automatically be added to the configuration file.
Restore Configuration file / Check Restore File / Restore
Use the ‘Browse’ button to find the backup file that needs to be restored to the unit. Use the ‘Check
Restore File’ button to verify that the file is valid, and then the option to restore the configuration is displayed, as seen above. The option is available to keep the current carrier settings rather than replace them with the settings contained in the Config file.
36
4.0 Configuration
4.1.6 System > Logout
The logout function allows a user to end the current configuration session and prompt for a login screen.
Image 4-1-10: System > logout
© Microhard Systems Inc. 37
4.0 Configuration
4.1.7 System > Reboot
The IPn4G can be remotely rebooted using the System > Reboot menu. As seen below a button
‘OK, reboot now’ is provided. Once pressed, the unit immediately reboots and starts its boot up procedure.
Image 4-1-11: System > Reboot
© Microhard Systems Inc. 38
4.0 Configuration
4.2 Network
4.2.1 Network > Status
The Network Status display gives a overview of the currently configured network interfaces including the Connection Type (Static/DHCP), IP Address, Net Mask, Default Gateway, DNS, and IPv4 Routing Table.
© Microhard Systems Inc.
Image 4-2-1: Network > Network Status
39
4.0 Configuration
4.2.2 Network > LAN
Network LAN Configuration
The Ethernet port (RJ45) on the back of the IPn4G is the LAN port, used for connection of devices on a local network. By default, this port has a static IP Address of 192.168.168.1. It also, by default is running a DHCP server to provide IP Addresses to devices that are connected to the physical port, and devices connected by a WiFi connection (if equipped).
DHCP: Dynamic Host
Configuration Protocol may be used by networked devices
(Clients) to obtain unique network addresses from a
DHCP server.
Advantage:
Ensures unique IP addresses are assigned, from a central point
(DHCP server) within a network.
Disadvantage:
The address of a particular device is not
‘known’ and is also subject to change.
STATIC addresses must be tracked (to avoid duplicate use), yet they may be permanently assigned to a device.
Image 4-2-2: Network > LAN
LAN Add/Edit Interface
The IPn4G has the capability to have multiple SSID’s for the WiFi radio (optional). New
Interfaces can be added for additional SSID’s, providing, if required, separate subnets for each
SSID. By default any additional interfaces added will automatically assign IP addresses to connecting devices via DHCP. Additional interfaces can only be used by additional WIFI SSID’s
(virtual interfaces).
© Microhard Systems Inc.
Image 4-2-3: Network > Add/Edit LAN Interface
40
4.0 Configuration
Within any IP network, each device must have its own unique IP address.
Spanning Tree (STP) is used by default to detect and prevent any loops from occurring.
A SUBNET MASK is a bit mask that separates the network and host (device) portions of an IP address.
The ‘unmasked’ portion leaves available the information required to identify the various devices on the subnet.
This selection determines if the IPn4G will obtain an IP address from a DHCP server on the attached network, or if a static IP address will be entered. If a Static IP Address is chosen, the fields that follow must also be populated.
If ‘Static’ Connection Type is selected, a valid IPv4 Address for the network being used must be entered in the field. If ‘DHCP’ is chosen this field will not appear and it will be populated automatically from the DHCP server.
Spanning Tree (STP)
Values (selection)
On
Off
Connection Type
Values (selection)
DHCP
Static
IP Address
Values (IP Address)
192.168.168.1
A GATEWAY is a point within a network that acts as an entrance to another network.
In typical networks, a router acts as a gateway.
If ‘Static’ Connection Type is selected, the Network Mask must be entered for the Network. If ‘DHCP’ is chosen this field will not appear and it will be populated automatically from the
DHCP server.
If the IPn4G is integrated into a network which has a defined gateway, then, as with other hosts on the network, this gateway’s IP address will be entered into this field. If there is a
DHCP server on the network, and the Connection Type (see previous page) is selected to be DHCP, the DHCP server will populate this field with the appropriate gateway address.
DNS: Domain Name
Service is an Internet service that translates easily- remembered domain names into their not-so-easily- remembered IP addresses.
Being that the Internet is based on IP addresses, without DNS, if one entered the domain name www.microhardcorp.com
(for example) into the
URL line of a web browser, the website
‘could not be found’).
A simple way of looking at what the gateway value should be is: If a device has a packet of data is does not know where to send, send it to the gateway. If necessary - and applicable - the gateway can forward the packet onwards to another network.
DNS (Domain Name Service) Servers are used to resolve domain names into IP addresses. If the Connection Type is set for DHCP the DHCP server will populate this field and the value set can be viewed on the Network > Status page.
Values (IP Address)
255.255.255.0
(no default)
Netmask
Default Gateway
Values (IP Address)
LAN DNS Servers
Values (IP Address)
(no default)
© Microhard Systems Inc. 41
4.0 Configuration
Prior to enabling this service, verify that there are no other devices - either wired (e.g. LAN) or wireless (e.g. another VIP
Series unit) with an active
DHCP SERVER service.
(The Server issues IP address information at the request of a DHCP Client, which receives the information.)
LAN DHCP
A IPn4G may be configured to provide dynamic host control protocol (DHCP) service to all attached (either wired or wireless (WiFi)-connected) devices. By default the DHCP service is enabled, so devices that are connected to the physical Ethernet LAN ports, as well as any devices that are connected by WiFi will be assigned an IP by the IPn4G. The LAN DHCP service is available for each interface, and is located in the add/edit interface menus.
© Microhard Systems Inc.
Image 4-2-4: Network > Add/Edit Interface DHCP
The option is used to enable or disable the DHCP service for devices connected to the LAN Port and devices connected through a Wireless connection. This includes VIP connected as clients and other wireless devices such as 802.11 connections.
Values (selection)
On / Off
DHCP
Select the starting address DHCP assignable IP Addresses.
The first octets of the subnet will be pre-set based on the LAN
IP configuration, and can not be changed.
Values (IP Address)
192.168.168.100
Start
Limit
Set the maximum number of IP addresses that can be assigned by the IPn4G.
Values (integer)
150
The DHCP lease time is the amount of time before a new request for a network address must be made to the DHCP
Server.
Lease Time
Values (minutes)
(minutes)
42
4.0 Configuration
Specify an alternate gateway for DHCP assigned devices if the default gateway is not to be used.
Alternate Gateway
Values (IP Address)
(IP Address)
Specify a preferred DNS server address to be assigned to DHCP devices.
Preferred DNS Server
Values (IP Address)
(IP Address)
Specify the alternate DNS server address to be assigned to DHCP devices.
Alternate DNS Server
Values (IP Address)
(IP Address)
Enter the Domain Name for the DHCP devices.
Domain Name
Values (string)
(IP Address)
Enter the address of the WINS/NBNS (NetBIOS) Server. The WINS server will translate computers names into their IP addresses, similar to how a DNS server translates domain names to IP addresses.
WINS/NBNS Servers
Values (IP/Domain)
(no default)
Select the method used to resolve computer names to IP addresses.
Four name resolution methods are available:
B-node: broadcast
P-node: point-to-point
M-node: mixed/modified
H-node: hybrid
WINS/NBT Node Type
Values (selection) none b-node p-node m-node h-node
© Microhard Systems Inc. 43
4.0 Configuration
Static IP Addresses (for DHCP)
In some applications it is important that specific devices always have a predetermined IP address. This section allows for MAC Address binding to a IP Address, so that whenever the device that has the specified MAC address, will always get the selected IP address. In this situation, all attached (wired or wireless) devices can all be configured for DHCP, but still get a known IP address.
© Microhard Systems Inc.
Image 4-2-5: Network > MAC Address Binding
The name field is used to give the device a easily recognizable name.
Enter in the MAC address of the device to be bound to a set IP address. Set the IP Address in the next field. Must use the format: AB:CD:DF:12:34:D3. It is not case sensitive, but the colons must be present.
Name
Values (characters)
(no default)
MAC Address
Values (MAC Address)
(no default)
Enter the IP Address to be assign to the device specified by the
MAC address above.
IP Address
Values (IP Address)
(minutes)
Static Addresses
This section displays the IP address and MAC address currently assigned through the DCHP service, that are bound by it’s MAC address. Also shown is the Name, and the ability to remove the binding by clicking “Remove _______”.
Active DHCP Leases
This section displays the IP Addresses currently assigned through the DCHP service. Also shown is the MAC Address, Name and Expiry time of the lease for reference.
Using the “Release All” button, all DHCP leases are released and any connected devices must request new leases.
44
4.0 Configuration
4.2.3 Network > WIFI
Network WIFI Configuration
The WIFI menu is used to define (if required) a virtual interface in which to bind a WIFI connection. This connection can then be bound to the Wireless Radio in the Wireless > Radio1 menu. If this interface is not bound to the Wireless interface it has no operation or purpose.
The WIFI interface can be used setup a separate WIFI connection for connected devices
(separating them from the devices connected to the LAN), this would be the same as adding another interface under the LAN configuration. In this mode the IPn4G would be operating as a
Access Point (AP) providing network access to any connected devices. A separate DHCP server must be defined if it is required to provide DHCP services to connecting devices.
In most cases the WIFI interface would be setup to allow the IPn4G to operate as a Client to another Access Point (AP). Using this menu it can be decided to use DHCP to obtain an IP address and related networking information from the connected Access Point, or it could be setup with a static IP address that is part of the AP’s network.
When connected as a Client the IPn4G would be able to use the WIFI network for data rather than the cellular connection. However unless an appropriate default route(s) was set to manage this connection there would be no way to predict which interface is used for
data.
Image 4-2-2: Network > WIFI
WIFI Configuration
The description of each of the parameters for setting up a WIFI interface is identical to those of adding/editing a virtual LAN interface, which is discussed in the last section.
© Microhard Systems Inc. 45
4.0 Configuration
4.2.4 Network > Routes
Static Routes Configuration
It may be desirable to have devices on different subnets to be able to talk to one another. This can be accomplished by specifying a static route, telling the IPn4G where to send data.
© Microhard Systems Inc.
Image 4-2-6: Network > Routes
Routes can be names for easy reference, or to describe the route being added.
Enter the network IP address for the destination.
Specify the Gateway used to reach the network specified above.
Name
Values (characters)
(no default)
Destination
Values (IP Address)
(192.168.168.0)
Gateway
Values (IP Address)
192.168.168.1
Enter the Netmask for the destination network.
Netmask
Values (IP Address)
255.255.255.0
46
4.0 Configuration
In some cases there may be multiple routes to reach a destination.
The Metric can be set to give certain routes priority, the lower the metric is, the better the route. The more hops it takes to get to a destination, the higher the metric.
Values (Integer)
0
Metric
Define the exit interface. Is the destination a device on the LAN, or the
WAN (for the IPn4G would be the cellular connection)?
Interface
Values (Selection)
LAN
WAN (4G)
WIFI
None
© Microhard Systems Inc. 47
4.0 Configuration
4.2.5 Network > GRE
GRE Configuration
The IPn4G supports GRE (Generic Routing Encapsulation) Tunneling which can encapsulate a wide variety of network layer protocols not supported by traditional VPN. This allows IP packets to travel from one side of a GRE tunnel to the other without being parsed or treated like IP packets.
working example of how to setup GRE on your
Image 4-2-7: Network > GRE Summary
© Microhard Systems Inc.
Image 4-2-8: Network > Edit/Add GRE Tunnel
Each GRE tunnel must have a unique name. Up to 10 GRE tunnels are supported by the IPn4G.
Values (Chars(32)) gre
Name
48
4.0 Configuration
Enable / Disable the GRE Tunnel.
Enable / Disable Multicast support over the GRE tunnel.
Enable
Values (selection)
Disable / Enable
Multicast
Values (selection)
Disable / Enable
TTL
Set the TTL (Time-to-live) value for packets traveling through the GRE tunnel.
Values (value)
1 - 255
Key
Enter a key is required, key must be the same for each end of the GRE tunnel.
Values (chars)
(none)
Enable / Disable ARP (Address Resolution Protocol) support over the GRE tunnel.
ARP
Values (selection)
Disable / Enable
Local Setup
The local setup refers to the local side of the GRE tunnel, as opposed to the remote end.
This is the WAN IP Address of the IPn4G, this field should be populated with the current WAN IP address.
Gateway IP Address
Values (IP Address)
(varies)
This is the IP Address of the local tunnel.
Enter the subnet mask of the local tunnel IP address.
Tunnel IP Address
Values (IP Address)
(varies)
Netmask
Values (IP Address)
(varies)
© Microhard Systems Inc. 49
4.0 Configuration
Enter the subnet address for the local network.
The subnet mask for the local network/subnet.
Subnet IP Address
Values (IP Address)
(varies)
Subnet Mask
Values (IP Address)
(varies)
Remote Setup
The remote setup tells the IPn4G about the remote end, the IP address to create the tunnel to, and the subnet that is accessible on the remote side of the tunnel.
Enter the WAN IP Address of the IPn4G or other GRE supported device in which a tunnel is to be created with at the remote end.
Gateway IP Address
Values (IP Address)
(varies)
The is the IP Address of the remote network, on the remote side of the
GRE Tunnel.
Subnet IP Address
Values (IP Address)
(varies)
The is the subnet mask for the remote network/subnet.
Subnet Mask
Values (IP Address)
(varies)
IPsec Setup
Refer to the IPsec setup in the VPN Site to Site section of the manual for more information.
© Microhard Systems Inc. 50
4.0 Configuration
SNMP: Simple Network
Management Protocol provides a method of managing network devices from a single PC running network management software.
Managed networked devices are referred to as
SNMP agents.
4.2.6 Network > SNMP
The IPn4G may be configured to operate as a Simple Network Management Protocol (SNMP) agent. Network management is most important in larger networks, so as to be able to manage resources and measure performance. SNMP may be used in several ways:
configure remote devices
monitor network performance
detect faults
audit network usage
detect authentication failures
A SNMP management system (a PC running SNMP management software) is required for this service to operate. This system must have full access to the IPn4G. Communications is in the form of queries (information requested by the management system) or traps (information initiated at, and provided by, the SNMP agent in response to predefined events).
Objects specific to the IPn4G are hosted under private enterprise number 21703.
An object is a variable in the device and is defined by a Management Information Database
(MIB). Both the management system and the device have a copy of the MIB. The MIB in the management system provides for identification and processing of the information sent by a device (either responses to queries or device-sourced traps). The MIB in the device relates subroutine addresses to objects in order to read data from, or write data to, variables in the device.
An SNMPv1 agent accepts commands to retrieve an object, retrieve the next object, set and object to a specified value, send a value in response to a received command, and send a value in response to an event (trap).
SNMPv2c adds to the above the ability to retrieve a large number of objects in response to a single request.
SNMPv3 adds strong security features including encryption; a shared password key is utilized.
Secure device monitoring over the Internet is possible. In addition to the commands noted as supported above, there is a command to synchronize with a remote management station.
The pages that follow describe the different fields required to set up SNMP on the IPn4G. MIBS may be requested from Microhard Systems Inc.
The MIB file can be downloaded directly from the unit using the ‘Get MIB File’ button on the
Network > SNMP menu.
© Microhard Systems Inc. 51
4.0 Configuration
SNMP Settings
Image 4-2-9: Network > SNMP
SNMP Operation Mode
If disabled, an SNMP service is not provided from the device.
Enabled, the device - now an SNMP agent - can support SNMPv1, v2,
& v3.
Values (selection)
Disable / V1&V2c&V3
Read Only Community Name
Effectively a plain-text password mechanism used to weakly authenticate SNMP queries. Being part of the community allows the
SNMP agent to process SNMPv1 and SNMPv2c requests. This community name has only READ priority.
Values (string) public
Read Only Community Name
Also a plain-text password mechanism used to weakly authenticate
SNMP queries. Being part of the community allows the SNMP agent to process SNMPv1 and SNMPv2c requests. This community name has only READ/WRITE priority.
Values (string) private
© Microhard Systems Inc.
Defines the user name for SNMPv3.
SNMP V3 User Name
Values (string)
V3user
52
4.0 Configuration
Defines accessibility of SNMPv3; If Read Only is selected, the
SNMPv3 user may only read information; if Read Write is selected, the SNMPv3 user may read and write (set) variables.
V3 User Read Write Limit
Values (selection)
Read Only / Read Write
V3 User Authentication Level
Defines SNMPv3 user’s authentication level:
NoAuthNoPriv: No authentication, no encryption.
AuthNoPriv: Authentication, no encryption.
AuthPriv: Authentication, encryption. (Not supported)
Values (selection)
NoAuthNoPriv
AuthNoPriv
AuthPriv (Not supported)
V3 User Authentication Password
SNMPv3 user’s authentication password. Only valid when V3 User
Authentication Level set to AuthNoPriv or AuthPriv (Not supported).
Values (string)
00000000
V3 User Privacy Password
SNMPv3 user’s encryption password. Only valid when V3 User
Authentication Level set to AuthPriv (see above). Authpriv is currently not supported on the IPn4G(b).
Values (string)
00000000
Select which version of trap will be sent should a failure or alarm condition occur.
SNMP Trap Version
Values (string)
V1 Traps V2 Traps
V3 Traps V1&V2 Traps
V1&V2&V3 Traps
If enabled, an authentication failure trap will be generated upon authentication failure.
Auth Failure Traps
Values (selection)
Disable / Enable
The community name which may receive traps.
Trap Community Name
Values (string)
TrapUser
Defines a host IP address where traps will be sent to (e.g. SNMP management system PC IP address).
Trap Manage Host IP
Values (IP Address)
0.0.0.0
© Microhard Systems Inc. 53
4.0 Configuration
4.2.7 Network > sdpServer sdpServer Settings
Microhard Radio employ a discovery service that can be used to detect other Microhard Radio’s on a network. This can be done using a stand alone utility from Microhard System’s called ‘IP
Discovery’ or from the Tools > Discovery menu. The discovery service will report the MAC
Address, IP Address, Description, Product Name, Firmware Version, Operating Mode, and the
SSID.
Image 4-2-10: Network > sdpServer Settings
Use this option to disable or enable the discovery service.
Discovery Service Status
Values (selection)
Disable / Discoverable /
Changable
Specify the port running the discovery service on the IPn4G unit.
Server Port Settings
Values (Port #)
20097
© Microhard Systems Inc. 54
4.0 Configuration
4.2.8 Network > Local Monitor
The Local Device Monitor allows the IPn4G to monitor a local device connected locally to the
Ethernet port or to the locally attached network. If the IPn4G cannot detect the specified IP or a
DHCP assigned IP, the unit will restart the DHCP service, and eventually restart the modem to attempt to recover the connection.
Image 4-2-11: Network Configuration , Local Monitor
Enable or disable the local device monitoring service.
Status
Values (selection)
Disable / Enable
Select the IP mode. By selecting a fixed IP address the service will monitor the connection to that specific IP. If auto detect is selected, the IPn4G will detect and monitor DHCP assigned IP address.
IP Mode
Values (selection)
Fixed local IP
Auto Detected IP
This field is only shown if Fixed Local IP is selected for the IP Mode. Enter the static IP to be monitored in this field.
Local IP Setting
Values (IP)
0.0.0.0
The status timeout is the maximum time the IPn4G will wait to detect the monitored device. At this time the IPn4G will restart the DHCP service. (5-
65535 seconds)
Status Timeout
Values (seconds)
10
Waiting DHCP Timeout
This field defines the amount of time the IPn4G will wait to detect the monitored device before it will reboot the modem. (30-65535 seconds)
Values (seconds)
60
© Microhard Systems Inc. 55
4.0 Configuration
4.2.9 Network > Port
Ethernet Port Configuration
This menu shows the current status and allows the configuration of the Ethernet Port (LAN).
© Microhard Systems Inc.
Image 4-2-11: Network > Ethernet Port Configuration
Select between Auto, where the IPn4G will decide the best port settings based on a negotiation with the connected device. It can also be set to manual where the Speed and Duplex can be set manually.
Mode
Values (selection)
Auto / Manual
If the mode above is set to manual it is possible to select the speed at which the LAN port is to operate. Chose between 10MBit/s or 100Mbit/s.
If the mode above is set to manual it is possible to select the duplex mode of the Ethernet port. Choose between Full and Half duplex.
Speed
Values (selection)
100Mbit/s / 10Mbit/s
Duplex
Values (selection)
Full / Half
Ethernet Port Status
The Ethernet Port Status shows the current status of the Ethernet port, and in the case of ‘Auto’, will also show the current port configuration.
56
4.0 Configuration
4.3 Carrier
4.3.1 Carrier > Status
The Carrier Status window provides complete overview information related to the Cellular Carrier portion of the IPn4G . A variety of information can be found here, such as Activity Status, Network (Name of Wireless
Carrier connected) , Data Service Type (WCDMA/HSPA/HSPA+/LTE etc), Frequency band, Phone
Number etc.
Image 4-3-1: Carrier > Status
Not all statistics parameters displayed are applicable.
The Received and Transmitted bytes and packets indicate the respective amount of data which has been moved through the radio.
The Error counts reflect those having occurred on the wireless link.
© Microhard Systems Inc. 57
4.0 Configuration
4.3 Carrier
4.3.2 Carrier > Settings
The Carrier Menu provides all the options for configuring the IPn4G to communicate with a
Cellular Carrier. In addition to setting up the SIM card, there are several tools such as the Traffic
Watchdog and Data Usage Alerts that can be used to ensure your modem is functioning and performing as required. The parameters within the Carrier Configuration menu must be input properly; they are the most basic requirement required by your cellular provider for network connectivity.
© Microhard Systems Inc.
Image 4-3-2: Carrier > Settings
Carrier Status is used to Enable or Disable the connection to the
Cellular Carrier. By default this option is enabled.
Carrier Status
Values (Selection)
Enable / Disable
Data Roaming
Values (Selection) This option is used to prevent the modem from roaming. This is important as there is usually a significant charge for roaming data. This option can be used to prevent this from happening. This is generally used in mobile applications.
Enable / Disable
58
4.0 Configuration
In some cases, a user may want to lock onto certain carrier to avoid data roaming. There were four options presented to a user to choose from, Auto, SIM based, Scan & Select and Fixed.
Auto will allow the IPn4G to pick the carrier automatically. Data roaming is permitted.
SIM based will only allow the IPn4G to connect to the network indicated by the SIM card used in the unit.
Manual will scan for available carriers and allow a user to select from the available carriers. It takes 2 to 3 minutes to complete a scan.
Fixed allows a user to enter the carrier code (numerical) directly and then the
IPn4G will only connect to that carrier.
Carriers
Values (Selection)
Auto
Based on SIM
Manual
Fixed
IP pass-through allows the WAN IP address to be assigned to the device connected to the RJ45 LAN Port. In this mode the IPn4G is for
the most part transparent and forwards all traffic to the device connected to the Ethernet port except that listed below:
The WebUI port (Default Port:TCP 80), this port is retained for remote management of the IPn4G. This port can be changed to a different port under the System > Settings Menu.
The SNMP Listening Port (Default Port: UDP 161).
Refer to the Appendix for an example of how to configure IP-Passthrough.
IP-Passthrough
Values (selection)
Disable
Ethernet
This field is only visible once IP Passthrough has been selected above. This gives the user the option to manually configure the IP-
Passthrough feature of the modem. (It is recommended to only use this option if you are an advanced user and the automatic settings do not work for your application or carrier)
IP-Passthrough Mode
Values (selection)
Auto / Manual
IP-Passthrough Gateway
This field is used to specify the Gateway to be used for IP Passthrough if set to manual mode. As mentioned above it is recommended to use the Auto mode for IP-Passthrough.
Values
(no default)
IP-Passthrough Netmask
This field is used to specify the Netmask to be used for IP Passthrough if set to manual mode. As mentioned above it is recommended to use the Auto mode for IP-Passthrough.
Values
(no default)
© Microhard Systems Inc.
IP-Passthrough Local IP
This is a read only field that displays the current IP address assigned by the cellular carrier that will be assigned (DHCP) or needs to be configured (Static) on the attached device.
Values (selection)
(current carrier IP to be assigned to attached device).
59
4.0 Configuration
When enabled DNS-Passthrough will pass on the WAN assigned DNS information to the end device.
DNS-Passthrough
Values (selection)
Enable / Disable
APN (Access Point Name)
The APN is required by every Carrier in order to connect to their networks. The APN defines the type of network the IPn4G is connected to and the service type. Most Carriers have more than one
APN, usually many, dependant on the types of service offered.
Values (characters) auto
Auto APN (default) may allow the unit to quickly connect to a carrier, by cycling through a predetermined list of common APN’s. Auto APN will not work for private APN’s or for all carriers.
The SIM Pin is required for some international carriers. If supplied and required by the cellular carrier, enter the SIM Pin here.
SIM Pin
Values (characters)
(none)
Set to ALL by default, the Technologies field allows the selection of
3GPP technologies (LTE), and or 3GPP2 technology (CDMA).
Technologies Type
Values (selection)
ALL / 3GPP / 3GPP2
The Technologies Mode option allows a user the ability to specify what type of Cellular networks to connect to.
Technologies Mode
Values (selection)
AUTO / LTE Only / WCDMA
Only / GSM Only
Sets the modems connect string if required by the carrier. Not usually required in North America.
Data Call Parameters
Values (string)
(none)
If let blank the IPn4G with use the DNS server as specified automatically by the service provider.
Primary DNS Address
Values (IP Address)
(none)
© Microhard Systems Inc. 60
4.0 Configuration
If let blank the IPn4G with use the DNS server as specified automatically by the service provider.
Secondary DNS Address
Values (IP Address)
(none)
Primary NetBIOS Name Server
Enter the Primary NetBIOS Name Server if required by the carrier. Values (IP Address)
(none)
Secondary NetBIOS Name Server
Enter the Secondary NetBIOS Name Server if required by the carrier. Values (IP Address)
(none)
In some cases the Static IP address must be entered in this field if assigned by a wireless carrier. In most cases the IP will be read from the SIM card and this field should be left at the default value.
(none)
IP Address
Values (IP Address)
Sets the authentication type required to negotiate with peer.
PAP - Password Authentication Protocol.
CHAP - Challenge Handshake Authentication Protocol.
Authentication
Values (Selection)
Device decide (AUTO)
PAP
CHAP
A User Name may be required for authentication to a remote peer. Although usually not required for dynamically assigned IP addresses from the wireless carrier, but required in most cases for static IP addresses. Varies by carrier.
User Name
Values (characters)
Carrier/peer dependant
Enter the password for the user name above. May not be required by some carriers, or APN’s
Password
Values (characters)
Carrier/peer dependant
© Microhard Systems Inc. 61
4.0 Configuration
4.3 Carrier
4.3.3 Carrier > Keepalive
The Keep alive tab allows for the configuration of the keep alive features of the IPn4G. The
IPn4G can either do a ICMP or HTTP keep alive by attempting to reach a specified address at a regular interval. If the IPn4G cannot reach the intended destination, it will reset the unit in an attempt to obtain a new connection to the carrier.
© Microhard Systems Inc.
Image 4-3-3: Carrier > Keepalive
Enable or Disable the keep alive functions in the IPn4G.
Select the type of keep alive used. ICMP uses a “ping” to reach a select destination.
Keep Alive Status
Values (Selection)
Enable / Disable
Type
Values (Selection)
ICMP / HTTP
Host Name
Values (IP or Domain)
8.8.8.8
Specify a IP Address or Domain that is used to test the IPn4G connection. (Use the ‘Test’ button to ensure that a reachable host is used.)
The Interval value determines the frequency, or how often, the
IPn4G will send out PING messages to the Host.
The Count field is the maximum number of PING errors such as “Host unreachable” the IPn4G will attempt before the unit will reboot itself to attempt to correct connection issues. If set to zero (0), the unit will never reboot itself.
Interval
Values (seconds)
300
Count
Values (number)
10
62
4.0 Configuration
4.3 Carrier
4.3.4 Carrier > Traffic Watchdog
The Wireless Traffic Watchdog will detect if there has been no wireless traffic, or communication with the Cellular carrier for a configurable amount of time. Once that time has elapsed, the unit will reset, and attempt to re-establish communication with the cellular carrier.
Image 4-3-4: Carrier > Traffic Watchdog
Enable or Disable the Traffic Watchdog.
The Check Interval tells the IPn4G how often (in seconds) to check for wireless traffic to the cellular carrier. (1-60000 seconds)
The Reboot Timer will reset the unit if there has been no
Cellular RF activity in the configured time. (300 –60000 seconds)
Traffic Watchdog
Values (Selection)
Enable / Disable
Check Interval
Values (seconds)
1
Reboot Time Limit
Values (seconds)
600
© Microhard Systems Inc. 63
4.0 Configuration
4.3 Carrier
4.3.5 Carrier > Dynamic DNS
Unless a carrier issues a Static IP address, it may be desirable to use a dynamic DNS service to track dynamic IP changes and automatically update DNS services. This allows the use of a constant resolvable host name for the IPn4G.
© Microhard Systems Inc.
Image 4-3-5: Carrier > Traffic Watchdog
This selection allows the use of a Dynamic Domain Name
Server (DDNS), for the IPn4G.
This is a list of supported Dynamic DNS service providers. Free and premium services are offered, contact the specific providers for more information.
‘customized_ddns’ can be selected to configure your own
DDNS service if required.
DDNS Status
Values (Selection)
Enable / Disable
Service
Values (selection) changeip dyndns eurodyndns hn noip ods ovh regfish tzo zoneedit
Enter a valid user name for the DDNS service selected above.
Enter a valid password for the user name of the DDNS service selected above.
This is the host or domain name for the IPn4G as assigned by the DDNS provider.
User Name
Values (characters)
(none)
Password
Values (characters)
(none)
Host
Values (domain name)
(none)
64
4.0 Configuration
4.3 Carrier
4.3.6 Carrier > SMS Config
SMS messages can be used to remotely reboot or trigger events in the IPn4G. SMS alerts can be set up to get SMS messages based on system events such as Roaming status, RSSI,
Ethernet Link Status or IO Status.
System SMS Command
Image 4-3-6: SMS > SMS Configuration
This option allows a user to enable or disable to use of the following SMS commands to reboot or trigger events in the
IPn4G:
MSC#REBOOT Reboot system
MSC#NMS Send NMS UDP Report
MSC#WEB Send web client inquiry
MSC#MIOP1 open I/O ouput1
MSC#MIOP2 open I/O ouput2
MSC#MIOP3 open I/O ouput3
MSC#MIOP4 open I/O ouput4
MSC#MIOC1 close I/O ouput1
MSC#MIOC2 close I/O ouput2
MSC#MIOC3 close I/O ouput3
MSC#MIOC4 close I/O ouput4
MSC#EURD0 trigger event report0
MSC#EURD1 trigger event report1
MSC#EURD2 trigger event report2
MSC#EURD3 trigger event report3
MSC#GPSR0 trigger gps report0
MSC#GPSR1 trigger gps report1
MSC#GPSR2 trigger gps report2
MSC#GPSR3 trigger gps report3
SMS Commands are case sensitive.
Status
Values (Selection)
Enable / Disable
If enabled, the IPn4G will only accept and execute commands originating from the phone numbers in the Phone Filter List. Up to 6 numbers can be added.
Set Phone Filter
Values (Selection)
Enable / Disable
© Microhard Systems Inc. 65
4.0 Configuration
System SMS Alerts
© Microhard Systems Inc.
Image 4-3-7: SMS > SMS Alerts
Enable SMS Alerts. IF enabled SMS alerts will be send when conditions are met as configured to the phone numbers listed.
Status
Values (Selection)
Enable / Disable
SMS Alerts can be sent to up to 6 different phone numbers that are listed here.
Received Phone Numbers
Values (Selection)
(no default)
SMS alerts, when active, will be sent out at the frequency defined here.
A text field that allows up to 30 characters to add an alias or other information that will be included with the SMS message.
Time Interval(s)
Values (Seconds)
300
Device Alias
Values (characters)
300
66
4.0 Configuration
Enable or disable the RSSI alerts.
RSSI Check
Values (Selection)
Disable RSSI check
Enable RSSI check
Set the low threshold for RSSI alerts. When the RSSI drops below this value, an alert will be sent indicating poor service.
Enable or disable SMS Alerts for Roaming Status.
The IPn4G can send alerts based on the roaming status. Data rates during roaming can be expensive and it is important to know when a device has started roaming.
Low Threshold (dBm)
Values (dBm)
-99
Carrier Network
Values (Selection)
Disable Roaming Check
Enable Roaming Check
Home / Roaming Status
Values (Selection)
In Roaming
Changed or In Roaming
Changed to Roaming
Enable or disable SMS Alerts for the Ethernet Link status of the
LAN RJ45 port.
The status of the Ethernet Link of the LAN (RJ45) can be used to send SMS Alerts. The link status may indicate an issue with the connected device.
SMS Alerts can be sent based on the state changes of the
Digital I/O lines.
Ethernet
Values (Selection)
Disable Ethernet check
Enable Ethernet check
Ethernet Link Status
Values (Selection)
Changed
In no-link
Changed or in no-link
Changed to no-link
I/O Status
Values (Selection)
Disable IO Check
Enable: INPUT Changed
Enable: Output Changed
Enable: INPUT or OUTPUT
Changed.
© Microhard Systems Inc. 67
4.0 Configuration
4.3 Carrier
4.3.7 Carrier > SMS
SMS Command History
The SMS menu allows a user to view the SMS Command History and view the SMS messages on the SIM Card.
Image 4-3-8: SMS > SMS Command History
Send SMS Message
The SMS messages can be sent directly from the IPn4G WebUI interface. Also, the SMS message history can be viewed.
© Microhard Systems Inc.
Image 4-3-9: SMS > SMS Send
68
4.0 Configuration
4.3.8 Carrier > Data Usage
The Data Usage tool on the IPn4G allows users to monitor the amount of cellular data consumed. Since cellular devices are generally billed based on the amount of data used, alerts can be triggered by setting daily and/or monthly limits. Notifications can be sent using SMS or
Email, allowing a early warning if configurable limits are about to be exceeded. The usage data reported by the Data Usage Monitor may not match the data reported by the carrier, but it gives the users an idea of the bandwidth consumed by the IPn4G.
Image 4-3-10: Carrier > Data Usage
If enabled the IPn4G will track the amount of cellular data consumed. If disabled, data is not recorded, even in the Current
Data Usage display.
Status
Values (selection)
Disable
Enable
© Microhard Systems Inc. 69
4.0 Configuration
Monthly/Daily Over Limit
Select the notification method used to send alerts when daily or monthly thresholds are exceeded. If none is selected, notifications will not be sent, but data usage will be recorded for reference purposes.
Values (selection)
None
Send Notice SMS
Send Notice Email
Image 4-3-11: Data Usage > SMS Config
Select the data unit to be used for data usage monitoring.
Monthly/Daily Data Unit
Values (selection)
Bytes / K Bytes / M Bytes
G Bytes
Data Limit
Select the data limit for the day or month, used in connection with the data unit is the previous field. If you want to set the limit to 250
Values (1-65535)
Mbytes, select M Bytes for the data unit, and 250 for the data limit. 500
For Monthly tracking, select the day the billing/data cycles begins.
On this day each month the IPn4G will reset the data usage monitor numbers.
Period Start Day
Values (1-31)
1 (Day of Month)
If SMS is selected as the notification method, enter the phone number to send any SMS messages generated when the data usage exceeds the configured limits.
Phone Number
Values (phone)
+1403
© Microhard Systems Inc.
Image 4-3-12: Data Usage > Email Config
70
4.0 Configuration
If Email is selected as the notification method, enter the desired email subject line for the notification email sent when daily and/or monthly usage limits are exceeded.
Mail Subject
Values (string)
Daily/Monthly Data Usage
Notice
If Email is selected as the notification method, enter the SMTP server details for the account used to send the Email notifications.
Domain or IP address with the associated port as shown.
Mail Server(IP/Name)
Values (xxx:port) smtp.gmail.com:465
If Email is selected as the notification method, enter the username of the Email account used to send Emails.
Username
Values (username)
@gmail.com
If Email is selected as the notification method, enter the password of the Email account used to send Emails. Most email servers require authentication on outgoing emails.
Password
Values (string)
***
Enter the email address of the individual or distribution list to send the email notification to.
Mail Recipient
Values ([email protected])
host@
© Microhard Systems Inc. 71
4.0 Configuration
4.4 Wireless (WiFi)
4.4.1 Wireless > Status
The Status window gives a summary of all radio or wireless related settings and connections.
The General Status section shows the Wireless MAC address of the current radio, the
Operating Mode (Access Point, Client, MESH etc), the SSID being used, frequency channel information and the type of security used.
Traffic Status shows statistics about the transmitted and received data.
The IPn4G shows information about all Wireless connections in the Connection Status section.
The Wireless MAC address, Noise Floor, Signal to Noise ratio (SNR), Signal Strength (RSSI),
The transmit and receive Client Connection Quality (CCQ), TX and RX data rates, and a graphical representation of the signal level or quality.
© Microhard Systems Inc.
Image 4-4-1: Wireless > Status
72
4.0 Configuration
4.4.2 Wireless > Radio1
Radio1 Phy Configuration
The top section of the Wireless Configuration allows for the configuration of the physical radio module. You can turn the radio on or off, and select the channel bandwidth and frequency as seen below.
Image 4-4-2: Wireless > Radio Configuration
This option is used to turn the radio module on or off. If turned off Wireless connections can not be made. The default is On.
Values (selection)
Radio
On / Off
The Mode defines which wireless standard to use for the wireless network. The IPn4G supports 802.11b/g modes as seen here. Select the appropriate operating mode from the list.
Values (selection)
802.11B ONLY
802.11BG
Mode
The Channel-Freq setting allows configuration of which channel to operate on, auto can be chosen where the unit will automatically pick a channel to operate. If a link cannot be established it will try another channel.
© Microhard Systems Inc.
Channel-Freq
2.4 GHz Channels
Auto
Channel 01 : 2.412 GHz
Channel 02 : 2.417 GHz
Channel 03 : 2.422 GHz
Channel 04 : 2.427 GHz
Channel 05 : 2.432 GHz
Channel 06 : 2.437 GHz
Channel 07 : 2.442 GHz
Channel 08 : 2.447 GHz
Channel 09 : 2.452 GHz
Channel 10 : 2.457 GHz
Channel 11 : 2.462 GHz
Channel 12 : 2.467 GHz
73
4.0 Configuration
The Wireless Distance parameter allows a user to set the expected distance the WiFi signal needs to travel. The default is 3km, so the IPn4G will assume that the signal may need to travel up to 3km so it sets various internal timeouts to account for this travel time. Longer distances will require a higher setting, and shorter distances may perform better if the setting is reduced.
Wireless Distance
Values (meters)
3000
Once the RTS Threshold defined packet size is reached, the system will invoke RTS/CTS flow control. A large RTS
Threshold will improve bandwidth, while a smaller RTS
Threshold will help the system recover from interference or collisions caused by obstructions.
RTS Thr (256 ~ 2346)
Values (selection)
On / OFF
Fragment Thr (256 ~ 2346)
The Fragmentation Threshold allows the system to change the maximum RF packet size. Increasing the RF packet size reduces the need to break packets into smaller fragments.
Increasing the fragmentation threshold slightly may improve performance if a high packet error rate is experienced.
Values (selection)
On / OFF
Radio1 Virtual Interface
The bottom section of the Wireless Configuration provides for the configuration of the Operating
Mode of the Wireless Interface, the TX power, Wireless Network information, and Wireless
Encryption. The IPn4G can support multiple virtual interfaces. These interfaces provide different
SSID’s for different users, and can also be assigned to separate subnets (Network Interfaces) to prevent groups from interacting.
© Microhard Systems Inc.
Image 4-4-3: Wireless > Radio1 Virtual Interface Configuration
74
4.0 Configuration
Choose between LAN or WAN for the Virtual Interface. If additional Network Interfaces have been defined in the
Network > LAN section, the Interface name will also appear here.
Network
Values (selection)
LAN
WAN
(Additional Interfaces…)
Values (selection)
Access Point
Client
Repeater
Mesh Point
Mode
Access Point - An Access Point may provide a wireless data connection to many clients, such as stations, repeaters, or other supported wireless devices such as laptops etc.
If more than 1 Virtual Interface (more than 1 SSID) has been defined, the IPn4G can ONLY operate as a Access Point, and will be locked into this mode.
Station/Client - A Station may sustain one wireless connection, i.e. to an Access Point.
Repeater - A Repeater can be connected to an Access Point to extend the range and provide a wireless data connection to many clients, such as stations.
Mesh Point - Units can be configured as a Mesh “Node”. When multiple units are configured as a Mesh node, they automatically establish a network between each other. SSID for each radio in a Mesh network must be the same.
This setting determines the rate at which the data is to be wirelessly transferred.
The default is ‘Auto’ and, in this configuration, the unit will transfer data at the highest possible rate in consideration of the receive signal strength (RSSI).
Setting a specific value of transmission rate has the benefit of
‘predictability’ of that rate, but if the RSSI drops below the required minimum level to support that rate, communications will fail.
802.11 b/g
Auto
1 Mbps (802.11b,g)
2 Mbps (802.11b,g)
5.5 Mbps (802.11b,g)
11 Mbps (802.11b,g)
6 Mbps (802.11g)
9 Mbps (802.11g)
12 Mbps (802.11g)
18 Mbps (802.11g)
24 Mbps (802.11g)
36 Mbps (802.11g)
48 Mbps (802.11g)
54 Mbps (802.11g)
TX Rate
© Microhard Systems Inc. 75
4.0 Configuration
Refer to FCC (or as otherwise applicable) regulations to ascertain, and not operate beyond, the maximum allowable transmitter output power and effective isotropic radiated power
(EIRP).
This setting establishes the transmit power level which will be presented to the antenna connectors at the rear of the IPn4G.
Unless required, the Tx Power should be set not for maximum, but rather for the minimum value required to maintain an adequate system fade margin.
TX Power
Values (selection)
11 dBm
12 dBm
13 dBm
14 dBm
15 dBm
16 dBm
17 dBm
18 dBm
19 dBm
20 dBm
21 dBm
22 dBm
23 dBm
24 dBm
25 dBm
26 dBm
27 dBm
28 dBm
29 dBm
30 dBm
WDS
Wireless distribution system (WDS) is a system enabling the wireless interconnection of access points. WDS preserves the
MAC addresses of client frames across links between access points
Values (selection)
On / Off
SSID: Service Set
Identifier. The ‘name’ of a wireless network. In an open wireless network, the SSID is broadcast; in a closed system it is not.
The SSID must be known by a potential client for it to be able to access the wireless network.
Disabling the SSID broadcast helps secure the wireless network. Enabling the broadcast of the SSID (Network Name) will permit others to ‘see’ the wireless network and perhaps attempt to ‘join’ it.
ESSID Broadcast
Values (selection)
On / Off
When AP Isolation is enabled wireless devices connected to this SSID will not be able to communicate with each other. In other words if the IPn4G is being used as a Hot Spot for many wireless clients, AP Isolation would provide security for those clients by not allowing access to any other wireless device.
AP Isolation
Values (selection)
On / Off
SSID
Change the default value for the Network Name to something unique for your network. Do this for an added measure of security and to differentiate your network from others which may be operating nearby.
All devices connecting to the IPn4G in a given network must use the SSID of the IPn4G. This unique network address is not only a security feature for a particular network, but also allows other networks - with their own unique network address - to operate in the same area without the possibility of undesired data exchange between networks.
Values (string)
wlan0
In Mesh Networks, this must be the same for all IPn4G, or VIP
Series units participating, similar to the SSID for other wireless networks.
Values (string)
(no default)
MESH ID
© Microhard Systems Inc. 76
4.0 Configuration
WEP: Wired Equivalency
Privacy is a security protocol defined in
802.11b. It is commonly available for Wi-Fi networks and was intended to offer the equivalent security of a wired network, however, it has been found to be not as secure as desired.
Operating at the data link and physical layers, WEP does not provide complete end-to-end security.
Security options are dependent on the version type. This section describes all available options. Export versions may not have all optional available to meet regulatory requirements set government policies.
Encryption Type
Values (selection)
Disabled
WEP
WPA (PSK)
WPA2 (PSK)
WPA+WPA2 (PSK)
WEP: Wired Equivalency Protocol (WEP) encryption adds some overhead to the data, thereby negatively effecting throughput to some degree.
The image below shows the associated configuration options:
Image 4-4-4: Encryption Type > WEP
Key Generation
4 complex WEP keys may be generated based on the supplied Passphrase
Procedure: Input a Key Phrase, select the type of Key to be generated using the
Generate Key soft button.
Using the same Passphrase on all IPn4G/VIP Series units within the network will generate the same Keys on all units. All units must operate with the same Key selected.
Alternately, key phrases may be entered manually into each Key field.
WPA: Wi-Fi Protected Access (WPA/WPA2). It provides stronger security than WEP does. The configuration is essentially the same as for WEP (described above), without the option for automatic Key generation.
Check this box to show the currently configured password for
WPA/WPA2 encryption passphrase.
Show Password
Values (selection)
unchecked
© Microhard Systems Inc. 77
4.0 Configuration
4.4.3 Wireless > HotSpot
The Wireless Hotspot configuration is used when providing public hotspot services and it is required to use a server or web based authentication service to verify users.
© Microhard Systems Inc.
Image 4-4-5: Wireless > Hotspot
Use this option to enable or disable the hotspot authentication service.
Hotspot Status
Values (selection)
Enable / Disable
This is the RADIUS name of your Hotspot as given by your
Hotspot Service Provider.
Radius NAS ID
Values
Microhard_1
This field is used to specify which configured network is bonded to the hotspot. Sub networks can be created in the Network >
LAN menu, which are dedicated to the hotspot devices.
*The DHCP service for the network used should be turned off as all IP address assignments will be made by the hotspot service provider.*
Hotspot Network
Values
Varies
78
4.0 Configuration
Specify the IP Address of the Hotspot application. All hotspot clients will get an IP address in the same network as the
Hotspot.
Specify the Netmask of the Hotspot application. All hotspot clients will get an IP address in the same network as the
Hotspot.
Provide your service providers 1st DNS Server address.
As assigned by the Hotspot Service Provider, the name or IP address of the primary RADIUS Server.
As assigned by the Hotspot Service Provider, the name or IP address of the alternate RADIUS Server.
Hotspot IP Address
Values
192.168.182.0
Hotspot Netmask
Values
255.255.255.0
DNS Domain
Values
Key.chillispot.info
Values
Radius Server 1
radius.hotspotsystem.com
Values
Radius Server 2
radius2.hotspotsystem.com
The Radius Authentication Port Number. The default is 1812.
This is provided by your Hotspot service provider.
The Radius Account Port Number. The default is 1813. This is provided by your Hotspot service provider.
As given by your service provider. The address of the UAM
Server, the authentication portal.
Radius Auth Port
Values
1812
Radius Acct Port
Values
1813
Redirect URL
Values https:// customer.hotspotsystem.com/ customer/hotspotlogin.php
© Microhard Systems Inc. 79
4.0 Configuration
This is a secret password between the Redirect URL and the
Hotspot given by the hotspot provider.
Also called a shared key, this is the RADIUS password assigned by you Hotspot provider.
UAM Secret
Values hotsys123
Values hotsys123
Radius Secret
© Microhard Systems Inc. 80
4.0 Configuration
4.5 Comport
4.5.1 Comport > Status
The Status window gives a summary of the serial ports on the IPn4G. The Status window shows if the com port has been enabled, how it is configured (Connect As), and the connection status.
© Microhard Systems Inc.
Image 4-5-1: Comport > Status
81
4.0 Configuration
4.5.2 Comport > COM0/1
This menu option is used to configure the serial device server for the serial communications port. Serial device data may be brought into the IP network through TCP, UDP, or multicast; it may also exit the IPn4G network on another VIP Series’ serial port. The fully-featured RS232 interface supports hardware handshaking.
Image 4-5-2: Comport > Settings Configuration
© Microhard Systems Inc. 82
4.0 Configuration
Note: Most PCs do not readily support serial communications greater than 115200bps.
Software flow control
(XON/XOFF) is not supported.
Select operational status of the Com0/1 Serial Port. The port is disabled by default.
Determines which serial interface shall be used to connect to external devices: RS232, RS485, or RS422. When an interface other than RS232 is selected, the DE9 port will be inactive.
Com0/1 Port Status
Values (selection)
Disabled / Enable
Channel Mode
Values (selection)
RS232
RS485
RS422
The serial baud rate is the rate at which the modem is to communicate with the attached local asynchronous device.
921600
460800
230400
115200
57600
38400
28800
19200
14400
Data Baud Rate
Values (bps)
9600
7200
4800
3600
2400
1200
600
300
Data Format
This setting determines the format of the data on the serial port.
The default is 8 data bits, No parity, and 1 Stop bit.
Values (selection)
8N1
8N2
8E1
8O1
7N1
7N2
7E1
7O1
7E2
7O2
Flow Control
Flow control may be used to enhance the reliability of serial data communications, particularly at higher baud rates. If the attached device does not support hardware handshaking, leave this setting at the default value of ‘None’. When CTS Framing is selected, the IPn4G uses the CTS signal to gate the output data on the serial port.
Values (selection)
None
Hardware
CTS Framing
© Microhard Systems Inc.
Drawing 4A: CTS Output Data Framing
83
4.0 Configuration
Refer to Drawing 6A on the preceding page.
Refer to Drawing 6A on the preceding page.
Pre-Data Delay
Values (time (ms) )
100
Post-Data Delay
Values (time (ms) )
100
This setting defines the serial output data framing. In
Transparent mode (default), the received data will be output promptly from the IPn4G.
Date Mode
Values (selection)
Seamless / Transparent
When set to Seamless, the serial port server will add a gap between data frames to comply with the MODBUS protocol for example. See ‘Character Timeout’ below for related information.
© Microhard Systems Inc.
In Seamless mode (see Data Mode described on the preceding page), this setting determines when the serial server will consider the recently-received incoming data as being ready to transmit. As per the MODBUS standard, frames will be marked as ‘bad’ if the time gap between frames is greater than 1.5 characters, but less than the Character Timeout value.
0
Character Timeout
Values (characters)
The serial server also uses this parameter to determine the time gap inserted between frames.
It is measured in ‘characters’ and related to baud rate.
Example: If the baud rate is 9600bps, it takes approximately 1ms to move one character. With the Character Timeout set to 4, the timeout period is 4ms. When the calculated time is less than
3.5ms, the serial server will set the character timeout to a minimum value of 3.5ms.
If the baud rate is greater than 19200bps, the minimum character timeout is internally set to
750us (microseconds).
Defines the buffer size that the serial server will use to receive data from the serial port. When the server detects that the
Character Timeout criteria has been met, or the buffer is full, it packetizes the received frame and transmits it.
Maximum Packet Size
Values (bytes)
1024
This setting effects the quality of service associated with the data traffic on the COM port.
Priority
Values (selection)
Normal / Medium / High
84
4.0 Configuration
When enabled the data will continue to buffer received on the serial data port when the radio loses synchronization. When disabled the IPn4G will disregard any data received on the serial data port when radio synchronization is lost.
No-Connection Data
Values (selection)
Disable / Enable
This option will enable or disable the MODBUS decoding and encoding features.
MODBUS TCP Status
Values (selection)
Disable / Enable
The field allows the MODBUS TCP Protection Status flag to be enabled or disabled. If enabled the MODBUS data will be encrypted with the MODBUS Protection Key.
MODBUS TCP Protection
Values (selection)
Disable / Enable
MODBUS TCP Protection Key
MODBUS encryption key used for the MODBUS TCP
Protection Status feature.
Values (string)
1234
© Microhard Systems Inc. 85
4.0 Configuration
This setting determines which protocol the serial server will use to transmit serial port data over the IPn4G network.
The protocol selected in the IP Protocol Config field will determine which configuration options appear in the remainder of the COM0/COM1 Configuration Menu.
IP Protocol Config
Values (selection)
TCP Client
TCP Server
TCP Client/Server
UDP Point-to-Point
UDP Point-to-Multipoint (P)
UDP Point-to-Multipoint(MP)
UDP Multipoint-to-Multipoint
SMTP Client (COM0)
PPP (COM0)
GPS Transparent Mode
UDP: User Datagram
Protocol does not provide sequencing information for the packets sent nor does it establish a
’connection’ (‘handshakin g’) and is therefore most suited to communicating small packets of data.
TCP: Transmission
Control Protocol in contrast to UDP does provide sequencing information and is connection-oriented; a more reliable protocol, particularly when large amounts of data are being communicated.
Requires more bandwidth than UDP.
TCP Client: When TCP Client is selected and data is received on its serial port, the IPn4G takes the initiative to find and connect to a remote TCP server. The TCP session is terminated by this same unit when the data exchange session is completed and the connection timeout has expired. If a TCP connection cannot be established, the serial port data is discarded.
Remote Server Address
IP address of a TCP server which is ready to accept serial port data through a TCP connection. For example, this server may reside on a LAN network server.
Default: 0.0.0.0
Remote Server Port
A TCP port which the remote server listens to, awaiting a session connection request from the TCP Client. Once the session is established, the serial port data is communicated from the Client to the Server.
Default: 20001
Outgoing Connection Timeout
This parameter determines when the IPn4G will terminate the TCP connection if the connection is in an idle state (i.e. no data traffic on the serial port).
Default: 60 (seconds)
TCP Server: In this mode, the IPn4G Series will not INITIATE a session, rather, it will wait for a
Client to request a session of it (it’s being the Server—it ‘serves’ a Client). The unit will ‘listen’ on a specific TCP port. If a session is established, data will flow from the Client to the Server, and, if present, from the Server to the Client. If a session is not established, both Client-side serial data, and Server-side serial data , if present, will be discarded.
Local Listening Port
The TCP port which the Server listens to. It allows a TCP connection to be created by a TCP Client to carry serial port data.
Default: 20001
Incoming Connection Timeout
Established when the TCP Server will terminate the TCP connection is the connection is in an idle state.
Default: 300 (seconds)
© Microhard Systems Inc. 86
4.0 Configuration
A UDP or TCP port is an application end-point.
The IP address identifies the device and, as an extension of the IP address, the port essentially ‘fine tunes’ where the data is to go
‘within the device’.
Be careful to select a port number that is not predetermined to be associated with another application type, e.g.
HTTP uses port 80.
Multicast is a one-tomany transmission of data over an IP network.
It is an efficient method of transmitting the same data to many recipients.
The recipients must me members of the specific multicast group.
TTL: Time to Live is the number of hops a packet can travel before being discarded.
In the context of multicast, a TTL value of 1 restricts the range of the packet to the same subnet.
IP Protocol Config (Continued…)
TCP Client/Server: In this mode, the IPn4G will be a combined TCP Client and Server, meaning that it can both initiate and serve TCP connection (session) requests. Refer to the
TCP Client and TCP Server descriptions and settings described previously as all information, combined, is applicable to this mode.
UDP Point-to-Point: In this configuration the IPn4G will send serial data to a specificallydefined point, using UDP packets. This same IPn4G will accept UDP packets from that same point.
Remote IP Address
IP address of distant device to which UDP packets are sent when data received at serial port.
Default: 0.0.0.0
Remote Port
UDP port of distant device mentioned above.
Default: 20001
Listening Port
UDP port which the IP Series listens to (monitors). UDP packets received on this port are forwarded to the unit’s serial port.
Default: 20001
UDP Point-to-Multipoint (P): This mode is configured on an IPn4G which is to send multicast
UDP packets; typically, the Access Point in the IPn4G network.
Multicast IP Address
A valid multicast address this unit uses to send multicast UDP packets upon receiving data from the serial port. The default value is a good example of a valid multicast address.
Default: 224.1.1.1
Multicast Port
A UDP port that this IP Series will send UDP packets to. The Multipoint (MP - see the UDP Point-to-Multipoint (MP) description) stations should be configured to listen to this point in order to receive multicast packets from this IPn4G unit.
Default: 20001
Listening Port
The UDP port that this unit receives incoming data on from multiple remote units.
Default: 20011
Time to Live
Time to live for the multicast packets.
Default: 1 (hop)
© Microhard Systems Inc. 87
4.0 Configuration
In a Point-to-Multipoint
(PMP) network topology which is to utilize UDP multicast, typically the
MASTER would be configured as ’(P)’ (the
POINT) and the
REMOTES would be configured as ’(MP)’ (the
MULTIPOINTS).
IP Protocol Config (Continued…)
UDP Point-to-Multipoint (MP): This protocol is selected on the units which are to receive multicast UDP packets, typically the Remote units. See the previous description of UDP Point-to
-Multipoint (P).
Remote IP Address
The IP address of a distant device (IPn4G or, for example, a PC) to which the unit sends UDP packets of data received on the serial port. Most often this is the IP address of the Access Point.
Default: 0.0.0.0
Remote Port
The UDP port associated with the Remote IP Address (above). In the case of this
‘Remote’ being the VIP Series Station, the value in this field should match the
Listening Port of the Access Point (see UDP Point-to-Multipoint (P)).
Default: 20011
Multicast IP Address
A valid MULTICAST address that this unit will use to receive multicast UDP packets sent by a UDP Point-to-Multipoint (P) unit. Note that the default value for this field matches the default Multicast IP Address of the UDP Point-to-Multipoint (P) configuration described on the previous page.
Default: 224.1.1.1
Multicast Port
The UDP port that this unit will use, along with the Multicast IP Address detailed above, to receive the multicast UDP packets sent by the UDP Point-to-Multipoint (P) unit.
Default: 20001
UDP Multipoint-to-Multipoint
Multicast IP Address
A valid multicast address the unit will use to send multicast UDP packets upon receiving them at its serial port.
Default: 224.1.1.1
Multicast Port
UDP port that the packets are sent to. Multipoint stations should be configured to listen to this port in order to receive multicast packets.
Default: 20011
Time to Live
Time to live for the multicast packets.
Default: 1 (hop)
Listening Multicast IP Address
A valid multicast address the unit is to listen to receive multicast UDP packets sent by another UDP Multipoint-to-Multipoint unit.
Default: 224.1.1.1
Listening Multicast Port
UDP port that the unit will listen to for multicast UDP packets sent by another
UDP Multipoint-to-Multipoint unit.
Default: 20011
© Microhard Systems Inc. 88
4.0 Configuration
SMTP: Simple Mail
Transport Protocol is a protocol used to transfer mail across an IP network.
IP Protocol Config (Continued…)
SMTP Client: If the IPn4G has Internet access, this protocol may be used to send the data received on the serial port (COM1), in a selectable format (see Transfer Mode (below)), to an email addressee. Both the SMTP Server and the email addressee must be ‘reachable’ for his feature to function.
Mail Subject
Enter a suitable ‘e-mail subject’ (e-mail heading).
Default: COM1 Message
Mail Server (IP/Name)
IP address or ‘Name’ of SMTP (Mail) Server.
Default: 0.0.0.0
Mail Recipient
A valid e-mail address for the intended addressee, entered in the proper format.
Default: host@
Message Max Size
Maximum size for the e-mail message.
Default: 1024
Timeout (s)
How long the unit will wait to gather data from the serial port before sending an e-mail message; data will be sent immediately upon reaching Message Max
Size.
Default: 10
Transfer Mode
Select how the data received on COM1 is to be sent to the email addressee.
Options are: Text, Attached File, Hex Code.
Default: Text
© Microhard Systems Inc. 89
4.0 Configuration
IP Protocol Config (Continued…)
PPP: COM0 can be configured as a PPP server for a serial connection with a PC or other device. The attached PC could then use a dedicated serial (Windows - dialup/modem) type PPP connection to access the network resources of the IPn4G. Note: COM1 does not support this mode.
PPP Mode
Can be set for Active or Passive. If set for Active, the PPP server will initiate the PPP connection with a PPP client. The server will periodically send out link requests following PPP protocol. If set to Passive, the PPP server will not initiate the PPP connection with PPP client.
The server will wait passively for the client to initiate connection.
Default: Passive
Expected String
When a client (PC or device) initiates a PPP session with the modem, this is the handshaking string that is expected in order to allow a connection. Generally this doe not need to be changed.
Default: CLIENT
Response String
This is the handshaking string that will be sent by the modem once the expected string is received. Generally this does not need to be changed.
Default: CLIENTSERVER
PPP LCP Echo Failure Number
The PPP server will presume the peer to be dead if the LCP echo-requests are sent without receiving a valid LCP echo-reply. If this happens, PPP server will terminate the connection.
Use of this option requires a non-zero value for the LCP Echo Interval parameter. This option can be used to enable PPP server to terminate after the physical connection has been broken (e.g., the modem has hung up).
Default: 0
PPP LCP Echo Interval
The PPP server will send an LCP echorequest frame to the peer every ‘n’ seconds. Normally the peer should respond to the echo-request by sending an echo-reply. This option can be used with the LCP-echo-failure option to detect that the peer is no longer connected.
Default: 0
PPP Local IP
Enter the local PPP IP Address, the IP Address of the IPn4G COM0 Port.
Default: 192.168.0.1
PPP Host IP
Enter the PPP Host IP here. This is the IP of the PC or attached device.
Default: 192.168.0.99
PPP Idle Timeout(s)
It is the timeout for tearing down the ppp connection when there is no data traffic within the time interval. When there is data coming, new ppp connection will be created.
Default: 30
© Microhard Systems Inc. 90
4.0 Configuration
IP Protocol Config (Continued…)
GPS Transparent Mode: When in GPS Transparent Mode, GPS data is reported out the serial port at 1 second intervals. Sample output is shown below:
Image 4-5-3: Comport > GPS Transparent Mode
© Microhard Systems Inc. 91
4.0 Configuration
4.6 I/O
4.6.1 I/O > Status
The IPn4G has 1 status input, which can be used with various alarms and sensors for monitoring, telling the modem when certain events have occurred, such as an intrusion alarm on a door, a temperature threshold has been exceed, or a generator has failed, out of fuel. Also included is 1 output, that can be used to drive external relays to remotely control equipment and devices. The Digital I/O pins are available on the back connector shared with the input power.
© Microhard Systems Inc.
Image 4-6-1: I/O > Status
Input Status
The WebUI will display the current state the input. The I/O pins are all normally open so an open status indicates that there is nothing connected to the input pin, or that an event has not occurred to trigger the input. The inputs have a small wetting current (Vin) used to detect a contact closure, and prevent false readings by any noise or intermittent signals, it has a threshold sensitivity of 1.8V.
Output Status
The WebUI will display the current state of each control output. Using the Output menu discussed in the next section, a user can remotely control the status of the output pins.
92
4.0 Configuration
4.6.2 I/O > OUTPUT
The Output menu is used to open or close the output pin, allowing a user to remotely trigger an
Image 4-6-2: I/O > OUTPUT
The output pin on the IPn4G can be used to provide output signals, which can be used to drive an external relay to control an external device. Maximum recommended load for the Output Pin is 150mA @ 32 VDC (Vin)
© Microhard Systems Inc. 93
4.0 Configuration
4.7 GPS
4.7.1 GPS > Location
Location Map
The location map shows the location on the IPn4G. The unit will attempt to get the GPS coordinates from the built in GPS receiver, and if unsuccessful, will use the Cell ID location reported by the Cellular Carrier.
© Microhard Systems Inc.
Image 4-7-1: GPS > Location Map
94
4.0 Configuration
4.7.2 GPS > Settings
The IPn4G can be polled for GPS data via GPSD standards and/or provide customizable reporting to up to 4 different hosts using UDP or Email Reporting.
Image 4-7-2: GPS > Settings
Enable or disable the GPS polling function of the IPn4G.
The IPn4G contains an embedded GPS feature in the cellular module. To use the GPS features of the IPn4G a cellular antenna must be connected to the Diversity Antenna Port.
Specify the TCP port on the IPn4G where the GPS service is running and remote systems can connect and poll for GPSD data.
GPS Status
Values
Disable / Enable
GPS Source
Values
Embedded Carrier GPS
TCP Port
Values
2947
© Microhard Systems Inc. 95
4.0 Configuration
4.7.3 GPS > Report
The IPn4G can provide customizable reporting to up to 4 hosts using UDP or Email Reporting.
© Microhard Systems Inc.
Image 4-7-3: GPS > GPS Report
Enable UDP and/or Email or disable GPS Reporting. Up to 4 reports can be set up and configured independently.
Report Define
Values (selection)
Disable
UDP Report
Email Report
The interval timer specifies the frequency at which the GPS data is reported in seconds.
Time Interval
Values (seconds)
600
96
4.0 Configuration
The Message field allows customization of up to 4 different GPS messages to be sent to the specified host.
None - Message is not used, no data will be sent
ALL - Sends all of the below
GGA - GPS Fix Data
GSA - Overall Satellite Data
GSV - Detailed Satellite Data
RMC - Recommended Min Data for GPS
VTG - Vector Track & Ground Speed
GPSGate - For use with GPSGate Tracking Software
The trigger condition defines the conditions that must be met before a GPS update is reported. If OR is chosen, the Repeater Timer OR the Distance trigger conditions must be met before an update is sent. The AND condition, requires that both the Repeat timer AND the Distance trigger conditions be met before an update is sent.
Message 1-4
Values (selection)
None
ALL NMEA
GGA
GSA
GSV
RMC
VTG
Latitude/Longitude
GPSGate UDP Protocol
Trigger Set
Values (selection)
Only Timer
Timer AND Distance
Timer OR Distance
Distance Set
The distance parameter allows the GPS data to only be sent when a specified distance has been traveled since the last report.
Values (meters)
1000
UDP Remote IP / Port
This is the IP Address and port of the remote host in which the UDP packets are to be sent.
Values (Address/Port)
0.0.0.0 / 20175
If an Email report is chosen, the subject line of the Email can be defined here.
If an Email report is to be sent, the outgoing mail server must be defined, and the port number.
Mail Subject
Values (characters)
1000
Mail Server
Values (Address:port)
smtp.gmail.com:465
Some outgoing mail servers required username and password to prevent an account being used for spam. Enter the login credentials here.
Username / Password
Values (characters)
Username / password
Mail Recipient
Some outgoing mail servers require a username and password to prevent an account being used for spam. Enter the login credentials here.
© Microhard Systems Inc.
Values (characters)
97
4.0 Configuration
4.7.4 GPS > GpsGate
The IPn4G is compatible with GpsGate - GPS Tracking Software, which is a 3rd party mapping solution used for various GPS services including vehicle and asset tracking The IPn4G can communicate with GpsGate via Tracker Mode and TCP/IP. (UDP reporting can also send information to GpsGate, see the GPS > Report - UDP Reports)
© Microhard Systems Inc.
Image 4-7-4: GPS > GpsGate Tracker Mode
GpsGate - Tracker Mode
Enable GpsGate Tracker Mode or TCP modes. In tracker mode
The IPn4G and GpsGate software will communicate via TCP/IP, however if a connection is not available it will attempt to use SMS messaging.
Mode Set
Values (selection)
Disable
Enable Tracker Mode
Enable TCP Send Mode
Server Command Channel
By default IPn4G and GpsGate will use TCP and SMS to ensure communication between each other. It is also possible to specify
TCP or SMS communication only. Initial setup in Tracker mode must be via SMS.
Values (seconds)
TCP and SMS
TCP Only
SMS Only
TCP Alive Mode / Alive Time Interval
TCP alive mode will keep TCP connection alive if tracker is not enabled or the tracker interval is too long. The default is 150 seconds.
Values (seconds)
150
98
4.0 Configuration
A phone number filter can be applied to prevent SMS commands not intended for the IPn4G from being processed.
Setup Phone Filter
Values (selection)
Disable: Accept All
Enable Filter
Use this parameter to enable or disable the motion trigger in the
IPn4G.
Motion Trigger
Values (selection)
Disable
Enable Motion Trigger
When enabled, the IPn4G will send the current status of the Digital
I/O inputs and/or outputs to the GpsGate Server.
Send IO Status
Values (selection)
Disable
Send Input Status
Send Output Status
Send Input&Output Status
When GPS Invalid, Sending Data
Specify what happens when the GPS data is invalid, either use the last valid position or do not use the last valid position.
Values (selection)
Not Use Last Valid Position
Use Last Valid Position
GpsGate - TCP Mode
© Microhard Systems Inc.
Image 4-7-5: GPS > GpsGate TCP Mode
99
4.0 Configuration
Enable GpsGate Tracker Mode or TCP modes. In TCP Mode the
IPn4G will establish a connection with the GpsGate Server directly without the SMS setup process. If the TCP connection is not available, the IPn4G will continue to try to connect every few seconds.
Mode Set
Values (selection)
Disable
Enable Tracker Mode
Enable TCP Send Mode
Enter the IP Address of the server running the GpsGate application.
Server Address / IP
Values (IP Address)
192.168.168.1
Enter the TCP Port of the server running the GpsGate application.
Server Port
Values (Port)
30175
Define the interval at which the IPn4G will send data to the
GpsGate Server.
Server Interval
Values (seconds)
60
Set the motion threshold in which the IPn4G will be triggered to send location data.
Motion Distance
Values (meters)
100
When enabled, the IPn4G will send the current status of the Digital
I/O inputs and/or outputs to the GpsGate Server.
Send IO Status
Values (selection)
Disable
Send Input Status
Send Output Status
Send Input&Output Status
When GPS Invalid, Sending Data
Specify what happens when the GPS data is invalid, either use the last valid position or do not use the last valid position.
Values (selection)
Not Use Last Valid Position
Use Last Valid Position
© Microhard Systems Inc. 100
4.0 Configuration
4.7.5 GPS > Recorder
The IPn4G can log the last 200 GPS events and store them in non-volatile memory. These events can then be viewed within the WebUI, on a map, or sent to a remote server.
Image 4-7-6: GPS > GPS Recorder Service
Use the Status parameter to enable the GPS recording functionality of the IPn4G.
Status
Values (selection)
Disable
Enable GPS Recorder
Specify the maximum number of events to be recorded by the
IPn4G. Currently this is a fixed value at 2000 entries.
Position Items
Values (selection)
Max 2000 Items
Define the interval at which the IPn4G will record GPS data. If there is no valid data available at the specified time, the unit will wait until the next time valid information is received.
Record Interval
Values (seconds)
300
© Microhard Systems Inc. 101
4.0 Configuration
4.7.6 GPS > Load Record
Data that has been recorded and saved by the IPn4G can then be viewed or sent to a remote server.
© Microhard Systems Inc.
Image 4-7-7: GPS > GPS Load Record
Check the boxes next to the records listed above that are to be sent to the server.
Record Time Range
Values (selection)
(no default)
Specify the data format / protocol type for the data to be sent.
Send Mode / Protocol
Values (selection)
NMEA via UDP
NMEA via TCP
GpsGate via UDP
GpsGate via TCP
Plain Text via UDP
Plain Text via TCP
Server Address/IP / Port
Enter the address or IP address and port number of the remote server to which the data is to be sent.
Values (IP/Port) nms.microhardcorp.com
30175
102
4.0 Configuration
4.8 Firewall
4.8.1 Firewall > Status
Firewall Status allows a user to see detailed information about how the firewall is operating. The
All, Filter, Nat, Raw, and Mangle options can be used to view different aspects of the firewall.
© Microhard Systems Inc.
Image 4-8-1: Firewall > Status
103
4.0 Configuration
4.8.2 Firewall > General
The General Firewall settings allow users to enable or disable the firewall, and to decide which areas of the modem to protect. The Firewall can also be reset to factory defaults from this area of the WebUI.
Image 4-8-2: Firewall > General
For best practices and to control data usage it is critical that the firewall be configured properly.
It is recommended to block all incoming 4G/Cellular traffic and create rules to open specific ports and/or use ACL lists to limit incoming connections.
When enabled, the firewall settings are in effect. When disabled, none of the settings configured in the menu’s below have an effect, the modem is
“open” to anyone.
Firewall Status
Values
Disable / Enable
Allow remote management of the IPn4G on the WAN/4G side using the WebUI on port 80(HTTP), and 443 (HTTPS). If disabled, the configuration can only be accessed from the LAN.
Remote Management
Values
Disable / Enable
When Blocked the IPn4G will block all requests from the WAN/4G unless specified otherwise in the Access Rules, MAC List, IP List configurations.
Access to ports 80 (HTTP) and 443 (HTTPS-if enabled), is still available unless disabled in the WAN Remote Management option.
WAN Request
Values
Block / Allow
When WAN is set to ‘Allow’ the modem is open to anyone, this is not recommended as it may impact data usage from unwanted sources.
LAN to WAN Access Control
Allows or Blocks traffic from the LAN accessing the WAN unless specified otherwise using the Access Rules, MAC, and IP List configuration.
Values
Block / Allow
Packet Normalization is the normalization of packets so there are no ambiguities in interpretation by the ultimate destination of the packet. The scrub directive also reassembled fragmented packets, protecting some operating systems from some forms of attack, and drops TCP packets that have invalid flag combinations.
Packet Normalization
Values
Enable / Disable
© Microhard Systems Inc. 104
4.0 Configuration
4.8.3 Firewall > Rules
Once the firewall is turned on, rules configuration can be used to define specific rules on how local and remote devices access different ports and services. MAC List and IP List are used for general access, and are applied before rules are processed.
Refer to Appendix E for an example of how to set up a firewall to block all connections and then add access to only specific IP’s and Ports.
Image 4-8-3: Firewall > Rules
The rule name is used to identify the created rule. Each rule must have a unique name and up to 10 characters can be used.
Rule Name
Values (10 Chars) characters
Action
The Action is used to define how the rule handles the connection request.
ACCEPT will allow a connection, while REJECT (error) and DROP
(quietly dropped), will refuse connections.
This is configured based on how the WAN/4G Request and LAN to
WAN/4G Access Control are configured in the previous menus.
Values (selection)
ACCEPT
DROP
REJECT
Select the zone which is to be the source of the data traffic. WAN applies to the connection to the cellular carrier. The LAN refers to local connections on the IPn4G (Ethernet/WiFi).
Source
Values
LAN
WAN
(Additional LAN Interfaces)
None
© Microhard Systems Inc. 105
4.0 Configuration
Match incoming traffic from the specified source IP range. Boxes accept single IP Addresses without network masks, example: 192.168.1.0 to
192.168.1.255 represents all IP Addresses in the 192.168.1.0/24 network.
(Put same IP in both boxes for a single IP match.)
Source IPs
Values (IP Address)
192.168.0.0
Select the zone which is the intended destination of the data traffic. WAN applies to the wireless connection to the cellular carrier and the LAN refers to local connections on the IPn4G (Ethernet/WiFi)
Destination
Values (selection)
LAN
WAN
(Additional LAN Interfaces)
None
Match incoming traffic from the specified destination IP range. Boxes accept single IP Addresses without network masks, example: 192.168.1.0 to 192.168.1.255 represents all IP Addresses in the 192.168.1.0/24 network. (Put same IP in both boxes for a single IP match.)
Destination IPs
Values (IP Address)
192.168.0.0
Match incoming traffic directed at the given destination port or port range.
(To specify a port range use a From:To (100:200) format)
Destination Port
Values (port)
0
Protocol
The protocol field defines the transport protocol type controlled by the rule. Values
TCP
UDP
Both
ICMP
© Microhard Systems Inc. 106
4.0 Configuration
4.8.4 Firewall > Port Forwarding
The IPn4G can be used to provide remote access to connected devices. To access these devices a user must define how incoming traffic is handled by the IPn4G. If all incoming traffic is intended for a specific connected device, DMZ could be used to simplify the process, as all incoming traffic can be directed towards a specific IP address.
In the case where there is multiple devices, or only specific ports need to be passed, Port forwarding is used to forward traffic coming in from the WAN (Cellular) to specific IP Addresses and Ports on the LAN.
Port forwarding can be used in combination with other firewall features, but the Firewall must be enabled for Port forwarding to be in effect. If the WAN Request is blocked on the General Tab, additional rules and/ or IP Lists must be set up to allow the port forwarding traffic to pass through the firewall.
IP-Passthrough (Carrier > Settings) is another option for passing traffic through the IPn4G, in this case all traffic is passed to a single device connected to the RJ45 port of the IPn4G, The device must be set for
DHCP, as the IPn4G assigns the WAN IP to the device, and the modem enters into a transparent mode, routing all traffic to the RJ45 port. This option bypasses all firewall features of the IPn4G, as well as all other features of the IPn4G such as COM, VPN, GPS etc.
Image 4-8-4: Firewall > Port Forwarding
Enable or disable DMZ Mode. DMZ can be used to forward all traffic to the
DMZ Server IP listed below.
DMZ Mode
Values (selection)
Disable / Enable
© Microhard Systems Inc. 107
4.0 Configuration
Enter the IP address of the DMZ server on the LAN side of the IPn4G.
DMZ Server IP
Values (IP Address)
192.168.100.100
If DMZ is enabled and an exception port for the WebUI is not specified, remote management will not be possible. The default port for remote management is TCP
80.
Enter a exception port number that will NOT be forwarded to the DMZ server IP. Usually a configuration or remote management port (HTTP Port
80 or HTTPS Port 443 by default) that is excluded to retain external control of the IPn4G.
Exception TCP Port
Values (Port #)
0
If required, enter a UDP exception port number that will NOT be forwarded to the DMZ server IP.
Exception UDP Port
Values (Port #)
0
If the firewall is set to block incoming traffic on the WAN and/or 4G interfaces, additional rules or IP/MAC lists must be configured to allow desired traffic access.
Firewall Port Forwarding Configuration
This is simply a field where a convenient reference or description is added to the rule. Each Forward must have a unique rule name and can use up to
10 characters.
Name
Values (10 chars)
Forward
Enter the IP address of the intended internal (i.e. on LAN side of IPn4G) server. This is the IP address of the device you are forwarding traffic to.
Internal Server IP
Values (IP Address)
192.168.2.1
Target port number of internal server on the LAN IP entered above.
Internal Port
Values (Port #)
3000
Select the type of transport protocol used. For example Telnet uses TCP,
SNMP uses UDP, etc.
Protocol
Values (selection)
TCP / UDP / Both
Port number of incoming request (from 4G/WAN-side).
External Port
Values (Port #)
2000
© Microhard Systems Inc. 108
4.0 Configuration
4.8.5 Firewall > MAC-IP List
MAC List configuration can be used to control which physical LAN devices can access the ports on the IPn4G, by restricting or allowing connections based on the MAC address. IP List configuration can be used to define who or what can access the IPn4G, by restricting or allowing connections based on the IP Address/Subnet.
MAC-IP List can be used alone or in combination with LAN to WAN/4G Access Control to provide secure access to the physical ports of the IPn4G.
Image 4-8-5: Firewall > MAC-IP List
Firewall MAC List Configuration
The Rule Name field is required to give the rule a convenient name for reference. Each rule must have a unique name, up to 10 characters in length.
Rule Name
Values (10 chars)
MAC_List
Specify the MAC Address to be added to the list. Must be entered in the correct format as seen above. Not case sensitive.
MAC Address
Values ( MAC Address )
00:00:00:00:00:00
© Microhard Systems Inc. 109
4.0 Configuration
Firewall MAC List Configuration (Continued)
The Action is used to define how the rule handles the connection request.
ACCEPT will allow a connection, while REJECT (error) and DROP
(quietly dropped), will refuse connections.
Action
Values (selection)
ACCEPT
DROP
REJECT
Firewall IP List Configuration
The Rule Name field is required to give the rule a convenient name for reference. Each rule must have a unique name, up to 10 characters in length.
The Action is used to define how the rule handles the connection request. ACCEPT will allow a connection, while REJECT (error) and DROP (quietly dropped), will refuse connections.
Rule Name
Values (10 chars)
IP_List
Action
Values (selection)
ACCEPT / DROP / REJECT
Enter the specific zone that the IP List will apply to, 4G/WAN
(Cellular), LAN (Ethernet, WiFi) or None (both).
Specify the specific IP or range. A range of 0.0.0.0 to
255.255.255.255 will allow/block all source IP’s
Optional, enter destination IP address(s) to make the IP list more specific. Set to 0.0.0.0 to 255.255.255.255 to cover the entire IP range if not being used.
Source
Values (Selection)
LAN / WAN/ NONE
Source IP Address
Values (IP Address)
192.168.0.0
Destination Address
Values (IP Address)
192.168.0.0
© Microhard Systems Inc. 110
4.0 Configuration
4.8.6 Firewall > Reset
The Reset menu allows a user to reset the Firewall on the IPn4G, returning the settings to those found in a factory default state. This only resets the Firewall and not any other configuration parameters.
Image 4-8-6: Firewall > Reset
© Microhard Systems Inc. 111
4.0 Configuration
4.9 VPN
4.9.1 VPN > Summary
A Virtual Private Network (VPN) may be configured to enable a tunnel between the IPn4G and a remote network. The IPn4G supports VPN IPsec Gateway to Gateway (site-to-site) tunneling, meaning you are using the IPn4G to create a tunnel to a network with VPN capabilities (Another IPn4G or VPN capable device). The IPn4G can also operate as a L2TP Server, allowing users to VPN into the unit from a remote
PC, and a L2TP Client.
© Microhard Systems Inc.
Image 4-9-1: VPN > Summary
112
4.0 Configuration
4.9.2 VPN > Gateway To Gateway (Site-to-Site)
A Gateway to Gateway connection is used to create a tunnel between two VPN devices such as an IPn4G and another device (another IPn4G or Cisco VPN Router or another vendor…). The local and remote group settings will need to be configured below to mirror those set on the other
VPN device.
Image 4-9-2: VPN > Gateway to Gateway
Enter a name for the VPN Tunnel. Up to 16 different tunnels can be created, each requiring a unique name.
Tunnel Name
Values (chars)
tunnel1
© Microhard Systems Inc. 113
4.0 Configuration
Used to enable (checked) is disable (unchecked) the VPN tunnel.
Enable
Values (checkbox)
Enable (Checked)
Select Between Preshared Key (configured under IPsec Setup), or x509.CA (required Certificate setup under Certificate Management)
Authentication
Values (selection)
Preshared Key
X509.CA
Local Group Setup
Local Security Gateway Type
Specify the method for identifying the router to establish the VPN tunnel.
The Local Security Gateway is on this router; the Remote Security
Gateway is on the other router. At least one of the routers must have either a static IP address or a dynamic IP with server id to make a connection.
Values (selection)
IP Only
IP + Server ID
Dynamic IP + Server ID
IP Only: Choose this option if this router has a static WAN IP address. The WAN IP address appears automatically. For the Remote Security Gateway Type, an extra field appears. If you know the IP address of the remote VPN router, choose IP Address, and then enter the address.
IP + Server ID: Choose this option if this router has a static WAN IP address and a server id. The WAN IP address appears automatically. For the Remote Security Gateway Type, an extra field appears. If you know the IP address of the remote VPN router, choose IP Address, and then enter the address.
Dynamic IP + Server ID: Choose this option if this router has a dynamic IP address and a server id
(available such as @microhard.vpn). Enter the server id to use for authentication. The server id can be used only for one tunnel connection.
Displays the IP address of the IPn4G, which is the local VPN Gateway.
Interface IP Address
Values (IP Address)
Current IP Address
This option appears when the Local Security Gateway Type specifies that the Server ID is required for the connection. The Server ID must be in the format @name, where name can be anything. Both routers must know each others names to establish a connection.
(no default)
Server ID
Values (characters)
© Microhard Systems Inc. 114
4.0 Configuration
Next-hop Gateway means the next-hop gateway IP address for the local or remote gateway participant's connection to the public network.
Next-hop Gateway IP
Values (IP Address)
(no default)
Define the local network by specifying the local subnet. The local and remote routers must use different subnets.
Group Subnet IP
Values (IP Address)
(no default)
Specify the subnet mask of the local network address.
Group Subnet Mask
Values (IP Address)
255.255.255.0
Enter the Gateway for the local group network.
Group Subnet Gateway
Values (IP Address)
(no default)
Remote Group Setup
Remote Security Gateway Type
Specify the method for identifying the router to establish the VPN tunnel.
The Local Security Gateway is on this router; the Remote Security
Gateway is on the other router. At least one of the routers must have either a static IP address or a dynamic IP with server id to make a connection.
(See Local Group Setup for details)
Values (selection)
IP Only
IP + Server ID
Dynamic IP + Server ID
If the remote VPN router has a static IP address, enter the IP address of the remote VPN Gateway here.
Gateway IP Address
Values (IP Address)
(no default)
This option appears when the Remote Security Gateway Type specifies that the Server ID is required for the connection. The Server ID must be in the format @name, where name can be anything. Both routers must know each others names to establish a connection.
Server ID
Values (IP Address)
(no default)
Next-hop Gateway means the next-hop gateway IP address for the local or remote gateway participant's connection to the public network.
Next-hop Gateway IP
Values (IP Address)
(no default)
© Microhard Systems Inc. 115
4.0 Configuration
Define the remote network by specifying the local subnet.
Specify the subnet mask of the remote network address.
Subnet IP Address
Values (IP Address)
Subnet Mask
Values (IP Address)
255.255.255.0
IPsec Setup
Select value to match the values required by the remote VPN router.
Phase 1 DH Group
Values (selection) modp1024 modp1536 modp2048
Select value to match the Phase 1 Encryption type used by the remote
VPN router.
Phase 1 Encryption
Values (selection)
3des aes aes128 aes256
Phase 1 Authentication
Select value to match the Phase 1 Authentication used by the remote VPN router.
Values (selection) md5 sha1
Select value to match the values required by the remote VPN router.
Phase 1 SA Life Time
Values
28800
Perfect Forward Secrecy (pfs)
Select value to match the values required by the remote VPN router. Values (selection)
Disable / Enable
© Microhard Systems Inc. 116
4.0 Configuration
Select value to match the values required by the remote VPN router.
Phase 2 DH Group
Values (selection) modp1024 modp1536 modp2048
Select value to match the Phase 1 Encryption type used by the remote
VPN router.
Phase 2 Encryption
Values (selection)
3des aes aes128 aes256
Phase 2 Authentication
Select value to match the Phase 1 Authentication used by the remote VPN router.
Values (selection) md5 sha1
Select value to match the values required by the remote VPN router.
Phase 2 SA Life Time
Values
3600
Set the Preshared Key required to authenticate with the remote VPN router.
Preshared Key
Values (characters)
password
DPD Delay(s)
Dead Peer Detection is used to detect if there is a dead peer. Set the DPD
Delay (seconds), as required.
Values (seconds)
32
Set the DPD (Dead Peer Detection) Timeout (seconds), as required.
DPD Timeout(s)
Values (seconds)
122
Set the DPD action, hold or clear, as required.
© Microhard Systems Inc.
DPD Action
Values (seconds)
Hold
Clear
117
4.0 Configuration
4.9.3 VPN > Client To Gateway (L2TP Client)
The IPn4G can operate as a L2TP Client, allowing a VPN connection to be made with a L2TP Server.
© Microhard Systems Inc.
Image 4-9-3: VPN > Client to Gateway
Enter a name for the VPN Tunnel. Up to 16 different tunnels can be created, each requiring a unique name.
Tunnel Name
Values (chars)
tunnel1
Used to enable (checked) is disable (unchecked) the VPN tunnel.
Enable
Values (checkbox)
Enable (Checked)
118
4.0 Configuration
This will display the current IPn4G WAN (4G/Cellular) IP Address.
Local Interface IP Address
Values (IP Address)
Current IP
Remote Gateway IP Address
Enter the IP Address of the Remote Gateway that you wish to establish a connection with.
Values (IP Address) none
Some servers require that you know the Server ID as well as the IP address. Enter the Server ID of the remote router here.
Remote Server ID
Values none
In order to communicate with the devices on the other side of the tunnel, the IPn4G must know which data to pass through the tunnel, to do this enter the Remote Subnet network IP address here.
Remote Subnet IP
Values (IP Address) none
Enter the Remote Subnet Mask
Remote Subnet Mask
Values (IP Address) none
Idle time before hanging up
Enter the Idle time (in seconds) to wait before giving up the PPP connection. The default is 0, which means the time is infinite. (0
—65535)
Values (seconds)
0
Enter the Username
The preshared key is required to connect to the L2TP Server.
Username
Values (chars)
0
Preshared Key
Values (chars)
0
IPSec Setup - See previous sections for additional info.
© Microhard Systems Inc. 119
4.0 Configuration
4.9.4 VPN > VPN Client Access
For VPN L2TP operation, users will be required to provide a username and password. Use VPN Client
Access to set up the required users.
Image 4-9-4: VPN > VPN Client Access
Enter a username for the user being set up.
Username
Values (characters)
Enter a password for the newly created user.
New Password
Values (characters)
Confirm New Password
Enter the password again, the IPn4G will ensure that the password match. Values (IP Address)
© Microhard Systems Inc. 120
4.0 Configuration
4.9.5 VPN > Certificate Management
When using the VPN features of the IPn4G, it is possible to select X.509 for the Authentication Type. If that is the case, the IPn4G must use the required x.509 certificates in order to establish a secure tunnel between other devices. Certificate Management allows the user a place to manage these certificates.
Image 4-9-5: VPN > Certificate Management
© Microhard Systems Inc. 121
4.0 Configuration
4.9.6 VPN > Cisco VPN Client
The IPn4G can be configured to create a connection with a Cisco VPN Server. Use the menu below to setup the IPsec Gateway information and the User login details as required by the Cisco VPN Server.
Image 4-9-6: VPN > Cisco VPN Client
This parameter is used to enable or disable the Cisco VPN Client. When disabled the IPn4G will not attempt to create a connection with a Cisco
VPN Server.
Cisco VPN Client
Values (selection)
Disable
Enable
Enter the IPSec Gateway IP of the Cisco VPN Server that the IPn4G will connect to.
Enter the IPSec ID of the Cisco VPN Server that the IPn4G will connect to.
IPSec Gateway
Values (IP Address)
(no default)
IPSec ID
Values (characters)
(no default)
Enter the IPSec Secret of the Cisco VPN Server that the IPn4G will connect to.
IPSec Secret
Values (characters)
(no default)
This configuration parameter is used to set up the IKE (Internet Key
Exchange) protocol to use that set by the VPN Server. If Hybrid or
Certificate is used an additional parameter is shown to allow the upload of the required certificate.
IKE Authmode
Values (selection)
PSK, Hybrid, Certificate
© Microhard Systems Inc.
Specify a valid username and password as required by the Cisco VPN
Server.
Username / Password
Values (characters)
(no default)
122
4.0 Configuration
4.10 Tools
4.10.1 Tools > Discovery
Network Discovery
The Network discovery tool allows the IPn4G to send a broadcast to all Microhard Devices on the same physical network. Other units on the network will respond to the broadcast and report their MAC address,
IP address (With a hyperlink to that units WebUI page), description, firmware version, operating mode, and the SSID (regardless of whether it was set to broadcast or not).
The discovery service can be a useful troubleshooting tool and can be used to quickly find and indentify other units on the network. It can be disabled from the Network > sdpServer menu.
Image 4-10-1: Tools > Discovery
© Microhard Systems Inc. 123
4.0 Configuration
4.10.2 Tools > Netflow Report
The IPn4G can be configured to send Netflow reports to up to 3 remote systems. Netflow is a tool that collects and reports IP traffic information, allowing a user to analyze network traffic on a per interface basis to identity bandwidth issues and to understand data needs. Standard Netflow Filters can be applied to narrow down results and target specific data requirements.
© Microhard Systems Inc.
Image 4-10-2: Tools > Netflow Report
Enable / Disable Netflow Reporting.
Status
Values (selection)
Disable / Enable
The Source Address is the IP Address, of which data is to be collected and analyzed. The default of 0.0.0.0 will collect and report information about all addresses connected to the interface selected below.
Source Address
Values (IP Address)
0.0.0.0
Select between WAN (4G) and LAN interfaces, or capture data from all interfaces.
Interface
Values (selection)
LAN / WAN / ALL
124
4.0 Configuration
The Remote IP is the IP Address of the NetFlow collector where the flow reports are be sent.
Remote IP
Values (IP Address)
Enter the Remote Port number.
0.0.0.0
Remote Port
Values (IP Address)
Filter expression selects which packets will be captured. If no expression is given, all packets will be captured. Otherwise, only packets for which expression is `true' will be captured. Example: tcp&&port 80
The “tcpdump” manual, available on the internet provides detailed expression syntax.
0
Filter expression
Values (chars)
(no default)
Select the Netflow version format to use. V1, 5 and 7 are supported.
Version
Values (selection)
V1 / V5 / V7
© Microhard Systems Inc. 125
4.0 Configuration
4.10.3 Tools > NMS Settings
The Microhard NMS is a no cost server based monitoring and management service offered by Microhard
Systems Inc. Using NMS you can monitor online/offline units, retrieve usage data, perform backups and centralized upgrades, etc. The following section describes how to get started with NMS and how to configure the IPn4G to report to NMS.
To get started with NMS, browse to the Microhard NMS website, nms.microhardcorp.com, click on the register button in the top right corner to register for a Domain (profile), and set up a Domain Administrator
Account.
© Microhard Systems Inc.
Image 4-10-3: NMS
126
4.0 Configuration
Domain Name: A logical management zone for 3G or 4G devices will report to on NMS, the logged data is separated from any other users that are using NMS. The Domain Name is required in every 3G or 4G device for it to report to right zone. Under this user domain, one can create and manage sub-domain. The sub-domain can only be created by the domain administrator, NOT by the NMS subscription page.
Domain Password: This password is used to prevent misuse of the domain. This needs to be entered into each 3G or 4G device for it to report to right zone.
Email Address: The email address entered here will be the login username. During the registration stage, a confirmation email will be sent by the NMS system for verification and confirmation to activate your account.
Once confirmed, this account will be the administrator of the domain. The administrator can manage subdomain and user accounts that belong to this domain.
Once NMS has been configured, each IPn4G must be configured to report into NMS.
© Microhard Systems Inc.
Image 4-10-4: NMS Settings
127
4.0 Configuration
Network Management System (NMS) Configuration
Default Settings
The default Settings link will reset the configuration form to the default factory values. The form still needs to be submitted before any changes will occur.
NMS Server/IP
The default server address for NMS is nms.microhardcorp.com. The NMS can also be hosted privately, and if that is the case, enter the address here.
Values (IP/Name)
nms.microhardcorp.com
Domain Name / Password
This is the domain name and password that was registered on the NMS website, it must be entered to enable reporting to the NMS system.
Values (chars)
default
NMS Report Setting
Enable or Disable location estimation via carrier connection. When enabled, the IPn4G will consume some data to retrieve location information from the internet.
Carrier Location
Values (chars)
Disable/Enable
Enable or Disable UDP reporting of data to the NMS system.
Report Status
Values (chars)
Enable NMS Report
Disable NMS Report
This is the port to which the UDP packets are sent, and the NMS system is listening on. Ensure this matches what is configured on NMS. The default is 20200.
Remote Port
Values (UDP Port#)
20200
The Interval defines how often data is reported to NMS. The more often data is reported, the more data is used, so this should be set according to a user’s data plan. (0 to 65535 seconds)
Interval(s)
Values (seconds)
300
© Microhard Systems Inc. 128
4.0 Configuration
The IPn4G can report information about the different interfaces it has. By default the IPn4G is set to send information about the Carrier, such as usage and RSSI. Statistical and usage data on the Radio (WiFi), Ethernet and Serial interfaces can also be reported.
The more that is reported, the more data that is sent to the NMS system, be aware of data plan constraints and related costs.
Information Selection
Values (check boxes)
Ethernet
Carrier
Radio
COM
DI / DO
Webclient Setting
The Web Service can be enabled or disabled. This service is used to remotely control the IPn4G. It can be used to schedule reboots, firmware upgrade and backup tasks, etc.
Values (chars)
Status
Disable/Enable
Select between HTTPS (secure), or HTTP server type.
Server Type
Values (chars)
HTTPS/ HTTP
This is the port where the service is installed and listening. This port should be open on any installed firewalls.
Server Port
Values (Port#)
9998
This is the username and password used to authenticate the unit.
Username / Password
Values (seconds)
admin/admin
The Interval defines how often the IPn4G checks with the NMS System to determine if there are any tasks to be completed. Carrier data will be consumed every time the device probes the NMS system.
Values (min)
60
Interval
© Microhard Systems Inc. 129
4.0 Configuration
4.10.4 Tools > Event Report
4.10.4.1 Event Report > Configuration
Event Reporting allows the IPn4G to send periodic updates via UDP packets. These packets are customizable and can be sent to up to 3 different hosts, and at a programmable interval. The event packet can report information about the modem such as the hardware/ software versions, core temperature, supply voltage, etc; carrier info such as signal strength (RSSI), phone number, RF Band; or about the WAN such as if the assigned IP Address changes. All events are reported in binary.
© Microhard Systems Inc.
Image 4-10-5: Tools > Event Report
This box allows the selection of the type of event to be reported. The default is disabled. If Modem_event is selected, additional options appear to the right and allow for customization of the event reported via Messages.
If Management is selected, additional check boxes appear below to select the interfaces to report to the Microhard NMS system.
Event Type
Values (selection)
Modem_Event
SDP_Event
Management
130
4.0 Configuration
Enter the IP Address of a reachable host to send the UDP packets
Remote IP
Values (IP Address)
0.0.0.0
Specify the UDP port number of the Remote IP Address.
*Default Port Numbers for Microhard NMS (20100 for modem events, 20200 for
Management)
Remote Port
Values (Port #)
20200
This is the interval time in seconds, that the IPn4G will send the configured
UDP message to the Remote IP and Port specified.
Interval Time(s)
Values (seconds)
600
When Modem_Event is selected, up to three different payloads can be selected.
Message Info Type
Values (seconds)
Modem
Carrier
WAN
4.10.4.2 Event Report > Message Structure
Modem_event message structure
-
-
-
-
- fixed header (fixed size 20 bytes)
Modem ID (uint64_t (8 bytes))
Message type mask (uint8_t(1 byte)) reserved packet length (uint16_t(2 bytes))
Note: packet length = length of fixed header + length of message payload.
Message type mask
Modem info - 2 bits
00 no
Carrier info -
01 yes (0x1)
2 bits
WAN Info -
00 no
01 yes (0x4)
2 bits
00 no
01 yes (0x10) sdp_event message structure
-
-
- spd_cmd (1 byte(0x01)) content length (1 byte) spd_package - same as spd response inquiry package format
© Microhard Systems Inc. 131
4.0 Configuration
4.10.4.3 Event Report > Message Payload
Modem info:
Content length
Modem name
Hardware version
Software version
Core temperature
Supply voltage
Carrier info:
Content length
RSSI
WAN Info:
RF Band
Service type
Channel number
SIM card number
Phone number
Content length
IP address
DNS1
DNS2
- 2 BYTES (UINT16_T)
- STRING (1-30 bytes)
- STRING (1-30 bytes)
- STRING (1-30 bytes)
- STRING (1-30 bytes)
- STRING (1-30 bytes)
- 2 BYTES (UINT16_T)
- 1 BYTE (UINT8_T)
- 2 BYTES (UINT16_T)
- STRING (1-30 Bytes)
- STRING (1-30 Bytes)
- STRING (1-30 Bytes)
- STRING (1-30 Bytes)
- 2 BYTES (UINT16_T)
- 4 BYTES (UINT32_T)
- 4 BYTES (UINT32_T)
- 4 BYTES (UINT32_T)
Message Order:
Messages will be ordered by message type number.
For example,
If message type mask = 0x15, the eurd package will be equipped by header+modem information+carrier information+wanip information.
If message type mask = 0x4, the eurd package will be equipped by header+carrier information.
If message type mask = 0x11, the eurd package will be equipped by header+modem infomation+wanip infomation.
© Microhard Systems Inc. 132
4.0 Configuration
4.10.5 Tools > Modbus
4.10.5.1 Modbus > TCP Modbus
The IPn4G can be configured to operate as a TCP/IP or Serial (COM) Modbus slave and respond to
Modbus requests and report various information as shown in the Data Map.
Image 4-10-6: Modbus
Disable or enable the Modbus service on the IPn4G.
Status
Values (selection)
Disable Service
Enable Service
© Microhard Systems Inc. 133
4.0 Configuration
Disable or enable the Modbus TCP Connection Service on the IPn4G.
TCP Mode Status
Values (selection)
Disable
Enable
Port
Specify the Port in which the Modbus TCP service is to listen and respond to polls.
Values (Port #)
502
Define the active timeout in seconds.
Active Timeout(s)
Values (seconds)
30
Each Modbus slave device must have a unique address, or Slave ID. Enter this value here as required by the Modbus Host System.
Slave ID
Values (value)
1
Enter the Coils Address offset as required by the Master.
Coils Address Offset
Values (value)
0
Enter the Input Address offset as required by the Master.
Enter the Register Address offset as required by the Master.
Input Address Offset
Values (value)
0
Register Address Offset
Values (value)
0
It is possible to only accept connections from specific Modbus Master IP’s, to use this feature enable the Master IP Filter and specify the IP Addresses in the fields provided.
Master IP Filter Set
Values (selection)
Disable / Enable
© Microhard Systems Inc. 134
4.0 Configuration
4.10.5.2 Modbus > COM (Serial) Modbus
The IPn4G can also participate in serial based Modbus, to configure and view the serial Modbus settings, the COM1 port must first be disabled in the Comport > Settings menu. Only the settings that are different from TCP Modbus will be discussed.
Image 4-10-7: Tools > Modbus Serial Configuration
Disable to select the Serial (COM) mode for the Modbus service. In RTU mode, communication is in binary format and in ASCII mode, communication is in ASCII format.
COM Mode Status
Values (selection)
Disable
Enable COM ASCII Mode
Enable COM RTU Mode
Determines which (rear of unit) serial interface shall be used to connect to external devices: RS232, RS485, or RS422. This option applies only to
COM1. When an interface other than RS232 is selected, the DE9 port will be inactive.
Data Mode
Values (selection)
RS232
RS485
RS422
The serial baud rate is the rate at which the modem is to communicate with the attached local serial device.
Baud Rate
Values (selection (bps))
921600
460800
230400
115200
57600
38400
28800
19200
14400
9600
7200
4800
3600
2400
1200
600
300
This setting determines the format of the data on the serial port.
The default is 8 data bits, No parity, and 1 Stop bit.
Data Format
Values (selection)
8N1
8N2
8E1
8O1
7N1
7N2
7E1
7O1
7E2
7O2
© Microhard Systems Inc. 135
4.0 Configuration
4.10.5.3 Modbus > Modbus Data Map
© Microhard Systems Inc.
Image 4-10-8: Tools > Modbus Data Map
136
4.0 Configuration
4.10.6 Tools > Websocket
The Websocket service is a feature of HTML5.0 or later. Web Socket is designed to be implemented in web browsers and web servers to allow XML scripts to access the HTML web service with a TCP socket connection.
It is mainly used for two purposes:
refreshing page information without refreshing the entire page to reduce network stream. to integrate internet applications with xml to get required information in real time.
Currently we provide four types of information as configured:
GPS Coordinate Information
GPS NMEA Data
Carrier Information
Comport Data
Image 4-10-9: Tools > Web Socket Service
Enable or disable the web socket service in the IPn4G.
Status
Values (selection)
Enable / Disable
Enter the desired web socket TCP port number. The default is 7681, and the valid range is 100 to 65535.
Web Socket Port
Values (TCP port)
7681
© Microhard Systems Inc. 137
4.0 Configuration
Enter in the time at which data is to be refreshed. The default is 10 seconds, the valid range is 2 to 65535 seconds.
Data Fresh Intervals
Values (seconds)
10
For added security a password can be required to connect to the web socket service. To disable, leave this field blank. The default is disabled.
Connect Password
Values
(blank)
This field determines how long the web socket is open once started/ enabled. The default is 60 mins, a value of zero means the service with continue to run indefinitely.
Max Keep Time
Values (minutes)
60
If enabled the IPn4G will report GPS coordinate data to the websocket.
If enabled the IPn4G will report GPS NMEA data to the websocket.
GPS Coordinate
Values (selection)
Disable / Enable
GPS NMEA Data
Values (selection)
Disable / Enable
If enabled the IPn4G will report carrier information to the websocket.
Carrier Information
Values (selection)
Disable / Enable
If enabled, and the COM1 port is configured for TCP Server, the comport data will be reported to the web socket.
Comport Data
Values (selection)
Disable / Enable
© Microhard Systems Inc. 138
4.0 Configuration
4.10.7 Tools > Site Survey
Wireless Survey
The Wireless Survey feature will scan the available wireless channels for any other 802.11 wireless networks in proximity to the IPn4G. The Survey will display the Channel number the other networks are operating on, the MAC address, Encryption Type, Frequency and general signal level and quality information. This can be useful for finding available networks, or troubleshooting connection and sensitivity problems. If there are other networks operating on the same frequency, or a channel close to the one chosen, it can then be decided to try to use another channel.
Image 4-10-10: Tools > Site Survey
© Microhard Systems Inc. 139
4.0 Configuration
4.10.8 Tools > Ping
Network Tools Ping
The Network Tools Ping feature provides a tool to test network connectivity from within the IPn4G unit. A user can use the Ping command by entering the IP address or host name of a destination device in the
Ping Host Name field, use Count for the number of ping messages to send, and the Packet Size to modify the size of the packets sent.
Image 4-10-11: Tools > Ping
© Microhard Systems Inc. 140
4.0 Configuration
4.10.9 Tools > TraceRoute
Network TraceRoute
The Trace Route command can be used to provide connectivity data by providing information about the number of hops, routers and the path taken to reach a particular destination.
Image 4-10-12: Tools > TraceRoute
© Microhard Systems Inc. 141
5.0 AT Command Line Interface
5.1 AT Command Overview
AT Commands can be issued to configure and manage the IPn4G, via the front serial port (COM1), or by
TCP/IP (telnet).
5.1.1 Serial Port
To connect and access the AT Command interface on the IPn4G, a physical connection must be made on the RS232 DB9 serial port on the front of the IPn4G labeled ‘COM1’. A terminal emulation program
(Hyperterminal, Tera Term, ProComm, Putty etc) can then be used to communicate with the IPn4G. The port settings of this port can be modified by changing the settings of COM1, in the configuration menus.
Default Settings:
Baud rate: 115200
Data bits: 8
Parity: None
Stop Bits: 1
Flow Control: None
Image 5-1: COM1 Port Settings
Once communication is established, a login is required to access the AT Command interface, once logged in, the AT Command Line Interface menu is displayed. Type “?” or Help to list the menu commands.
Default Settings:
IPn4G login: admin
Password: admin
Image 5-2: AT Command Window
© Microhard Systems Inc. 142
5.0 AT Command Line Interface
5.1.2 Telnet (TCP/IP)
Telnet can be used to access the AT Command interface of the IPn4G. The default port is TCP Port 23. A telnet session can be made to the unit using any Telnet application (Windows Telnet, Tera Term,
ProComm etc). Once communication is established, a login is required to continue.
Image 5-3: Establishing a Telnet Session
A session can be made to the WAN IP Address (if allowed in the firewall settings) for remote configuration, or to the local RJ45 interface (default IP: 192.168.168.1).
Once a session is established a login is required to continue. As seen in the Serial port setup, the default login is admin, and the password is admin. Once verified, the AT Command Line Interface menu is shown and AT Commands can now be issued. (Type “?” or Help to list the commands)
Image 5-4: Telnet AT Command Session
© Microhard Systems Inc. 143
5.0 AT Command Line Interface
5.2 AT Command Syntax
The follow syntax is used when issuing AT Commands on the IPn4G
-
-
All commands start with the AT characters and end with the <Enter> key
Microhard Specific Commands start with +M
-
-
-
Help will list top level commands (ATL will list ALL available AT Commands)
To query syntax of a command: AT+<command_name>=?
Syntax for commands that are used only to query a setting:
AT<command_name>
- Syntax for commands that can be used to query and set values:
AT<command_name>=parameter1,parameter2,… (Sets Values)
AT<command_name>? (Queries the setting)
Query Syntax:
AT+MLEIP=? <Enter>
+MLEIP: Command Syntax:AT+MLEIP=<IP Address>,<Netmask>,<Gateway>
OK
Setting a value:
AT+MLEIP=192.168.0.1,255.255.255.0,192.168.0.1 <Enter>
OK
Query a setting:
AT+MLEIP? <Enter>
+MLEIP: “192.168.0.1”, “255.255.255.0”, “192.168.0.1”
OK
A screen capture of the above commands entered into a unit is shown below:
© Microhard Systems Inc.
Image 5-5: Telnet AT Command Syntax
144
5.0 AT Command Line Interface
5.3 Supported AT Commands
Description
Echo OK.
Example
Input:
AT <enter>
Response:
OK
Description
Disables Local Echo.
Example
Input:
ATE0 <enter>
Response:
OK
Description
Enables Local Echo.
Example
Input:
ATE1 <enter>
Response:
OK
Description
Echo TEST
Example
Input:
AT+TEST <enter>
Response:
AT ECHO TEST:
:0
© Microhard Systems Inc.
Command Syntax
AT <enter>
Command Syntax
ATE0 <enter>
Command Syntax
ATE1 <enter>
Command Syntax
AT+TEST <enter>
AT
ATE0
ATE1
AT+TEST
145
5.0 AT Command Line Interface
Description
Show a list of previously run commands.
Example
Input:
ATH <enter>
Response:
AT Command history: 1. ATH 2. ATL 3. ATH
Command Syntax
ATH <enter>
Description
List all available AT commands.
Example
Input:
ATL <enter>
Response:
AT Commands available:
AT AT Echo OK
ATE0 Disable Echo
ATE1 Enable Echo
AT+TEST AT Echo TEST
ATH Show a list of previously run AT commands
ATL List all available AT commands
AT&R Reserved
AT&V Display modem active profile
AT&W Reserved
AT+MREB Reboot the modem
ATA Quit
ATO Quit
.
.
.
(Additional Output Omitted…)
Command Syntax
ATL <enter>
Description
Read modem profile to editable profile. (Reserved)
© Microhard Systems Inc.
Example
Input:
AT&R <enter>
Response:
OK
Command Syntax
AT&R <enter>
146
ATH
ATL
AT&R
5.0 AT Command Line Interface
AT&V
Description
Read modem active profile.
Example
Input:
AT&V <enter>
Response:
&V:
hostname:IPn4G
timezone:MST7MDT,M3.2.0,M11.1.0
systemmode:gateway
time mode:sync
OK
Command Syntax
AT&V <enter>
Description
Writes configuration to memory. (No Longer required, Reserved).
Command Syntax
AT&W <enter>
Example
Input:
AT&W <enter>
Response:
OK
Description
Reboots the modem.
Example
Input:
AT+MREB <enter>
Response:
OK. Rebooting...
Command Syntax
AT+MREB <enter>
AT&W
AT+MREB
© Microhard Systems Inc. 147
5.0 AT Command Line Interface
ATA
Description
Quit. Exits AT Command session and returns you to login prompt.
Command Syntax
ATA <enter>
Example
Input:
ATA <enter>
Response:
OK
IPn4G Login:
ATO
Description
Quit. Exits AT Command session and returns you to login prompt.
Command Syntax
ATO <enter>
Example
Input:
ATA <enter>
Response:
OK
IPn4G Login:
Description
Send SMS message. To send message CTRL+Z must be entered, to exit, ESC.
AT+CMGS
Command Syntax
AT+CMGS=<Phone Number><CR> text is entered <CTRL+Z/ESC>
Example
Input:
AT+CMGS=4035553776 <enter>
4035553776 Test <ctrl+z>
Response:
OK
© Microhard Systems Inc. 148
5.0 AT Command Line Interface
AT+CMGR
Description
This command allows the application to read stored messages. The messages are read from the SIM card memory.
Command Syntax
AT+CMGR=<index>
Example
Input:
AT+CMGR=<index><enter>
Response:
+CMGR: <stat>,<oa>,,<dt>
<data>
OK
Parameters:
<index> Index in SIM card storage of the message
<stat> Status of Message in Memory (Text Mode)
“REC UNREAD” Received unread messages
“REC READ” Received read messages
<oa> Originator Address
String type
<dt> Discharge Time
String format: "yy/MM/dd,hh:mm:ss±zz" (year [00-99]/ month [01-12]/Day [01-31],
Hour:Min:Second and TimeZone [quarters of an hour])
<data> SMS User Data in Text Mode
String type
Description
This command allows the application to read stored messages by indicating the type of the message to read. The messages are read from the SIM card memory.
Command Syntax
AT+CMGL=<status>
Status:
0 - Lists all unread messages
1 - Lists all read messages
4 - Lists all messages
Example
Input:
AT+CMGL=1 <enter>
Response:
AT+CMGL=1
+CMGL: 0,"REC READ","+14035553776",,"2013/10/04,11:12:27-06"
Test Message 1
+CMGL: 1,"REC READ","+14035553776",,"2013/10/04,11:12:53-06"
Test Message 2
+CMGL: 2,"REC READ","+14035553776",,"2013/10/04,11:13:06-06"
Another test message!
OK
© Microhard Systems Inc.
AT+CMGL
149
5.0 AT Command Line Interface
Description
This command handles deletion of a single message from memory location <index>, or multiple messages according to <delflag>.
AT+CMGD
Command Syntax
AT+CMGD=<index>,<delflag> delflag:
0 - Deletes the message specified in <index>
1 - Deletes all read messages
4 - Deletes all messages
Example
Input:
AT+CMGD=0,4 <enter>
Response: index=0 dflag=4
OK
AT+GMR
Description
Modem Record Information
Command Syntax
AT+GMR <enter>
Example
Input:
AT+GMR <enter>
Response:
+GMR:
Hardware Version:v1.0.0 Software Version:v1.1.0 build 1086
Copyright: 2012 Microhard Systems Inc.
System Time: Tue Feb 3 15:32:12 2015
OK
AT+GMI
Description
Get Manufacturer Identification
Command Syntax
AT+GMI=<enter>
Example
Input:
AT+GMI<enter>
Response:
+GMI: 2012 Microhard Systems Inc.
OK
© Microhard Systems Inc. 150
5.0 AT Command Line Interface
Description
Check modem’s phone number.
Example
Input:
AT+CNUM <enter>
Response:
+CNUM: "+15875558645"
OK
Command Syntax
AT+CNUM <enter>
Description
Check modem’s IMEI and IMSI numbers.
Example
Input:
AT+CIMI <enter>
Response:
+CIMI: IMEI:012773002108403, IMSI:302720406982933
OK
Command Syntax
AT+CIMI <enter>
Description
Check modem’s SIM card number.
Example
Input:
AT+CCID<enter>
Response:
+CCID: 89302720401025355531
OK
Command Syntax
AT+CCID=<enter>
AT+CNUM
AT+CIMI
AT+CCID
© Microhard Systems Inc. 151
5.0 AT Command Line Interface
AT+MSYSI
Description
System Summary Information
Example
Input:
AT+MSYSI <enter>
Response:
Carrier:
IMEI:012773002108403
SIMID:89302610402015463536
IMSI:302610010578158
Phone Num: 15874358437
Status: CONNECTED
Network: Bell
RSSI:LTE RSSI : 65
Temperature:72 degC
Ethernet Port:
MAC:00:0F:92:00:B5:EE
IP:192.168.168.1
MASK:255.255.255.0
Wan MAC:00:A0:C6:00:00:00
Wan IP:184.151.235.115
Wan MASK:255.255.255.255
System:
Device:IPn4G
Product:IPn4G+WIFI
Image:IPn4G
Hardware:v1.0.0
Software:v1.1.0 build 1086
Copyright: 2012 Microhard Systems Inc.
Time: Tue Feb 3 15:34:00 2015
© Microhard Systems Inc.
Description
Modem Name / Radio Description. 30 chars.
Example
Input: (To set value)
AT+MMNAME=IPn4G_CLGY<enter>
Response:
OK
Input: (To retrieve value)
AT+MMNAME=?<enter>
Response:
+MMNAME: IPn4G_CLGY
OK
Command Syntax
AT+MSYSI <enter>
Command Syntax
AT+MMNAME
AT+MMNAME=<modem_name>
152
5.0 AT Command Line Interface
Description
Set the IP Address, Netmask, and Gateway for the local Ethernet interface.
AT+MLEIP
Command Syntax
AT+MLEIP=<IP Address>, <Netmask>,
<Gateway>
Example
Input:
AT+MLEIP=192.168.168.1,255.255.255.0,192.168.168.1 <enter>
Response:
+MLEIP: setting and restarting network...
OK
AT+MDHCP
Description
Enable/Disable the DHCP server running of the local
Ethernet interface.
Command Syntax
AT+MDHCP=<action>
0 Disable
1 Enable
Example
Input:
AT+MDHCP=1 <enter>
Response:
OK
Description
Define the Starting and Ending IP Address (range) assignable by DHCP on the local Ethernet interface.
AT+MDHCPA
Command Syntax
AT+MDHCPA=<Start IP>, <End IP>
Example
Input:
AT+MDHCPA=192.168.168.100,192.168.168.200 <enter>
Response:
OK
© Microhard Systems Inc. 153
5.0 AT Command Line Interface
AT+MEMAC
Description
Retrieve the MAC Address of the local Ethernet interface.
Command Syntax
AT+MEMAC <enter>
Example
Input:
AT+MEMAC<enter>
Response:
+MEMAC: "00:0F:92:00:40:9A"
OK
Description
Set LAN static IP
AT+MSIP
Command Syntax
AT+MSIP=<static IP address> <enter>
Example
Input:
AT+MSIP=192.168.168.1 <enter>
Response:
+MSIP: setting and restarting network...
OK
AT+MSCT
Description
Set LAN Connection Type.
Command Syntax
AT+MSCT=<Mode>
Mode:
0 DHCP
1 Static IP
Example
Input:
AT+MSCT=1 <enter>
Response:
OK
© Microhard Systems Inc. 154
5.0 AT Command Line Interface
Description
Enable and define a NTP server.
Command Syntax
AT+MNTP=<status>,<NTP server>
Status:
0 Disable
1 Enable
AT+MNTP
Example
Input:
AT+MNTP=1,pool.ntp.org<enter>
Response:
OK
AT+MPIPP
Description
Enable/Disable IP-Passthrough
Command Syntax
AT+MPIPP=<Mode>
Mode:
0 Disable
1 Ethernet
Example
Input:
AT+MPIPP=1 <enter>
Response:
OK
Description
Sets the timeout value for the serial and telnet consoles. Once expired, user will be return to login prompt.
Command Syntax
AT+MCNTO=<Timeout_s>
0 - Disabled
0 - 65535 (seconds)
Example
Input:
AT+MCNTO=300 <enter>
Response:
OK
AT+MCNTO
© Microhard Systems Inc. 155
5.0 AT Command Line Interface
AT+MRTF
Description
Reset the modem to the factory default settings stored in non-volatile (NV) memory. Unit will reboot with default settings.
Command Syntax
AT+MRTF <action>
Action:
0 pre-set action
1 confirm action
OK
Example
Input:
AT+MRTF=1 <enter>
Response:
OK
Description
Enable/Disable the Wireless Traffic Timeout. Unit will reset if it does not see any traffic from the carrier for the amount of time defined.
AT+MTWT
Command Syntax
AT+MTWT=<Mode>[,<Interval_s>,<Reboot
Time Limit_s>]
Mode:
0 Disable
1 Enable
Reboot Time Limit:300-60000
Example
Input:
AT+MTWT=1,1,300 <enter>
Response:
OK
Description
Enable/Disable the Wireless Traffic Timeout. Unit will reset if it does not see any traffic from the carrier for the amount of time defined.
Example
Input:
AT+MSCMD=1,1,403556767,4057890909<enter>
Response:
OK
AT+MSCMD
Command Syntax
AT+MSCMD=<Mode>[,<Filter Mode>[,<Phone
No.1>[,...,<Phone
No.6>]]]
Mode:
0 Disable
1 Enable SMS Command
Filter Mode:
0 Disable
1 Enable Phone Filter
OK
© Microhard Systems Inc. 156
5.0 AT Command Line Interface
AT+MDISS
Description
Configure discovery mode service used by IPn4G and utilities such as “IP Discovery”.
Command Syntax
AT+MDISS=<Mode>
Mode:
0 Disable
1 Discoverable
Example
Input:
AT+MDISS=1 <enter>
Response:
OK
Description
Used to set or change the ADMIN password for the
IPn4G.
AT+MPWD
Command Syntax
AT+MPWD=<New password>,<confirm password> password: at least 5 characters
Example
Input:
AT+MPWD=admin,admin<enter>
Response:
OK
AT+MIKACE
Description
Enable or Disable IMCP ICMP keep-alive check.
Command Syntax
AT+MIKACE=<Mode>
Mode:
0 Disable
1 Enable
Example
Input:
AT+MIKACE=1<enter>
Response:
OK
© Microhard Systems Inc. 157
5.0 AT Command Line Interface
Description
Set ICMP Keep-alive check parameters.
AT+MIKAC
Command Syntax
AT+MIKAC=<host name>, <interval in seconds>, <count>
Example
Input:
AT+MIKAC=www.google.com,600,10<enter>
Response:
OK
AT+MDDNSE
Description
Enable/Disable DDNS.
Command Syntax
AT+MDDNSE=<Mode>
Mode:
0 Disable
1 Enable
Example
Input:
AT+MDDNSE=0<enter>
Response:
OK
Description
Select DDNS service provider, and login credentials as required for DDNS services.
AT+MDDNS
Command Syntax
AT+MDDNS=<service type>,<host>,<user name>,<password> service type:
0 changeip
1 dyndns
2 eurodyndns
3 hn
4 noip
5 ods
6 ovh
7 regfish
8 tzo
9 zoneedit
Example
Input:
AT+MDDNS=0,user.dydns.org,user,password <enter>
Response:
OK
© Microhard Systems Inc. 158
5.0 AT Command Line Interface
Description
Define Event Report UDP Report No.1/2/3.
AT+MEURD1
AT+MEURD2
AT+MEURD3
Command Syntax
AT+MEURD1=<Mode>[,<Remote IP>,<Remote
Port>,<Interval Ti me_s>]
Mode:
0 Disable
1 Moden Event Report
2 SDP Event Report
3 Management Report
Example
Input:
AT+MIKAC=www.google.com,600,10<enter>
Response:
OK
Description
Define NMS Report.
AT+MNMSR
Command Syntax
AT+MNMSR=<Mode>[,<Remote Port>,<Interval
Time_s>]
Mode:
0 Disable
1 Enable NMS Report
Example
Input:
AT+MNMSR=1,20200,300<enter>
Response:
OK
Description
Define GPS Report No.1/2/3/4.
Example
Input:
AT+MGPSR1=1,192.168.168.25,20175,600 <enter>
Response:
OK
AT+MGPSR1
AT+MGPSR2
AT+MGPSR3
AT+MGPSR4
Command Syntax
AT+MGPSR1=<Mode>[,<Remote IP>,<Remote
Port>,<Interval Ti me_s>]
Mode:
0 Disable
1 Enable UDP Report
© Microhard Systems Inc. 159
5.0 AT Command Line Interface
Description
Enable/Disable the Com0 serial port.
Example
Input:
AT+MCTPS0=0<enter>
Response:
OK
Description
Set Comport baud rate.
Example
Input:
AT+MCTBR0=13<enter>
Response:
OK
Command Syntax
AT+MCTPS0=<Mode>
Mode:
0 Disable
1 Enable
AT+MCTPS0
Command Syntax
AT+MCTBR0=<Baud Rate>
Baud Rate:
0 300
1 600
2 1200
3 2400
4 3600
5 4800
6 7200
7 9600
8 14400
9 19200
10 28800
11 38400
12 57600
13 115200
AT+MCTBR0
© Microhard Systems Inc. 160
5.0 AT Command Line Interface
Description
Set Comport data format
Example
Input:
AT+MCTDF0=0<enter>
Response:
OK
Description
Set Comport data mode.
Example
Input:
AT+MCTDM0=1<enter>
Response:
OK
Description
Set Comport character timeout.
Example
Input:
AT+MCTCT0=0<enter>
Response:
OK
Command Syntax
AT+MCTDF0=<data format>
Data Format:
0 8N1
1 8N2
2 8E1
3 8O1
4 7N1
5 7N2
6 7E1
7 7O1
8 7E2
9 7O2
AT+MCTDF0
Command Syntax
AT+MCTDM0=<Data Mode>
Data Mode:
0 Seamless
1 Transparent
AT+MCTDM0
Command Syntax
AT+MCTCT0=<timeout_s>
AT+MCTCT0
© Microhard Systems Inc. 161
5.0 AT Command Line Interface
AT+MCTMPS0
Description
Set Comport data format
Example
Input:
AT+MCTMPS0=1024<enter>
Response:
OK
Command Syntax
AT+MCTMPS0=<size>
AT+MCTP0
Description
Set Comport port priority.
Command Syntax
AT+MCTP0=<Mode>
Mode:
0 Normal
1 Medium
2 High
Example
Input:
AT+MCTP0=0<enter>
Response:
OK
Description
Enable/Disable Comport port no-connection data intake.
Command Syntax
AT+MCTNCDI0=<Mode>
Mode:
0 Disable
1 Enable
AT+MCTNCDI0
Example
Input:
AT+MCTNCDI0=1<enter>
Response:
OK
© Microhard Systems Inc. 162
5.0 AT Command Line Interface
Description
Set Comport modbus TCP configuration.
AT+MCTMTC0
Command Syntax
AT+MCTMTC0=<Status>, <Protection status>,
<Protection Key>
Status and Protection Status:
0 Disable
1 Enable
Example
Input:
AT+MCTMTC0=0,0,1234<enter>
Response:
OK
Description
Set the Comport serial port IP Protocol Mode.
Example
Input:
AT+MCTIPM0=1<enter>
Response:
OK
AT+MCTIPM0
Command Syntax
AT+MCTIPM0=<Mode>
Mode:
0 TCP Client
1 TCP Server
2 TCP Client/Server
3 UDP Point to Point
4 UDP Point to Multipoint(P)
5 UDP Point to Multipoint(MP)
6 UDP Multipoint to Multipoint
7 SMTP Client
9 SMS Transparent Mode
11 GPS Transparent Mode
AT+MCTTC0
Command Syntax
AT+MCTTC0=<Remote Server IP>, <Remote
Server Port>, <Outgoing timeout_s>
Description
Set Comport TCP Client parameters when IP
Protocol Mode is set to TCP Client.
Example
Input:
AT+MCTTC0=0.0.0.0,20002,60<enter>
Response:
OK
© Microhard Systems Inc. 163
5.0 AT Command Line Interface
Description
Set TCP Server parameters when IP Protocol Mode is set to TCP Server.
Example
Input:
AT+MCTTS0=0,100,20002,300<enter>
Response:
OK
AT+MCTTS0
Command Syntax
AT+MCTTS0=<Polling Mode>, <Polling timeout_s>, <Local Listener Port>,
<Connection timeout_s>
Polling Mode:
0 Monitor
1 Multi-polling
Description
Set TCP Client/Server parameters when IP Protocol is set to TCP Client/Server mode.
Example
Input:
AT+MCTCS0=0.0.0.0,20002,60,0,100,20002,300<en ter>
Response:
OK
AT+MCTTCS0
Command Syntax
AT+MCTTCS0=<Remote Server IP>, <Remote
Server Port>, <Outgoing timeout_s>, <Polling
Mode>, <Polling timeout_s>,<Local Listener
Port>, <Connection timeout_s>
Polling Mode:
0 Monitor
1 Multi-polling
Description
Set UDP Point-to-Point parameters when IP
Protocol is set to UDP Point-to-Point mode.
AT+MCTUPP0
Command Syntax
AT+MCTUPP0=<Remote Server IP>, <Remote
Server Port>, <Liste ner Port>, <UDP timeout_s>
Example
Input:
AT+MCTUPP0=0.0.0.0,20002,20002,10<enter>
Response:
OK
© Microhard Systems Inc. 164
5.0 AT Command Line Interface
Description
Set UDP Point-to-Multipoint as point parameters when IP Protocol Mode is set to UDP Point-to-
Multipoint (P)
AT+MCTUPMP0
Command Syntax
AT+MCTUPMP0=<Multicast IP>, <Multicast
Port>, <Listener Port>, <Time to live>
Example
Input:
AT+MCTUPMP0=224.1.1.2,20002,20012,1<enter>
Response:
OK
Description
Set UDP Point-to-Multipoint as MP parameters when
IP Protocol Mode is set to UDP Point-to-Multipoint
(MP)
AT+MCTUPMM0
Command Syntax
AT+MCTUPMM0=<Remote IP>, <Remote Port>,
<Multicast IP>, <Multicast Port>
Example
Input:
AT+MCTUPMM0=0.0.0.0,20012,224.1.1.2,20002<enter>
Response:
OK
Description
Set UDP Multipoint-to-Multipoint parameters when
IP Protocol is set to UDP Multipoint-to-Multipoint mode.
AT+MCTUMPMP0
Command Syntax
AT+MCTUMPMP0=<Multicast IP>, <Multicast
Port>, <Time to live>, <Listen Multicast IP>,
<Listen Multicast Port>
Example
Input:
AT+MCTUMPMP0=224.1.1.2,20012,1,224.1.1.2,20012<enter>
Response:
OK
© Microhard Systems Inc. 165
5.0 AT Command Line Interface
Description
Enable/Disable the Com1 serial port.
Example
Input:
AT+MCTPS=0<enter>
Response:
OK
Description
Set Comport baud rate.
Example
Input:
AT+MCTBR=13<enter>
Response:
OK
Command Syntax
AT+MCTPS=<Mode>
Mode:
0 Disable
1 Enable
AT+MCTPS
Command Syntax
AT+MCTBR=<Baud Rate>
Baud Rate:
0 300
1 600
2 1200
3 2400
4 3600
5 4800
6 7200
7 9600
8 14400
9 19200
10 28800
11 38400
12 57600
13 115200
AT+MCTBR
© Microhard Systems Inc. 166
5.0 AT Command Line Interface
Description
Set Comport data format
Example
Input:
AT+MCTDF=0<enter>
Response:
OK
Description
Set Comport data mode.
Example
Input:
AT+MCTDM=1<enter>
Response:
OK
Description
Set Comport character timeout.
Example
Input:
AT+MCTCT=0<enter>
Response:
OK
AT+MCTDF
Command Syntax
AT+MCTDF=<data format>
Data Format:
0 8N1
1 8N2
2 8E1
3 8O1
4 7N1
5 7N2
6 7E1
7 7O1
8 7E2
9 7O2
Command Syntax
AT+MCTDM=<Data Mode>
Data Mode:
0 Seamless
1 Transparent
AT+MCTDM
Command Syntax
AT+MCTCT=<timeout_s>
AT+MCTCT
© Microhard Systems Inc. 167
5.0 AT Command Line Interface
AT+MCTMPS
Description
Set Comport data format
Example
Input:
AT+MCTMPS=1024<enter>
Response:
OK
Command Syntax
AT+MCTMPS=<size>
AT+MCTP
Description
Set Comport port priority.
Command Syntax
AT+MCTP=<Mode>
Mode:
0 Normal
1 Medium
2 High
Example
Input:
AT+MCTP=0<enter>
Response:
OK
Description
Enable/Disable Comport port no-connection data intake.
Command Syntax
AT+MCTNCDI=<Mode>
Mode:
0 Disable
1 Enable
Example
Input:
AT+MCTNCDI=1<enter>
Response:
OK
AT+MCTNCDI
© Microhard Systems Inc. 168
5.0 AT Command Line Interface
Description
Set Comport modbus TCP configuration.
AT+MCTMTC
Command Syntax
AT+MCTMTC=<Status>, <Protection status>,
<Protection Key>
Status and Protection Status:
0 Disable
1 Enable
Example
Input:
AT+MCTMTC=0,0,1234<enter>
Response:
OK
Description
Set the Comport serial port IP Protocol Mode.
Example
Input:
AT+MCTIPM=1<enter>
Response:
OK
AT+MCTIPM
Command Syntax
AT+MCTIPM=<Mode>
Mode:
0 TCP Client
1 TCP Server
2 TCP Client/Server
3 UDP Point to Point
4 UDP Point to Multipoint(P)
5 UDP Point to Multipoint(MP)
6 UDP Multipoint to Multipoint
7 SMTP Client
9 SMS Transparent Mode
11 GPS Transparent Mode
AT+MCTTC
Command Syntax
AT+MCTTC=<Remote Server IP>, <Remote
Server Port>, <Outgoing timeout_s>
Description
Set Comport TCP Client parameters when IP
Protocol Mode is set to TCP Client.
Example
Input:
AT+MCTTC=0.0.0.0,20002,60<enter>
Response:
OK
© Microhard Systems Inc. 169
5.0 AT Command Line Interface
Description
Set TCP Server parameters when IP Protocol Mode is set to TCP Server.
Example
Input:
AT+MCTTS=0,100,20002,300<enter>
Response:
OK
AT+MCTTS
Command Syntax
AT+MCTTS=<Polling Mode>, <Polling timeout_s>, <Local Listener Port>,
<Connection timeout_s>
Polling Mode:
0 Monitor
1 Multi-polling
Description
Set TCP Client/Server parameters when IP Protocol is set to TCP Client/Server mode.
Example
Input:
AT+MCTCS=0.0.0.0,20002,60,0,100,20002,300<ent er>
Response:
OK
AT+MCTTCS
Command Syntax
AT+MCTTCS=<Remote Server IP>, <Remote
Server Port>, <Outgoing timeout_s>, <Polling
Mode>, <Polling timeout_s>,<Local Listener
Port>, <Connection timeout_s>
Polling Mode:
0 Monitor
1 Multi-polling
Description
Set UDP Point-to-Point parameters when IP
Protocol is set to UDP Point-to-Point mode.
AT+MCTUPP
Command Syntax
AT+MCTUPP=<Remote Server IP>, <Remote
Server Port>, <Liste ner Port>, <UDP timeout_s>
Example
Input:
AT+MCTUPP=0.0.0.0,20002,20002,10<enter>
Response:
OK
© Microhard Systems Inc. 170
5.0 AT Command Line Interface
Description
Set UDP Point-to-Multipoint as point parameters when IP Protocol Mode is set to UDP Point-to-
Multipoint (P)
AT+MCTUPMP
Command Syntax
AT+MCTUPMP=<Multicast IP>, <Multicast
Port>, <Listener Port>, <Time to live>
Example
Input:
AT+MCTUPMP=224.1.1.2,20002,20012,1<enter>
Response:
OK
Description
Set UDP Point-to-Multipoint as MP parameters when
IP Protocol Mode is set to UDP Point-to-Multipoint
(MP)
AT+MCTUPMM
Command Syntax
AT+MCTUPMM=<Remote IP>, <Remote Port>,
<Multicast IP>, <Multicast Port>
Example
Input:
AT+MCTUPMM=0.0.0.0,20012,224.1.1.2,20002<enter>
Response:
OK
Description
Set UDP Multipoint-to-Multipoint parameters when
IP Protocol is set to UDP Multipoint-to-Multipoint mode.
AT+MCTUMPMP
Command Syntax
AT+MCTUMPMP=<Multicast IP>, <Multicast
Port>, <Time to live>, <Listen Multicast IP>,
<Listen Multicast Port>
Example
Input:
AT+MCTUMPMP=224.1.1.2,20012,1,224.1.1.2,20012<enter>
Response:
OK
© Microhard Systems Inc. 171
5.0 AT Command Line Interface
Description
Module Input Status.
Example
Input:
AT+MIS <enter>
Response:
+MIS: available input status
INPUT 1: 0 open
OK
Description
Module Output Status.
Example
Input:
AT+MOS=0 <enter>
Response:
+MOS: available output status
OUTPUT 1: 0 open
OK
Input:
AT+MOS=1,1,1 <enter>
Response:
OK
Description
Check Modem’s IMEI Number.
Example
Input:
AT+IMEI <enter>
Response:
+IMEI: 012773002108403
OK
© Microhard Systems Inc.
Command Syntax
AT+MIS
AT+MIS
AT+MOS
Command Syntax
AT+MOS=<Mode>[,<Setting No.>,<Status>]
Mode:
0 All Output Status
1 Output Setting
Setting No.: 1, 2, 3, 4(if output available)
Status:
0 open
1 close
Command Syntax
AT+IMEI
AT+IMEI
172
5.0 AT Command Line Interface
Description
Check Modem’s RSSI.
Example
Input:
AT+NETRSSI <enter>
Response:
+NETRSSI: 65
OK
Description
Check Modem’s RSSI.
Example
Input:
AT+NETRSSI <enter>
Response:
+NETRSSI: 65
OK
Description
Check Modem’s Voltage.
Example
Input:
AT+POWERIN <enter>
Response:
+POWERIN: 11.68
OK
Command Syntax
AT+NETRSSI
AT+NETRSSI
Command Syntax
AT+NETRSSI
AT+NETRSSI
Command Syntax
AT+POWERIN
AT+POWERIN
© Microhard Systems Inc. 173
5.0 AT Command Line Interface
Description
Check Modem’s Temperature. (C)
Example
Input:
AT+BOARDTEMP <enter>
Response:
+BOARDTEMP: 73
OK
Description
Check Modem’s WAN IP. (Carrier)
Example
Input:
AT+WANIP <enter>
Response:
+WANIP: 184.151.235.115
OK
Command Syntax
AT+BOARDTEMP
AT+BOARDTEMP
Command Syntax
AT+WANIP
AT+WANIP
© Microhard Systems Inc. 174
5.0 AT Command Line Interface
Description
Lists all available AT Commands.
Command Syntax
ATL <enter>
Example
ATL <enter>
AT Commands available:
AT Commands available:
AT
ATE0
ATE1
AT+TEST
ATH
ATL
AT&R
AT&V
AT&W
AT+MREB
ATA
ATO
AT+CMGS
AT+CMGR
AT+CMGL
AT+CMGD
AT+GMR
AT+GMI
AT+CNUM
AT+CIMI
AT+CCID
AT+MSYSI
AT+MMNAME
AT+MLEIP
AT+MDHCP
AT+MDHCPA
AT+MEMAC
AT+MSIP
AT+MSCT
AT+MNTP
AT+MPIPP
AT+MCNTO
AT+MRTF
AT+MTWT
AT+MSCMD
AT+MDISS
AT+MPWD
AT+MIKACE
AT+MIKAC
AT+MDDNSE
AT+MDDNS
AT+MEURD1
AT+MEURD2
AT+MEURD3
AT+MNMSR
AT+MGPSR1
AT+MGPSR2
AT+MGPSR3
AT+MGPSR4
AT Echo OK
Disable Echo
Enable Echo
AT Echo TEST
Show a list of previously run AT commands
List all available AT commands
Reserved
Display modem active profile
Reserved
Reboot the modem
Quit
Quit
Send SMS
Read SMS with changing status
List SMSs with changing status
Delete SMSs
Modem Record Information
Get Manufacturer Identification
Check Modem's Phone Number
Check Modem's IMEI and IMSI
Check Modem's SIM Card Number
System summary information
Modem Name Setting
Set the IP address of the modem LAN Ethernet interface
Enable or disable DHCP server running on the Ethernet interface
Set the range of IP addresses to be assigned by the DHCP server
Query the MAC address of local Ethernet interface
Set LAN static IP
Set LAN Connection Type
Define NTP server
Enable or disable IP-Passthrough
Set console timeout
Reset the modem to the factory default settings of from non-volatile (NV) memory
Enable or disable traffic watchdog timer used to reset the modem
Enable or disable system sms command service
Set discovery service used by the modem
Set password
Enable or disable ICMP keep-alive check
Set ICMP keep-alive check
Enable or disable DDNS
Set DDNS
Define Event UDP Report No.1
Define Event UDP Report No.2
Define Event UDP Report No.3
Define NMS Report
Define GPS Report No.1
Define GPS Report No.2
Define GPS Report No.3
Define GPS Report No.4
(Continued……)
ATL
© Microhard Systems Inc. 175
5.0 AT Command Line Interface
AT+MCTPS0
AT+MCTBR0
AT+MCTDF0
AT+MCTDM0
AT+MCTCT0
AT+MCTMPS0
AT+MCTP0
AT+MCTNCDI0
AT+MCTMTC0
AT+MCTIPM0
AT+MCTTC0
AT+MCTTS0
AT+MCTTCS0
AT+MCTUPP0
AT+MCTUPMP0
AT+MCTUPMM0
AT+MCTUMPMP0
AT+MCTPS
AT+MCTBR
AT+MCTDF
AT+MCTDM
AT+MCTCT
AT+MCTMPS
AT+MCTP
AT+MCTNCDI
AT+MCTMTC
AT+MCTIPM
AT+MCTTC
AT+MCTTS
AT+MCTTCS
AT+MCTUPP
AT+MCTUPMP
AT+MCTUPMM
AT+MCTUMPMP
AT+MIS
AT+MOS
AT+IMEI
AT+IMSI
AT+NETRSSI
AT+POWERIN
AT+BOARDTEMP
AT+WANIP
Enable or disable com0 port
Set com0 port baud rate
Set com0 port data format
Set com0 port data mode
Set com0 port character timeout
Set com0 port maximum packet size
Set com0 port priority
Enable or disable com0 port no-connection data intake
Set com0 port modbus tcp configuration
Set com0 port IP protocol mode
Set com0 port tcp client configuration when IP protocol mode be set to TCP Client
Set com0 port tcp server configuration when IP protocol mode be set to TCP Server
Set com0 port tcp client/server configuration when IP protocol mode be set to TCP Client/
Server
Set com0 port UDP point to point configuration when IP protocol mode be set to UDP point to point
Set com0 port UDP point to multipoint as point configuration when IP protocol mode be set to UDP point to multipoint(P)
Set com0 port UDP point to multipoint as MP configuration when IP protocol mode be set to UDP point to multipoint(MP)
Set com0 port UDP multipoint to multipoint configuration when IP protocol mode be set to
UDP multipoint to multipoint
Enable or disable com1 port
Set com1 port baud rate
Set com1 port data format
Set com1 port data mode
Set com1 port character timeout
Set com1 port maximum packet size
Set com1 port priority
Enable or disable com1 port no-connection data intake
Set com1 port modbus tcp configuration
Set com1 port IP protocol mode
Set com1 port tcp client configuration when IP protocol mode be set to TCP Client
Set com1 port tcp server configuration when IP protocol mode be set to TCP Server
Set com1 port tcp client/server configuration when IP protocol mode be set to TCP Client/
Server
Set com1 port UDP point to point configuration when IP protocol mode be set to UDP point to point
Set com1 port UDP point to multipoint as point configuration when IP protocol mode be set to UDP point to multipoint(P)
Set com1 port UDP point to multipoint as MP configuration when IP protocol mode be set to UDP point to multipoint(MP)
Set com1 port UDP multipoint to multipoint configuration when IP protocol mode be set to
UDP multipoint to multipoint
Module Input status
Module Output status and setting
Check Modem's IMEI
Check Modem's IMSI
Check Modem's RSSI
Check Modem's Voltage
Check Modem's Temperature
Check Modem's WAN IP
© Microhard Systems Inc. 176
Appendix A: Serial Interface
Module
(DCE)
1
2
3
4
5
6
7
8
Signal
DCD
Host (e.g. PC)
(DTE)
RX
IN
IN
Arrows denote the direction that signals are asserted (e.g., DCD originates at the DCE, informing the DTE that a carrier is present).
The interface conforms to standard RS-232 signals, so direct connection to a host PC (for example) is accommodated.
TX OUT
DTR OUT
SG
DSR
RTS
CTS
IN
OUT
IN
The signals in the asynchronous serial interface are described below:
DCD Data Carrier Detect - Output from Module - When asserted (TTL low), DCD informs the DTE that a communications link has been established with another MHX 920A.
RX Receive Data - Output from Module - Signals transferred from the MHX 920A are received by the DTE via RX.
TX Transmit Data - Input to Module - Signals are transmitted from the DTE via TX to the MHX 920A.
DTR Data Terminal Ready - Input to Module - Asserted (TTL low) by the DTE to inform the module that it is alive and ready for communications.
SG Signal Ground - Provides a ground reference for all signals transmitted by both DTE and DCE.
DSR Data Set Ready - Output from Module - Asserted (TTL low) by the DCE to inform the DTE that it is alive and ready for communications. DSR is the module’s equivalent of the DTR signal.
RTS Request to Send - Input to Module -
A “handshaking” signal which is asserted by the DTE (TTL low) when it is ready. When hardware handshaking is used, the RTS signal indicates to the DCE that the host can receive data.
CTS Clear to Send - Output from Module - A “handshaking” signal which is asserted by the DCE (TTL low) when it has enabled communications and transmission from the DTE can commence. When hardware handshaking is used, the CTS signal indicates to the host that the DCE can receive data.
Notes: It is typical to refer to RX and TX from the perspective of the DTE. This should be kept in mind when looking at signals relative to the module (DCE); the module transmits data on the RX line, and receives on TX.
“DCE” and “module” are often synonymous since a module is typically a DCE device.
“DTE” is, in most applications, a device such as a host PC.
© Microhard Systems Inc. 177
Appendix B: IP-Passthrough Example (Page 1 of 2)
By completing the Quick Start process, a user should have been able to log in and set up the IPn4G to work with their cellular carrier. By completing this, the modem is ready to be used to access the internet and provide mobile connectivity. However, a common application of the IPn4G is to access connected devices remotely. In order to do this, the IPn4G must be told how to deal with incoming traffic, where to send it to. To accomplish this there are three options :
- IP-Passthrough
- Port Forwarding
- DMZ (a type of Port Forwarding)
In this section we will talk about IP-Passthrough and how to configure the IPn4G and the connected device/PC to work with IP-Passthrough. IP-Passthrough means that the IPn4G is transparent, and all outside (WAN) traffic is simply sent directly to a single device connected to the physical LAN RJ-45 port on the IPn4G (With exception of port 80, which is retained for remote configuration (configurable). Also, any traffic that is sent to the RJ45 port is sent directly out the WAN port and is not processed by the IPn4G.
IP-Passthrough is ideal for applications where only a single device is connected to the IPn4G, and other features of the IPn4G are not required. When in pass-through mode, most features of the IPn4G are bypassed, this includes the serial ports, the GPS features, VPN, the Firewall, and much more. The advantage of IP-Passthrough is that the configuration is very simple.
In the example below we have a IPn4G connected to a PC (PC2). The application requires that PC1 be able to access several services on PC2. Using Port Forwarding this would require a new rule created for each port, and some applications or services may require several ports so this would require several rules, and the rules may be different for each installation, making future maintenance difficult. For IP-
Passthrough, PC1 only needs to know the Public Static IP Address of the IPn4G, the IPn4G would then automatically assign, via DHCP, the WAN IP to the attached PC2, creating a transparent connection.
Cellular Network/
Internet
Wireless Cellular
Connection
Connected to RJ45
LAN Ethernet Port.
PC1: Connected to
internet.
WAN IP: 74.198.186.193
(Cellular Carrier)
LAN IP: 74.198.186.1 (Used for WebUI from LAN)
PC2: (DHCP)
WebServer running on port 80
Step 1
Log into the IPn4G (Refer to Quick Start), and ensure that DHCP is enabled on the Network > LAN page.
Step 2
Since PC2 requires port 80 to be used as its Web server port, port
80 cannot be used on the IPn4G, by default it retains this port for remote configuration. To change the port used by the IPn4G, navigate to the System > Settings page as seen below. For this example we are going to change it to port 8080. When changing port numbers on the IPn4G, it is recommended to reboot the unit before continuing, remember the new WebUI port is now 8080 when you log back into the IPn4G. (e.g. 192.168.168.1:8080).
© Microhard Systems Inc. 178
Appendix B: IP-Passthrough Example (Page 2 of 2)
Step 3
Now IP-Passthrough can be enabled on the IPn4G. Under the
Carrier > Settings tab, IP-Passthrough can be found. To enable this feature, select “Ethernet” from the drop down box. Once the changes are applied, whichever device is physically connected to the LAN
RJ45 port, will dynamically be assigned the WAN IP Address. In this example, this would be 74.198.186.193.
The default IP address of 192.168.168.1 on the LAN is no longer available, but it is still possible to access and configure the IPn4G on the LAN side, by using the X.X.X.1 IP Address, where the first 3 octets of the WAN IP are used in place of the X’s. (e.g.
74.198.186.1, and remember the HTTP port in this example was changed to 8080).
Step 4
Attach the remote device or PC to the RJ45 port of the IPn4G. The end device has to be set up for DHCP to get an IP address from the IPn4G. In the test/example setup we can verify this by looking at the current IP address. In the screenshot to the right we can see that the Laptop connected to the IPn4G has a IP Address of 74.198.186.193, which is the IP address assign by the cellular carrier for the modem.
Step 5 (Optional)
IP-Passthrough operation can also be verified in the IPn4G. Once IP-
Passthrough is enabled you can access the IPn4G WebUI by one of the following methods:
Remotely on the WAN side (usually the internet), using the WAN
IP, and the port specified for HTTP operation (or, if enabled, by using the HTTPS (443) ports), in this example with would be 74.198.186.193:8080.
On the LAN side, by entering in the first 3 octets of the WAN IP and .1 for the fourth, so in our example
74.198.186.1:8080.
Once logged in, navigate to the Carrier > Status page. Under
WAN IP Address it should look something like shown in the image to the right, 74.198.186.193 on LAN.
Step 6
The last step is to verify the remote device can be accessed. In this example a PC is connected to the RJ45 port of the
IPn4G. On this PC a simple apache web server is running to illustrate a functioning system. On a remote PC, enter the
WAN IP Address of the IPn4G into a web browser. As seen below, when the IP Address of the IPn4G is entered, the data is passed through to the attached PC. The screen shot below shows that our test setup was successful.
© Microhard Systems Inc. 179
Appendix C: Port Forwarding Example (Page 1 of 2)
© Microhard Systems Inc.
By completing the Quick Start process, a user should have been able to log in and set up the IPn4G to work with their cellular carrier. By completing this, the modem is ready to be used to access the internet and provide mobile connectivity. However, one of the main applications of the IPn4G is to access connected devices remotely. In order to do this, the IPn4G must be told how to deal with incoming traffic, where to send it to. To accomplish this there are three options :
- IP-Passthrough
- Port Forwarding
- DMZ (a type of Port Forwarding)
In the previous section we illustrated how to use and setup IP-Passthrough. In this section we will talk about port forwarding. Port forwarding is ideal when there are multiple devices connected to the IPn4G, or if other features of the IPn4G are required (Serial Ports, Firewall, GPS, etc). In port forwarding, the IPn4G looks at each incoming Ethernet packet on the WAN and by using the destination port number, determines where it will send the data on the private LAN . The IPn4G does this with each and every incoming packet.
DMZ (a form of port forwarding) is useful for situations where there are multiple devices connected to the
IPn4G, but all incoming traffic is destined for a single device. It is also popular to use DMZ in cases where a single device is connected but several ports are forwarded and other features of the IPn4G are required, since in passthrough mode all of these features are lost.
Consider the following example. A user has a remote location that has several devices that need to be accessed remotely. The User at PC1 can only see the IPn4G directly using the public static IP assigned by the wireless carrier, but not the devices behind it. In this case the IPn4G is acting a gateway between the
Cellular Network and the Local Area Network of its connected devices. Using port forwarding we can map the way that data passes through the IPn4G.
PC1: Connected to
internet.
Cellular Network/
Internet
Wireless Cellular
Connection
IPn4G
WAN IP:
74.198.186.193
(Cellular Carrier)
LAN IP:
192.168.168.1
Wired or Wireless
Devices
Switch
PC2: 192.168.168.20
Webserver on port 80
PLC/RTU: 192.168.168.30
Webserver on port 80
Modbus on port 502
IP Camera: 192.168.168.40
Webserver on Port 80
Step 1
Log into the IPn4G (Refer to Quick Start), and ensure that the
Firewall is enabled. This can be found under Firewall >
General. Also ensure that WAN Request is set to Allow, which allows traffic to come in from the WAN/4G, or that sufficient
Rules or IP lists have been setup to allow specific traffic to pass through the IPn4G. Once that is complete, remember to “Submit” the changes.
180
Appendix C: Port Forwarding Example (Page 2 of 2)
Step 2
Determine which external ports (WAN) are mapped to which internal IP Addresses and Ports (LAN). It is important to understand which port, accessible on the outside, is connected or mapped to which devices on the inside. For this example we are going to use the following ports, in this case it is purely arbitrary which ports are assigned, some systems may be configurable, other systems may require specific ports to be used.
Description
IPn4G WebUI
WAN IP
74.198.186.193
External Port
80
Internal IP
192.168.168.1
Internal Port
80
PC2 Web Server
PLC Web Server
PLC Modbus
74.198.186.193
74.198.186.193
74.198.186.193
74.198.186.193
8080
8081
10502
8082
192.168.168.20
192.168.168.30
192.168.168.30
192.168.168.40
80
80
502
80 Camera Web Server
Notice that to the outside user, the IP Address for every device is the same, only the port number changes, but on the
LAN, each external port is mapped to an internal device and port number. Also notice that the port number used for the configuration GUI for all the devices on the LAN is the same, this is fine because they are located on different IP addresses, and the different external ports mapped by the IPn4G (80, 8080, 8081, 8082), will send the data to the intended destination.
Step 3
Create a rule for each of the lines above. A rules does not need to be created for the first line, as that was listed simply to show that the external port 80 was already used, by default, by the IPn4G itself. To create port forwarding rules, Navigate to the Firewall >
Port Forwarding menu. When creating rules, each rules requires a unique name, this is only for reference and can be anything desired by the user. Click on the “Add Port Forwarding” button to add each rule to the IPn4G.
Once all rules have been added, the IPn4G configuration should look something like what is illustrated in the screen shot to the right. Be sure to “Submit” the Port Forwarding list to the IPn4G.
For best results, reboot the IPn4G.
Step 4
Configure the static addresses on all attached devices. Port forwarding required that all the attached devices have static
IP addresses, this ensure that the port forwarding rules are always correct, as changing IP addresses on the attached devices would render the configured rules useless and the system will not work.
Step 5
Test the system. The devices connected to the IPn4G should be accessible remotely. To access the devices:
For the Web Server on the PC, use a browser to connect to 74.198.186:193:8080, in this case the same webserver is running as in the IP-Passthrough example, so the result should be as follows:
To access the other devices/services: For the PLC Web Server: 74.198.186.193:8081, for the Camera
74.198.186.193:8082, and for the Modbus on the PLC telnet to 74.198.186.193:10502 etc.
© Microhard Systems Inc. 181
Appendix D: VPN Example (Page 1 of 2)
By completing the Quick Start process, a user should have been able to log in and set up the IPn4G to work with their cellular carrier. By completing this, the modem is ready to be used to access the internet and provide mobile connectivity. However, one of the main applications of the IPn4G is to access connected devices remotely. In addition to Port Forwarding and IP-Passthrough, the IPn4G has several
VPN capabilities, creating a tunnel between two sites, allowing remote devices to be accessed directly.
VPN allows multiple devices to be connected to the IPn4G without the need to individually map ports to each device. Complete access to remote devices is available when using a VPN tunnel. A VPN tunnel can be created by using two IPn4G devices, each with a public IP address. At least one of the modems require a static IP address. VPN tunnels can also be created using the IPn4G to existing VPN capable devices, such as Cisco or Firebox.
Example: IPn4G to IPn4G (Site-to-Site)
Site A Site B
IPn4G
WAN IP Carrier
Assigned: A.B.C.D
IPn4G
WAN IP Carrier
Assigned: E.F.G.H
Step 1
Log into each of the IPn4Gs (Refer to Quick Start), and ensure that the Firewall is enabled. This can be found under
Firewall > General. Also ensure that either WAN Request is set to Allow, which allows traffic to come in from the WAN, or that sufficient Rules or IP lists have been setup to allow specific traffic to pass through the IPn4G. Once that is complete, remember to “Apply” the changes.
Step 2
Configure the LAN IP and subnet for each IPn4G. The subnets must be different and cannot overlap.
Site A Site B
© Microhard Systems Inc. 182
Appendix D: VPN Example (Page 2 of 2)
Step 3
Add a VPN Gateway to Gateway tunnel on each IPn4G.
Site A
A.B.C.D
Site B
E.F.G.H
Must Match!
Step 4
Submit changes to both units. It should be possible to ping and reach devices on either end of the VPN tunnel if both devices have been configured correctly and have network connectivity.
© Microhard Systems Inc. 183
Appendix E: Firewall Example (Page 1 of 2)
By completing the Quick Start process, a user should have been able to log in and set up the IPn4G to work with their cellular carrier. By completing this, the modem is ready to be used to access the internet and provide mobile connectivity. However, one of the main applications of the IPn4G is to access connected devices remotely. Security plays an important role in M2M deployments as in most cases the modem is publically available on the internet. Limiting access to the IPn4G is paramount for a secure deployment. The firewall features of the IPn4G allow a user to limit access to the IPn4G and the devices connected to it by the following means
- Customizable Rules
- MAC and/or IP List
- ACL (Access Control List) or Blacklist using the above tools.
Consider the following example. An IPn4G is deployed at a remote site to collect data from an end device such as a PLC or RTU connected to the serial DATA port (Port 20001 on the WAN. It is required that only a specific host (Host A) have access to the deployed IPn4G and attached device, including the remote management features.
Host B:
84.53.23.12
Host A:
184.71.46.126
Host C:
186.41.57.101
Firewall
IPn4G
WAN IP: 74.198.186.193
Local Device on TCP
Port 20001
Step 1
Log into the IPn4G (Refer to Quick Start). Navigate to the Firewall > General tab as shown below and ensure that the
Firewall is turned on by enabling the Firewall Status. Next block all WAN traffic by setting the WAN Request to Block, and disable Remote Management. Be sure to Apply the settings. At this point it should be impossible to access the
IPn4G from the WAN.
© Microhard Systems Inc. 184
Appendix E: Firewall Example (Page 2 of 2)
Step 2
Under the Rules tab we need to create two new rules. A rule to enable Host A access to the Remote Management Port
(TCP Port 80), and another to access the device attached the to serial port (WAN TCP Port 20001).
Rule 1
Rule 2
After each rule is created be sure to click the ADD Rule button, once both rules are created select the Submit button to write the rules to the IPn4G. The Firewall Rules Summary should look like what is shown below.
Step 3
Test the connections. The IPn4G should only allow connections to the port specified from the Host A. An alternate means to limit connections to the IPn4G to a specific IP would have been to use the MAC-IP List Tool. By using Rules, we can not only limit specific IP’s, but we can also specify ports that can be used by an allowed IP address.
© Microhard Systems Inc. 185
Appendix F: GRE Example
The following pages outline the different GRE configurations available for the IPn4G. This may be useful in determining which fields are populated by showing a working example. Three different setups are shown:
General GRE (without IPsec), GRE over IPsec (Transport Mode) and GRE over IPsec (Tunnel Mode).
Appendix F Image 1: Network Configuration Example Topology
Prerequisites:
1. Firewall > General > WAN Request Allow (Not Recommened), OR add a specific firewall rules
(Recommened)
2. Add a route on PC-1: ip route add 192.168.169.0/24 via 192.168.168.1 dev eth0
Add a route on PC-2: ip route add 192.168.168.0/24 via 192.168.169.1 dev eth0
Example 1: General GRE (without IPsec)
© Microhard Systems Inc. 186
Appendix F: GRE Example
Example 2: GRE over IPsec (Transport Mode)
© Microhard Systems Inc. 187
Appendix F: GRE Example
Example 3: GRE over IPsec (Tunnel Mode)
© Microhard Systems Inc. 188
Appendix G: Firmware Recovery Procedure
In event that your unit becomes unresponsive it may be required to perform a firmware recovery procedure outlined below:
1. Download and save firmware file in a local folder, for example C:\;
2. Separate the PC from the network and set IP to static:
192.168.1.1
255.255.255.0
3. Connect PC Ethernet port to the Ethernet port of the modem to be recovered
4. Start a ping on the PC
C:\>ping 192.168.1.39 -t
Pinging 192.168.1.39 with 32 bytes of data:
Request timed out.
Request timed out.
5. Power cycle modem while pressing and holding CFG(Config) button;
6. Release the CFG button when ping responded:
C:\>ping 192.168.1.39 -t
Pinging 192.168.1.39 with 32 bytes of data:
Request timed out.
Request timed out.
Request timed out.
Reply from 192.168.1.39: bytes=32 time<1ms TTL=128
Reply from 192.168.1.39: bytes=32 time<1ms TTL=128
Reply from 192.168.1.39: bytes=32 time<1ms TTL=128
Reply from 192.168.1.39: bytes=32 time<1ms TTL=128
Note, If ping responds as shown above, then you can probably recover the unit, please proceed.
Otherwise, send the unit back for RMA.
7. Now use TFTP to push firmware file into the corrupted unit:
For example, on Windows XP using following command line:
tftp -i 192.168.1.39 put IPn4G-v1_1_0-r1084-16.bin (or the file saved).
8. Wait until above command to successfully transfered the image, similar message should show
Transfer successful: xxxxxxx bytes in 5 seconds, nnnnnnn bytes/s, note the number might change for different firmware file
Note, if you see message above, the unit will re-flash itself and reboot, otherwise call for help or send back for RMA.
9. Wait for the unit to recover and reboot.
© Microhard Systems Inc. 189
Appendix H: Troubleshooting
Below is a number of the common support questions that are asked about the IPn4G. The purpose of the section is to provide answers and/or direction on how to solve common problems with the IPn4G.
__________________________________________________________________
Question:
Why can’t I connect to the internet/network?
Answer: To connect to the internet a SIM card issued by the Wireless Carrier must be installed and the
APN programmed into the Carrier Configuration of the IPn4G. For instructions of how to log into the IPn4G refer to the Quick Start.
__________________________________________________________________
Question: What is the default IP Address of the IPn4G?
Answer: The default IP address for the LAN (the RJ45 connector on the back of the unit) is
192.168.168.1.
__________________________________________________________________
Question: What is the default login for the IPn4G?
Answer: The default username is admin, the default password is admin.
__________________________________________________________________
Question: What information do I need to get from my wireless carrier to set up the IPn4G?
Answer: The APN is required to configure the IPn4G to communicate with a wireless carrier. Some carriers also require a username and password. The APN, username and password are only available from your wireless carrier.
Newer units may support an AUTO APN feature, which will attempt to determine the APN from a preconfigured list of carriers and commonly used APN’s. This is designed to provide quick network connectivity, but will not work with private APN’s. Success with AUTO APN will vary by carrier.
________________________________________________________________
Question: How do I reset my modem to factory default settings?
Answer: If you are logged into the IPn4G navigate to the System > Maintenance Tab. If you cannot log in, power on the IPn4G and wait until the status LED in on solid (not flashing). Press and hold the
CONFIG button until the unit reboots (about 8-10 seconds).
_________________________________________________________________
Question: I can connect the Carrier, but I can’t access the Internet/WAN/network from a connected PC?
Answer: Ensure that you have DHCP enabled or manually set up a valid IP, Subnet, Gateway and DNS set on the local device.
__________________________________________________________________
Question: I connected a device to the serial port of the IPn4G and nothing happens?
Answer: In addition to the basic serial port settings, the IP Protocol Config has to be configured. Refer to the COM0/1 Configuration pages for a description of the different options.
© Microhard Systems Inc. 190
Appendix H: Troubleshooting
__________________________________________________________________
Question: How do I access the devices behind the modem remotely?
Answer: To access devices behind the IPn4G remotely, several methods can be used:
A. IP Passthrough - The IPn4G is transparent and the connected device can be access directly.
Refer to The IP-Passthrough Appendix for a detailed example of how this may be deployed.
B. Port Forwarding/DMZ -
Individual external WAN ports are mapped to internal LAN IP’s and
Ports. See the Port-Forwarding Appendix for a detailed example.
C. VPN - A tunnel can be created and full access to remote devices can be obtained. Required the use of multiple modems or VPN routers. See the VPN Appendix on an example of how to set up a VPN.
_________________________________________________________________
Question: I have set up firewall rules and/or port forwarding rules but they do not work?
Answer: Ensure that the Firewall is Enabled. Even port forwarding requires that the firewall feature is enabled. Also, ensure the WAN request is enabled. If blocked, additional rules will need to be created for any external request.
_________________________________________________________________
Question: I have Internet/WAN access but I cannot ping the device remotely?
Answer: Ensure that the WAN request is enabled in the Firewall settings.
_________________________________________________________________
Question: I’m using IP-Passthrough but the serial ports won’t work?
Answer: When using IP-Passthrough, the WAN IP is assigned to the device connected to the Ethernet port, all traffic is passed through to that device. As a result serials port will not work. The only port not being passed through is the remote management port (default port 80), which can be changed in the security settings.
_________________________________________________________________
Question: I’m using IP-Passthrough but the modem won’t take my Firewall settings?
Answer: When using IP-Passthrough, the WAN IP is assigned to the device connected to the Ethernet port, all traffic is passed through to that device. As a result the firewall settings have no effect on the unit, and is automatically disabled.
_________________________________________________________________
Question: I cannot get IP-Passthrough to work?
Answer: When using IP-Passthrough, the WAN IP is assigned to the device connected to the Ethernet port, all traffic is passed through to that device. In order for IP-Passthrough to work, the connected local device must have DHCP enabled.
© Microhard Systems Inc. 191
Appendix H: Troubleshooting
_________________________________________________________________
Question: Why does my modem reset every 10 minutes (or other time)?
Answer: There are a number of processes in the IPn4G that ensure that the unit is communicating at all times, and if a problem is detected will reboot the modem to attempt to resolve any issues:
1. Traffic Watchdog - Detects if there is any Wireless Traffic between the IPn4G and the
Cellular Carrier. Will reboot modem when timer expires unless there is traffic. Carrier > Traffic
Watchdog.
2. Keepalive - Attempts to contact a configured host on a defined basis. Will reboot modem if host is unreachable. Enabled by default to attempt to ping 8.8.8.8. May need to disable on private networks, or provide a reachable address to check. Access via Carrier > Keepalive.
3. Local Device Monitor - The IPn4G will monitor a local device, if that device is not present the
IPn4G may reboot. Network > LocalMonitor.
_______________________________________________________________
Question: How do I set up VPN?
Answer: Refer to the VPN Appendix for an example.
© Microhard Systems Inc. 192
© Microhard Systems Inc.
150 Country Hills Landing NW
Calgary, Alberta
Canada T3K 5P3
Phone: (403) 248-0028
Fax: (403) 248-2762 www.microhardcorp.com
193
advertisement
Key Features
- Provides secure and reliable data connectivity to remote serial devices over LTE networks, enabling remote monitoring and control.
- Supports a variety of serial protocols, including Modbus, DNP3, and ASCII.
- Offers flexible mounting options, including DIN-rail, panel, or desktop.
- Equipped with high-gain antennas for enhanced signal reception.
- Supports advanced security features, such as VPN and firewall protection.
- Compact and rugged design, suitable for harsh industrial environments.
- Capable of operating in extreme temperatures, from -40°C to +70°C.
Related manuals
Frequently Answers and Questions
What is the IP rating of the IPN4G?
Does the IPN4G support PoE (Power over Ethernet)?
What is the maximum data transfer rate of the IPN4G?
advertisement