Quectel BG96 Installation manual

BG96 NIDD
AT Commands Manual
LTE Module Series
Rev. BG96_NIDD_AT_Commands_Manual_V1.0
Date: 2018-05-25
Status: Released
www.quectel.com

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 1 / 13
Our aim is to provide customers with timely and comprehensive service. For any
assistance, please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
7th Floor, Hongye Building, No.1801 Hongmei Road, Xuhui District, Shanghai 200233, China
Tel: [phone]
Email: [email protected]om
Or our local office. For more information, please visit:
http://quectel.com/support/sales.htm
For technical support, or to report documentation errors, please visit:
http://quectel.com/support/technical.htm
Or email to: [e-mail]
GENERAL NOTES
QUECTEL OFFERS THE INFORMATION AS A SERVICE TO ITS CUSTOMERS. THE INFORMATION
PROVIDED IS BASED UPON CUSTOMERS’ REQUIREMENTS. QUECTEL MAKES EVERY EFFORT
TO ENSURE THE QUALITY OF THE INFORMATION IT MAKES AVAILABLE. QUECTEL DOES NOT
MAKE ANY WARRANTY AS TO THE INFORMATION CONTAINED HEREIN, AND DOES NOT ACCEPT
ANY LIABILITY FOR ANY INJURY, LOSS OR DAMAGE OF ANY KIND INCURRED BY USE OF OR
RELIANCE UPON THE INFORMATION. ALL INFORMATION SUPPLIED HEREIN IS SUBJECT TO
CHANGE WITHOUT PRIOR NOTICE.
COPYRIGHT
THE INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF
QUECTEL WIRELESS SOLUTIONS CO., LTD. TRANSMITTING, REPRODUCTION, DISSEMINATION
AND EDITING OF THIS DOCUMENT AS WELL AS UTILIZATION OF THE CONTENT ARE
FORBIDDEN WITHOUT PERMISSION. OFFENDERS WILL BE HELD LIABLE FOR PAYMENT OF
DAMAGES. ALL RIGHTS ARE RESERVED IN THE EVENT OF A PATENT GRANT OR
REGISTRATION OF A UTILITY MODEL OR DESIGN.
Copyright © Quectel Wireless Solutions Co., Ltd. 2018. All rights reserved.

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 2 / 13
About the Document
History
Revision
Date
Author
Description
1.0
2018-05-25
Lane HAO
Initial

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 3 / 13
Contents
About the Document.................................................................................................................................. 2
Contents...................................................................................................................................................... 3
Table Index.................................................................................................................................................. 4
1Introduction......................................................................................................................................... 5
2Description of AT Commands........................................................................................................... 6
2.1. Description of NIDD Related AT Commands............................................................................. 6
2.1.1. AT+QCFGEXT="pdp_type" Modify the Parameters of Specified PDP Context........... 6
2.1.2. AT+QCFGEXT="nipdcfg" Configure Parameters for NIDD Connection...................... 7
2.1.3. AT+QCFGEXT="nipd" Open or Close the NIDD Connection...................................... 7
2.1.4. AT+QCFGEXT="nipds" Send MO Non-IP Data........................................................... 8
2.1.5. AT+QCFGEXT="nipdr" Retrieve MT Non-IP Data....................................................... 9
2.2. Description of NIDD Related URCs......................................................................................... 10
2.2.1. URC of Incoming Data.................................................................................................. 10
2.2.2. URC of Connection Closed........................................................................................... 10
2.3. Example of NIDD Related Configurations............................................................................... 10
3Summary of <err> Codes................................................................................................................. 12
4Appendix A References.................................................................................................................... 13

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 4 / 13
Table Index
TABLE 1: SUMMARY OF <ERR> CODE.......................................................................................................... 12
TABLE 2: RELATED DOCUMENTS.................................................................................................................. 13
TABLE 3: TERMS AND ABBREVIATIONS........................................................................................................ 13

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 5 / 13
1Introduction
The support for NIDD (Non-IP Data Delivery) is introduced from 3GPP Rel. 13 and later releases.
Functions for NIDD may be used to handle MO and MT communication with UE, where the data used for
the communication is considered unstructured from the EPS standpoint (which we refer to also as
Non-IP). NIDD is only applicable for LTE Cat NB1 RAT. Non-IP data calls are supported for both tethered
and embedded use cases.
This document mainly introduces how to use the NIDD function of Quectel BG96 module through AT
commands.

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 6 / 13
2Description of AT Commands
2.1. Description of NIDD Related AT Commands
2.1.1. AT+QCFGEXT="pdp_type" Modify the Parameters of Specified PDP Context
Parameter
AT+QCFGEXT="pdp_type" Modify the Parameters of Specified PDP Context
Write Command
Query the current configuration:
AT+QCFGEXT="pdp_type"
Response
+QCFGEXT: "pdp_type",<cid>,<type>,<apn>
OK
Write Command
Configure the parameters of a specified
PDP context:
AT+QCFGEXT="pdp_type",<cid>,<typ
e>[,<apn>[,<username>,<password>]
]
Response
OK
<cid> Integer type. PDP context identifier. A numeric parameter which specifies a particular
PDP context definition (see AT+CGDCONT command in Quectel_BG96_AT_
Commands_Manual for more details). It is currently only valid for <cid> is 1.
<type> String type. Packet data protocol type.
“IP”
“PPP”
“IPV6”
“IPV4V6”
“Non-IP”
<apn> String type.Access point name.
<username> String type. User name of the selectedAPN.
<password> String type. Password of the selectedAPN.

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 7 / 13
The command will take effect after reboot, or by executing AT+CFUN=0 and AT+CFUN=1 consecutively.
2.1.2. AT+QCFGEXT="nipdcfg" Configure Parameters for NIDD Connection
Parameter
2.1.3. AT+QCFGEXT="nipd" Open or Close the NIDD Connection
AT+QCFGEXT="nipdcfg" Configure Parameters for NIDD Connection
Write Command
Query the current configuration for NIDD
connection:
AT+QCFGEXT="nipdcfg"
Response
+QCFGEXT: "nipdcfg",<type>,<apn>
OK
Write Command
Configure the parameters for NIDD
connection:
AT+QCFGEXT="nipdcfg",<type>[,<ap
n>[,<username>,<password>]]
Response
OK
<type> Non-IP outgoing data type.
0 MO Non-IP data type
1 MO Exception Non-IP data type
<apn> String type. Access point name.
<username> String type. User name of the selected APN.
<password> String type. Password of the selectedAPN.
AT+QCFGEXT="nipd" Open or Close the NIDD Connection
Write Command
Configure to open or close the NIDD
connection:
AT+QCFGEXT="nipd",<mode>[,<time
out>]
Response
OK
If <mode> is 1, the following URC is reported after the OK
response:
+QIND: "nipd","open",<err>
If there is an error related to ME functionality, response:
+CME ERROR: <err>
NOTE

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 8 / 13
Parameter
1. NV 73916 should be set as 277 to enable NIDD function.
2. Non-IP data calls are supported forAP embedded and tethered RmNet calls only.
3. Non-IP data calls are not supported for modem embedded calls.
2.1.4. AT+QCFGEXT="nipds" Send MO Non-IP Data
Parameter
If there is any other error, response:
ERROR
<mode> Integer type.
0 Close the NIDD connection.
1 Open the NIDD connection.
<timeout> Integer type. The range is 30-90 and the default value is 30. Unit: second.
<err> Integer type. The error code of the operation. Please refer to Chapter 3 for details.
AT+QCFGEXT="nipds" Send MO Non-IP Data
Write Command
Configure the MO Non-IP data to be
sent:
AT+QCFGEXT="nipds",<mode>,<data
>[,<data_length>]
Response
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
If there is any other error, response:
ERROR
<mode> Integer type. Data format.
0 ASCII format string.
1 HEX format string.
<data> String type. The data to be sent.
<data_length> Integer type. The data length to be sent. The range is 1-100. Unit: byte.
<err> Integer type. The error code of the operation. Please refer to Chapter 3 for details.
NOTES

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 9 / 13
2.1.5. AT+QCFGEXT="nipdr" Retrieve MT Non-IP Data
Parameter
AT+QCFGEXT="nipdr" Retrieve MT Non-IP Data
Write Command
AT+QCFGEXT="nipdr"[,<read_length
>]
Response
If the connection has received data, response:
+QCFGEXT: "nipdr",<read_actual_length>,<data>
OK
If there is no data that can be retrieved, response:
+QCFGEXT: "nipdr",0
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
If there is any other error, response:
ERROR
Write Command
When <read_length> is 0, query the
retrieved data:
AT+QCFGEXT="nipdr",0
Response
If the connection has existed, response:
+QCFGEXT:
"nipdr",<total_receive_length>,<have_read_length>,<unr
ead_length>
OK
If there is an error related to ME functionality, response:
+CME ERROR: <err>
If there is any other error, response:
ERROR
<read_length> Integer type. The data length to be retrieved. Unit: byte.
<read_actual_length> The actual length of retrieved data. Unit: byte.
<data> String type. Retrieved data.
<total_receive_length> The total length of received data. Unit: byte.
<have_read_length> The length of read data. Unit: byte.
<unread_length> The length of unread data. Unit: byte.
<err> Integer type. The error code of the operation. Please refer to Chapter 3 for

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 10 / 13
2.2. Description of NIDD Related URCs
2.2.1. URC of Incoming Data
After receiving MT Non-IP data, the module will report URC as +QIND: "nipd","recv" to notify the host.
Then host can retrieve data via AT+QCFGEXT="nipdr". Please note that if the buffer is not empty, and
the module receives data again, it will not report a new URC until all the received data has been retrieved
via AT+QCFGEXT="nipdr" from buffer. The size of the buffer is 2048 bytes. If the data received exceeds
the buffer size, the subsequent data will be discarded.
2.2.2. URC of Connection Closed
2.3. Example of NIDD Related Configurations
AT+QCFGEXT="pdp_type",1,"Non-IP","cmcc" //Modify the parameters of the first PDP context.
OK
AT+CFUN=0
OK
AT+CFUN=1
OK
AT+CEREG?
+CEREG: 0,1
OK
AT+QCFGEXT="nipdcfg",0,"cmcc" //Set the Non-IP data type and APN.
details.
URC of Incoming Data
URC Format
+QIND: "nipd","recv"
Description
URC to notify the host incoming data from network. Then the
host can retrieve the data through AT+QCFGEXT="nipdr".
URC of Connection Closed
URC Format
+QIND: "nipd","close"
Description
URC to notify that the connection has been accidentally
closed. If the connection is closed via the
AT+QCFGEXT="nipd",0, this URC will be not reported.

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 11 / 13
OK
AT+QCFGEXT="nipdcfg"
+QCFGEXT: "nipdcfg",0,"cmcc"
OK
AT+QCFGEXT="nipd",1,30 //Open NIDD connection.
OK
+QIND: "nipd","open",0
AT+QCFGEXT="nipds",0,"quectel",7 //Send the string “quectel” in ASCII format via NIDD
connection.
OK
AT+QCFGEXT="nipds",1,"6162636465",10 //Send the string “abcde” in hex format via NIDD
connection.
OK
//When there is any incoming data from the network, the following URC will be reported.
+QIND: "nipd","recv"
AT+QCFGEXT="nipdr",0 //Query the received data length.
+QCFGEXT: "nipdr",10,0,10 //There are 10 bytes data that have been received.
OK
AT+QCFGEXT="nipdr",10 //Read 10 bytes of the incoming data.
+QCFGEXT: "nipdr",10,"0123456789"
OK
AT+QCFGEXT="nipdr",0 //Query the received data length.
+QCFGEXT: "nipdr",10,10,0
OK
AT+QCFGEXT="nipd",0 //Close the NIDD connection.
OK

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 12 / 13
3Summary of <err> Codes
The error code <err> indicates an error related to mobile equipment or network. The details about <err>
are described in the following table.
Table 1: Summary of <err> Code
<err>
Meaning
0
Operation successful
651
Invalid input value
652
Send error
653
Network error
654
NIDD Busy
655
Timeout error
656
Connection not open
657
Connection already opened
658
Connection accidentally closed

LTE Module Series
BG96 NIDD Commands Manual
BG96_NIDD_AT_Commands_Manual 13 / 13
4Appendix A References
Table 2: Related Documents
Table 3: Terms and Abbreviations
SN
Document Name
Remark
[1]
Quectel_BG96_AT_Commands_Manual
BG96AT Commands Manual
Abbreviation
Description
AP
Application Processor
EPS
Evolved Packet System
ME
Mobile Equipment
MO
Mobile Originated
MT
Mobile Terminated
NIDD
Non-IP Data Delivery
NV
Non-volatile
UE
User Equipment