Quectel EP06 User manual

EP06&EG06&EM06 DFOTA
User Guide
LTE-A Module Series
Rev. EP06&EG06&EM06_DFOTA_User_Guide_V1.0
Date: 2018-08-31
Status: Released
www.quectel.com

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 1 / 16
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://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.
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-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 2 / 16
About the Document
History
Revision
Date
Author
Description
1.0
2018-08-31
Ramos ZHANG/
Mayra XU
Initial

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 3 / 16
Contents
About the Document...................................................................................................................................2
Contents.......................................................................................................................................................3
Table Index...................................................................................................................................................4
1Introduction..........................................................................................................................................5
2Firmware Upgrade Procedure via DFOTA.........................................................................................6
2.1. Get Delta Firmware Package..................................................................................................7
2.2. Put Delta Package on FTP/HTTP(S) Server...........................................................................7
2.3. ExecuteAT Command to Upgrade the Firmware ...................................................................7
3Description of DFOTA AT Commands...............................................................................................8
3.1. AT+QFOTADL=<ftpURL> Upgrade Firmware When Delta Package is Stored on an FTP
Server 8
3.2. AT+QFOTADL=<httpURL>Upgrade Firmware When Delta Package is Stored on an
HTTP(S) Server ...................................................................................................................................10
3.3. AT+QFOTADL=<file_name> Upgrade Firmware When Delta Package is Stored on the
Local File System................................................................................................................................. 11
4Abnormalities and Important Note...................................................................................................13
4.1. Abnormalities.........................................................................................................................13
4.1.1. Wrong Delta Firmware Package .....................................................................13
4.1.2. Failure of Firmware Upgrade...........................................................................13
4.2. Important Note.......................................................................................................................14
5Summary of Error Codes ..................................................................................................................15
6Appendix A References.....................................................................................................................16

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 4 / 16
Table Index
TABLE 1: SUMMARY OF <FTP_ERR>, <HTTP_ERR> AND <ERR> CODES................................................ 15
TABLE 2: TERMS AND ABBREVIATIONS........................................................................................................ 16

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 5 / 16
1Introduction
Quectel EP06&EG06&EM06 modules support DFOTA (Delta Firmware Upgrade Over-the-air) function,
which allows customers to upgrade the firmware over the air. It can upgrade the firmware to a new version
and revert to the old version as well.
Before firmware upgrading, customers only need to prepare the firmware package which contains the
differences between the original and target firmware versions. This reduces the amount of data
transmitted and accelerates the speed of firmware upgrade.
This document is applicable to Quectel EP06&EG06&EM06 modules.

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 6 / 16
2Firmware Upgrade Procedure via
DFOTA
The following chart illustrates the firmware upgrade procedure via DFOTA.
1. Get delta firmware package
FTP/HTTP(S)
Server
4. Automatically download
from FTP/HTTP(S) server via
LTE/WCDMA network
LTE/WCDMA/
(FTP/HTTP(S))
Ext.
MCU
Quectel
Module
2. Put the package on FTP/HTTP(S) server
3. Execute AT+QFOTADL
command
5. Automatically
upgrade the
module’s firmware
Figure 1: Firmware Upgrade Procedure via DFOTA

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 7 / 16
As shown in the above figure, customers only need to perform the following steps to upgrade the
firmware.
Step 1: Get the delta firmware package from Quectel.
Step 2: Put the delta firmware on FTP/HTTP(S) server.
Step 3: Execute AT+QFOTADL command. Then the module will automatically download the package
from FTP/HTTP(S) server via LTE/WCDMA network (Step 4) and finally automatically upgrade
the module’s firmware (Step 5).
2.1. Get Delta Firmware Package
Before upgrading, customers need to check the current firmware version (the original version) by
executing ATI command, and also need to know the target firmware version. Then the two firmware
versions should be provided for Quectel or the module supplier in order to get the delta firmware package.
2.2. Put Delta Package on FTP/HTTP(S) Server
When using the DFOTA function, customers need to set up an FTP/HTTP(S) server by themselves, for
Quectel does not provide such a server. Then please put the delta firmware package on the server, and
record the FTP/HTTP(S) path. The module will get the delta package from the path after executing
correspondingAT command.
2.3. Execute AT Command to Upgrade the Firmware
After putting the delta firmware package on the FTP/HTTP(S) server, customers need to execute
AT+QFOTADL command. Then the module will download the firmware package from the FTP/HTTP(S)
server over the air and upgrade the firmware automatically. For more details, please refer to Chapter 3.

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 8 / 16
3Description of DFOTA AT Commands
AT+QFOTADL command enables automatic firmware upgrade for the module via DFOTA. After executing
the command, the module will automatically download the package from FTP/HTTP(S) server, reboot
automatically and then enter into recovery mode. When the upgrade package is checked OK and the
firmware upgrade is successful, the module will reboot and enter into normal mode.
3.1. AT+QFOTADL=<ftpURL> Upgrade Firmware When Delta Package is
Stored on an FTP Server
If the delta firmware package is stored on an FTP server, AT+QFOTADL=<ftpURL> should be executed to
enable automatic firmware upgrade via DFOTA. Then the module will download the delta package from
the FTP server over the air and upgrade the firmware automatically.
AT+QFOTADL Upgrade Firmware via DOFTA
Test Command
AT+QFOTADL=?
Response
OK
AT+QFOTADL=<ftpURL> Upgrade Firmware When Delta Package is Stored on an
FTP Server
Write Command
AT+QFOTADL=<ftpURL>
Response
OK
+QIND: "FOTA","FTPSTART"
+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, response:
ERROR

LTE-A Module Series
EP06&EG06&EM06 DFOTA User Guide
EP06&EG06&EM06_DFOTA_User_Guide 9 / 16
Parameter
Example
//Upgrade the firmware when the delta firmware package is stored on an FTP server.
//The FTP server address is “ftp://test:test@124.74.41.170:21/Jun/update-v12-to-v13.zip".
//Execute AT+QFOTADL command to enable automatic firmware upgrade via DFOTA, and then the
module will start to download the delta package and upgrade firmware automatically.
AT+QFOTADL="ftp://test:test@124.74.41.170:21/Jun/update-v12-to-v13.zip"
OK
+QIND: "FOTA","FTPSTART" //Start to download the delta package from the FTP server.
+QIND: "FOTA","FTPEND",0 //Finish downloading the delta package.
//The module will reboot automatically and the USB port will be re-initialized. If the current port is USB port,
then the MCU should close and reopen it.
+QIND: "FOTA","START" //Start to upgrade the firmware.
+QIND: "FOTA","UPDATING",1
+QIND: "FOTA","UPDATING",2
...
+QIND: "FOTA","UPDATING",100
+QIND: "FOTA","END",0 //The firmware is upgraded successfully.
<ftpURL> String type. The URL of the FTP server. The maximum length is 255 bytes. It
should be started with "ftp://". For example: “ftp://<user_name>:<password>
@<serverURL>:<port>/<file_path>”.
<username> String type. The user name for authentication.
<password> String type. The password for authentication.
<serverURL> String type. The IP address or domain name of the FTP server.
<port> Integer type. The port of the FTP server. The default value is 21. The range is
1-65535.
<file_path> String type. The file name on FTP server.
<ftp_err> Integer type. The FTP error code. 0 means the upgrade is successful. Please
refer to Chapter 5 for details.
<percent> Integer type. The upgrade progress in percentage.
<err> Integer type. 0 means firmware upgrade successful. Any other value means an
error. Please refer to Chapter 5 for details.