NetComm NTC-100 User Manual

Page 1
User Guide
4G LTE Cat M1/NB1 Industrial IoT Serial Modem
Doc No. UG01037
Page 2
2 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Important Notice
This device, like any wireless device, operates using radio signals which cannot guarantee the transmission and reception of data in all conditions. While the delay or loss of signal is rare, you should not rely solely on any wireless device for emergency communications or otherwise use the device in situations where the interruption of data connectivity could lead to death, personal injury, property damage, data loss, or other loss. NetComm Wireless accepts no responsibility for any loss or damage resulting from errors or delays in transmission or reception, or the failure of the NTC-100 to transmit or receive such data.
Safety and Hazards
Do not connect or disconnect cables or devices to or from the USB port, SIM card tray, Ethernet port or the terminals of the Molex power connector in hazardous locations such as those in which flammable gases or vapours may be present, but normally are confined within closed systems; are prevented from accumulating by adequate ventilation; or the location is adjacent to a location from which ignitable concentrations might occasionally be communicated.
Copyright
Copyright© 2018 NetComm Wireless Limited. All rights reserved.
The information contained herein is proprietary to NetComm Wireless. No part of this document may be translated, transcribed, reproduced, in any form, or by any means without prior written consent of NetComm Wireless.
Trademarks and registered trademarks are the property of NetComm Wireless Limited or their respective owners. Specifications are subject to change without notice. Images shown may vary slightly from the actual product.
Note – This document is subject to change without notice.
Save our environment
When this equipment has reached the end of its useful life, it must be taken to a recycling centre and processed separately from domestic waste.
The cardboard box, the plastic contained in the packaging, and the parts that make up this device can be recycled in accordance with regionally established regulations. Never dispose of this electronic equipment along with domestic waste. You may be subject to penalties or sanctions under the law. Instead, ask for disposal instructions from your municipal government.
Please be responsible and protect our environment.
Page 3
3 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Document history
This guide covers the following products:
NetComm - 4G LTE Cat M1/NB1 Industrial IoT Serial Modem
VER.
DOC UM EN T DE SC RI PT IO N
D AT E
v1.0
Initial document release
24 July 2018
v1.1
Added relevant Quectel AT command list
Added common scenario configurations for PPP and PAD mode
Added note to AT+APN command
Corrected NanoFit cable diagram
Correction to AT+PDP_TYPE options
Correction to AT+SMS_PASSWORD command
Corrections to
o FAQs o Application firmware upgrade Over the Air from HTTP/S server using
SMS
o Application firmware upgrade Over the Air from an HTTP/S server
using Customized AT command
o Module firmware upgrade Over the Air from an HTTP/S server using
SMS
25 September 2018
Table i. - Document revision history
Page 4
4 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Contents
Introduction ....................................................................................................................................................................... 9
Target users .................................................................................................................................................................................................................... 9
Prerequisites ................................................................................................................................................................................................................... 9
Notation .......................................................................................................................................................................................................................... 9
Safety and product care ................................................................................................................................................... 10
Transport and handling .................................................................................................................................................... 10
Product introduction ........................................................................................................................................................ 11
Product features ........................................................................................................................................................................................................... 11
Connect legacy equipment.................................................................................................................................................................................. 11
Network and service flexibility ............................................................................................................................................................................. 11
Universal installation ............................................................................................................................................................................................. 11
Custom application ............................................................................................................................................................................................... 11
SMS control ............................................................................................................................................................................................................ 11
Package contents ............................................................................................................................................................. 12
Accessories ................................................................................................................................................................................................................... 12
Physical dimensions and indicators ................................................................................................................................... 13
LED indicators............................................................................................................................................................................................................... 13
Signal strength....................................................................................................................................................................................................... 13
Physical dimensions ......................................................................................................................................................... 14
Interfaces ......................................................................................................................................................................... 15
Hardware installation ....................................................................................................................................................... 16
Connecting the antenna.............................................................................................................................................................................................. 16
Inserting the SIM card ................................................................................................................................................................................................. 16
Mounting the device ........................................................................................................................................................ 18
Connecting the data/power cables ........................................................................................................................................................................... 19
Powering the NTC-100 serial modem via 5V Micro USB socket ............................................................................................................................. 19
Powering the NTC-100 serial modem via Y-cable .................................................................................................................................................... 20
Accessing the NTC-100 via terminal emulator .................................................................................................................. 21
Command Line Interface Guide........................................................................................................................................ 22
PPP Mode...................................................................................................................................................................................................................... 22
Configuring PPP mode with SMS commands .................................................................................................................................................... 22
Configuring PPP mode with AT commands ....................................................................................................................................................... 23
PAD Mode .................................................................................................................................................................................................................... 23
Configuring PAD mode with SMS ....................................................................................................................................................................... 24
Configuring PAD mode with AT commands ..................................................................................................................................................... 24
Command Line List .......................................................................................................................................................... 25
AT+ALL.......................................................................................................................................................................................................................... 25
AT+APN ........................................................................................................................................................................................................................ 25
AT+APN_SEP ............................................................................................................................................................................................................... 25
AT+AUTH_TYPE ........................................................................................................................................................................................................... 26
Page 5
5 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+CFUN ..................................................................................................................................................................................................................... 26
AT+CHAR_TIMEOUT .................................................................................................................................................................................................. 27
AT+DAILY_SMS_LIMIT ................................................................................................................................................................................................ 27
AT+DNS ........................................................................................................................................................................................................................ 27
AT+DYN_ENABLE ....................................................................................................................................................................................................... 28
AT+DYN_HOST ........................................................................................................................................................................................................... 28
AT+DYN_PASS ............................................................................................................................................................................................................. 28
AT+DYN_USER ............................................................................................................................................................................................................ 28
AT+EOL ......................................................................................................................................................................................................................... 29
AT+FACTORY_RESET ................................................................................................................................................................................................. 29
AT+FAIL_COUNT ........................................................................................................................................................................................................ 30
AT+FORCE_RECONNECT ......................................................................................................................................................................................... 30
AT+FORCE_RESET ...................................................................................................................................................................................................... 30
AT+FTP_FILE ................................................................................................................................................................................................................ 31
AT+FTP_HOST ............................................................................................................................................................................................................. 31
AT+FTP_PARA .............................................................................................................................................................................................................. 31
AT+FTP_PASS .............................................................................................................................................................................................................. 31
AT+FTP_PATH ............................................................................................................................................................................................................. 32
AT+FTP_RETRY ............................................................................................................................................................................................................ 32
AT+FTP_UPLOAD=1 ................................................................................................................................................................................................... 32
AT+FTP_USER .............................................................................................................................................................................................................. 32
AT+HISTORY ................................................................................................................................................................................................................ 33
AT+HW_VERSION ....................................................................................................................................................................................................... 33
AT+IMEI ........................................................................................................................................................................................................................ 33
AT+IPV4_MTU .............................................................................................................................................................................................................. 33
AT+IPV6_MTU .............................................................................................................................................................................................................. 34
AT+LOCAL_IP .............................................................................................................................................................................................................. 34
AT+LOGIN_PASS......................................................................................................................................................................................................... 34
AT+LOGIN_USER ........................................................................................................................................................................................................ 34
AT+MODEM_MODE ................................................................................................................................................................................................... 35
AT+MODULE_WATCHDOG ...................................................................................................................................................................................... 35
AT+NO_WHITELIST .................................................................................................................................................................................................... 35
AT+NON_REBOOT ..................................................................................................................................................................................................... 36
AT+PAD ........................................................................................................................................................................................................................ 36
AT+PAKBUS ................................................................................................................................................................................................................. 37
AT+PDP_TYPE .............................................................................................................................................................................................................. 37
AT+PING ....................................................................................................................................................................................................................... 37
AT+PING_ACC_TIMER ............................................................................................................................................................................................... 38
AT+PING_IP1................................................................................................................................................................................................................ 38
AT+PING_IP2................................................................................................................................................................................................................ 38
AT+PING_TIMER ......................................................................................................................................................................................................... 38
AT+PING_WATCHDOG ............................................................................................................................................................................................. 39
AT+REPLY_CMD_ERROR ........................................................................................................................................................................................... 39
AT+SAVE ....................................................................................................................................................................................................................... 39
AT+SERIAL_BAUD ....................................................................................................................................................................................................... 40
AT+SERIAL_FLOW ....................................................................................................................................................................................................... 40
AT+SERIAL_FORMAT ................................................................................................................................................................................................. 41
AT+SERIAL_MODE ...................................................................................................................................................................................................... 41
AT+SERIAL_ON_START .............................................................................................................................................................................................. 42
AT+SERIAL_PARITY ..................................................................................................................................................................................................... 42
AT+SERVER .................................................................................................................................................................................................................. 43
AT+SMS ........................................................................................................................................................................................................................ 43
AT+SMS_ACK............................................................................................................................................................................................................... 44
AT+SMS_DIAGNOSTICS ............................................................................................................................................................................................ 44
AT+SMS_PASSWORD ................................................................................................................................................................................................. 45
Page 6
6 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+STATUS .................................................................................................................................................................................................................. 45
AT+STATUS_FORMAT ................................................................................................................................................................................................ 45
AT+TCP_RETRY ........................................................................................................................................................................................................... 46
AT+TCP_TIMEOUT ...................................................................................................................................................................................................... 46
AT+USER_PASS ........................................................................................................................................................................................................... 47
AT+VERSION ................................................................................................................................................................................................................ 47
AT+WEB_FILE .............................................................................................................................................................................................................. 47
AT+WEB_HOST ........................................................................................................................................................................................................... 47
AT+WEB_PASS ............................................................................................................................................................................................................ 48
AT+WEB_PATH ............................................................................................................................................................................................................ 48
AT+WEB_PORT ............................................................................................................................................................................................................ 48
AT+WEB_RETRY .......................................................................................................................................................................................................... 48
AT+WEB_UPLOAD ...................................................................................................................................................................................................... 49
AT+WEB_USER ............................................................................................................................................................................................................ 49
AT+WHITELIST ............................................................................................................................................................................................................. 49
Quectel AT Command List ............................................................................................................................................... 50
AT+CEREG EPS Network Registration Status ......................................................................................................................................................... 50
AT+CGATT Attachment or Detachment of PS........................................................................................................................................................ 52
AT+CLCK Facility Lock ............................................................................................................................................................................................... 53
AT+COPS Operator Selection .................................................................................................................................................................................. 56
AT+CPIN Enter PIN .................................................................................................................................................................................................... 58
AT+GSN Request International Mobile Equipment Identity (IMEI) ...................................................................................................................... 60
AT+QCFG="band” Band Configuration ................................................................................................................................................................. 61
AT+QCFG="celevel" Get LTE Cat NB1 Coverage Enhancement Level ............................................................................................................. 63
AT+QCFG="iotopmode" Configure Network Category to be Searched under LTE RAT ............................................................................... 64
AT+QCFG="nwscanmode" Network Search Mode Configuration ..................................................................................................................... 65
AT+QCFG="nwscanseq" Network Searching Sequence Configuration ............................................................................................................. 66
AT+QCFG="PDP/DuplicateChk" Establish Multi PDNs with the Same APN ..................................................................................................... 66
AT+QCSQ Query and Report Signal Strength ........................................................................................................................................................ 67
AT+QNWINFO Query Network Information ........................................................................................................................................................... 69
AT+QSPN Display the Name of Registered Network ............................................................................................................................................ 71
AT+QSPN* Display the Name of Registered Network .......................................................................................................................................... 72
AT+CVERSION Display module firmware version .................................................................................................................................................. 72
General Operation ........................................................................................................................................................... 73
PAD mode ..................................................................................................................................................................................................................... 73
PPP mode ...................................................................................................................................................................................................................... 73
PSTN mode ................................................................................................................................................................................................................... 73
Configuration through SMS .............................................................................................................................................. 74
execute clear .......................................................................................................................................................................................................... 74
execute factory_reset ........................................................................................................................................................................................... 74
execute pdpcycle .................................................................................................................................................................................................. 74
execute pdpdown ................................................................................................................................................................................................. 74
execute pdpup ...................................................................................................................................................................................................... 74
execute reboot ...................................................................................................................................................................................................... 74
execute save .......................................................................................................................................................................................................... 74
get apn ................................................................................................................................................................................................................... 74
get apn_sep ........................................................................................................................................................................................................... 74
get ccid ................................................................................................................................................................................................................... 75
get daily_sms_limit ................................................................................................................................................................................................ 75
get fail_count ......................................................................................................................................................................................................... 75
get force_reconnect .............................................................................................................................................................................................. 75
get force_reset ...................................................................................................................................................................................................... 75
get ftp_para ........................................................................................................................................................................................................... 75
get hw_version....................................................................................................................................................................................................... 75
Page 7
7 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
get imei .................................................................................................................................................................................................................. 75
get modem_mode ................................................................................................................................................................................................ 75
get module_watchdog ......................................................................................................................................................................................... 75
get pdp_type ......................................................................................................................................................................................................... 76
get ping_acc_timer ............................................................................................................................................................................................... 76
get ping_ip1 ........................................................................................................................................................................................................... 76
get ping_ip2 ........................................................................................................................................................................................................... 76
get ping_timer ....................................................................................................................................................................................................... 76
get ping_watchdog ............................................................................................................................................................................................... 76
get ping=[domain name / IP address] ................................................................................................................................................................ 76
get serial_on_start ................................................................................................................................................................................................. 76
get settings ............................................................................................................................................................................................................ 76
get status ................................................................................................................................................................................................................ 76
get version ............................................................................................................................................................................................................. 77
get web_file ........................................................................................................................................................................................................... 77
get web_host ......................................................................................................................................................................................................... 77
get web_pass ......................................................................................................................................................................................................... 77
get web_path ......................................................................................................................................................................................................... 77
get web_port ......................................................................................................................................................................................................... 77
get web_retry ......................................................................................................................................................................................................... 77
get web_user ......................................................................................................................................................................................................... 77
serv=xxxx ................................................................................................................................................................................................................ 77
set apn_sep ............................................................................................................................................................................................................ 78
set apn+=xxxxx ..................................................................................................................................................................................................... 78
set apn=xxxxx ........................................................................................................................................................................................................ 78
set at=xxxx ............................................................................................................................................................................................................. 78
set auth_type=x ..................................................................................................................................................................................................... 78
set baud=xxx ......................................................................................................................................................................................................... 78
set daily_sms_limit=xxx ........................................................................................................................................................................................ 78
set dyn_enable=0,1 ............................................................................................................................................................................................... 78
set dyn_host=xxx .................................................................................................................................................................................................. 78
set dyn_pass=xxx .................................................................................................................................................................................................. 78
set dyn_user=xxx ................................................................................................................................................................................................... 79
set fail_count .......................................................................................................................................................................................................... 79
set force_reconnect=xxx ...................................................................................................................................................................................... 79
set force_reset=xxxxx ........................................................................................................................................................................................... 79
set ftp_file=xxx ...................................................................................................................................................................................................... 79
set ftp_host=xxx .................................................................................................................................................................................................... 79
set ftp_pass=xxx .................................................................................................................................................................................................... 79
set ftp_path=xxx .................................................................................................................................................................................................... 79
set ftp_retry=xxx .................................................................................................................................................................................................... 79
set ftp_user=xxx .................................................................................................................................................................................................... 79
set ipv4_mtu ........................................................................................................................................................................................................... 79
set ipv6_mtu ........................................................................................................................................................................................................... 80
set modem_mode=x ............................................................................................................................................................................................ 80
set module_watchdog .......................................................................................................................................................................................... 80
set no_whitelist=x ................................................................................................................................................................................................. 80
set non_reboot=0,1 .............................................................................................................................................................................................. 80
set pad=0,1,2,3,4 ................................................................................................................................................................................................... 80
set pdp_type=xxx ................................................................................................................................................................................................. 80
set pdpauth=<username>,<password> ............................................................................................................................................................ 80
set ping_acc_timer ................................................................................................................................................................................................ 80
set ping_ip1 ........................................................................................................................................................................................................... 80
set ping_ip2 ........................................................................................................................................................................................................... 80
set ping_timer ........................................................................................................................................................................................................ 81
set ping_watchdog=0,1 ........................................................................................................................................................................................ 81
set reply_cmd_error=x ......................................................................................................................................................................................... 81
set serial_mode ..................................................................................................................................................................................................... 81
set serial_on_start=0,1 .......................................................................................................................................................................................... 81
set server= ip address/hostname, port .............................................................................................................................................................. 81
set sms=XXXXXXXXXX,”message content” ...................................................................................................................................................... 81
set smspassword=XXXXXX .................................................................................................................................................................................. 81
set web_file ............................................................................................................................................................................................................ 81
set web_host .......................................................................................................................................................................................................... 81
set web_pass.......................................................................................................................................................................................................... 82
set web_path ......................................................................................................................................................................................................... 82
Page 8
8 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set web_port .......................................................................................................................................................................................................... 82
set web_retry ......................................................................................................................................................................................................... 82
set web_upload=1,2 ............................................................................................................................................................................................. 82
set web_user .......................................................................................................................................................................................................... 82
set whitelist=+XXXXXXXXXXX ............................................................................................................................................................................. 82
Upload .................................................................................................................................................................................................................... 82
Updating the application firmware ................................................................................................................................... 83
Via Local PC .................................................................................................................................................................................................................. 83
Pre-requisites for application firmware installation: .......................................................................................................................................... 83
Over the Air (OTA) ....................................................................................................................................................................................................... 85
Updating the module firmware ......................................................................................................................................... 89
Via Local PC .................................................................................................................................................................................................................. 89
Pre-requisites for module firmware installation: ................................................................................................................................................ 89
Over the Air (OTA) ....................................................................................................................................................................................................... 92
Pre-requisites for Module Firmware Over the Air Upgrade: ............................................................................................................................ 92
NanoFit to DE-9 Serial/Power Adapter Cable ................................................................................................................... 95
Electrical Specifications ............................................................................................................................................................................................... 95
Environmental Specifications / Tolerances ............................................................................................................................................................... 96
Product Service and Support ............................................................................................................................................ 97
Troubleshooting .............................................................................................................................................................. 97
FAQs ............................................................................................................................................................................... 98
Appendix A: Tables ......................................................................................................................................................... 99
Page 9
9 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Introduction
This document details the process of configuring the NTC-100 device via a terminal emulation program (such as PuTTY) as well as mounting and deployment advice.
Target users
This document is intended for system integrators or experienced hardware installers who are comfortable with all aspects of IP based networking and possess an understanding of serial-based technologies such as dial-up modems, AT commands and legacy data collection devices.
Prerequisites
A computer with a terminal emulation program (such as PuTTY), a serial port, an appropriate power supply and a device to connect to the NTC-100 modem after configuration has been completed. A SIM card in 2FF format is required for cellular connection.
Notation
The following symbols are used in this user guide:
The following note provides useful information.
The following note requires attention.
The following note provides a warning.
Page 10
10 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Safety and product care
The NTC-100 offers a hardened industrial enclosure making it suitable for a variety of remote deployment locations.
With reference to the unpacking, installation, use and maintenance of your electronic device, the following basic guidelines are recommended:
Installation, configuration and disassembly should be performed by trained personnel only. Do not use or install this product near water to avoid fire or shock hazard. Avoid exposing the equipment to
rain or damp areas.
Do not use or install this product in extremely hot or cold areas. Ensure that the device is installed in an area
where the temperature is within the supported operating temperature range (-30°C to 70°C).
Arrange any cables in a manner such that they are not likely to be stepped on or have items placed on them. Ensure that the voltage and rated current of the power source match the requirements of the device. Do not
connect the device to an inappropriate power source.
Use only a clean, dry cloth to wipe the device. Never apply chemical cleaners on the device.
WARNING
Disconnect the power line from the device before servicing.
Transport and handling
When transporting the NTC-100, we recommend using the original packaging. This ensures the product will not be damaged.
Important – In the event that the product needs to be returned, ensure it is securely packaged with appropriate padding to prevent damage during courier transport.
Page 11
11 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Product introduction
Product features
The NTC-100 is a rugged 4G LTE Cat M1/NB1 Industrial IoT Serial Modem that enables wireless data communication and supports SCADA (Supervisory Control and Data Acquisition) systems. It comes equipped with RS232 serial data connectivity and a Micro USB 2.0 port for the real-time monitoring and control of machines in remote locations.
Connect legacy equipment
Avoid the cost of replacing or upgrading existing assets that run critical processes. The cost-effective NTC-100 sends data to any IP enabled device using RS-232 serial data. Ideal for SCADA use in areas such as manufacturing, utilities, construction and agriculture, the NTC-100 enables the remote collection, monitoring and control across a wide range of IoT applications.
Network and service flexibility
Featuring a multi-mode data module, the NTC-100 supports remote deployments and allows you to choose between a variety of Cat M1/NB1 IoT networks.
Universal installation
Deploy IoT applications in any environment with access to a wide input voltage range, extreme temperature tolerance (-30˚C to 70˚C) and a lockable SIM tray. For easy installation, the compact NTC-100 also includes a DIN rail and flexible wall mount options including a removable mounting bracket.
Custom application
Take advantage of the custom NetComm Wireless application with the capacity to: transparently transfer serial port traffic over the Internet via TCP or UDP using the built-in Packet Assembler and Disassembler (PAD) functionality; configure a periodic reboot to ensure the modem is always accessible and connect to a DynDNS account to update the NTC-100’s IP address when not using a static IP address.
SMS control
Reduce onsite visits and save costs using advanced diagnostics and control via SMS to query status information and settings, execute commands and configure settings.
Page 12
12 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Package contents
The NTC-100 package includes:
1 x NTC-100 serial modem 1 x Y-cable (Nano-fit to DE-9 and DC power input) 1 x DIN rail mounting bracket 1 x Torx screw 1 x Quick start guide
If any of these items are missing or damaged, please contact NetComm Support immediately by visiting the NetComm Support website at: http://support.netcommwireless.com/ .
Accessories
Additional cables are available for purchase separately. Contact your NetComm Wireless sales representative to order additional cables. Refer to the table below for the product codes.
A CC E S SO RY N AM E
P RO DU C T C OD E
Y-Cable (DE-9 female to 10-pin + DC5521 female)
MCBL-00004
Straight cable (10-pin Nano to 8P8C)
MCBL-00003
Straight cable (10-pin Nano to open cable)
MCBL-00005
Page 13
13 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Physical dimensions and indicators
LED indicators
The NTC-100 serial modem uses two LEDs to display the current system and connection status.
L ED
I ND IC AT OR
S TA TU S
D ES CR IP TI ON
Status
Off
The power is off.
Flashing Red
Device error.
Flashing Green
The NTC-100 is powering up.
Solid Green
The NTC-100 is powered up and connected to network.
Network
Off
No signal.
Intermittently Red (on 30 seconds, off 30 seconds)
No SIM detected.
Blinking Red (displays red once every 2 seconds)
SIM detected but not connected, e.g. SIM is PIN locked.
Blinking Red, Amber or Green
Registered to network with poor (red), medium (amber) or strong (green) signal strength.
Flashing Red, Amber or Green
Data being transferred with poor (red), medium (amber) or strong (green) signal strength.
Table 1 - LED indicators
Note: The term blinking means that the LED turns on for 2 seconds and then off for 0.5 seconds, while the term “flashing” means the LED turns on for 100ms and off for 100ms.
Signal strength
The table below provides more detail on the signal strength indicated by the colour of the network LED.
N ET WO RK L ED
G SM
" CA T - M1 " OR " CA T - N B 1 "
Green
RSSI > - 87 dBm
RSRP (value 2)>-90 dBm
Amber
-87>=RSSI>-93
-90 RSRP > -100
Red
-93>=RSSI>-109
-120<RSRP -100
Off
RSSI < = -109 or No Sync to signal
RSRP≤-120 or No Sync to signal
Table 2 - Signal strength
Page 14
14 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Physical dimensions
Below are the physical dimensions of the NTC-100 as well as the physical dimensions of the mounting bracket which can be used to attach the NTC-100 to a Type-O DIN Rail or to provide a wall / ceiling mount.
Figure 1 – NTC-100 Dimensions
N TC -1 00 D IM EN SI O N S
Length
80 mm
Width
50 mm
Depth
20 mm
Weight
60 grams (without mounting bracket and antenna)
Table 3 – NTC-100 Dimensions
Page 15
15 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Interfaces
The following interfaces are available on the NTC-100:
#
I NT ER FA CE
F UN C T IO N
1
10-pin Nano-Fit™ connector
Provides a serial interface via a standard Windows modem for AT command communication and dial-up networking. The serial modem may also be powered from this interface using the Y-cable. Refer to the Technical Data section of this manual for more information.
2
Micro USB 2.0 port
Provides a serial interface via a virtual COM port for AT command communication and dial­up networking. Requires that the Quectel driver is installed. The NTC-100 may be powered from the Micro USB 2.0 port.
3
Reset button
The reset button is multifunctional and can be used to reboot to the main operating system, reboot to recovery or reset the device to factory default settings.
Press and hold the reset button for less than 5 seconds to reboot the device in normal mode. The Status LED flashes green for 5 seconds and then the device reboots.
Press and hold the reset button for between 5 and 15 seconds to reboot to recovery mode. The Status LED flashes amber for 5 seconds then the device reboots into recovery mode.
Press and hold the reset button for between 15 and 20 seconds to reset the device to factory default settings. The Status LED flashes red for 5 seconds then the device reboots with factory default settings.
4
SIM card slot
Push-push SIM connector compatible with 2FF format SIM cards.
5
Cellular antenna socket
SMA Female connector for use with a suitable LTE antenna.
Table 4 - Interfaces
Note – The driver required for the Micro USB virtual COM port is available from the NTC-100 Product Support page at: http://support.netcommwireless.com/product/m2m/NTC-100.
Page 16
16 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Hardware installation
Connecting the antenna
Connect the antenna to the SMA connector on the NTC-100 serial modem by placing it on the SMA connector and turning it in a clockwise direction.
Inserting the SIM card
Ensure that the NTC-100 is not connected to the power cable before proceeding.
Lift the cover from the right side. This reveals the Micro USB 2.0 port and the reset button.
Figure 2 – Opening the side panel
Slide the cover to the right to reveal the SIM card slot.
Figure 3 – Revealing the SIM card slot
Page 17
17 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Insert the SIM card into the slot with the gold SIM conductor pins facing down. Push the SIM card in until it
locks in place. To remove the SIM card, push it in again and it will unlock.
Figure 4 - Inserting a SIM card into the NTC-100 SIM card slot
Slide the cover back to the left and then push the right side closed. To lock the protective cover, fasten the provided Torx screw into the hole below the SIM card slot on the
bottom of the device using a T6 Torx driver.
Figure 5 – Securing the SIM card slot
Page 18
18 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Mounting the device
The NTC-100 can be mounted on the wall or a DIN rail by using the mounting bracket. The mounting bracket is made from polyamide, which is a flexible material.
DIN rail mounting
The NTC-100 serial modem mounting bracket has been designed to fit a TS 35 Type-O DIN rail with a 25mm core.
Bend the mounting bracket at the bend line so that the ridges are able to ‘hold’ onto the DIN rail edges as per the
diagram below. Alternatively, if the end of the DIN rail is open, you can slide the bracket on to the rail. You also have the option of securing the mounting bracket further by screwing it into place on the rail.
Figure 6 – DIN rail mounting
Wall mounting
Select the location where you would like to attach the NTC-100 serial modem. Attach the mounting bracket to the chosen wall or ceiling by using the 3 screw holes (screws not included).
Figure 7 – Wall mounting
Page 19
19 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Connecting the data/power cables
The NTC-100 serial modem may be connected and powered by:
The built-in 5V Micro USB socket (USB cable not included)
OR
The 10-pin power/data connector using the included Y-cable.
Powering the NTC-100 serial modem via 5V Micro USB socket
The NTC-100 serial modem features a USB port which can optionally be used for serial connectivity, terminal emulation, firmware installation or for establishing a PPP internet connection. The USB port enumerates a number of endpoints after the USB port driver is installed.
Connect a standard USB Type A to USB Micro Type B cable (not included) between the NTC-100 serial
modem and a powered USB port on your device (e.g. computer). The USB cable provides the NTC-100 serial modem with power and an emulated serial port input.
Figure 8 – Inserting the USB cable
For USB port communication, you must install a driver compatible with the NTC-100 serial modem’s
embedded Quectel BG96 cellular module. The Windows drivers are available from the NTC-100 serial modem product page on the NetComm Wireless website (https://www.netcommwireless.com/product/ntc-
100) or from the Quectel website.
After the download has completed, install the driver by double-clicking on the downloaded file and
following the installer prompts.
Open the Control Panel and then Device Manager. The NTC-100 serial modem appears under Ports with
three Quectel USB entries.
Page 20
20 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
The COM port used for each port is displayed in brackets next to each port type. For terminal access, take note of the COM port assigned to the Quectel USB AT Port. In the screenshot above, it is COM11. For further instructions, see the Accessing the NTC-100 via terminal emulator section of this guide.
Important – It is not possible to use the mini-USB and Serial connection concurrently. Make sure any open connection on the Serial port is disabled before connecting via the mini-USB cable.
Powering the NTC-100 serial modem via Y-cable
The included Y-cable features a breakout cable providing a DC Jack. Connect the Serial plug to a Serial port on your device (e.g. computer) and then connect a 5-36V power source to the DC Jack to power the unit. Connect the 10-pin plug into the 10-pin connector on the NTC-100 serial modem.
Figure 9 – Powering the NTC-100 serial modem via Y-cable
After powering up, the NTC-100 serial modem is ready to establish a serial communication link. See the next section for instructions on accessing the NTC-100 serial modem via terminal emulator.
Page 21
21 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Accessing the NTC-100 via terminal emulator
From the Serial interface, you can access both module AT commands and custom application AT commands, but you can access only module AT commands from the USB port.
To access the NTC-100 using a terminal emulator:
Using your terminal emulator, create a new connection to the COM port assigned to the connected serial
port, with the bitrate set to 115200.
In the terminal window that appears, type any character. A login prompt appears.
a At the Username prompt type root then press Enter. b At the Password prompt, type admin then press Enter. c Type AT. If the NTC-100 serial modem is connected, it replies with OK.
If you are using another terminal emulator and are required to enter more serial options, the following table lists the correct settings:
S ER IA L OP TI ON S
Port
As assigned by your system. Refer to Device Manager on Windows.
Baud rate
115200
Data bits
8
Parity
None
Stop bits
1
Table 5 – Serial Options
Using a terminal emulator such as PuTTY, the NTC-100 can be configured to perform customised operations.
If you are unable to type at and receive a response, check that you have selected the correct COM port for the NTC-100. Alternatively, try to open a connection using a physical COM port with a DE-9 serial/power adapter cable attached.
Page 22
22 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Command Line Interface Guide
The NTC-100 comes pre-loaded with a NetComm Wireless custom application. This application allows the NTC­100 to operate in different modes, providing additional functionality and support for a number of terminal commands specific to this application. These commands can be used locally via the serial interface to send or receive serial data to or from TCP/UDP servers (typically another NTC-100) using EGPRS/Cat-M1/Cat-NB1 connections. The syntax for using the commands in the command line and over SMS differ slightly and are detailed in the following sections.
Important – Installing another custom application will cause the NetComm Wireless custom application to cease functioning as only one custom application may be used at a time
The NTC-100 has 3 modes:
N UM BE R
M OD E
D ES CR IP TI ON
0
PPP mode
In this mode, a Dumb Terminal Emulator (DTE) can get an IP address from the Serial Interface. A PPP connection can be established between the DTE and the NTC-100.
1
PAD/IP mode
In this mode, the NTC-100 acts as a Serial/IP gateway device converting asynchronous serial data to IP data across the cellular network. The NTC-100 can be configured as a TCP Client, TCP Server, UDP client or UDP server.
2
PSTN modem mode
In this mode, the NTC-100 application creates a tunnel between the modem and a DTE. The DTE can directly access the modem AT commands.
Table 6 - NTC-100 modes
PPP Mode
In this mode, the NTC-100 acts as a PPP Server and the meter connected via serial should have a PPP client feature. The NTC-100 accepts PPP dial in from the meter and the meter receives an IP address from the network.
Below is the configuration example in which NTC-100 is configured in PPP mode.
Configuring PPP mode with SMS commands
Query the current modem mode. If it is not 0, configure 1234set modem_mode=0
1234get modem_mode
Configure the APN
1234set apn=telstra.internet
Save the configuration
1234execute save
Power cycle the NTC-100
1234execute reboot
Page 23
23 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Configuring PPP mode with AT commands
Query current modem mode. If it is not 0, configure at+modem_mode=0
at+cgatt=0
at+modem_mode?
Configure the APN
at+apn=telstra.internet
Save the configuration
at+save=1
Power cycle the NTC-100
at+cfun=1,1
The NTC-100 is ready to accept PPP dial in from a meter connected to it.
PAD Mode
In this mode, the NTC-100 acts as a Serial-IP gateway. The asynchronous serial data from the serial interface is converted to IP packets before they are sent across the cellular IP network to the remote destination and vice­versa.
The NTC-100 establishes a TCP or UDP connection to the remote end. The NTC-100 can be configured as a TCP Client, TCP Server, UDP Client or UDP server in PAD mode.
The NTC-100 modem has 4 PAD modes available:
N UM BE R
M OD E
D ES CR IP TI ON
0
Disabled
In this mode, the Serial to TCP gateway function is disabled and the NTC-100 is in configuration mode. This is the default mode.
1
TCP Client
The NTC-100 acts as a TCP client and transfers TCP data between the serial and IP connections.
2
TCP Server
The NTC-100 acts as a TCP server and accepts incoming IP connections and transfers data between serial and IP connections.
3
UDP Client
The NTC-100 acts as a UDP client and transfers UDP data between the serial and IP connections.
4
UDP Server
The NTC-100 acts as a UDP server and transfers UDP data between the serial and IP connections.
Table 7 - NTC-100 PAD modes
Below is an example in which the NTC-100 is configured as a TCP Server. After this configuration, the remote client software can read and write to the utility meter via the serial connection to the NTC-100.
Page 24
24 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Configuring PAD mode with SMS
Query the current modem mode. If it is not 1, configure 1234set modem_mode=1
1234get modem_mode
Configure the APN
1234set=telstra.extranet
Configure the NTC-100 as a TCP server in PAD mode
1234set pad=2
Save configuration
1234execute save
Power cycle the NTC-100
1234execute reboot
Log in again and check for a WAN IP address on the NTC-100
1234get status
Configure a Local IP address with Server and TCP port
1234set server=x.x.x.x,1516 [x.x.x.x is the IP address of DUT obtained from get status]
Save the server configuration
1234execute save
Configuring PAD mode with AT commands
Query the current modem mode. If it is not 1, configure at+modem_mode=1
at+modem_mode?
Configure the APN
at+apn=telstra.extranet
Configure the NTC-100 as TCP server in PAD mode
at+pad=2
Save the configuration
at+save=1
Power cycle the NTC-100
at+cfun=1,1
Log in again and check for a WAN IP address on the NTC-100
at+local_ip?
Configure Local IP address as Server and TCP port
at+server=x.x.x.x,1516 [x.x.x.x is the IP address of DUT obtained from at+local_ip? command]
Save server configuration
at+save=1
The NTC-100 is ready to accept a connection from a remote TCP Client.
Page 25
25 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Command Line List
The following is a complete list of commands for the NetComm Wireless custom application. These commands can only be accessed via the Serial port in configuration mode (AT+PAD=0).
AT+ALL
Description:
Displays a list of all supported AT commands.
Usage:
To display all AT commands, enter:
AT+ALL?
AT+APN
Description:
Sets the Access Point Name (APN) used to connect to the broadband network. The default setting is telstra.internet.
Note: Confirm that at+qcfg="pdp/duplicatechk” returns 0
If it returns 1, change it to 0 with command at+qcfg="pdp/duplicatechk”,0
Usage 1:
To set the APN
AT+APN=xxxx
where ‘xxxx’ is the APN that you wish to use.
Usage 2:
To retrieve the currently configured APN
AT+APN?
Example:
To set the APN to ‘testAPN’ enter
AT+APN=testAPN
AT+APN_SEP
Description:
Sets the separation character to use when specifying multiple APNs using the AT+APN command. Valid characters are “|”, ”/” , “[“ , “]”. The default is “|”.
Usage 1:
To set the APN separator:
AT+APN_SEP=x
where ‘x’ is an option listed below.
Usage 2:
To retrieve the currently configured APN
AT+APN_SEP?
Options:
|, /, [, ]
Example:
To set the APN separator to /, enter
AT+APN_SEP=/
Page 26
26 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+AUTH_TYPE
Description:
This command is used to set authentication type when a username and password are configured for an APN.
Usage 1:
To set the authentication type, enter:
AT+AUTH_TYPE=x
Where ‘x’ is an option number.
Usage 2:
To retrieve the currently configured authentication type, enter:
AT+AUTH_TYPE?
Usage 3:
To display the authentication options, enter:
AT+AUTH_TYPE=?
Options:
0 None (default)
1 PAP
2 CHAP
3 PAP or CHAP
Example:
To set the authentication type to PAP, enter:
AT+AUTH_TYPE=1
AT+CFUN
Description:
This is a standard AT command which resets the device.
Usage:
To reset the device
AT+CFUN=1,1
Page 27
27 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+CHAR_TIMEOUT
Description:
By default, data received from the serial interface is not buffered. This can be changed to a value up to 65535 seconds, expressed as a factor of 100ms. After this delay, data will be sent out regardless of end of line input.
Usage 1:
To configure the character timeout
AT+CHAR_TIMEOUT=xxx
where ‘x’ is an integer to be multiplied by 100ms between 0 and 255.
Usage 2:
To retrieve the currently configured character timeout value
AT+CHAR_TIMEOUT?
Help:
AT+CHAR_TIMEOUT=?
Options:
0 disable (always use delimiters instead)
1 – 255 * 100ms
Example:
To configure the character timeout to 1 second, enter
AT+CHAR_TIMEOUT=10
AT+DAILY_SMS_LIMIT
Description:
This command is used to set a maximum number of SMS messages that the NTC-100 may send each day. When the maximum number of sent messages is reached in a day, the NTC-100 processes any commands sent to it but will not send any SMS messages to the sender. A day begins from the moment the feature is enabled, however, the limit is set to its original value if the module is rebooted using AT+CFUN=1,1 or AT+FORCE_RESET=XXX.
The valid range of daily SMS messages is 5 to 255.
Usage:
AT+DAILY_SMS_LIMIT=XXX
where ‘x’ is an integer between 5 and 255.
Example:
To set a maximum daily limit of SMS messages to 100, enter:
AT+DAILY_SMS_LIMIT=100
AT+DNS
Description:
Retrieves the NTC-100’s allocated DNS address.
Usage:
AT+DNS?
Example:
To retrieve the DNS address of the NTC-100, enter
AT+DNS?
Page 28
28 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+DYN_ENABLE
Description:
Instructs the NTC-100 to enable updating its IP address to the configured Dynamic DNS server.
Usage:
AT+DYN_ENABLE=x
where ‘x’ is an option number
Help:
AT+DYN_ENABLE=?
Options:
0 disable (default)
1 enable
Example:
To set the NTC-100 to enable star updates to the Dynamic IP address table, enter
AT+DYN_ENABLE=1
AT+DYN_HOST
Description:
Instructs the NTC-100 to use the supplied hostname to perform an IP address update.
Note: The only dynamic DNS service supported at this time is www.dyndns.org
Usage:
AT+DYN_HOST=XXXX
where “XXXX” is the hostname of the dynamic DNS service.
Example:
To instruct the NTC-100 to use ‘testuser.dyndns.org’ as the dynamic DNS hostname to perform an IP address update, enter
AT+DYN_HOST=testuser.dyndns.org
AT+DYN_PASS
Description:
Configures the password for the dynamic DNS service.
Usage:
AT+DYN_PASS=XXX
Example:
To set the dynamic DNS service username to ‘testpass1’, enter
AT+DYN_PASS=testpass1
AT+DYN_USER
Description:
Configures the username for the dynamic DNS service.
Usage:
AT+DYN_USER=XXX
Example:
To set the dynamic DNS service username to ‘testuser’, enter
AT+DYN_USER=testuser
Page 29
29 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+EOL
Description:
Send this command to delimit data received from the serial port. The default setting is 0x0D,0x0A.
Usage:
AT+EOL=xx,yy
where ‘xx’ is the hexadecimal code for the carriage return character and ‘yy’ is the hexadecimal
code of the line feed character.
Help:
AT+EOL=?
Example:
To configure the carriage return and line feed characters to ‘D’ and ‘A’, enter
AT+EOL=0x0D,0x0A
AT+FACTORY_RESET
Description:
Resets the NTC-100 to factory default settings, effectively performing the following commands:
AT+PAD=0
AT+APN=telstra.internet
AT+USER_PASS="",""
AT+FORCE_RESET=0
AT+SERVER=,1516
AT+SMS_DIAGNOSTICS=1
AT+SMS_ACK=1
AT+SMS_PASSWORD=1234
AT+EOL=0x0D,0x0A
AT+SERIAL_BAUD=115200
AT+SERIAL_FORMAT=2
AT+SERIAL_PARITY=2
AT+SERIAL_FLOW=0
AT+CHAR_TIMEOUT=0
AT+TCP_TIMEOUT=10
AT+TCP_RETRY=0 (Infinite)
AT+DYN_ENABLE=0
AT+DYN_HOST=
AT+DYN_USER=
AT+DYN_PASS=
The NTC-100 automatically reboots after this command is entered.
Usage:
AT+FACTORY_RESET=1
Help:
AT+FACTORY_RESET=?
Page 30
30 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+FAIL_COUNT
Description:
This command configures fail count for ping watchdog.
Usage:
AT+FAIL_COUNT=[1-65535]
Example:
The default setting is 1. To set it to 5:
AT+FAIL_COUNT=5
AT+FORCE_RECONNECT
Description:
This command enables or disables the TCP reconnect function and can be used to set the reconnect period. The difference between AT+FORCE_RECONNECT and AT+TCP_TIMEOUT is that
AT+FORCE_RECONNECT is intended for use in situations where the TCP server is down and the NTC-
100’s TCP client is unaware of it. The TCP client assumes the server is still operational and hence
does not reconnect. Using AT+FORCE_RECONNECT, you can force the TCP client to connect. The
AT+TCP_TIMEOUT command is used for situations where the TCP client can’t make a connection to
the server and you want to tell it to try to connect then wait for an interval before retrying.
Usage:
To force the TCP client to reconnect, enter:
AT+FORCE_RECONNECT=x
Where ‘x’ is an integer in seconds. When ‘x’ is 0, the force reconnect function is disabled. The
default value is 0.
Example:
To set the NTC-100 to reconnect the TCP client after waiting 10 minutes, enter:
AT+FORCE_RECONNECT=600
AT+FORCE_RESET
Description:
Sets the period for which the NTC-100 will automatically reset (reboot).
Usage 1:
To set the force reset period
AT+FORCE_RESET=xxxxx
where ‘x’ is an integer between 2 and 65535 minutes.
Usage 2:
To retrieve the currently configured force reset period
AT+FORCE_RESET?
Help:
AT+FORCE_RESET=?
Options:
0 no reset
2 - 65535 minutes between a forced reset
Example:
To set the NTC-100 to reboot every 60 minutes, enter
AT+FORCE_RESET=60
Page 31
31 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+FTP_FILE
Description:
This command sets the filename of the firmware used to perform an application firmware upgrade.
Usage:
AT+FTP_FILE=xxx
where ‘xxx’ is a string containing the filename of the firmware that is stored on the FTP server.
Example:
To configure the FTP filename as NTC100.bin.signed, enter:
AT+FTP_FILE=NTC100.bin.signed
AT+FTP_HOST
Description:
This command sets the FTP hostname or IP address used to perform an application firmware upgrade.
Usage 1:
AT+FTP_HOST=xxx
where ‘xxx’ is a string containing the IP address or domain name of the FTP server.
Example:
To configure the FTP hostname as 123.456.789.0, enter:
AT+FTP_HOST=123.456.789.0
AT+FTP_PARA
Description:
This command is used to retrieve the configured FTP settings on the modem.
Usage:
AT+FTP_PARA?
Example:
To retrieve the configured FTP settings on the NTC-100, enter:
AT+FTP_PARA?
AT+FTP_PASS
Description:
This command sets the password of the account used to access the FTP server when performing an application firmware upgrade over FTP.
Usage:
AT+FTP_PASS=xxx
where ‘xxx’ is a string containing the password of the account on the FTP server used to access
the firmware file.
Example:
To configure the FTP password as “password123”, enter:
AT+FTP_PASS=password123
Page 32
32 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+FTP_PATH
Description:
This command sets the path to the firmware file stored on the FTP server used to perform a firmware upgrade.
Usage:
AT+FTP_PATH=xxx
where ‘xxx’ is a string containing the path to the firmware file stored on the FTP server.
Example:
To configure the FTP path as /firmware/NTC-100, enter:
AT+FTP_PATH=firmware/NTC-100/
AT+FTP_RETRY
Description:
This command is used to set the number of times the NTC-100 will retry an FTP firmware upgrade in the event that the FTP upgrade fails.
Usage 1:
AT+FTP_RETRY=XXX
Where ‘xxx’ is an integer between 0 and 255.
Usage 2:
AT+FTP_RETRY?
Example:
To set the maximum number of FTP retries to 5, enter:
AT+FTP_RETRY=5
AT+FTP_UPLOAD=1
Description:
This command is used to trigger the NTC-100 to contact the FTP server using the details provided by the AT+FTP_HOST, AT+FTP_FILE, AT+FTP_PATH, AT_FTP_USER and AT+FTP_PASS commands and perform a firmware upgrade.
Usage:
AT+FTP_UPLOAD=1
AT+FTP_USER
Description:
This command sets the username of the account used to access the FTP server when performing a firmware upgrade over FTP.
Usage:
AT+FTP_USER=xxx
where ‘xxx’ is a string containing the username of the account on the FTP server used to access
the firmware file.
Example:
To configure the FTP username as “administrator”, enter:
AT+FTP_USER=administrator
Page 33
33 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+HISTORY
Description:
This command is used to retrieve the previous 250 SMS commands issued to the NTC-100.
Usage:
AT+HISTORY?
Example:
To add retrieve the last 250 SMS messages, enter:
AT+HISTORY?
AT+HW_VERSION
Description:
This command displays the hardware version of the NTC-100 board.
Usage:
To display the hardware version of the NTC-100, board enter:
AT+HW_VERSION?
AT+IMEI
Description:
This command retrieves the IMEI of the NTC-100.
Usage:
AT+IMEI?
Example:
To print the NTC-100’s IMEI to the screen, enter
AT+IMEI?
AT+IPV4_MTU
Description:
This command is used to set the maximum transmission unit (MTU) for the IPv4 protocol. The default value is 1460.
Usage 1:
To set the MTU for the IPV4 protocol, enter:
AT+IPV4_MTU=x
Where ‘x’ is a value between 1000 and 1460.
Example:
To set the MTU for the IPv4 protocol to 1000, enter:
AT+IPV4_MTU=1000
Page 34
34 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+IPV6_MTU
Description:
This command is used to set the maximum transmission unit (MTU) for the IPv6 protocol. The default value is 1358.
Usage 1:
To set the MTU for the IPV6 protocol, enter:
AT+IPV6_MTU=x
Where ‘x’ is a value between 1000 and 1500.
Example:
To set the MTU for the IPv6 protocol to 1000, enter:
AT+IPV6_MTU=1000
AT+LOCAL_IP
Description:
Retrieves the NTC-100’s allocated WAN IP address.
Usage:
AT+LOCAL_IP?
AT+LOGIN_PASS
Description:
This command configures the password required to log in to the AT interface via a serial connection.
Usage:
AT+LOGIN_PASS=<Password>
Example:
The default setting is admin. To set it to pa$$w0rd:
AT+LOGIN_PASS=pa$$w0rd
AT+LOGIN_USER
Description:
This command configures the username required to log in to the AT interface via a serial connection.
Usage:
AT+LOGIN_USER=<Username>
Example:
The default setting is root. To set it to admin:
AT+LOGIN_USER=admin
Page 35
35 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+MODEM_MODE
Description:
This command sets the NTC-100 into IP/PAD mode, PPP mode or PSTN mode. In PPP mode, PSTN mode customized AT commands can't be accessed when the NTC-100 is connected to the network. In order to switch between modem modes you can either run at+cgatt=0 command or take the SIM out before entering the AT+MODEM+MODE AT command. However, the SMS command to switch modem mode doesn't have this restriction.
Usage 1:
AT+MODEM_MODE=x
where ‘x’ is an option number.
Usage 2:
AT+MODEM_MODE?
Options:
0 PPP mode
1 IP/PAD mode (default)
2 PSTN mode
Example:
To set the NTC-100 to IP mode, enter
AT+MODEM_MODE=1
AT+MODULE_WATCHDOG
Description:
This command enables/disables the module watchdog function. The default setting is enabled (1).
Usage:
AT+MODULE_WATCHDOG=0,1
Example:
To disable the module watchdog function, enter:
AT+MODULE_WATCHDOG=0
AT+NO_WHITELIST
Description:
This command is used to remove a phone number from the SMS whitelist. Mobile phone numbers must be entered in the following format: +614XXXXXXXX.
Usage
AT+NO_WHITELIST=+XXXXXXXXXXX
where ‘+XXXXXXXXXXXX’ is a mobile phone number.
Example:
To remove +61412345678 from the SMS whitelist, enter:
AT+NO_WHITELIST=+61412345678
To remove +61412345678 and +61411234567 from the whitelist, enter:
AT+NO_WHITELIST=+61412345678,+61411234567
Page 36
36 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+NON_REBOOT
Description:
This command defines whether the NTC-100 will reboot when PAD mode is changed using the AT+PAD command.
Usage 1:
To set the NTC-100 to not reboot after changing PAD mode, enter:
AT+NON_REBOOT=0
Usage 2:
To set the NTC-100 to reboot after changing PAD mode, enter:
AT+NON_REBOOT=1
Options:
0 no reboot (default) 1 reboot
AT+PAD
Description:
Specifies the NTC-100 PAD operation mode. To exit PAD mode, enter ‘+++’. This sets PAD mode to 0. This feature is used when modem_mode=1.
Usage 1:
To set the operation mode
AT+PAD=x
where ‘x’ is an option number.
Usage 2:
To retrieve the currently configured operation mode
AT+PAD?
Help:
AT+PAD=?
Options:
0 Disabled (default)
1 TCP client
2 TCP server
3 UDP client
4 UDP server
Example:
To switch the NTC-100 to TCP client mode, enter
AT+PAD=1
To exit PAD mode, enter
+++
Page 37
37 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+PAKBUS
Description:
Enables a buffer time for serial data before it is sent to the IP network. Must be used in conjunction with the AT+CHAR_TIMEOUT and AT+EOL commands.
If CHAR_TIMEOUT is > 0, serial data is buffered and checked for carriage return (EOL) characters. When PAKBUS is set to 0 and a single EOL appears, the data is sent to the IP network. If PAKBUS is 1, EOL characters must be seen on either side of the data frame before the data is sent. For example:
<EOL> xx xx xx xx <EOL> - data is sent
EOL><EOL> xx xx xx xx <EOL> - data is sent
<EOL> xx xx xx xx – data is not sent
EOL><EOL> xx xx xx xx – data is not sent
However, when CHAR_TIMEOUT value is reached, the NTC-100 sends all data in the buffer even if no EOL characters have appeared yet.
Usage:
AT+PAKBUS=x
where ‘x’ is an option number
Help:
AT+PAKBUS=?
Example:
To set PAKBUS to 1, enter
AT+PAKBUS=1
AT+PDP_TYPE
Description:
This command sets the packet data protocol type for PDP context 1.
Usage:
To set the packet data protocol type, enter:
AT+PDP_TYPE=x
Where ‘x’ is an option string.
Options:
IPv4 (default)
IPv6
IPV4V6
PPP
Example:
To set the packet data protocol type to IPv4, enter:
AT+PDP_TYPE=IPv4
AT+PING
Description:
This command is used to send a ping to an internet host.
Usage:
AT+PING=[domain name/IP address]
Example:
To ping www.google.com, enter:
AT+PING=www.google.com
Page 38
38 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+PING_ACC_TIMER
Description:
This command configures the accelerated periodic ping timer for the ping watchdog.
Usage:
AT+PING_ACC_TIMER=[60-65535]
Example:
The default setting is 60. To set it to 120 seconds:
AT+PING_ACC_TIMER=120
AT+PING_IP1
Description:
This command configures first destination IP address for the ping watchdog.
Usage:
AT+PING_IP1=<IP address/hostname>
Example:
To set the first destination IP address to 8.8.8.8:
AT+PING_IP1=8.8.8.8
AT+PING_IP2
Description:
This command configures the second destination IP address for the ping watchdog.
Usage:
AT+PING_IP2=<IP address/hostname>
Example:
To set the second destination IP address to 8.8.4.4:
AT+PING_IP2=8.8.4.4
AT+PING_TIMER
Description:
This command configures the periodic ping timer for the ping watchdog.
Usage:
AT+PING_TIMER=[120-65535]
Example:
The default setting is 300.To set it to 120 seconds:
AT+PING_TIMER=120
Page 39
39 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+PING_WATCHDOG
Description:
This command is used to enable/disable ping watchdog feature.
Usage:
AT+PING_WATCHDOG=0,1
Options:
0 disabled (default)
1 enabled
Example:
To enable the ping watchdog:
AT+PING_WATCHDOG=1
AT+REPLY_CMD_ERROR
Description:
This command is used to enable or disable the NTC-100 from sending error replies if an invalid command is sent. Note that error replies are not sent if the password is incorrect, regardless of the status of the AT+REPLY_CMD_ERROR option. Also, AT+SMS_ACK must be enabled for this option to work. When enabled, the NTC-100 replies with an error message.
Usage 1:
AT+REPLY_CMD_ERROR=x
where ‘x’ is an option number.
Usage 2:
AT+REPLY_CMD_ERROR?
Options:
0 disable
1 enable (default)
Example:
To enable error replies, enter:
AT+REPLY_CMD_ERROR=1
AT+SAVE
Description:
Saves any changes made to the settings using commands in this list. Changes to settings using
the commands in this list do not take effect immediately and must be saved to the board’s flash
memory using this command, followed by a reboot.
Usage:
To save settings to the onboard flash memory
AT+SAVE=1
Example:
To save settings to the onboard flash memory, enter
AT+SAVE=1
Then enter
AT+CFUN=1,1
to perform a reboot so that the new settings take effect.
Page 40
40 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SERIAL_BAUD
Description:
Sets the baud rate used for communication between the modem and the connected device.
Usage 1:
To set the baud rate
AT+SERIAL_BAUD=[baud]
Usage 2:
To retrieve the currently configured baud rate
AT+SERIAL_BAUD?
Help:
AT+SERIAL_BAUD=?
Options:
300, 600, 1200. 2400. 4800, 9600, 19200, 38400, 57600, 115200 (default value), 230400.
Example:
To configure the baud rate to 115200bps, enter
AT+SERIAL_BAUD=115200
AT+SERIAL_FLOW
Description:
Sets the hardware flow control used for communication between the modem and the connected device.
Usage 1:
To set the flow control
AT+SERIAL_FLOW=x
where ‘x’ is an option number.
Usage 2:
To retrieve the currently configured flow control setting
AT+SERIAL_FLOW?
Help:
AT+SERIAL_FLOW=?
Options:
0 no flow control, default value
2 hardware, RTSCTS
Example:
To set no flow control enter
AT+SERIAL_FLOW=0
Page 41
41 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SERIAL_FORMAT
Description:
Sets the serial format used for communication between the modem and the connected device.
Usage 1:
To set the serial format
AT+SERIAL_FORMAT=x
where ‘x’ is an option number.
Usage 2:
To retrieve the currently configured serial format
AT+SERIAL_FORMAT?
Help:
AT+SERIAL_FORMAT=?
Options:
1 8 data 2 stop
2 8 data 1 stop – default value
3 7 data 2 stop
4 7 data 1 stop
Example:
To set the serial format to 8 data 2 stop enter
AT+SERIAL_FORMAT=1
AT+SERIAL_MODE
Description:
This command is used to set the serial port mode of the Serial AT interface.
Usage 1:
To set the serial port mode, enter:
AT+SERIAL_MODE=x
Where ‘x’ is an option string.
Usage 2:
To display the current serial port mode, enter:
AT+SERIAL_MODE?
Options:
RS232 (default)
RS422
RS485
Example:
To set the serial port mode to RS422, enter:
AT+SERIAL_MODE=RS422
Page 42
42 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SERIAL_ON_START
Description:
This command configures whether the serial port initialises on power up or initialises when there are active connections. When set to 1, the serial port does not respond to AT commands as it enters into data mode.
Usage 1:
AT+SERIAL_ON_START=x
where ‘x’ is an option number
Usage 2:
AT+SERIAL_ON_START?
Help:
AT+SERIAL_ON_START=?
Options:
0 serial port is initialised when there are active connections (default)
1 serial port is initialised on power up
Example:
AT+SERIAL_ON_START=1
AT+SERIAL_PARITY
Description:
Sets the serial parity used for communication between the modem and the connected device.
Usage 1:
To set the serial parity
AT+SERIAL_PARITY=x
where ‘x’ is an option number.
Usage 2:
To retrieve the currently configured serial parity
AT+SERIAL_PARITY?
Help:
AT+SERIAL_PARITY=?
Options:
0 Odd
1 Even
2 No parity, default value
Example:
To set no serial parity enter
AT+SERIAL_PARITY=2
Page 43
43 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SERVER
Description:
Sets the TCP/UDP server IP address and port or hostname and port. In TCP Client and UDP client mode this command sets the remote TCP/UDP server IP address and remote port number. In TCP Server and UDP server mode the port number will be used as the local TCP/UDP Server port number. If a remote UDP socket wants to send back data, it must use this
port number. When configured as a server, the device’s local IP address should be configured in
the server parameters.
Usage 1:
To set the server IP address and port
AT+SERVER=xxx.xxx.xxx.xxx,yyyyy
where ‘xxx.xxx.xxx.xxx’ is the server IP address and ‘yyyyy’ is the port number
Usage 2:
To set the server hostname and port
AT+SERVER=xxxx,yyyyy
where ‘xxxx’ is the hostname of the server and ‘yyyy’ is the port number. If no port number is
specified, the NTC-100 uses the default port 1516.
Usage 3:
To retrieve the currently configured server IP and port
AT+SERVER?
Help:
AT+SERVER=?
Options:
ip address: the ip address of the server
hostname: the hostname of the server
port number: the port number of the server
Example:
To set the IP address of the server to 10.1.193.11 and port to 1516, enter
AT+SERVER=10.1.193.11,1516
To set the hostname of the server to ‘testhost.domain.com’ and port to 8888, enter
AT+SERVER=testhost.domain.com,8888
AT+SMS
Description:
Instructs the NTC-100 to send an SMS message.
Usage:
To send an SMS message, enter:
AT+SMS=<phone>,<message>
Where ‘phone’ is a valid phone number and ‘message’ is the SMS message you want to send.
Example:
To send an SMS message containing the text “Hello world” to mobile number +61412345678,
enter:
AT+SMS=+61412345678,"Hello world"
Page 44
44 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SMS_ACK
Description:
Sets the status of the SMS acknowledgment feature. When enabled, the NTC-100 sends a reply SMS to inform whether the command was successful.
Usage 1:
To configure SMS acknowledgments
AT+SMS_ACK=x
where ‘x’ is an option number.
Usage 2:
To retrieve the SMS acknowledgment status
AT+SMS_ACK?
Help:
AT+SMS_ACK=?
Options:
0 disabled
1 enabled (default)
Example:
To enable SMS acknowledgments, enter
AT+SMS_ACK=1
AT+SMS_DIAGNOSTICS
Description:
Sets the status of the SMS Diagnostics feature on the NTC-100.
Usage:
To set the status of SMS Diagnostics
AT+SMS_DIAGNOSTICS=x
where ‘x’ is an option number.
Help:
AT+SMS_DIAGNOSTICS=?
Options:
0 disabled
1 enabled (default)
Example:
To enable SMS Diagnostics, enter
AT+SMS_DIAGNOSTICS=1
Page 45
45 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+SMS_PASSWORD
Description:
Used to define the password used with the SMS Diagnostics feature. The password is limited to 6 characters. The default password is ‘1234’.
Usage 1:
To set the SMS password
AT+SMS_PASSWORD=XXXXXX
Help:
AT+SMS_PASSWORD=?
Example:
To set the password to ‘1234’, enter
AT+SMS_PASSWORD=1234
AT+STATUS
Description:
Instructs the NTC-100 to print its current status details including signal strength, Cat-M1/Cat­NB1/EGPRS connection, device uptime, connection uptime and PAD mode status.
Usage:
AT+STATUS?
Example:
To print the current status to the screen, enter
AT+STATUS?
AT+STATUS_FORMAT
Description:
Sets the format that information is presented in when using the AT+STATUS command.
Usage:
AT+STATUS_FORMAT=x
where ‘x’ is an option number
Options:
0 single line 1 multiple lines
Example:
To set the output of AT+STATUS to multiple lines, enter
AT+STATUS_FORMAT=1
Page 46
46 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+TCP_RETRY
Description:
If the NTC-100 is operating in TCP client mode and the connection with the server is down, the application will try for the AT+TCP_RETRY number of times to re-establish the connection with the server, then it will wait for the specified TCP_TIMEOUT period and try again. The minimum value is 0 which will cause the NTC-100 to retry the connection until a connection is made while the maximum value is 10.
Usage 1:
To set the TCP retry count
AT+TCP_RETRY=xx
where ‘x’ is an integer between 0 and 10.
Usage 2:
To retrieve the currently configured TCP retry count
AT+TCP_RETRY?
Help:
AT+TCP_RETRY=?
Options:
0 Infinite (always try to connect when connection fails)
1 – 10 times to attempt reconnection
Example:
To configure the NTC-100 to retry a TCP connection 10 times, enter
AT+TCP_RETRY=10
AT+TCP_TIMEOUT
Description:
This command sets the TCP timeout value in seconds. If the TCP/IP connection is not working, the application will wait for this period of time to re-establish the connection. The minimum timeout period is 10 seconds while the maximum is 65535 seconds.
Usage 1:
To configure the TCP timeout value
AT+TCP_TIMEOUT=xxxxx
where ‘x’ is an integer in seconds between 10 and 65535.
Usage 2:
To read the currently configured TCP timeout value
AT+TCP_TIMEOUT?
Help:
AT+TCP_TIMEOUT=?
Example:
To set the TCP timeout period to 10 seconds
AT+TCP_TIMEOUT=10
Page 47
47 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+USER_PASS
Description:
Sets the username and password used to connect to the broadband network associated with the APN.
Usage 1:
To set the username and password
AT+USER_PASS=<username>,<password>
Usage 2:
To retrieve the currently configured username and password
AT+USER_PASS?
Help:
AT+USER_PASS=?
Options:
username: the user name for the broadband account
password: the password for the broadband account
Example:
To configure the username as ‘user1’ and password as ‘testpass’ enter
AT+USER_PASS=user1,testpass
AT+VERSION
Description:
Displays the version number of the application firmware and module firmware installed.
Usage:
AT+VERSION?
AT+WEB_FILE
Description:
This command configures the file name for module or application firmware OTA upgrade.
Usage:
AT+WEB_FILE=<Filename>
Example:
To configure filename to NTC100.bin.signed, enter:
AT+WEB_FILE=NTC100.bin.signed
AT+WEB_HOST
Description:
This command configures the HTTP/S server for the module or application firmware OTA upgrade.
Usage:
AT+WEB_HOST=<hostname/ipaddress>
Example:
To configure the HTTP/S server for module/application firmware OTA upgrade, enter:
AT+WEB_HOST=http://repository.netcomm.com
AT+WEB_HOST=https://repository.netcomm.com
Page 48
48 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+WEB_PASS
Description:
This command configures the password if authentication is implemented on the HTTP/S server for the application firmware OTA upgrade.
Note: Username/password authentication can be implemented on the HTTP/S server only for the application firmware OTA, not for module firmware OTA.
Usage:
AT+WEB_PASS=<password>
Example:
To configure the password to admin, enter:
AT+WEB_PASS=admin
AT+WEB_PATH
Description:
This command configures file path on the HTTP/S server for the module or application firmware OTA upgrade.
Usage:
AT+WEB_PATH=<PATH>
Example:
To configure the path to the NTC-100 firmware, enter:
AT+WEB_PATH= NTC100/firmware/
AT+WEB_PORT
Description:
This command configures the HTTP/S port for the module or application firmware OTA upgrade.
Usage:
AT+WEB_PORT=<port>
Example:
To configure the port to 8081, enter:
AT+WEB_PORT=8081
AT+WEB_RETRY
Description:
This command configures the number of retry attempts if HTTP/S OTA fails.
Usage:
AT+WEB_RETRY=[4-255]
Example:
To configure the number of retries to 5, enter:
AT+WEB_RETRY=5
Page 49
49 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+WEB_UPLOAD
Description:
This command triggers the firmware upgrade from the HTTP/S server.
Usage:
AT+WEB_UPLOAD=1,2
Example:
To perform an HTTP/S OTA for the application firmware, enter:
AT+WEB_UPLOAD=1
To perform an HTTP/S OTA for the module firmware, enter:
AT+WEB_UPLOAD=2
AT+WEB_USER
Description:
This command configures the username if authentication is implemented on the HTTP/S server for the application firmware OTA upgrade.
Note: Username/password authentication can be implemented on the HTTP/S server only for the application firmware OTA, not for module firmware OTA.
Usage:
AT+WEB_USER=<username>
Example:
To configure the username to admin, enter:
AT+WEB_USER=admin
AT+WHITELIST
Description:
This command is used to add a phone number to the SMS whitelist. When the first number is added to the whitelist, the whitelist is enabled and numbers that are not on the whitelist are unable to execute commands. Mobile phone numbers must be entered in the following format: +614XXXXXXXX. You may enter multiple numbers which are comma separated.
Usage:
AT+WHITELIST=+XXXXXXXXXXX
where ‘+XXXXXXXXXXXX’ is a mobile phone number.
Example:
To add +61412345678 to the SMS whitelist, enter:
AT+WHITELIST=+61412345678
Page 50
50 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Quectel AT Command List
This section presents the AT command set for the Quectel BG96 module.
AT+CEREG EPS Network Registration Status
The command queries the network registration status and controls the presentation of:
the unsolicited result code +CEREG: <stat> when <n>=1 and there is a change in the MTs EPS network
registration status in E-UTRAN,
the unsolicited result code +CEREG: <stat>[,[<tac>],[<ci>],[<Act>]] when <n>=2 and there is a change of
the network cell in E-UTRAN, and
the unsolicited result code +CEREG: <stat>[,[<tac>],[<ci>],[<AcT>][,,[,[<Active-Time>],[<Periodic -TAU>]]]]
when <n>=4 and there is a change of the network cell in E-UTRAN.
A T+ CE RE G EP S NE TW OR K R E G I S T R A T I O N S T A T U S
Test Command
AT+CEREG=?
Response
+CEREG: (list of supported <n>s)
OK
Read Command
AT+CEREG?
Response
When <n>=0, 1, or 2 and command successful:
+CEREG: <n>,<stat>[,[<tac>],[<ci>],[<AcT>[,<cause_t yp e>,<reject_cause>]]]
When <n>=4 and command successful:
+CEREG: <n>,<stat>[,[<tac>],[<ci>],[<AcT>],[<rac>][,[ <ca
use_type>],[<reject_cause>][,[<Active­Time>],[<Periodic- TAU>]]]]
OK
Write Command
AT+CEREG[=<n>]
Response
OK
If there is any error, response:
ERROR
Maximum Response Time
300ms
Reference
3GPP TS 27.007
Page 51
51 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Parameter
<n>
0
Disable network registration unsolicited result code
1 Enable network registration unsolicited result code: +CEREG:<stat>
2 Enable network registration and location information unsolicited result code:
4 +CEREG: <stat>[,<tac>,<ci>[,<Act>]]
For a UE that wants to apply PSM, enable network registration and location information unsolicited result code:
+CEREG: <stat>[,[<tac>],[<ci>],[<AcT>][,,[,[<Active-Time>],[<Periodic-TAU>]]]]
<stat>
0
Not registered. MT is not currently searching an operator to register to.
1 Registered, home network
2 Not registered, but MT is currently trying to attach or searching an operator to
register to.
3 Registration denied
4 Unknown
5 Registered, roaming
<tac>
String type. Two-byte tracking area code in hexadecimal format.
<ci>
String type. Four-byte E-UTRAN cell ID in hexadecimal format.
<Act>
Access technology selected
0 GSM
8 LTE Cat M1
9 LTE Cat NB1
<cause_type>
Integer type. The type of <reject_cause>.
0 Indicates that <reject_cause> contains an EMM cause value.
1 ndicates that <reject_cause> contains a manufacturer-specific cause.
<reject_cause>
Integer type. Contains the cause of the failed registration. The value is of type as defined by <cause_type>.
<Active-Time>
String type. One byte in an 8 bit format. Active Time value (T3324) to be allocated to the UE.
(e.g. "00001111" equals to 1 minute)
Bits 5 to 1 represent the binary coded timer value.
Bits 6 to 8 define the timer value unit as follows:
Bits 8 7 6
0 0 0
value is incremented in multiples of 2 seconds
Page 52
52 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
0 0 1
value is incremented in multiples of 1 minute
0 1 0
value is incremented in multiples of decihours
1 1 1
value indicates that the timer is deactivated.
<Periodic-TAU>
String type. One byte in an 8 bit format. Extend periodic TAU value (T3412_ext) to be allocated to the UE in E-UTRAN.
(e.g. "00001010" equals to 100 minutes)
Bits 5 to 1 represent the binary coded timer value.
Bits 6 to 8 define the timer value unit as follows:
Bits 8 7 6
0 0 0
value is incremented in multiples of 10 minutes
0 0 1
value is incremented in multiples of 1 hour
0 1 0
value is incremented in multiples of 10 hours
0 1 1
value is incremented in multiples of 2 seconds
1 0 0
value is incremented in multiples of 30 seconds
1 0 1
value is incremented in multiples of 1 minute
AT+CGATT Attachment or Detachment of PS
The Write Command is used to attach the MT to, or detach the MT from the Packet Domain service. After the command has been completed, the MT remains in V.25ter command state. If the MT is already in the requested state, the command is ignored and the OK response will be returned. If the requested state cannot be achieved, an ERROR or +CME ERROR response is returned.
A T+ CG A T T A T TA CH ME NT O R D E T A C H M E N T O F P S
Test Command
AT+CGATT=?
Response
+CGATT: (list of supported <state>s)
OK
Read Command
AT+CGATT?
Response
+CGATT: <state>
OK
Write Command
AT+CGATT=<state>
Response
OK
If there is an error related to ME functionality, response:
Page 53
53 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
A T+ CG A T T A T TA CH ME NT O R D E T A C H M E N T O F P S
+CME ERROR: <err>
Maximum Response Time
140s, determined by network.
Reference
3GPP TS 27.007
Parameter
<state>
Indicates the state of PS attachment
0 Detached 1
Attached
Other values are reserved and will result in an ERROR response to the Write Command.
Example
AT+CGATT=1
OK
AT+CGATT=0
OK
AT+CGATT?
+CGATT: 0
OK
//Attach to PS service
//Detach from PS service
//Query the current PS service state
AT+CLCK Facility Lock
The command is used to lock, unlock or interrogate a MT or a network facility <fac>. It can be aborted when network facilities are being set or interrogated. The factory default password of PF, PN, PU, PP and PC lock is “12341234”.
A T+ CL CK F AC IL IT Y LO C K
Test Command
AT+CLCK=?
Response
+CLCK: (list of supported <fac>s)
OK
Write Command
AT+CLCK=<fac>,<mode>[ ,<passwd>[
,<class>]]
Response
This command is used to lock, unlock or interrogate the ME or network facility <fac>. Password is normally needed to do such actions. When querying the status of network service (<mode>=2) the response line for „not active case (<status>=0) should be returned only if service is not active for any <class>.
Page 54
54 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
A T+ CL CK F AC IL IT Y LO C K
If <mode> is not equal to 2 and the command is executed successfully:
OK
If <mode>=2 and the command is executed successfully:
+CLCK: <status>[,<class>]
[+CLCK: <status>[, <class>]]
[…]
OK
Maximum Response Time
5s
Reference
3GPP TS 27.007
Parameter
<fac>
“SC”
(U)SIM (lock SIM/UICC card installed in the currently selected card slot) (SIM/UICC asks password in MT power-up and when this lock command issued). “AO”
BAOC (Bar All Outgoing Calls) (refer to 3GPP TS 22.088 clause 1).
“OI”
BOIC (Bar Outgoing International Calls) (refer to 3GPP TS 22.088 clause 1).
“OX”
BOIC-exHC (Bar Outgoing International Calls except to Home Country) (refer to 3GPP TS 22.088 clause 1).
“AI”
BAIC (Bar All Incoming Calls) (refer to 3GPP TS 22.088 clause 2).
“IR”
BIC-Roam (Bar Incoming Calls when Roaming outside the home country) (refer to 3GPP TS 22.088 clause 2).
“AB”
All Barring services (refer to 3GPP TS 22.030) (applicable only for <mode>=0).
“AG”
All outgoing barring services (refer to 3GPP TS 22.030) (applicable only for <mode>=0).
“AC”
All incoming barring services (refer to 3GPP TS 22.030) (applicable only for <mode>=0).
“FD”
SIM card or active application in the UICC (GSM or USIM) fixed Dialling memory feature (if PIN2 authentication has not been done during the current session, PIN2 is required as <passwd>).
“PF”
Lock Phone to the very first inserted SIM/UICC card (also referred in the present document as PH-FSIM) (MT asks password when other SIM/UICC cards are inserted).
Page 55
55 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
“PN”
Network Personalization (refer to 3GPP TS 22.022)
“PU”
Network Subset Personalization (refer to 3GPP TS 22.022)
“PP”
Service Provider Personalization (refer to 3GPP TS 22.022)
“PC”
Corporate Personalization (refer to 3GPP TS 22.022)
<mode>
0
Unlock 1
Lock 2
Query status
<passwd>
Password
1 Voice
2 Data
4 FAX 7
All telephony except SMS (Default)
8 Short message service
16
Data circuit synchronization
<class>
1
Voice 2
Data 4
FAX 7
All telephony except SMS (Default)
8 Short message service
16
Data circuit synchronization
32
Data circuit asynchronization
<status>
0
OFF 1
ON
Example
AT+CLCK=“SC”,2
+CLCK: 0
OK
AT+CLCK=“SC”,1,“1234”
OK
AT+CLCK=“SC”,2
+CLCK: 1
OK
//Query the status of (U)SIM card
//The (U)SIM card is unlocked (OFF)
//Lock (U)SIM card, and the password is 1234
//Query the status of (U)SIM card
//The (U)SIM card is locked (ON)
Page 56
56 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+CLCK=“SC”,0,“1234”
OK
//Unlock (U)SIM card
AT+COPS Operator Selection
The command returns the current operators and their status and allows setting automatic or manual network selection.
A T+ CO PS O P E R A T O R S E L E CT I O N
Test Command
AT+COPS=?
Response
TA returns a set of five parameters, each representing an operator presenting in the network. Any of the formats may be unavailable and should then be an empty field. The list of operators shall be in the order of: home network, networks referenced in (U)SIM and other networks.
+COPS: (list of supported<stat>, long alphanumeric <oper>, short alphanumeric <oper>, numeric <oper>s)[,< Act>])s] [,,(list of supported <mode>s),(list of supported <format>s )]
OK
If there is an error related to ME functionality:
+CME ERROR: <err>
Read Command
AT+COPS?
Response
TA returns the current mode and the currently selected operator. If no operator is selected, <format>, <oper> and
<Act> are omitted.
+COPS: <mode>[,<format>[,<oper>][,<Act>]]
OK
If there is an error related to ME functionality:
+CME ERROR: <err>
Write Command
AT+COPS=<mode>[,<fo rmat>[,<oper
>[,<Act>]]]
Response
TA forces an attempt to select and register the GSM/UMTS network operator. If the selected operator is not available, no other operator shall be selected (except <mode>=4). The
format of selected operator name shall apply to further Read
Command (AT+COPS?).
OK
Page 57
57 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
A T+ CO PS O P E R A T O R S E L E CT I O N
If there is an error related to ME functionality:
+CME ERROR: <err>
Maximum Response Time
180s, determined by network.
Reference
3GPP TS 27.007
Parameter
<stat>
0
Unknown 1
Operator available
2 Current operator
3 Operator forbidden
<oper>
Operator in format as per <mode>
<mode>
0
Automatic mode. <oper> field is ignored.
1
Manual operator selection. <oper> field shall be presented and <Act> optionally.
2 Manual deregister from network.
3
Set only <format> (for AT+COPS? Read Command), and do not attempt to register/deregister (<oper> and <Act> fields are ignored). This value is invalid in the response of the Read Command.
4
Manual/automatic selection. <oper> field shall be presented. If manual selection fails, automatic mode (<mode>=0) is entered.
<format>
0
Long format alphanumeric <oper> which can be up to 16 characters long
1 Short format alphanumeric <oper>
2 Numeric <oper>. GSM location area identification number.
<Act>
Access technology selected. Values 3, 4, 5 and 6 occur only in the response of the Read Command while MS is in data service state and is not intended for AT+COPS Write Command.
0 GSM
2 UTRAN
3 GSM W/EGPRS
4 UTRAN W/HSDPA
5 UTRAN W/HSUPA
6 UTRAN W/HSDPA and HSUPA
Page 58
58 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
7 E-UTRAN
100
CDMA
Example
AAT+COPS=?
+COPS:
(1,"CHN-UNICOM","UNICOM","46001",2),(1,"CHN­UNICOM","UNICOM","46001",0),(2,"CHN-UNICO
M","UNICOM","46001",7),(1,"46011","46011","460 11",7),(3,"CHINA MOBILE","CMCC","46000",0),, (0,1,2,3,4),(0,1,2)
OK
OK AT+COPS?
+COPS: 0,0,“CHN-UNICOM”,0
OK
//List all current network operators
//Query the currently selected network operator
AT+CPIN Enter PIN
The command is used to enter a password or query whether or not the module requires a password which is necessary before it can be operated. The password may be (U)SIM PIN, (U)SIM PUK, PH-SIM PIN, etc.
A T+ CP IN E NT ER P I N
Test Command
AT+CPIN=?
Response
OK
Read Command
AT+CPIN?
Response
TA returns an alphanumeric string indicating whether or not some password is required.
+CPIN: <code>
OK
Write Command
AT+CPIN=<pin>[,<new pin>]
Response
TA stores a password, such as (U)SIM PIN, (U)SIM PUK, etc., which is necessary before it can be operated. If the PIN is to be entered twice, the TA shall automatically repeat the PIN. If no PIN request is pending, no action is taken and an error message, +CME ERROR, is returned to TE.
If the PIN required is (U)SIM PUK or (U)SIM PUK2, the second pin is required. This second pin, <new pin>, is used to replace the old pin in the (U)SIM.
OK
Page 59
59 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
A T+ CP IN E NT ER P I N
Maximum Response Time
5s
Reference
3GPP TS 27.007
Parameter
<code>
READY
MT is not pending for any password
SIM PIN
MT is waiting for (U)SIM PIN to be given
SIM PUK
MT is waiting for (U)SIM PUK to be given
SIM PIN2
MT is waiting for (U)SIM PIN2 to be given
SIM PUK2
MT is waiting for (U)SIM PUK2 to be given
PH-NET PIN
MT is waiting for network personalization password to be given
PH-NET PUK
MT is waiting for network personalization unblocking password to be given
PH-NETSUB PIN
MT is waiting for network subset personalization password to be given
PH-NETSUB PUK
MT is waiting for network subset personalization unblocking password to be given
PH-SP PIN
MT is waiting for service provider personalization password to be given
PH-SP PUK
MT is waiting for service provider personalization unblocking password to be given
PH-CORP PIN
MT is waiting for corporate personalization password to be given
PH-CORP PUK
MT is waiting for corporate personalization unblocking password to be given
<pin>
String type.
Password. If the requested password was a PUK, such as (U)SIM PUK1, PH­FSIM PUK or another password, then <pin> must be followed by <new pin>.
<new pin>
String type.
New password required if the requested code was a PUK.
Example
//Enter PIN
AT+CPIN?
+CPIN:SIM PIN
OK
AT+CPIN=1234
OK
//Queried PIN code is locked
//Enter PIN
Page 60
60 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
+CPIN: READY
AT+CPIN?
+CPIN: READY
OK
//Enter PUK and PIN
AT+CPIN?
+CPIN: SIM PUK
OK
AT+CPIN=”26601934”,”1234”
OK
+CPIN: READY
AT+CPIN?
+CPIN: READY
OK
//PIN has already been entered
//Queried PUK code is locked
/Enter PUK and new PIN password
//PUK has already been entered
AT+GSN Request International Mobile Equipment Identity (IMEI)
The command returns the International Mobile Equipment Identity (IMEI). It is identical with AT+CGSN.
A T+ GS N RE QU E S T IN TE R N A T I O N A L M O B I L E E Q U I PM E NT I DE NT IT Y (I ME I)
Test Command
AT+GSN=?
Response
OK
Execution Command
AT+GSN
Response
TA reports the IMEI (International Mobile Equipment Identity) number in information text which permits the user to identify the individual ME device.
<IMEI>
OK
Maximum Response Time
300ms
Reference
V.25ter
Page 61
61 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Parameter
<IMEI>
IMEI of the ME
Note – The serial number (IMEI) varies with the individual ME device.
AT+QCFG="bandBand Configuration
The command specifies the frequency bands allowed to be searched of UE. If <effect> is omitted, the configuration will take effect immediately.
A T+ QC FG =" BA ND " BA ND C ON FI G U R A T I O N
Write Command
AT+QCFG=“band”[,<gsmband
val>,<ca tm1bandval>,<catnb1bandval>[ ,<effec t>]]
Response
If configuration parameters and <effect> are omitted (that is, only execute AT+QCFG=“band”), return the current configuration:
+QCFG:
“band”,<gsmbandval>,<catm1bandval>,<catnb
1bandval>
OK
If configuration parameters are all entered, configure the frequency bands allowed to be searched:
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
If there is any other error, response:
ERROR
Maximum Response Time
300ms
Parameter
<gsmbandval>
A hexadecimal value that specifies the GSM frequency band. If it is set to 0, it means not to change GSM frequency band. (eg.: 0x0a=0x02(GSM1800)+ 0x08(GSM1900))
00000000
No change
00000001
GSM 900MHz
00000002
GSM 1800MHz
00000004
GSM 850MHz
00000008
GSM 1900MHz
Page 62
62 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
0000000F
Any frequency band
<catm1bandval>
A hexadecimal value that specifies the LTE Cat M1 frequency band. If it is set to 0 or 0x40000000, it means not to change the frequency band. (eg.: 0x15=0x01(LTE B1)+0x04(LTE B3)+0x10(LTE B5))
0x1 (CM_BAND_PREF_LTE_EUTRAN_BAND1)
LTE B1
0x2 (CM_BAND_PREF_LTE_EUTRAN_BAND2)
LTE B2
0x4 (CM_BAND_PREF_LTE_EUTRAN_BAND3)
LTE B3
0x8 (CM_BAND_PREF_LTE_EUTRAN_BAND4)
LTE B4
0x10 (CM_BAND_PREF_LTE_EUTRAN_BAND5)
LTE B5
0x80 (CM_BAND_PREF_LTE_EUTRAN_BAND8)
LTE B8
0x800(CM_BAND_PREF_LTE_EUTRAN_BAND12)
LTE B12
0x1000 (CM_BAND_PREF_LTE_EUTRAN_BAND13)
LTE B13
0x20000 (CM_BAND_PREF_LTE_EUTRAN_BAND18)
LTE B18
0x40000(CM_BAND_PREF_LTE_EUTRAN_BAND19)
LTE B19
0x80000 (CM_BAND_PREF_LTE_EUTRAN_BAND20)
LTE B20
0x2000000 (CM_BAND_PREF_LTE_EUTRAN_BAND26)
LTE B26
0x8000000(CM_BAND_PREF_LTE_EUTRAN_BAND28)
LTE B28
0x4000000000(CM_BAND_PREF_LTE_EUTRAN_BAND39)
LTE B39
0x40000000
No change
0x400A0E189F (CM_BAND_PREF_ANY)
Any frequency band
<catnb1bandval>
A hexadecimal value that specifies the LTE Cat NB1 frequency band. If it is set to 0 or 0x40000000, it means not to change the frequency band.
0x1 (CM_BAND_PREF_LTE_EUTRAN_BAND1)
LTE B1
0x2 (CM_BAND_PREF_LTE_EUTRAN_BAND2)
LTE B2
0x4 (CM_BAND_PREF_LTE_EUTRAN_BAND3)
LTE B3
0x8 (CM_BAND_PREF_LTE_EUTRAN_BAND4)
LTE B4
0x10 (CM_BAND_PREF_LTE_EUTRAN_BAND5)
LTE B5
0x80 (CM_BAND_PREF_LTE_EUTRAN_BAND8)
LTE B8
0x800(CM_BAND_PREF_LTE_EUTRAN_BAND12)
LTE B12
0x1000 (CM_BAND_PREF_LTE_EUTRAN_BAND13)
LTE B13
0x20000 (CM_BAND_PREF_LTE_EUTRAN_BAND18)
LTE B18
0x40000(CM_BAND_PREF_LTE_EUTRAN_BAND19)
LTE B19
0x80000 (CM_BAND_PREF_LTE_EUTRAN_BAND20)
LTE B20
Page 63
63 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
0x2000000 (CM_BAND_PREF_LTE_EUTRAN_BAND26)
LTE B26
0x8000000(CM_BAND_PREF_LTE_EUTRAN_BAND28)
LTE B28
0x40000000
No change
0xA0E189F (CM_BAND_PREF_ANY)
Any frequency band
<effect>
When to take effect
0 Take effect after UE reboots
1 Take effect immediately
Notes – 1. <gsmbandval> is applicable to multi-mode BG96 only.
2. <catm1bandval> is not supported on BG96-N.
3. <catnb1bandval> is not supported on BG96-M..
AT+QCFG="celevel" Get LTE Cat NB1 Coverage Enhancement Level
A T+ QC FG =" C E L E V E L" G E T L T E C AT N B1 C OV ER A G E E N H A N C E M E N T L E V E L
Read Command
AT+QCFG="celevel"
Response
+QCFG: "celevel",<level>
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
Maximum Response Time
300ms
Parameter
<level>
LTE Cat NB1 Coverage Enhancement Level
0 CE level 0 1
CE level 1
2 CE level 2
Note – This command is not supported on BG96-M.
Page 64
64 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+QCFG="iotopmode" Configure Network Category to be Searched under LTE RAT
The command specifies the network category to be searched under LTE RAT. If <effect> is omitted, the configuration will take effect immediately.
A T+ QC FG =" IO TO PM OD E" C O N F I G U R E N E T W O R K C A TE G O R Y T O B E SE AR CH E D U N D E R L T E
R AT
Write Command
AT+QCFG=“iotopmode”[,<
mode>[,<eff ect>]]
Response
If <mode> and <effect> are both omitted, return the current configuration:
+QCFG: “iotopmode”,<mode
OK
If <mode> and <effect> are not omitted, configure the network category to be searched under LTE RAT:
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
If there is any other error, response:
ERROR
Maximum Response Time
300ms
Parameter
<mode>
Number format.
Network category to be searched under LTE RAT.
0 LTE Cat M1
1 LTE Cat NB1
2 LTE Cat M1 and Cat NB1
<effect>
Number format.
When to take effect.
0 Take effect after UE reboots
1 Take effect immediately
Note – This command is not supported on BG96-M.
Page 65
65 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+QCFG="nwscanmode" Network Search Mode Configuration
The command specifies the mode of searching network. If <effect> is omitted, the configuration will take effect immediately.
A T+ QC FG =" NW SC AN M O D E " N E T W O RK SE AR CH M OD E C O N F I G U R A T I O N
Write Command
AT+QCFG=“nwscanmode”[,<sca
nmod e>[,<effect>]]
Response
If <scanmode> and <effect> are both omitted, return the current configuration:
+QCFG: “nwscanmode”,<scanmode>
OK
If <scanmode> and <effect> are not omitted, set the network search mode:
OK
ERROR
If there is an error related to ME functionality:
+CME ERROR: <err>
Maximum Response Time
300ms
Parameter
<scanmode>
Number format.
Network search mode.
0 AUTO 1
GSM only 2
WCDMA only
3 LTE only
4 TD-SCDMA only
5 UMTS only 6
CDMA only 7
HDR only 8
CDMA and HDR only
<effect>
Number format.
When to take effect.
0 Take effect after UE reboots
1 Take effect immediately
Page 66
66 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+QCFG="nwscanseq" Network Searching Sequence Configuration
The command specifies the sequence of searching network. This configuration is valid only after the module is restarted.
A T+ QC FG =" NW SC AN SE Q" N E T W O R K S E A R C H I N G S E QU E N C E C O N F I G U R A T I O N
Write Command
AT+QCFG=“nwscanseq”[,<scans eq>]
Response
If <scanseq> is omitted, return the current configuration:
+QCFG: “nwscanseq”,<scanseq>
OK
If <scanseq> is not omitted, configure the network searching sequence :
OK
ERROR
If there is an error related to ME functionality:
+CME ERROR: <err>
Maximum Response Time
300ms
Parameter
<scanseq>
Number format.
Network search sequence.
(e.g.: 04030201(LTE/WCDMA/TD-SCDMA/GSM))
00
Automatic (LTE/WCDMA/TD-SCDMA/GSM)
01
GSM 02
TD-SCDMA
03
WCDMA 04
LTE
05
CDMA
AT+QCFG="PDP/DuplicateChk" Establish Multi PDNs with the Same APN
The command allows/refuses establishing multiple PDNs with the same APN profile. The configuration will take effect immediately.
Page 67
67 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
A T+ QC FG =" PD P / DU P L IC A T E C H K " E S T A B LI S H M U L T I PD N S WI TH T HE S AM E A P N
Write Command
AT+QCFG=“PDP/DuplicateChk”[,
<ena ble>]
Response
If <enable> is omitted, return the current configuration:
+QCFG: “PDP/DuplicateChk”,<enable>
If <enable> is not omitted, allow/refuse establishing multiple PDNs with the same APN profile:
OK
ERROR
If there is an error related to ME functionality:
+CME ERROR: <err>
Maximum Response Time
300ms
Parameter
<enable>
0 Refused to establish multi PDNs with the same APN profile
1 Allowed to establish multi PDNs with the same APN profile
AT+QCSQ Query and Report Signal Strength
The command is used to query and report the signal strength of the current service network. If the MT is registered on multiple networks in different service modes, customers can query the signal strength of networks in each mode. No matter whether the MT is registered on a network or not, the command can be run to query the signal strength or allow the MT to unsolicitedly report the detected signal strength if the MT camps on the network. If the MT is not using any service network or the service mode is uncertain, "NOSERVICE" will be returned as the query result.
A T+ QC SQ Q U E R Y A ND R E P O R T S I G N A L S T R E N G T H
Execution Command
AT+QCSQ
Response
+QCSQ: <sysmode>,[,<value1>[,<value2>[,<value3>[,<value4>]]]]
OK
Maximum Response Time
300ms
Parameter
<sysmode>
A string type value indicating the service mode in which the MT will unsolicitedly report the signal strength.
Page 68
68 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
“NOSERVICE”
NOSERVICE mode
“GSM”
GSM/GPRS/EDGE mode
“CAT-M1”
LTE Cat M1 mode
“CAT-NB1”
LTE Cat NB1 mode
<value1>, <value2>, <value3>, <value4>:
the following table lists the signal strength type corresponding to each service mode.
<sysmdoe>
<value1>
<value2>
<value3>
<value4>
“NOSERVICE”
“GSM”
<gsm_rssi>
“CAT-M1”
<lte_rssi>
<lte_rsrp>
<lte_sinr>
<lte_rsrq>
“CAT-NB1”
<lte_rssi>
<lte_rsrp>
<lte_sinr>
<lte_rsrq>
<gsm_rssi>,<lte_rssi>
An integer indicating the received signal strength. These parameters are available for GSM and LTE mode respectively.
<lte_rsrp>
An integer indicating the reference signal received power (RSRP). This parameter is available for LTE mode.
<lte_sinr>
An integer indicating the signal to interference plus noise ratio (SINR).
Logarithmic value of SINR. Values are in 1/5th of a dB. The range is 0-250 which translates to -20dB - +30dB.
<lte_rsrq>
An integer indicating the reference signal received quality (RSRQ) in dB.
Example
AT+QCSQ //Execute command to query signal
+QCSQ: "CAT-M1",-52,-81,195,-10
OK
AT+QCSQ =? //List of supported <sysmode>s
+QCSQ: "NOSERVICE","GSM","CAT-M1","CAT-NB1"
BG96_AT_Commands_Manual 101 / 208
OK
Page 69
69 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+QNWINFO Query Network Information
The command indicates network information such as the access technology selected, the operator, and the band selected.
A T+ QN WI N F O QU ER Y N E T W O R K I N F O R M A T I O N
Test Command
AT+QNWINFO=?
Response
OK
Execution Command
AT+QNWINFO
Response
+QNWINFO: <Act>,<oper>,<band>,<channel>
OK
Maximum Response Time
300ms
Parameter
<Act>
String type.
Access technology selected “NONE”
“CDMA1X”
“CDMA1X AND HDR”
“CDMA1X AND EHRPD”
“HDR”
“HDR-EHRPD” “GSM”
“GPRS”
“WCDMA”
“HSDPA”
“HSUPA”
“HSPA+”
“TDSCDMA”
“TDD LTE”
“FDD LTE”
<oper>
String type.
Operator in numeric format
<band>
String type.
Band selected
“CDMA BC0”“CDMA BC19”
“GSM 450”
“GSM 480”
Page 70
70 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
“GSM 750”
“GSM 850”
“GSM 900”
“GSM 1800”
“GSM 1900”
“WCDMA 2100”
“WCDMA 1900”
“WCDMA 1800”
“WCDMA 1700 US”
WCDMA 850”
“WCDMA 800”
“WCDMA 2600”
“WCDMA 900”
“WCDMA 1700 JAPAN”
“WCDMA 1500”
“WCDMA 850 JAPAN”
“LTE BAND 1” – “LTE BAND 43”
“TDSCDMA BAND A”
“TDSCDMA BAND B”
“TDSCDMA BAND C”
“TDSCDMA BAND D”
“TDSCDMA BAND E”
“TDSCDMA BAND F”
<channel>
Integer type; channel ID
Note – BG96 supports SRLTE. Executing AT+QNWINFO will display CDMA 1X and LTE network information in SRLTE mode.
Example
AT+QNWINFO=?
OK
AT+QNWINFO
+QNWINFO: "CDMA1X","46003","CDMA BC0",283
Page 71
71 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
+QNWINFO: "FDD LTE","46011","LTE BAND 1",75
OK
AT+QSPN Display the Name of Registered Network
A T+ QS P N D IS PL AY T HE N A M E O F R E G I S T E R E D N ET W O R K
Test Command
AT+QSPN=?
Response
OK
Execution Command
AT+QSPN
Response
+QSPN: <FNN>,<SNN>,<SPN>,<alphabet>,<RPLMN>
OK
Reference
Parameter
<SPN>
Service provider name
<alphabet>
Alphabet of full network name and short network name
0 GSM 7 bit default alphabet
1 UCS2
<RPLMN>
Registered PLMN
<FNN>
Full network name
<SNN>
Short network name
Note – 1. If <alphabet> is 0, <FNN> and <SNN> will be shown in GSM 7 bit default alphabet string.
2. If <alphabet> is 1, <FNN> and <SNN> will be shown in UCS2 hexadecimal string.
Example
AT+QSPN //Query the EONS information of RPLMN
+QSPN: "CHN-UNICOM","UNICOM","",0,"46001"
OK
Page 72
72 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
AT+QSPN* Display the Name of Registered Network
A T+ Q S P N * DI SP LA Y TH E NA M E O F R E GI ST ER ED N E T W O R K
Test Command
AT+QSPN=?
Response
OK
Execution Command
AT+QSPN
Response
+QSPN: <FNN>,<SNN>,<SPN>,<alphabet>,<RPLMN>
OK
Reference
Parameter
<SPN>
Service provider name
<alphabet>
Alphabet of full network name and short network name
0 GSM 7 bit default alphabet
1 UCS2
<RPLMN>
Registered PLMN
<FNN>
Full network name
<SNN>
Short network name
Notes – If <alphabet> is 0, <FNN> and <SNN> will be shown in GSM 7 bit default alphabet string. If <alphabet> is 1, <FNN> and <SNN> will be shown in UCS2 hexadecimal string.
Example
AT+QSPN
+QSPN: "CHN-UNICOM","UNICOM","",0,"46001"
OK
//Query the EONS information of RPLMN
AT+CVERSION Display module firmware version
Description:
Displays the module firmware version and build timestamp.
Usage:
AT+CVERSION?
Page 73
73 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
General Operation
PAD mode
Upon powering up, the application gets an IP address from the network, subscribes to the SMS service and sets up customized AT commands. By default, the device boots up in PAD=0 mode which is also a configuration mode. To log in to this mode, the default username is root and password is admin. The device can be set to PAD modes (TCP Client, TCP server, UDP Client, UDP Server mode), PPP mode or PSTN mode. If the configuration is saved, the NTC-100 will start in the configured mode upon next boot.
The application can switch to any of these modes by AT command or remotely through SMS. The serial port can be initialized while GSM/GPRS registration in progress. If the flash configuration area is empty, the default parameters are loaded. The default parameters are as follows:
Serial Port
Baud Rate: 115200 Data Bits: 8 Parity: none Stop Bit: 1 Serial Mode: RS232
PDP profile
APN: telstra.internet User: Password:
Server configuration
Server: Port: 1516
The NTC-100 default PAD mode is with PAD=0.
PPP mode
In PPP mode, a DTE can dial the NTC-100 with an AT dialling command and create a PPP connection between the DTE and the NTC-100. An IP address will be assigned to the DTE and it can talk to remote servers.
PSTN mode
In this mode, the NTC-100 application creates a tunnel between the DTE and the modem. The DTE can directly
talk to the device module with AT commands.
Page 74
74 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Configuration through SMS
The NTC-100 can be configured through the serial port with AT commands or remotely through SMS messages. In order to use SMS commands, the AT+SMS_DIAGNOSTICS=1 command must be issued through the AT command port.
When configuring the NTC-100 using SMS messages, all the messages must be prefixed with a password and
without a space after it, for example, “1234get status”. When “set” and “execute” SMS commands are received,
the NTC-100 sends an acknowledgment reply message when the command has been implemented.
The following is a list of SMS commands that may be used, along with a description of their usage:
execute clear
Instructs the NTC-100 to erase all stored SMS messages.
execute factory_reset
Instructs the NTC-100 to reset to factory default settings, as per the “AT+FACTORY_RESET” terminal command.
execute pdpcycle
Instructs the NTC-100 to stop the current PDP session and reconnect it.
execute pdpdown
Instructs the NTC-100 to stop the active PDP session.
execute pdpup
Instructs the NTC-100 to connect the PDP.
execute reboot
Instructs the NTC-100 to perform a reboot immediately.
execute save
Instructs the NTC-100 to save the current settings to on-board flash memory.
get apn
The NTC-100 sends an SMS reply with the currently configured APN.
get apn_sep
Retrieves the currently configured separation character used when specifying multiple APNs using the “set apn+ command.
Page 75
75 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
get ccid
The NTC-100 replies with the SIM CCID value.
get daily_sms_limit
Retrieves the currently configured daily SMS limit.
get fail_count
Retrieves the fail count for the ping watchdog.
get force_reconnect
The NTC-100 replies with the enabled status of the force_reconnect command and the force_reconnect period.
get force_reset
The NTC-100 replies with the current FORCE_RESET period, i.e. the periodic reset frequency.
get ftp_para
This command retrieves the configured FTP settings on the NTC-100.
get hw_version
The NTC-100 replies with the hardware version of the board.
get imei
Retrieves the IMEI of the NTC-100.
get modem_mode
The NTC-100 replies with the currently configured modem mode (IP/PAD mode, PPP mode or PSTN emulation mode).
get module_watchdog
Retrieves the module watchdog status.
Page 76
76 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
get pdp_type
The NTC-100 replies with the currently configured packet data protocol type for PDP context 1.
get ping_acc_timer
Retrieves the accelerated periodic ping timer for the ping watchdog.
get ping_ip1
Retrieves the first destination IP address for the ping watchdog.
get ping_ip2
Retrieves the second destination IP address for the ping watchdog.
get ping_timer
Retrieves the periodic ping timer for the ping watchdog.
get ping_watchdog
Retrieves the ping_watchdog status.
get ping=[domain name / IP address]
Instructs the NTC-100 to send a ping to a remote host and display ping replies. For example, get ping=www.google.com.
get serial_on_start
The NTC-100 replies with the current SERIAL_ON_START flag.
get settings
The NTC-100 replies with the following information:
APN: testAPN
PDP: testuser@domain.com.au, test
SERVER: 10.1.193.11,1516
PAD: 1
BAUD: 115200
DYN_ENABLE: 1
DYN_HOST: testuser.dyndns.org
NON_REBOOT: 1
get status
The NTC-100 sends an SMS reply with the following information:
Page 77
77 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
IMEI:xxxxx
UpTime:xx:xx:xx
Connection UpTime:xx:xx:xx
IP:xxx.xxx.xxx.xxx
RSSI:xx
Current APN:xxxxxxxx
get version
The NTC-100 replies with the version of the application firmware and module firmware.
get web_file
Retrieves the file name for the module/application firmware OTA upgrade.
get web_host
Retrieves the HTTP/S server for module/application firmware OTA upgrade.
get web_pass
Retrieves the password if authentication is implemented on the HTTP/S Server for application firmware OTA upgrade.
get web_path
Retrieves the file path on the HTTP/S Server for the module/application firmware OTA upgrade.
get web_port
Retrieves the HTTP/S port for the module/application firmware OTA upgrade.
get web_retry
Retrieves the retry attempt setting if HTTP/S OTA fails.
get web_user
Retrieves the username if authentication is implemented on the HTTP/S Server for application firmware OTA upgrade.
serv=xxxx
This command sets a full set of FTP parameters allowing the NTC-100 to download and run a firmware upgrade with a single command. Use the following format:
1234serv=<hostname>;f=<firmware_filename>;p=<path_name>;u=<username>;p=<password>
Page 78
78 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set apn_sep
Configures the separation character to use when specifying multiple APNs using the “set apn+” command. The
characters that may be used as separators are |, [, ], and /.
set apn+=xxxxx
This command is the same as set apn=xxxxx, but does not overwrite the existing APNs. Instead, APNs are appended to the existing list.
set apn=xxxxx
Sets the APN used to connect to the PDP session. The new APN will take effect after performing the “execute save” and “execute pdpcycle” command. This new APN won't be saved to on-board flash memory unless the “execute save” command is issued. Multiple APNs can be entered using the apn_sep character (see the get
apn_sep command). The NTC-100 will attempt to connect to the APNs in the order specified.
set at=xxxx
This command allows you to run your own AT commands via SMS. For example, <password>set at=at+cfun=1,1.
set auth_type=x
Sets the authentication type when a username and password is set for the APN. Valid options are 0 (None), 1 (PAP), 2 (CHAP), 3 (PAP or CHAP).
set baud=xxx
Sets the baud rate to be used by the NTC-100. Valid baud rate values are “300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400”.
set daily_sms_limit=xxx
Sets the daily limit of SMS messages that the NTC-100 will send. This value is reset every 24 hours and when the NTC-100 is rebooted. The valid range of SMS messages to send is 5 to 255.
set dyn_enable=0,1
When this value is set to 1, the NTC-100 automatically updates the IP address from the dynamic DNS host. When this value is set to 0, the dynamic DNS feature is disabled.
set dyn_host=xxx
Sets the Dynamic DNS hostname.
set dyn_pass=xxx
Sets the Dynamic DNS password.
Page 79
79 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set dyn_user=xxx
Sets the Dynamic DNS username.
set fail_count
Configures the fail count for the ping watchdog.
set force_reconnect=xxx
This command sets the period in seconds to wait before attempting to reconnecting to the TCP server. When set to 0, the NTC-100 will not attempt to reconnect to the TCP server.
set force_reset=xxxxx
Sets the FORCE_RESET period in minutes. Valid intervals are 2 – 65535 minutes. Setting this value to 0 disables the forced reset function.
set ftp_file=xxx
This command specifies the filename of the firmware stored on the FTP server used to perform a firmware upgrade.
set ftp_host=xxx
This command specifies the hostname or IP address of the FTP server used to perform a firmware upgrade.
set ftp_pass=xxx
This command specifies the password of the account on the FTP server used to perform a firmware upgrade.
set ftp_path=xxx
This command specifies the path to the firmware file stored on the FTP server used to perform a firmware upgrade.
set ftp_retry=xxx
This command specifies the number of times to retry an FTP firmware upgrade if a failure occurs. The default setting is 4 and the maximum is 255.
set ftp_user=xxx
This command specifies the username of the account on the FTP server used to perform a firmware upgrade.
set ipv4_mtu
Sets the maximum transmission unit (MTU) of the IPv4 protocol. Default value is 1460. Valid values are between 1000 and 1460.
Page 80
80 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set ipv6_mtu
Sets the maximum transmission unit (MTU) of the IPv6 protocol. Default value is 1358. Valid values are between 1000 and 1500.
set modem_mode=x
Sets the modem mode. Valid options are 0 (PPP), 1 (IP mode), 2 (PSTN mode).
set module_watchdog
Enables/disables the module watchdog function.
set no_whitelist=x
Removes a number or numbers from the whitelist.
set non_reboot=0,1
When set to 0, the NTC-100 will not reboot when PAD mode is changed. When set to 1, the NTC-100 when PAD mode is changed.
set pad=0,1,2,3,4
Sets the NTC-100 mode of operation where “0” is “PAD disabled mode”, “1” is "TCP client mode”, “2” is “TCP server mode”, “3” is “UDP client mode” and “4” is “UDP server mode”.
set pdp_type=xxx
Sets the packet data protocol type for PDP context 1. Valid options are IPV4, IPV6, IPV4V6, PPP.
set pdpauth=<username>,<password>
Sets the username and password used for authentication to the PDP session.
set ping_acc_timer
Configures the accelerated periodic ping timer for the ping watchdog.
set ping_ip1
Configures the first destination IP address for the ping watchdog.
set ping_ip2
Configures the second destination IP address for the ping watchdog.
Page 81
81 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set ping_timer
Configures the periodic ping timer for the ping watchdog.
set ping_watchdog=0,1
Enables/disables the ping watchdog feature.
set reply_cmd_error=x
When set to 1, the NTC-100 replies to incorrect commands with an SMS error message. When set to 0, the NTC­100 does not send any error replies. Note that if the password is incorrect, no error message is sent, regardless of the state of this setting. Also, the AT+SMS_ACK option must be enabled for this to work.
set serial_mode
Sets the mode of the serial port. The default mode is RS232. Valid options are RS232, RS422, RS485.
set serial_on_start=0,1
When this value is set to 1, the NTC-100 enables the serial port in data mode when the unit boots up. When this value is set to 0, the NTC-100 will not start the serial port in data mode on boot.
set server= ip address/hostname, port
Sets the server IP address or hostname and port that the NTC-100 will use when operating in TCP/UDP server mode.
1234set server=123.123.12.34,9999
set sms=XXXXXXXXXX,”message content
Instructs the NTC-100 to send an SMS to a mobile phone number. For example:
1234set sms=0412345678,”This is a test message”
set smspassword=XXXXXX
Sets the SMS password required as a prefix for all SMS commands. The password may be a maximum of 6 characters in length.
set web_file
Configures the file name for the module/application firmware OTA upgrade.
set web_host
Configures the HTTP/S server for the module/application firmware OTA upgrade.
Page 82
82 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
set web_pass
Configures the password if authentication is implemented on the HTTP/S Server for application firmware OTA upgrade.
Note: Username/password authentication can be implemented in http/s server only for application firmware OTA, but not for Module firmware.
set web_path
Configures the file path on the HTTP/S Server for the module/application firmware OTA upgrade.
set web_port
Configures the HTTP/S port for the module/application firmware OTA upgrade.
set web_retry
Configures the retry attempt if HTTP/S OTA fails.
set web_upload=1,2
Triggers a firmware upgrade from an HTTP/S server.
For example:
To perform an HTTP/S OTA for the application firmware:
set web_upload=1
To perform an HTTP/S OTA for the module firmware:
set web_upload=2
set web_user
Configures the username if authentication is implemented on the HTTP/S Server for application firmware OTA upgrade.
Note: Username/password authentication can be implemented in http/s server only for application firmware OTA, but not for module firmware.
set whitelist=+XXXXXXXXXXX
Adds the number entered into a whitelist of numbers that are allowed to execute commands on the NTC-100. For example, set whitelist=+61412345678 adds the mobile number 0412345678 to the whitelist. When this command is executed, no other numbers may execute commands.
Upload
Issuing the upload command instructs the NTC-100 to begin the firmware upgrade process. Note that this is a case sensitive command and must begin with a capital “U”.
Page 83
83 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Updating the application firmware
Via Local PC
Pre-requisites for application firmware installation:
Please ensure that you have the following items:
A PC running Windows (XP or newer) with QEFS Explorer installed An NTC-100 device A MicroUSB Type B plug to Standard-A plug USB cable
Please ensure that you have all the following files to complete the upgrade.
Windows BG96 USB Driver file QExplorer Software to install application firmware Application package (NTC100.bin, NTC100.signature, oem_app_path.ini) for application firmware upgrade TeraTerm or PuTTY
Application firmware installation steps:
Install the Quectel BG96 Windows USB drivers by double-clicking on
Quectel_BG96_Windows_USB_Driver.exe. When the installation is complete, reboot the PC.
After the driver has been installed, connect the NTC-100 to a Windows PC with a USB cable and verify in the
Device Manager that the 3 COM ports (USB AT port, USB DM port and USB NMEA port) have enumerated.
Page 84
84 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Open QEFS Explorer. Click File, then Device and Quectel USB DM Port. Click the magnifying glass icon
below File.
The list of files in the file system are displayed.
Navigate to /datatx and drag the 3 application firmware files from your local PC to the datatx directory. The
application firmware contains 3 files named NTC100.bin, NTC100.signature, and oem_app_path.ini. If old firmware is present, it will be replaced by the new files. Note that copy and paste doesn’t work and drag/drop is required.
When the file transfer is finished, close the window and power cycle the device. The NTC-100 will reboot
with the new application firmware.
Page 85
85 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Over the Air (OTA)
There are two ways to upgrade the application firmware over the air:
From an FTP Server From an HTTP or HTTPS Server
There are also two ways to run commands to configure parameters and initiate the upgrade process.
Using customized AT commands via the serial interface Using SMS commands
Pre-requisites for Application Firmware Over the Air Upgrade:
Please ensure that you have the following items:
An HTTP/S Server or FTP Server for storing application firmware An NTC-100 device The serial Y-cable provided with NTC-100 A USB to RS232 serial adapter cable A power adapter A valid SIM
Please ensure that you have all the following files to complete the upgrade.
The application file: NTC100.bin.signed TeraTerm or PuTTY
Application firmware upgrade Over the Air from FTP server using SMS:
Save NTC100.bin.signed on the FTP server. For example, in the /application folder on the FTP server with
the address repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Check the current application version by sending the SMS command: 1234get version Configure the FTP server parameter on the NTC-100 by sending the SMS command: 1234set
ftp_host=repository.example.com
Wait for the acknowledgment message from the NTC-100.
Configure the FTP Path with the following command: 1234set ftp_path=application/
(Note: The folder should not be preceded by a /)
Wait for the acknowledgment message from the NTC-100.
Configure the file name of the application firmware: 1234set ftp_file=NTC100.bin.signed
Wait for the acknowledgment message from the NTC-100.
Configure the FTP user with the following command: 1234set ftp_user=username.
Wait for the acknowledgment message from the NTC-100.
Configure FTP password with the following command: 1234set ftp_pass=password.
Wait for the acknowledgment message from the NTC-100.
Page 86
86 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Save the configured parameters with the command: 1234set execute save
Check configured parameters with the command: 1234get ftp_para Initiate the application firmware upgrade with the command: 1234Upload
Wait for around two minutes and the NTC-100 will power cycle itself indicating that the firmware upgrade was successful.
When the NTC-100 has finished rebooting and connected to the network, confirm the new application
firmware with the SMS command:
1234get version
Application firmware upgrade Over the Air from FTP server using customized AT commands:
Save NTC100.bin.signed on the FTP server. For example, in the /application folder on FTP server with the
address repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Connect the NTC-100 to the PC via the serial interface. You can use a standard USB to DE-9 cable to
connect to the DE-9 female port of the Serial Y cable provided with the NTC-100.
Navigate to Device Manager and identify assigned COM port Open a Terminal emulator such as TeraTerm or PuTTY and configure the baud rate to 115200. Leave the
other serial parameters as default.
Type any character on the keyboard. The terminal prompts for a username and password. For the username,
enter root and for password, enter admin.
When you have logged in, you can run customized AT commands and module AT commands. Note that
from the USB AT interface, you can run only module AT commands.
Type at+version? and press Enter to check current application firmware version. Configure the FTP server parameter on the NTC-100 by typing the command:
at+ ftp_host=repository.example.com
Configure the FTP Path by entering the command:
at+ftp_path=application/
(Note: The folder should not be preceded by a /)
Configure the file name by entering the command:
at+ftp_file=NTC100.bin.signed
Configure the FTP user by entering the command:
at+ftp_user=username
Configure the FTP password by entering the command:
at+ftp_pass=password
Save the configured parameters by entering the command:
at+save=1
Check the configured parameters by entering the command:
at+ftp_para?
Initiate the application firmware upgrade by entering the command:
at+ftp_upload=1
Page 87
87 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
If successful, the NTC-100 replies with OK, otherwise it will reply with ERROR.
When the NTC-100 has finished rebooting and connected to the network, confirm the new application
firmware with the command:
at+version?
Application firmware upgrade Over the Air from an HTTP/S server using SMS:
Save NTC100.bin.signed on the HTTP or HTTPS server. For example, in the /application folder on the
HTTP/S server with the address “repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Check the current application version by sending the SMS command: 1234get version Configure the HTTP/S server parameter on the NTC-100 by sending SMS command:
1234set web_host=http://repository.example.com for http
OR
1234set web_host=https://repository.example.com for https
Wait for the acknowledgment message from the NTC-100.
Configure the HTTP/S path by entering the following command:
1234set web_path=application/
(Note: The folder should not be preceded by a /)
Wait for the acknowledgment message from the NTC-100.
Configure the file name by entering the following command:
1234set web_file=NTC100.bin.signed
Wait for the acknowledgment message from the NTC-100.
Configure the HTTP/S port by entering the following command:
1234set web_port=80 or 1234set web_port=443
Save the configured parameters by entering the following command:
1234set execute save
Check the configured parameters by entering the following command:
1234get web_host, 1234get web_path, 1234get web_file, 1234get web_port
Initiate the application firmware upgrade by entering the following command:
1234set web_upload=1
Wait for around two minutes. If the upgrade was successful, the NTC-100 replies with “ACK” power cycles itself. If the upgrade failed, the NTC-100 replies with “Error” and does not reboot.
When the NTC-100 has finished rebooting and connected to the network, confirm the new application
firmware with the SMS command:
1234get version
Page 88
88 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Application firmware upgrade Over the Air from an HTTP/S server using Customized AT command:
Save NTC100.bin.signed on the HTTP or HTTPS server. For example, in the /application folder on the
HTTP/S server with the address “repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Connect the NTC-100 to the PC via the serial interface. You can use a standard USB to DE-9 cable to
connect to the DE-9 female port of the Serial Y cable provided with the NTC-100.
Navigate to Device Manager and identify assigned COM port Open a Terminal emulator such as TeraTerm or PuTTY and configure the baud rate to 115200. Leave the
other serial parameters as default.
Type any character on the keyboard. The terminal prompts for a username and password. For the username,
enter root and for password, enter admin.
When you have logged in, you can run customized AT commands and module AT commands. Note that
from the USB AT interface, you can run only module AT commands.
Type at+version? and press Enter to check current application firmware version. Configure the HTTP/S server parameter on the NTC-100 by entering the following command:
at+ web_host=http://repository.example.com
OR
at+ web_host=https://repository.example.com
Configure the HTTP/S path by entering the following command:
at+web_path=application/
(Note: The folder should not be preceded by a /)
Configure the file name by entering the following command:
at+web_file=NTC100.bin.signed
Configure the HTTP/S port by entering the following command:
at+web_port=80 or at+web_port=443
Save the configured parameters by entering the following command:
at+save=1
Check the configured parameters by entering the following command:
at+web_host?, at+web_file?,at+web_path?
Initiate the application firmware upgrade by entering the following command:
at+web_upload=1
If successful, the NTC-100 replies with ACK, otherwise it will reply with ERROR.
When the NTC-100 has finished rebooting and connected to the network, confirm the new application
firmware with the command:
at+version?
Page 89
89 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Updating the module firmware
Via Local PC
Pre-requisites for module firmware installation:
The module firmware can be upgraded locally via the USB interface. Please ensure that you have the following items:
A PC running Windows (XP or newer) An NTC-100 device A Micro-USB Type B plug to Standard A plug USB cable
Please ensure that you have all the following files to complete the upgrade.
The Windows BG96 USB Driver file QFlash Software to install module firmware The module firmware package for the upgrade TeraTerm/PuTTY QEFS Explorer (may be required)
Module firmware installation steps:
Install the Quectel Windows USB drivers by double clicking on Quectel_BG96_Windows_USB_Driver.exe.
When the installation is complete, reboot the PC.
After the driver has finished installing, connect the NTC-100 to the Windows PC with a USB cable and verify
in Device manager that 3 COM ports (USB AT port, USB DM port and USB NMEA port) have enumerated.
Open QFlash software tool. Select Baud rate=115200 and COM port=Port assigned to USB DM port as
shown in above screenshot.
Click the Load FW Files button and browse to module firmware files. Select any of the .mbn files and click
Open, then Start to initiate the module firmware installation process.
Page 90
90 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Wait a few minutes for the process to complete until you see the “Pass” message as shown in the figure
below. When you see “Pass”, the module firmware has been updated and you can close the window.
Page 91
91 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
If you have a problem upgrading the module firmware such as a “Dynamic Port” error, try removing the init file of the existing application firmware using QEFS Explorer (delete the /datatx/oem_app_path.ini file first and retry from step 4).
To verify the newly installed module firmware version, open TeraTerm or PuTTY and set the baud rate to
115200 and port to the COM Port assigned to the USB AT port in Device Manager. Type ATI in the terminal to retrieve the current module firmware version.
Page 92
92 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Over the Air (OTA)
Module firmware can be upgraded Over the Air from an HTTP or HTTPS Server. The NTC-100 supports the DFOTA (Delta Firmware Upgrade Over-the-Air) function which allows you to upgrade the firmware to a new version and revert to the old version if required. Before upgrading the module firmware, you must prepare the delta firmware package which contains only the differences between the old and new firmware versions. This reduces the amount of data transmitted and accelerates the speed of the module firmware upgrade.
There are two ways to run the commands to configure parameters and initiate the upgrade process.
Using customized AT commands from the serial interface (Note: Customized AT commands are not accessible
via the USB AT interface)
Using SMS commands
Pre-requisites for Module Firmware Over the Air Upgrade:
Please ensure that you have the following items:
An HTTP/S Server for storing the Delta package of the module firmware An NTC-100 The serial Y cable provided with the NTC-100 A power adapter A valid SIM
Please ensure that you have all the following files to complete the upgrade.
The Delta firmware package (single zipped file) TeraTerm/PuTTY
Module firmware upgrade Over the Air from an HTTP/S server using customized AT commands:
Save the zipped delta module firmware package (eg: update.zip) on the HTTP or HTTPS server. For example,
in the /firmware folder on an http/s server with the address “repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Connect the NTC-100 to the PC via the serial interface. You can use a standard USB to DE-9 cable to
connect to the DE-9 female port of the Serial Y cable provided with the NTC-100.
Navigate to Device Manager and identify assigned COM port Open a Terminal emulator such as TeraTerm or PuTTY and configure the baud rate to 115200. Leave the
other serial parameters as default.
Type any character on the keyboard. The terminal prompts for a username and password. For the username,
enter root and for password, enter admin.
When you have logged in, you can run customized AT commands and module AT commands. Note that
from the USB AT interface, you can run only module AT commands.
Type at+version? and press Enter to check current module firmware version. Configure the HTTP/S server parameter on the NTC-100 by entering the following command:
at+ web_host=http://repository.example.com
OR
at+ web_host=https://repository.example.com
Page 93
93 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Configure the HTTP/S path by entering the following command:
at+web_path=firmware/
(Note: The folder should not be preceded by a /)
Configure the file name by entering the following command:
at+web_file=update.zip
Configure the HTTP/S port by entering the following command:
at+web_port=80 or at+web_port=443
Save the configured parameters by entering the following command:
at+save=1
Check the configured parameters by entering the following command:
at+web_host?, at+web_file?,at+web_path?
Initiate the module firmware upgrade by entering the command:
at+web_upload=2
If successful, the NTC-100 replies with OK, otherwise it will reply with ERROR.
When the NTC-100 has finished rebooting and connected to the network, confirm the new module firmware
with the command:
at+version?
Module firmware upgrade Over the Air from an HTTP/S server using SMS
Save the zipped delta module firmware package (e.g.: update.zip) on the HTTP or HTTPS server. For
example, in the /firmware folder on an http/s server with the address “repository.example.com”.
Insert the SIM in the NTC-100, power it on and connect the device to the network. The NTC-100 has
connected to the network when the Status LED displays solid green.
Check the current module version by sending the SMS command:
1234get version
Configure the HTTP/S server parameter on the NTC-100 by entering the following command:
1234set web_host=http://repository.example.com
OR
1234set web_host=https://repository.example.com
Wait for the acknowledgment message from the NTC-100.
Configure the HTTP/S path by entering the following command:
1234set web_path=firmware/
(Note: The folder should not be preceded by a /)
Wait for the acknowledgment message from the NTC-100.
Configure the file name by entering the following command:
1234set web_file=update.zip
Wait for the acknowledgment message from the NTC-100.
Configure the HTTP/S port by entering the following command:
1234set web_port=80 or 1234set web_port=443
Save the configured parameters by entering the command:
1234set execute save
Page 94
94 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Check the configured parameters by entering the following command:
1234get web_host, 1234get web_path, 1234get web_file, 1234get web_port
Initiate the module firmware upgrade by entering the following command:
1234set web_upload=2
Wait for around ten minutes. If the upgrade was successful, the NTC-100 replies with “ACK” power cycles itself. If the upgrade failed, the NTC-100 replies with “Error” and does not reboot.
When the NTC-100 has finished rebooting and connected to the network, confirm the new module firmware
with the SMS command:
1234get version
Page 95
95 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
NanoFit to DE-9 Serial/Power Adapter Cable
The following table displays the PIN out configuration for the 10-pin power/data connector of the NTC-100.
Figure 10 - NanoFit to DE-9 Serial/Power Adapter Cable
Note: The image above depicts the NanoFit connector as viewed from the pin side i.e. the side that connects to the NTC-100.
N AN O- FI T PI N
C OL OU R
DE- 9 PI N
D ES CR IP TI ON
1
Green
2
RXD
2
Blue
1
DCD
3
Yellow
7
RTS
4
Orange
9
RI 5 Black
5
GND
6
Brown
4
DTR
7
White
3
TXD
8
Purple
6
DSR
9
Grey
8
CTS
10
Red
-
Power in
Table 8 - NanoFit to DE-9 Serial/Power Connector Pin Outs
The NTC-100 is a DCE (Data Circuit-Terminating Environment), so the RTS (Ready To Send) signal is received by the NTC-100 and the CTS (Clear to Send) signal is transmitted with flow controlled from both ends.
The DCD (Data Carrier Detect) line is permanently set to one state, i.e. in the high state at the connector, GND at the chip.
Electrical Specifications
A suitable power supply is available on request or via direct purchase from the NetComm Online shop. It is recommended that the NTC-100 be powered using a 12VDC/1.5A power supply.
Page 96
96 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Environmental Specifications / Tolerances
The industrial enclosure of the NTC-100 makes it able to operate over a wide variety of temperatures from -40˚C ~ 85˚C.
Page 97
97 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Product Service and Support
The following section provides some assistance with issues that may be encountered when using the NTC-100 as well as providing web-based links for product specific information.
Troubleshooting
I am unable to send any AT commands to the NTC-100
Verify the NTC-100 is connected to both the power supply and an appropriate COM port.
Verify the LEDs on the front of the NTC-100 are illuminated.
Verify your terminal program settings or device is set to use the appropriate COM port.
Power cycle the NTC-100 by removing the power supply for 15 seconds and then reconnect it.
I only receive garbage text when sending AT commands to the NTC-100
Verify that the COM port parameters have not changed since the NTC-100 was initially connected.
Garbage text usually indicates that the port speed has been changed.
Note – Please refer to the AT Command reference document for more information on enabling remote access to the NTC-100.
The NTC-100 LEDs are not lighting up
Verify that the NTC-100 is connected to an appropriate power supply and that an active SIM has been
inserted.
Power cycle the NTC-100 by removing the power supply for 15 seconds and then reconnect it.
The LED is not turning on
Verify that the NTC-100 has sufficient signal strength to connect by checking the available signal
strength via the appropriate AT command.
Note – Please refer to the AT Command reference document for more information on signal strength.
I am receiving an ‘ERROR’ response from the NTC-100
Verify the AT command you are utilising has the correct syntax specified.
I am receiving an ‘ERROR (##)’ response from the NTC-100 with an error code that I don’t understand
Please refer to the error codes in the AT Command manual which can be found on the Quectel
website to learn the meaning of the Result codes.
If you are still experiencing issues after performing the above checks, please contact NetComm Technical Support by going to: http://support.netcommwireless.com/
Page 98
98 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
FAQs
Q: Is the NTC-100 a serial modem?
A: The NTC-100 is able to operate as a serial modem, however it is also so much more. It is also able to perform the following functions:
Creating a TCP server
Creating UDP sockets / TCP clients and a TCP server
Creating a PING session
Creating an FTP session (upload and download files)
Connect to a remote HTTP server
Q: What are the port settings required for the NTC-100?
A: The NTC-100 uses auto-bauding to determine the current communication port settings. This occurs when the first A or AT is sent to the NTC-100. Generally, a port speed of 115200, 8 data bits, 1 stop bit, no parity and hardware flow control should be fine. Garbage text usually indicates that the port speed has been changed.
Q: Does the NTC-100 support circuit and packet switched data?
A: The modem inside the NTC-100 supports packet switched and circuit switched communications methods.
Q: Can the micro USB port be used to connect to legacy devices?
A: No. The micro USB port requires Windows XP, Windows Vista, Windows 7, Windows 8 or Windows 10 operating systems.
Q: Why can’t I configure customized AT commands from the USB AT interface?
A: The USB AT interface talks directly to the module and has access only to module AT commands. Customized
Application AT commands can be accessed only via the serial port.
Page 99
99 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Appendix A: Tables
Table 1 - LED indicators .................................................................................................................................................... 13
Table 2 - Signal strength ................................................................................................................................................... 13
Table 3 – NTC-100 Dimensions......................................................................................................................................... 14
Table 4 - Interfaces ............................................................................................................................................................ 15
Table 5 – Serial Options .................................................................................................................................................... 21
Table 6 - NTC-100 modes ................................................................................................................................................. 22
Table 7 - NTC-100 PAD modes ......................................................................................................................................... 23
Table 8 - NanoFit to DE-9 Serial/Power Connector Pin Outs ......................................................................................... 95
Page 100
100 of 103
UG01037 v1.1 25 September 2018
© NetComm 2018
Safety and product care
Electrical safety
Accessories
Only use approved accessories.
Do not connect with incompatible products or accessories.
Connection to a car
Seek professional advice when connecting a device interface to the vehicle electrical system.
Distraction
Operating machinery
Full attention must be given to operating the machinery in order to reduce the risk of an accident.
Product handling
You alone are responsible for how you use your device and any consequences of its use.
You must always switch off your device wherever the use of a mobile phone is prohibited. Do not use the device without the clip-on covers attached, and do not remove or change the covers while using the device. Use of your device is subject to safety measures designed to protect users and their environment.
Always treat your device and its accessories with care and keep it in a clean and dust-free place.
Do not expose your device or its accessories to open flames or lit tobacco products.
Do not expose your device or its accessories to liquid, moisture or high humidity.
Do not drop, throw or try to bend your device or its accessories.
Do not use harsh chemicals, cleaning solvents, or aerosols to clean the device or its accessories.
Do not paint your device or its accessories.
Do not attempt to disassemble your device or its accessories, only authorised personnel must do so.
Do not use or install this product in extremely hot or cold areas. Ensure that the device is installed in an area where the temperature is within the supported operating temperature range (-40°C to 85°C)
Do not use your device in an enclosed environment or where heat dissipation is poor. Prolonged use in such space may cause excessive heat and raise ambient temperature, which will lead to automatic shutdown of your device or the disconnection of the mobile network connection for your safety. To use your device normally again after such shutdown, cool it in a well-ventilated place before turning it on.
Please check local regulations for disposal of electronic products.
Do not operate the device where ventilation is restricted
Loading...