Quectel EG800Q LTE Standard Module User Guide

Contact Information:
If you need assistance, please contact Quectel Wireless Solutions Co., Ltd. at the following address:
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: +86 21 5108 6236

Email: info@quectel.com

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 support@quectel.com.

Legal Notices
We offer information as a service to you. The provided information is based on your requirements and we make every effort to ensure its quality. You agree that you are responsible for using independent analysis and evaluation in designing intended products, and we provide reference designs for illustrative purposes only. Before using any hardware, software or service guided by this document, please read this notice carefully. Even though we employ commercially reasonable efforts to provide the best possible experience, you hereby acknowledge and agree that this document and related services hereunder are provided to you on an “as available” basis. We may revise or restate this document from time to time at our sole discretion without any prior notice to you.

Use and Disclosure Restrictions

License Agreements
Documents and information provided by us shall be kept confidential, unless specific permission is granted. They shall not be accessed or used for any purpose except as expressly provided herein.

Copyright
Our and third-party products hereunder may contain copyrighted material. Such copyrighted material shall not be copied, reproduced, distributed, merged, published, translated, or modified without prior written consent. We and the third party have exclusive rights over copyrighted material. No license shall be granted or conveyed under any patents, copyrights, trademarks, or service mark rights. To avoid ambiguities, purchasing in any form cannot be deemed as granting a license other than the normal non-exclusive, royalty-free license to use the material. We reserve the right to take legal action for noncompliance with abovementioned requirements, unauthorized use, or other illegal or malicious use of the material.

Trademarks
Except as otherwise set forth herein, nothing in this document shall be construed as conferring any rights to use any trademark, trade name or name, abbreviation, or counterfeit product thereof owned by Quectel or any third party in advertising, publicity, or other aspects.

Third-Party Rights
This document may refer to hardware, software and/or documentation owned by one or more third parties (“third-party materials”). Use of such third-party materials shall be governed by all restrictions and obligations applicable thereto. We make no warranty or representation, either express or implied, regarding the third-party materials, including but not limited to any implied or statutory, warranties of merchantability or fitness for a particular purpose, quiet enjoyment, system integration, information accuracy, and non-infringement of any third-party intellectual property rights with regard to the licensed technology or use thereof. Nothing herein constitutes a representation or warranty by us to either develop, enhance, modify, distribute, market, sell, offer for sale, or otherwise maintain production of any our products or any other hardware, software, device, tool, information, or product. We moreover disclaim any and all warranties arising from the course of dealing or usage of trade.

Privacy Policy
To implement module functionality, certain device data are uploaded to Quectel’s or third-party’s servers, including carriers, chipset suppliers or customer-designated servers. Quectel, strictly abiding by the relevant laws and regulations, shall retain, use, disclose or otherwise process relevant data for the purpose of performing the service only or as permitted by applicable laws. Before data interaction with third parties, please be informed of their privacy and data security policy.

Disclaimer

We acknowledge no liability for any injury or damage arising from the reliance upon the information.
We shall bear no liability resulting from any inaccuracies or omissions, or from the use of the information contained herein.

While we have made every effort to ensure that the functions and features under development are free from errors, it is possible that they could contain errors, inaccuracies, and omissions. Unless otherwise provided by valid agreement, we make no warranties of any kind, either implied or express, and exclude all liability for any loss or damage suffered in connection with the use of features and functions under development, to the maximum extent permitted by law, regardless of whether such loss or damage may have been foreseeable.
We are not responsible for the accessibility, safety, accuracy, availability, legality, or completeness of information, advertising, commercial offers, products, services, and materials on third-party websites and third-party resources.

About the Document

Revision History

Introduction

Quectel LTE Standard EG800Q series and EG91xQ family (EG915Q series and EG916Q-GL) modules support DFOTA (Delta Firmware Over-The-Air) function to realize the upgrade or degrade of the firmware version of the module.

DFOTA Implementation and User Responsibility
Quectel follows industry best practices with regard to firmware updates for its modules by enabling users to offer DFOTA updates. Please note that Quectel does not have the ability to unilaterally push updates to users’ devices. Quectel hands full control over the DFOTA process to users. In the process, Quectel solely provides the updated firmware but cannot initiate DFOTA updates on users’ devices. Users can determine when to push the update to the Quectel modules using the DFOTA mechanism by configuring corresponding parameters for the update that the users host on their own infrastructures.

Firmware Upgrade via DFOTA

The following chart illustrates the procedures of firmware upgrade through DFOTA.

User Side

Figure 1: Firmware Upgrade via DFOTA
As shown in the above figure, the following steps need to be performed to upgrade the firmware:

Step 1: Get the delta firmware package from Quectel Technical Support (See Chapter 2.1 for details).
Step 2: Upload the delta firmware package to your FTP/HTTP(S) server or host (See Chapter 2.2 for details).
Step 3: Execute AT+QFOTADL on the host to trigger automatic firmware upgrade on the module (see Chapter 2.3 for details).
Step 4: The module automatically downloads the delta firmware package from your FTP/HTTP(S) server via LTE network or gets delta firmware package from your host.
Step 5: The module internally runs the updating program to automatically upgrade the module firmware.

NOTE

During the upgrading process, please make sure that the module is powered up, otherwise, the DFOTA upgrade may fail and cannot be restored.
You are responsible for providing and managing the FTP/HTTP(S) server for the firmware upgrade. Quectel does not supply the server or assist with its setup.

Get Delta Firmware Package
Before firmware upgrading, check the original firmware version name with ATI and confirm the target firmware version, and then send the two firmware versions to Quectel Technical Support to obtain the corresponding delta firmware package.

NOTE
There are two types of delta firmware packages, one is a .par file to upgrade only the firmware version; the other is a .bin file to upgrade a tool for upgrading firmware (updater) and the firmware version at the same time. You can choose the delta package as needed.

Upload Delta Firmware Package to FTP/HTTP(S) Server or Host

When the delta package is stored on the FTP/HTTP(S) server:

Step 1: Please set up an FTP/HTTP(S) server before using the DFOTA function (Quectel does not provide such servers).
Step 2: After completing the server setup, upload the delta firmware package to your server, and save the storage path.

You can also store the delta package on your host directly after getting it.

Execute AT Command to Upgrade the Firmware
After uploading the delta firmware package to the FTP/HTTP(S) server or your host, execute AT+QFOTADL on the host, and then the module will download the delta firmware package from the FTP/HTTP(S) server over the air or gets the delta firmware package from your host and upgrade the firmware automatically. For more details about the DFOTA AT commands, see Chapter 3.3.

Description of DFOTA AT Commands

AT Command Introduction

Definitions

<CR> Carriage return character.
<LF> Line feed character.

<…> Parameter name. Angle brackets do not appear on command line.
[…] Optional parameter of a command or an optional part of TA information response. Square brackets do not appear on command line. When an optional parameter is not given in a command, the new value equals its previous value or the default settings, unless otherwise specified.
Underline Default setting of a parameter.

AT Command Syntax
All command lines must start with AT or at and end with <CR>. Information responses and result codes always start and end with a carriage return character and a line feed character: <CR><LF><response><CR><LF>. In tables presenting commands and responses throughout this document, only the commands and responses are presented, and <CR> and <LF> are deliberately omitted.

Table 1: Types of AT Commands

Declaration of AT Command Examples
The AT command examples in this document are provided to help you learn about the use of AT commands introduced herein. The examples, however, should not be taken as Quectel’s recommendation or suggestions about how to design a program flow or what status to set the module into. Sometimes multiple examples may be provided for one AT command. However, this does not mean that there exists a correlation among these examples and that they should be executed in a given sequence. The URLs, domain names, IP addresses, usernames/accounts, and passwords (if any) in the AT command examples are provided for illustrative and explanatory purposes only, and they should be modified to reflect your actual usage and specific needs.

AT Commands Description

AT+QFOTADL Upgrade Firmware via DFOTA
AT+QFOTADL enables automatic firmware upgrade for modules via DFOTA. See Chapter 3.3.1.1 to Chapter 3.3.1.3 for details. If the delta package is stored on the FTP/HTTP(S) server, after executing the corresponding command, the module will automatically download the package from FTP/HTTP(S) server. When the package is downloaded successfully, the module will automatically upgrade the firmware; After the firmware is successfully upgraded, the module automatically reboots. If the delta package is stored on your host, after executing the corresponding command, the module receives the package from your host through the main serial port or USB AT port, and then automatically upgrades the firmware.

Parameter

AT+QFOTADL=<FTP_URL> Upgrade Firmware over FTP Server
When the delta package is stored on the FTP server, execute AT+QFOTADL=<FTP_URL> to initiate automatic firmware upgrade for modules via DFOTA. After executing this command, the module will automatically download the package from FTP server and then upgrade the firmware.

AT+QFOTADL=<FTP_URL> Upgrade Firmware over FTP Server
Write Command If you only upgrade the firmware version (the delta package is a .par file.): AT+QFOTADL=<FTP_URL>[,<upgrade_mode>[,<download_URC_max>[,<up date_URC_max>]]]	Response OK+QIND: “FOTA”,”FTPSTART”[+QIND: “FOTA”,”DOWNLOADING”,<percent>+QIND: “FOTA”,”DOWNLOADING”,<percent>…]+QIND: “FOTA”,”FTPEND”,<FTP_err>+QIND: “FOTA”,”START”[+QIND: “FOTA”,”UPDATING”,<percent>+QIND: “FOTA”,”UPDATING”,<percent>…]+QIND: “FOTA”,”END”,<err>
	If there is any error: ERROR
Write Command If you upgrade the firmware version and	Response OK

the updater tool at the same time (the delta package is a .bin file): AT+QFOTADL=<FTP_URL>[,<upgrade_mode>[,<download_URC_max>[,<up date_URC_max>]]]	+QIND: “FOTA”,”FTPSTART”[+QIND: “FOTA”,”DOWNLOADING”,<percent>+QIND: “FOTA”,”DOWNLOADING”,<percent>…]+QIND: “FOTA”,”FTPEND”,<FTP_err>+QIND: “FOTA”,”UPDATERSTART”+QIND: “FOTA”,”UPDATEREND”,<updater_err>+QIND: “FOTA”,”START”[+QIND: “FOTA”,”UPDATING”,<percent>+QIND: “FOTA”,”UPDATING”,<percent>…]+QIND: “FOTA”,”END”,<err>
	If there is any error: ERROR
Maximum Response Time	180 s
Characteristics	–

Parameter

Example

//Upgrade the firmware when delta firmware package is stored on your FTP server.
“FTP://test:test@192.0.2.2:21/EG800Q_FOTA_PACKAGE.par” is used as an example URL below. (The URL is provided for illustrative purpose only. Please replace it with a valid URL that corresponds to your FTP server and firmware package.)
//Configure the PDP context. In this example, the PDP context ID is 2. For more details, refer to the document [1].
AT+QICSGP=2,1,”broadband”,””,””,1 //Set the PDP context ID to 2, the APN to “broadband” (representing AT&T), the username and password to be empty, and the authentication type to PAP.
OK
AT+QIACT=2 //Activate the PDP context.
OK
//Execute AT+QFOTADL to initiate automatic firmware upgrade via DFOTA, and then the module will start to download the delta package and upgrade the firmware automatically.
AT+QFOTADL=”FTP://test:test@192.0.2.2:21/EG800Q_FOTA_PACKAGE.par”,1,50
OK

+QIND: “FOTA”,”FTPSTART”

+QIND: “FOTA”,”DOWNLOADING”,2
+QIND: “FOTA”,”DOWNLOADING”,4

…

+QIND: “FOTA”,”DOWNLOADING”,100
+QIND: “FOTA”,”HTTPEND”,0 //Download the delta firmware package from the FTP server successfully.

//After the download completes, the module will reboot automatically and enter the upgrade mode and then upgrade firmware through DFOTA.

+QIND: “FOTA”,”START”
+QIND: “FOTA”,”UPDATING”,1
+QIND: “FOTA”,”UPDATING”,2

…

+QIND: “FOTA”,”UPDATING”,100
+QIND: “FOTA”,”END”,0 //Upgrade the firmware successfully

NOTE

The server address and delta package name above are only examples, and you can modify them as needed.
If the downloaded delta package is a file suffixed with .bin, after the delta package is downloaded, the updater tool will be upgraded first, and the following URC will be reported:
+ QIND: “FOTA”,”UPDATERSTART”
+QIND: “FOTA”,”UPDATEREND”,0 // Upgrade the updater tool successfully.
After the updater tool is successfully upgraded, the module will reboot automatically and enter the upgrade mode and then upgrade firmware through DFOTA.

AT+QFOTADL=<HTTP_URL> Upgrade Firmware over HTTP(S) Server
When the delta package is stored on the HTTP(S) server, execute AT+QFOTADL=<HTTP_URL> to initiate automatic firmware upgrade for modules via DFOTA. After executing this command, the module will automatically download the package from HTTP(S) server and then upgrade the firmware.

Parameter

Example
//Upgrade the firmware when delta firmware package is stored on your HTTP(S) server.
“http://www.example.com:100/EG800Q_FOTA_PACKAGE.par” is used as an example URL below. (The URL is provided for illustrative purpose only. Please replace it with a valid URL that corresponds to your HTTP(S) server and firmware package.)
//Configure the PDP context. In this example, the PDP context ID is 2. For more details, refer to the document [1].
AT+QICSGP=2,1,”broadband”,””,””,1 //Set the PDP context ID to 2, the APN to “broadband” (representing AT&T), the username and password to be empty, and the authentication type to PAP.
OK
AT+QIACT=2 //Activate the PDP context.
OK
//Execute AT+QFOTADL to initiate automatic firmware upgrade via DFOTA, and then the module will start to download the delta package and upgrade the firmware automatically.
AT+QFOTADL=”http://www.example.com:100/EG800Q_FOTA_PACKAGE.par“,1,50
OK

+QIND: “FOTA”,”HTTPSTART”

+QIND: “FOTA”,”DOWNLOADING”,2
+QIND: “FOTA”,”DOWNLOADING”,4

…

+QIND: “FOTA”,”DOWNLOADING”,100
+QIND: “FOTA”,”HTTPEND”,0 //Download the delta firmware package from the HTTP(S) server successfully.

//After the download completes, the module will reboot automatically and enter the upgrade mode and then upgrade firmware through DFOTA.

+QIND: “FOTA”,”START”
+QIND: “FOTA”,”UPDATING”,1
+QIND: “FOTA”,”UPDATING”,2

…

+QIND: “FOTA”,”UPDATING”,100
+QIND: “FOTA”,”END”,0 //Upgrade the firmware successfully.
1. The server address and delta package name above are only examples, and you can modify them as needed.
2. If the downloaded delta package is a file suffixed with .bin, after the delta package is downloaded, the updater tool will be upgraded first, and the following URC will be reported:
  + QIND: “FOTA”,”UPDATERSTART”
  +QIND: “FOTA”,”UPDATEREND”,0 //Upgrade the updater tool successfully.
  After the updater tool is successfully upgraded, the module will reboot automatically and enter the upgrade mode and then upgrade firmware through DFOTA.

AT+QFOTADL=”FILE:<length>” Upgrade Firmware over Host
When the delta package is stored on your host, execute AT+QFOTADL=”FILE:<length>” to initiate automatic firmware upgrade for modules via DFOTA. After executing this command, the module will receive the firmware package from your host through the main UART or USB AT port and then upgrade the firmware automatically.
If main UART (or USB AT port) is used, the following steps should be performed to upgrade firmware:

Step 1: The host opens the UART tool and chooses main UART(or USB AT port).
Step 2: Select the delta package from your host.
Step 3: Send AT+QFOTADL=”FILE:<length>”[,<upgrade_mode>[,<download_URC_max>[,<updat e_URC_max>]]]

Step 4: Send the delta firmware package.

AT+QFOTADL=”FILE:<length>” Upgrade Firmware over Host

Write Command AT+QFOTADL=”FILE:<length>”[,<upgrade_mode>[,<download_URC_max>[,<update_URC_max>]]]

Response OK
+QIND: “FOTA”,”FILESTART” [+QIND:”FOTA”,”DOWNLOADING”,<upload length><total length><percent>+QIND:”FOTA”,”DOWNLOADING”,<upload length><total length><percent>…]+QIND: “FOTA”,”FILEEND”,<file_err>+QIND: “FOTA”,”START”[+QIND: “FOTA”,”UPDATING”,<percent>+QIND: “FOTA”,”UPDATING”,<percent>…]+QIND: “FOTA”,”END”,<err>

	If there is any error: ERROR
Maximum Response Time	180 s
Characteristics	–

Parameter

Example
// Upgrade the firmware when delta firmware package is stored on your host.
AT+QFOTADL=”FILE:216014″,1,100 //The length of delta firmware package is 216014 bytes.
OK

+QIND: “FOTA”,”FILESTART”

//Wait for the host to send delta firmware package through UART tool to module.

+QIND: “FOTA”,”DOWNLOADING”,2450,216014,1
+QIND: “FOTA”,”DOWNLOADING”,4550,216014,2

…

+QIND: “FOTA”,”DOWNLOADING”,216014,216014,100
+QIND: “FOTA”,”FILEEND”,0

//Upgrade firmware via DFOTA immediately after downloading delta firmware package.

+QIND: “FOTA”,”START”
+QIND: “FOTA”,”UPDATING”,1
+QIND: “FOTA”,”UPDATING”,2

…

+QIND: “FOTA”,”UPDATING”,100
+QIND: “FOTA”,”END”,0 // Upgrade the firmware successfully.

Summary of Result Codes

This chapter introduces the result codes related to mobile equipment or network. The details about <FTP_err>, <HTTP_err>, <file_err>, <updater_err> and <err> are described as follows.

Summary of <FTP_err> Codes
Detailed information about <FTP_err> is listed as follows.

Table 2: Summary of <FTP_err> Codes

Summary of <HTTP_err> Codes
Detailed information about <HTTP_err> is listed as follows.

Table 3: Summary of <HTTP_err> Codes

Summary of <file_err> Codes
Detailed information about <file_err> is listed as follows.

Table 4: Summary of <file_err> Codes

Summary of <updater_err> Codes
Detailed information about <updater_err> is listed as follows.

Table 5: Summary of <updater_err> Codes

Summary of <err> Codes
Detailed information about <err> is listed as follows.

Table 6: Summary of <err> Codes

Appendix References

Table 7: Related Document

Document Name
[1] Quectel_EG800Q&EG91xQ_Series_TCP(IP)_Application_Note

Table 8: Terms and Abbreviations

FAQ

Q: Where can I find technical support?
A: For technical support, visit Technical Support or email support@quectel.com.

Q: What should I do if I encounter inaccuracies in the documentation?
A: Please report any inaccuracies to the technical support team by visiting Technica Support or emailing support@quectel.com.

Documents / Resources

	Quectel EG800Q LTE Standard Module [pdf] User Guide EG800Q LTE Standard Module, EG800Q, LTE Standard Module, Standard Module, Module
	QUECTEL EG800Q LTE Standard Module [pdf] User Guide EG800Q, EG91xQ, EG800Q LTE Standard Module, EG800Q, LTE Standard Module, Standard Module, Module