Quectel DFOTA User Guide V1.0
User Manual: Pdf
Open the PDF directly: View PDF 
.
Page Count: 18
| Download | |
| Open PDF In Browser | View PDF |
DFOTA User Guide UMTS/HSPA Module Series Rev. DFOTA_User_Guide_V1.0 Date: 2014-11-04 www.quectel.com UMTS/HSPA Module Series DFOTA User Guide Our aim is to provide customers with timely and comprehensive service. For any assistance, please contact our company headquarters: Quectel Wireless Solutions Co., Ltd. Office 501, Building 13, No.99, Tianzhou Road, Shanghai, China, 200233 Tel: +86 21 5108 6236 Mail: info@quectel.com l e t l c a e i t u n Q ide f n o C Or our local office, for more information, please visit: http://www.quectel.com/support/salesupport.aspx For technical support, to report documentation errors, please visit: http://www.quectel.com/support/techsupport.aspx GENERAL NOTES QUECTEL OFFERS THIS 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 THIS INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF QUECTEL CO., LTD. TRANSMITTABLE, REPRODUCTION, DISSEMINATION AND EDITING OF THIS DOCUMENT AS WELL AS UTILIZATION OF THIS CONTENTS 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. 2014. All rights reserved. DFOTA_User_Guide Confidential / Released 1 / 17 UMTS/HSPA Module Series DFOTA User Guide About the Document History Revision 1.0 l e t l c a e i t u n Q ide f n o C Date Author Description 2014-11-04 Ivan ZHANG Initial DFOTA_User_Guide Confidential / Released 2 / 17 UMTS/HSPA Module Series DFOTA User Guide Contents About the Document ................................................................................................................................... 2 Contents ....................................................................................................................................................... 3 Table Index ................................................................................................................................................... 4 1 Introduction .......................................................................................................................................... 5 1.1. Scope of the Document .............................................................................................................. 5 2 DFOTA Upgrade Procedure ................................................................................................................ 6 2.1. Get Delta Firmware Package ...................................................................................................... 7 2.2. Put Delta Package on FTP/HTTP Server ................................................................................... 7 2.3. Execute AT Command to Upgrade the Firmware ....................................................................... 7 3 Description of AT Command .............................................................................................................. 8 3.1. Upgrade Firmware via FTP Server by DFOTA ......................................................................... 10 3.2. Upgrade Firmware via HTTP Server by DFOTA ...................................................................... 10 3.3. Upgrade Firmware via File System by DFOTA ......................................................................... 11 4 5 6 Summary of FTP Error Codes .......................................................................................................... 13 Summary of HTTP Error Codes ........................................................................................................ 15 Appendix A Reference....................................................................................................................... 17 l e t l c a e i t u n Q ide f n o C DFOTA_User_Guide Confidential / Released 3 / 17 UMTS/HSPA Module Series DFOTA User Guide Table Index TABLE 1: SUMMARY OF FTP ERROR CODES .............................................................................................. 13 TABLE 2: RELATED DOCUMENTS .................................................................................................................. 17 TABLE 3: TERMS AND ABBREVIATIONS ........................................................................................................ 17 l e t l c a e i t u n Q ide f n o C DFOTA_User_Guide Confidential / Released 4 / 17 UMTS/HSPA Module Series DFOTA User Guide 1 Introduction Quectel provides DFOTA (Delta Firmware Upgrade Over The Air) function, which allows you to upgrade the firmware of the module over the air. It can upgrade the firmware to a new version, and upgrade back to the old version as well. l e t l c a e i t u n Q ide f n o C By using DFOTA, you only need to download the delta package into the module, which contains only the differences between the old and new firmware versions, thus reducing the amount of data transmitted and accelerating the speed of firmware upgrade. 1.1. Scope of the Document Quectel DFOTA function is applicable to the following modules: UC20 UMTS/HSPA+ series UC15 UMTS/HSDPA series DFOTA_User_Guide Confidential / Released 5 / 17 UMTS/HSPA Module Series DFOTA User Guide 2 DFOTA Upgrade Procedure The DFOTA upgrade procedure can be showed as the following Figure. l e t l c a e i t u n Q ide f n o C FTP/HTTP Server 2. Put the package on FTP/HTTP server 1. Get delta firmware package WCDMA/GPRS (FTP/HTTP) 4. Automatic download from FTP/HTTP server via WCDMA/GPRS network Ext. MCU 3. Execute AT command “AT+QFOTADL” Quectel Module 5. Automatic upgrade the module’s firmware Figure 1: DFOTA Upgrade Procedure As shown in the above figure, you need to operate three steps to upgrade the firmware: Step 1: Get the delta firmware package from Quectel. Step 2: Put the delta firmware on FTP/HTTP server. Step 3: Execute AT command “AT+QFOTADL” to upgrade, then the module will operate the step 4 and step 5 automatically. DFOTA_User_Guide Confidential / Released 6 / 17 UMTS/HSPA Module Series DFOTA User Guide 2.1. Get Delta Firmware Package Before upgrading the device, you need to check the current firmware (the old one) by executing AT command “ATI”. You also need to know the target firmware (the new one) which needs to be upgraded. Then you need to provide the two firmware version information to Quectel or your provider to get the delta firmware package. l e t l c a e i t u n Q ide f n o C 2.2. Put Delta Package on FTP/HTTP Server When using the DFOTA function, you need to setup a FTP/HTTP server by yourself, for Quectel does not provide a FTP/HTTP server. Then put the delta package on the server, and record the FTP/HTTP path. The module will get the delta package from this path. 2.3. Execute AT Command to Upgrade the Firmware After putting the delta firmware package on a FTP/HTTP server, you need to execute AT command “AT+QFOTADL”, then the module will download the firmware from FTP/HTTP server over the air and upgrade automatically. For details, please refer to Chapter 3. DFOTA_User_Guide Confidential / Released 7 / 17 UMTS/HSPA Module Series DFOTA User Guide 3 Description of AT Command AT+QFOTADL command is used to upgrade firmware of the module. l e t l c a e i t u n Q ide f n o C When you upgrade firmware on a FTP/HTTP server, you need to activate a PDP context ID for FTP /HTTP connection. The default PDP context ID is 1, and it can be configured by AT+QCFG=“fota/cid”,. The maximum response time of +QIND: "FOTA","FTPSTART" or +QIND: "FOTA","HTTPSTART" is 90 seconds. AT+QFOTADL Upgrade Firmware by DFOTA Test Command AT+QFOTADL=? Response OK Update firmware from local file AT+QFOTADL= Response OK +QIND: "FOTA","START" +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 ... +QIND: "FOTA","END", RDY Or ERROR Update firmware from FTP AT+QFOTADL= Response OK +QIND: "FOTA","FTPSTART" +QIND: "FOTA","FTPEND", +QIND: "FOTA","START" +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 ... +QIND: "FOTA","END", RDY Or ERROR Update firmware from HTTP AT+QFOTADL= DFOTA_User_Guide Response OK +QIND: "FOTA","HTTPSTART" Confidential / Released 8 / 17 UMTS/HSPA Module Series DFOTA User Guide +QIND: "FOTA","HTTPEND", +QIND: "FOTA","START" +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 ... +QIND: "FOTA","END", RDY Or ERROR l e t l c a e i t u n Q ide f n o C Maximum Response Time Parameter 90 seconds String type, max length is 128 bytes. String format, max length is 255 bytes. It should be started with "FTP://", for example: “FTP:// : @ : / ” String type, the user name for authentication. The maximum size of the parameter is 50 bytes String type, the password for authentication. The maximum size of the parameter is 50 bytes String type, the IP address or domain name of the FTP server. The maximum size of the parameter is 50 bytes Integer type, the port of the FTP server. The default value is 21. The range is 1-65535 String type, the file name in FTP server. The maximum size of the parameter is 50 bytes Integer type, indicates the FTP error code. 0 means OK String format, max length is 255 bytes. It should be started with "HTTP://", for example: “HTTP:// : / ” String type, the IP address or domain name of the HTTP server Integer type, the port of the HTTP server. The default value is 80. The range is 1-65535 String type, the file name in HTTP server Integer type, indicates the HTTP error code. 0 means OK Integer type, 0 means OK, else ERROR DFOTA_User_Guide Confidential / Released 9 / 17 UMTS/HSPA Module Series DFOTA User Guide 3.1. Upgrade Firmware via FTP Server by DFOTA If the delta package is stored on a FTP server, you can execute the “AT+QFOTADL” command, the module will upgrade the firmware automatically over the air via FTP, the example is shown as below: //Upgrade firmware via FTP server. //The FTP server address is “FTP://test:test@demo.com:21/update/delta.bin". l e t l c a e i t u n Q ide f n o C //Configure and activate the PDP context. AT+QICSGP=1,1,"UNINET","","",1 OK AT+QCFG="fota/cid",1 OK //Configure PDP context 1, APN is UNINET (indicates China Unicom), user name and password is set to null. //Set the PDP context ID as 1. //Execute command AT+QFOTADL, download and upgrade module’s firmware. AT+QFOTADL="FTP://test:test@demo.com:21/update/delta.bin" OK +QIND: "FOTA","FTPSTART" +QIND: "FOTA","FTPEND",0 //Finish downloading the package from FTP server. //Module will be rebooted and USB port will be re-initialized. If the current port is USB port, MCU should close and reopen it. +QIND: "FOTA","START" //Start to upgrade firmware. +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 +QIND: "FOTA","UPDATING",3 ... +QIND: "FOTA","UPDATING",100 +QIND: "FOTA","END",0 //Finish upgrading the firmware. RDY //Reboot the module, and it will be upgraded to the new version. 3.2. Upgrade Firmware via HTTP Server by DFOTA If the delta package is stored on a HTTP server, you can execute the “AT+QFOTADL” command, the module will upgrade the firmware automatically over the air via HTTP, the example is shown as below: //Upgrade firmware via HTTP server. //The HTTP server address is “HTTP://www.example.com:80/delta.bin ". DFOTA_User_Guide Confidential / Released 10 / 17 UMTS/HSPA Module Series DFOTA User Guide //Configure and activate the PDP context. AT+QICSGP=1,1,"UNINET","","",1 //Configure PDP context 1, APN is UNINET (indicates China Unicom), user name and password is set to null. OK AT+QCFG="fota/cid",1 //Set the PDP context ID as 1. OK //Execute command AT+QFOTADL, download and upgrade module’s firmware. AT+QFOTADL=" HTTP://www.example.com:80/delta.bin " OK l e t l c a e i t u n Q ide f n o C +QIND: "FOTA","HTTPSTART" +QIND: "FOTA","HTTPEND",0 //Finish downloading the package from HTTP server. //Module will be rebooted and USB port will be re-initialized. If the current port is USB port, MCU should close and reopen it. +QIND: "FOTA","START" //Start to upgrade firmware. +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 +QIND: "FOTA","UPDATING",3 ... +QIND: "FOTA","UPDATING",100 +QIND: "FOTA","END",0 RDY //Finish upgrading the firmware. 3.3. Upgrade Firmware via File System by DFOTA If the delta package has already been stored in module’s file system, you can execute the “AT+QFOTADL” command and the module will upgrade automatically, the example is shown as below: //Upgrade firmware through module’s file system. AT+QFOTADL="UFS:delta.bin" OK //Module will be rebooted and USB port will be re-initialized. If the current port is USB port, MCU should close and reopen it. +QIND: "FOTA","START" //Start to upgrade firmware. +QIND: "FOTA","UPDATING",1 +QIND: "FOTA","UPDATING",2 +QIND: "FOTA","UPDATING",3 ... DFOTA_User_Guide Confidential / Released 11 / 17 UMTS/HSPA Module Series DFOTA User Guide +QIND: "FOTA","UPDATING",100 +QIND: "FOTA","END",0 //Reboot the module, and it will be upgraded to the new version. RDY l e t l c a e i t u n Q ide f n o C DFOTA_User_Guide Confidential / Released 12 / 17 UMTS/HSPA Module Series DFOTA User Guide 4 Summary of FTP Error Codes The error code indicates an error related to mobile equipment or network. The detail about is described in the following table. l e t l c a e i t u n Q ide f n o C Table 1: Summary of FTP Error Codes 601 602 603 604 605 606 607 608 609 610 611 612 Meaning Unknown error FTP service blocked FTP service busy DNS parse fail Network error Control connection closed Data connection closed Socket closed by peer Timeout error Invalid parameter Failed to open file File position invalid 613 File error 614 Service not available, closing control connection 615 Open data connection fail 616 Connection closed; transfer aborted 617 Requested file action not taken 618 Requested action aborted: local error in processing DFOTA_User_Guide Confidential / Released 13 / 17 UMTS/HSPA Module Series DFOTA User Guide 619 Requested action not taken: insufficient system storage 620 Syntax error, command unrecognized 621 Syntax error in parameters or arguments 622 Command not implemented 623 Bad sequence of commands 624 625 626 627 628 629 630 l e t l c a e i t u n Q ide f n o C Command parameter not implemented Fail to login FTP Need account for storing files Requested action not taken. Requested action aborted: page type unknown Requested file action aborted Requested file name invalid DFOTA_User_Guide Confidential / Released 14 / 17 UMTS/HSPA Module Series DFOTA User Guide 5 Summary of HTTP Error Codes The error code indicates an error related to mobile equipment or network. The detail about is described in the following table. 0 701 702 703 704 705 706 707 708 709 710 711 712 l e t l c a e i t u n Q ide f n o C Meaning Operation successful HTTP unknown error HTTP timeout HTTP busy HTTP UART busy HTTP does not get/post request HTTP network busy HTTP network open failure HTTP network not configured HTTP network deactivated HTTP network error HTTP URL error HTTP empty URL 713 HTTP IP address error 714 HTTP DNS error 715 HTTP socket create error 716 HTTP socket connect error 717 HTTP socket read error 718 HTTP socket write error DFOTA_User_Guide Confidential / Released 15 / 17 UMTS/HSPA Module Series DFOTA User Guide 719 HTTP socket close 720 HTTP data encode error 721 HTTP data decode error 722 HTTP read timeout 723 HTTP response failure 724 725 726 727 728 729 730 l e t l c a e i t u n Q ide f n o C DFOTA_User_Guide Incoming call busy Voice call busy Input timeout Wait for data timeout HTTP response timeout Allocate memory failure Invalid parameter Confidential / Released 16 / 17 UMTS/HSPA Module Series DFOTA User Guide 6 Appendix A Reference Table 2: Related Documents l e t l c a e i t u n Q ide f n o C SN Document Name Remark [1] Quectel_UC20_TCPIP_AT_Commands_Manual Introduction about UC20 TCPIP AT commands [2] Quectel_UC20_AT_Commands_Manual UC20 AT commands manual [3] Quectel_UC20_FTP_AT_Commands_Manual Introduction about UC20 FTP AT commands [4] Quectel_UC20_HTTP_AT_Commands_Manual Introduction about UC20 HTTP AT commands Table 3: Terms and Abbreviations Abbreviation Description FTP File Transfer Protocol HTTP PDP DFOTA APN DFOTA_User_Guide Hyper Text Transport Protocol Packet Data Protocol Delta Firmware Upgrade over the Air Access Point Name Confidential / Released 17 / 17
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Has XFA : No Language : zh-CN XMP Toolkit : Adobe XMP Core 4.2.1-c041 52.342996, 2008/05/07-20:48:00 Format : application/pdf Creator : kelly Create Date : 2014:11:04 13:38:49+08:00 Creator Tool : Microsoft® Word 2010 Modify Date : 2014:11:04 14:39:05+08:00 Metadata Date : 2014:11:04 14:39:05+08:00 Producer : Microsoft® Word 2010 Document ID : uuid:22e101b0-d049-49d6-b426-6e0b927fd673 Instance ID : uuid:dd7ca6fa-174a-4328-acec-0a55fcfc4b3c Page Count : 18 Author : kellyEXIF Metadata provided by EXIF.tools