Quectel BG95 Series Installation and operating instructions

BG95&BG77&BG600L Series
TCP/IP Application Note
LPWA Module Series
Version: 1.1
Date: 2021-03-29
Status: Released

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 1 / 56
Our aim is to provide customers with timely and comprehensive service. For any assistance,
please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
Building 5, Shanghai Business Park Phase III (Area B), No.1016 Tianlin Road, Minhang District, Shanghai
200233, China
Tel: [phone]
Email: [email protected]om
Or our local office. For more information, please visit:
http://www.quectel.com/support/sales.htm.
For technical support, or to report documentation errors, please visit:
http://www.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.
Disclaimer
While Quectel has made efforts to ensure that the functions and features under development are free
from errors, it is possible that these functions and features could contain errors, inaccuracies and
omissions. Unless otherwise provided by valid agreement, Quectel makes no warranties of any kind,
implied or express, with respect to the use of features and functions under development. To the maximum
extent permitted by law, Quectel excludes all liability for any loss or damage suffered in connection with
the use of the functions and features under development, regardless of whether such loss or damage
may have been foreseeable.
Duty of Confidentiality
The Receiving Party shall keep confidential all documentation and information provided by Quectel,
except when the specific permission has been granted by Quectel. The Receiving Party shall not access
or use Quectel’s documentation and information for any purpose except as expressly provided herein.
Furthermore, the Receiving Party shall not disclose any of the Quectel's documentation and information
to any third party without the prior written consent by Quectel. For any noncompliance to the above
requirements, unauthorized use, or other illegal or malicious use of the documentation and information,
Quectel will reserve the right to take legal action.

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 2 / 56
Copyright
The information contained here is proprietary technical information of Quectel. Transmitting, reproducing,
disseminating and editing this document as well as using the content without permission are forbidden.
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. 2021. All rights reserved.

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 3 / 56
About the Document
Revision History
Version
Date
Author
Description
1.0
2019-08-12
Terrence YANG
Initial
1.1
2021-03-29
Terrence YANG/
Sherlock ZHAO
1. Added an applicable module BG600L-M3.
2. Updated the valid value range of <timeout> in
AT+QICLOSE from 1–65535 to 0–65535 (Chapter
2.3.5).
3. Added <RAI_info> for AT+QISENDEX to configure
RAI (Chapter 2.3.9).
4. Changed the default value of <max_backoffs> of
AT+QICFG="tcp/retranscfg" from 8 to 12 (Chapter
2.3.15).
5. Added AT+QICFG="sack" and AT+QICFG="tcp/ke
epalive" commands (Chapter 2.3.15).
6. Added some examples about TCP/UDP operations
under IPv6 (Chapter 3.3, 3.7 and 3.9) and an
example about UDP client with RAI feature (Chapter
3.10).

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 4 / 56
Contents
About the Document...................................................................................................................................3
Contents.......................................................................................................................................................4
Table Index...................................................................................................................................................7
1Introduction..........................................................................................................................................8
1.1. Applicable Modules......................................................................................................................8
1.2. Usage of TCP/IPAT Commands .................................................................................................9
1.3. Description of Data Access Modes............................................................................................11
2TCP/IP AT Commands.......................................................................................................................13
2.1. AT Command Introduction.........................................................................................................13
2.1.1. Definitions.......................................................................................................................13
2.1.1. AT Command Syntax.....................................................................................................13
2.2. Declaration ofAT Command Examples.....................................................................................14
2.3. Description of TCP/IPAT Commands........................................................................................14
2.3.1. AT+QICSGP Configure Parameters of a TCP/IP Context ..........................................14
2.3.2. AT+QIACT Activate a PDP Context............................................................................15
2.3.3. AT+QIDEACT Deactivate a PDP Context...................................................................16
2.3.4. AT+QIOPEN Open a Socket Service..........................................................................17
2.3.5. AT+QICLOSE Close a Socket Service........................................................................19
2.3.6. AT+QISTATE Query Socket Service Status................................................................20
2.3.7. AT+QISEND Send Data..............................................................................................22
2.3.8. AT+QIRD Retrieve the Received TCP/IP Data...........................................................24
2.3.9. AT+QISENDEX Send Hex String Data .......................................................................25
2.3.10. AT+QISWTMD Switch Data Access Mode ..........................................................26
2.3.11. AT+QPING Ping a Remote Host.................................................................................27
2.3.12. AT+QNTP Synchronize Local Time with NTP Server..........................................29
2.3.13. AT+QIDNSCFG Configure Address of DNS Server ............................................30
2.3.14. AT+QIDNSGIP Get IPAddress by Domain Name...............................................30
2.3.15. AT+QICFG Configure Optional Parameters ........................................................31
2.3.16. AT+QISDE Control Whether to Echo the Data for AT+QISEND .........................35
2.3.17. AT+QIGETERROR Query the Last Error Code...................................................35
2.4. Description of URCs ..................................................................................................................36
2.4.1. +QIURC: "closed" Indicate Connection Closed..........................................................36
2.4.2. +QIURC: "recv" Indicate Incoming Data.....................................................................37
2.4.3. +QIURC: "incoming full" Indicate Incoming Connection Reaches the Limit...............37
2.4.4. +QIURC: "incoming" Indicate Incoming Connection...................................................37
2.4.5. +QIURC: "pdpdeact" Indicate PDP Deactivation........................................................38
3Examples ............................................................................................................................................39
3.1. Configure and Activate a Context..............................................................................................39
3.1.1. Configure a Context.......................................................................................................39
3.1.2. Activate a Context..........................................................................................................39

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 5 / 56
3.1.3. Deactivate a Context......................................................................................................39
3.2. TCP Client Works in Buffer Access Mode under IPv4...............................................................39
3.2.1. Set up a TCP Client Connection and Enter BufferAccess Mode..................................39
3.2.2. Send Data in BufferAccess Mode.................................................................................40
3.2.3. Retrieve Data from Remote Server in Buffer Access Mode..........................................40
3.2.4. Close a Connection........................................................................................................41
3.3. TCP Client Works in BufferAccess Mode under IPv6...............................................................41
3.3.1. Set up a TCP Client Connection and Enter BufferAccess Mode..................................41
3.3.2. Send Data in BufferAccess Mode.................................................................................41
3.3.3. Receive Data from Remote Server in BufferAccess Mode...........................................42
3.3.4. Close a Connection........................................................................................................42
3.4. TCP Client Works in Transparent Transmission Mode..............................................................43
3.4.1. Set up a TCP Client Connection and Enter Transparent Transmission Mode..............43
3.4.2. Send Data in Transparent Transmission Mode .............................................................43
3.4.3. Retrieve Data from Remote Server in Transparent Transmission Mode.......................43
3.4.4. Close a TCP Client.........................................................................................................43
3.5. TCP Client Works in Direct Push Mode.....................................................................................43
3.5.1. Set up a TCP Client Connection and Enter Direct Push Mode.....................................43
3.5.2. Send Data in Direct Push Mode.....................................................................................44
3.5.3. Retrieve Data from Remote Server in Direct Push Mode..............................................44
3.5.4. Close a TCP Client.........................................................................................................44
3.6. TCP Server Works in BufferAccess Mode under IPv4 Network...............................................45
3.6.1. Start a TCP Server.........................................................................................................45
3.6.2. Accept TCP Incoming Connection.................................................................................45
3.6.3. Retrieve Data from Incoming Connection......................................................................45
3.6.4. Close a TCP Server .......................................................................................................46
3.7. TCP Server Works in BufferAccess Mode under IPv6 Network...............................................46
3.7.1. Start a TCP Server.........................................................................................................46
3.7.2. Accept TCP Incoming Connection.................................................................................46
3.7.3. Retrieve Data from Incoming Connection......................................................................46
3.7.4. Switch Incoming Connection to Transparent Transmission Mode ................................47
3.7.5. Close a TCP Server .......................................................................................................47
3.8. UDP Service under IPv4 Network..............................................................................................47
3.8.1. Start a UDP Service.......................................................................................................47
3.8.2. Send UDP Data to Remote Client..................................................................................48
3.8.3. Retrieve Data from Remote Client.................................................................................48
3.8.4. Close a UDP Service .....................................................................................................48
3.9. UDP Service under IPv6 Network..............................................................................................48
3.9.1. Start a UDP Service.......................................................................................................48
3.9.2. Send UDP Data to Remote Client..................................................................................49
3.9.3. Receive Data from Remote Client.................................................................................49
3.10. UDP Client with RAI Feature .....................................................................................................49
3.10.1. Start a UDP Client...................................................................................................49
3.10.2. Send UDP Data with RAI Information.....................................................................50

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 6 / 56
3.10.3. Close a UDP Client.................................................................................................50
3.11. PING...........................................................................................................................................51
3.12. Synchronize Local Time.............................................................................................................51
3.13. Getting the Last Error Code.......................................................................................................52
4Summary of Result Codes................................................................................................................53
5Appendix A References.....................................................................................................................55

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 7 / 56
Table Index
Table 1:Applicable Modules......................................................................................................................... 8
Table 2: Types of AT Commands ...............................................................................................................13
Table 3: Summary of Result Codes ........................................................................................................... 53
Table 4: Related Document........................................................................................................................55
Table 5: Terms and Abbreviations..............................................................................................................55

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 8 / 56
1Introduction
Quectel BG95 series, BG77 and BG600L-M3 modules feature an embedded TCP/IP stack, which
enables the host to access the Internet directly via AT commands. This greatly reduces the dependence
on external PPP and TCP/IP protocol stacks and thus minimizes the cost.
BG95 series, BG77 and BG600L-M3 modules provide the following socket services:
TCP client
UDP client
TCP server
UDP server
1.1. Applicable Modules
Table 1: Applicable Modules
Module Series
Model
Description
BG95
BG95-M1
Cat M1 only
BG95-M2
Cat M1/Cat NB2
BG95-M3
Cat M1/Cat NB2/EGPRS
BG95-M4
Cat M1/Cat NB2, 450 MHz Supported
BG95-M5
Cat M1/Cat NB2/EGPRS, Power Class 3
BG95-M6
Cat M1/Cat NB2, Power Class 3
BG95-MF
Cat M1/Cat NB2, Wi-Fi Positioning
BG77
BG77
Cat M1/Cat NB2
BG600L
BG600L-M3
Cat M1/Cat NB2/EGPRS

LPWA Module Series
BG95&BG77&BG600L Series TCP/IP Application Note
BG95&BG77&BG600L_Series_TCP/IP_Application_Note 9 / 56
See the firmware release notes of corresponding module models to check whether the function has been
supported.
1.2. Usage of TCP/IP AT Commands
Through TCP/IP AT commands, the host can configure a PDP context, activate/deactivate the PDP
context, open/close a socket service and send/retrieve data via the socket service. The following
illustrates how to use TCP/IP AT commands.
NOTE