Telit FOTA AT Script NT11347A Rev [ ] Mod Rev.7

Transcription

1 [ ] Telit FOTA AT Script 80000NT11347A Rev Mod Rev.7

2 SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE NOTICE While reasonable efforts have been made to assure the accuracy of this document, Telit assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. The information in this document has been carefully checked and is believed to be reliable. However, no responsibility is assumed for inaccuracies or omissions. Telit reserves the right to make changes to any products described herein and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Telit does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others. It is possible that this publication may contain references to, or information about Telit products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Telit intends to announce such Telit products, programming, or services in your country. COPYRIGHTS This instruction manual and the Telit products described in this instruction manual may be, include or describe copyrighted Telit material, such as computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and its licensors certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material. Accordingly, any copyrighted material of Telit and its licensors contained herein or in the Telit products described in this instruction manual may not be copied, reproduced, distributed, merged or modified in any manner without the express written permission of Telit. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit, as arises by operation of law in the sale of a product. COMPUTER SOFTWARE COPYRIGHTS The Telit and 3rd Party supplied Software (SW) products described in this instruction manual may include copyrighted Telit and other 3rd Party supplied computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and other 3rd Party supplied SW certain exclusive rights for copyrighted computer programs, including the exclusive right to copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrighted Telit or other 3rd Party supplied SW computer programs contained in the Telit products described in this instruction manual may not be copied (reverse engineered) or reproduced in any manner without the express written permission of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit or other 3rd Party supplied SW, except for the normal non-exclusive, royalty free license to use that arises by operation of law in the sale of a product NT11347A Rev. 13 Page 2 of

3 USAGE AND DISCLOSURE RESTRICTIONS I. License Agreements The software described in this document is the property of Telit and its licensors. It is furnished by express license agreement only and may be used only in accordance with the terms of such an agreement. II. Copyrighted Materials Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, without prior written permission of Telit III. High Risk Materials Components, units, or third-party products used in the product described herein are NOT fault-tolerant and are NOT designed, manufactured, or intended for use as on-line control equipment in the following hazardous environments requiring fail-safe controls: the operation of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic Control, Life Support, or Weapons Systems (High Risk Activities"). Telit and its supplier(s) specifically disclaim any expressed or implied warranty of fitness for such High Risk Activities. IV. Trademarks TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service names are the property of their respective owners. V. Third Party Rights The software may include Third Party Right software. In this case you agree to comply with all terms and conditions imposed on you in respect of such separate software. In addition to Third Party Terms, the disclaimer of warranty and limitation of liability provisions in this License shall apply to the Third Party Right software. TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM ANY THIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY MATERIALS INCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM WHICH THE SOFTWARE IS DERIVED (COLLECTIVELY OTHER CODE ), AND THE USE OF ANY OR ALL THE OTHER CODE IN CONNECTION WITH THE SOFTWARE, INCLUDING (WITHOUT LIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY OR FITNESS FOR A PARTICULAR PURPOSE. NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND WHETHER MADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY, ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE OTHER CODE OR THE EXERCISE OF ANY RIGHTS GRANTED UNDER EITHER OR BOTH THIS LICENSE AND THE LEGAL TERMS APPLICABLE TO ANY SEPARATE FILES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES NT11347A Rev. 13 Page 3 of

4 APPLICABILITY TABLE PRODUCTS GT863-PY GT864-QUAD/PY GE864-QUAD V2 GE864-QUAD AUTO V2 GE864-GPS GE865-QUAD GE866-QUAD GE910-QUAD GE910-GNSS GE910-QUAD AUTO GE910-QUAD V3 GL865-DUAL GL865-DUAL V3 GL865-QUAD GL865-QUAD V3 GL868-DUAL GL868-DUAL V3 GC864-QUAD V2 UE910 V2 SERIES UE910-EU V2 AUTO GT863-3EU UL865 SERIES UL865-N3G UE910 SERIES UE866 SERIES HE920 AUTO SERIES HE910 SERIES HE910 MINI PCIE CL865-DUAL CE910-DUAL CE910-SL 80000NT11347A Rev. 13 Page 4 of

5 DE910-DUAL DE910-SC DE910 MINI PCIE LE910 SERIES LE910 V2 SERIES LE910 CAT1 SERIES LE920 AUTO SERIES LE922A6 SERIES 80000NT11347A Rev. 13 Page 5 of

6 CONTENTS NOTICE 2 COPYRIGHTS... 2 COMPUTER SOFTWARE COPYRIGHTS... 2 USAGE AND DISCLOSURE RESTRICTIONS... 3 I. License Agreements... 3 II. Copyrighted Materials... 3 III. High Risk Materials... 3 IV. Trademarks... 3 V. Third Party Rights... 3 APPLICABILITY TABLE (REMOVE UNUSED)... 4 CONTENTS INTRODUCTION HOW TO UPGRADE THE FIRMWARE OF A TELIT MODULE. 11 The Telit Module needs to download the needed Delta FW from an FTP server Procedure valid for Telit Modules in Group A Procedure valid for Telit Modules in Group B The Telit Module can receive the needed Delta FW through a user s port connection Procedure valid for Telit Modules in Group A Procedure valid for Telit Modules in Group B The Telit Module can receive the needed Delta FW through a user s port connection Procedure valid for Telit Modules in Group A Procedure valid for Telit Modules in Group B URC Sequences Delta File Download Process messages for Telit Modules in Group B Update Result messages, valid for Telit Modules in Group A Update Result messages, valid for Telit Modules in Group B AT COMMANDS DESCRIPTION AT Commands, for Telit Modules in Group A #FTPGETOTA Command NT11347A Rev. 13 Page 6 of

7 #OTAUPW Command #OTAUP Command AT Commands, for Telit Modules in Group B #FTPGETOTAENH Command #OTAUPW Command #OTAUP Command GLOSSARY AND ACRONYMS DOCUMENT HISTORY NT11347A Rev. 13 Page 7 of

8 1. INTRODUCTION 1.1. Scope Aim of this document is to describe how to upgrade the firmware of Telit Modules using FOTA functionality via AT commands, either when a Telit Module has to download the Delta FW from an FTP server ( 2.1 and 2.3), or when a Telit Module can receive the Delta FW through a user s serial connection ( 2.2 and 2.3) Audience This document is intended for those users that need to upgrade via FOTA the firmware of their modules without direct control of FOTA servers Contact Information, Support For general contact, technical support services, technical questions and report documentation errors contact Telit Technical Support at: TS-EMEA@telit.com TS-AMERICAS@telit.com TS-APAC@telit.com Alternatively, use: For detailed information about where you can buy the Telit modules or for recommendations on accessories and components visit: Our aim is to make this guide as helpful as possible. Keep us informed of your comments and suggestions for improvements. Telit appreciates feedback from the users of our information NT11347A Rev. 13 Page 8 of

9 1.4. Text Conventions Danger This information MUST be followed or catastrophic equipment failure or bodily injury may occur. Caution or Warning Alerts the user to important points about integrating the module, if these points are not followed, the module and end user equipment may fail or malfunction. Tip or Information Provides advice and suggestions that may be useful when integrating the module. All dates are in ISO 8601 format, i.e. YYYY-MM-DD. In the following chapters we differentiate all the Telit Modules in two groups. Group A It consists of all the Telit Modules in the Applicability Table, except those belonging to either the LE910 Series or the LE920 AUTO Series. Group B It consists of all the Telit Modules belonging to either the LE910 Series or the LE920 AUTO Series. For the sake of simplicity we list the Telit Modules belonging to this group at the time when this document is written. LE910 Series: LE910-EUG, LE910-NAG, LE910-SVG, LE910- SKG LE920 AUTO Series: LE920-EUA, LE920-EUG, LE920-NAG, LE920-NA, LE920-NAA, LE920A4, LE920A4-EU 80000NT11347A Rev. 13 Page 9 of

10 1.5. Related Documents [1] AT Commands Reference Guide, Telit Document 80000ST10025a [2] LE9x0 AT Commands Reference Guide, Telit Document 80407ST10116a 80000NT11347A Rev. 13 Page 10 of

11 2. HOW TO UPGRADE THE FIRMWARE OF A TELIT MODULE This chapter reports the list of AT commands needed to upgrade the firmware of Telit Modules. We report in black the AT commands sent to the module, in blue the expected AT answers, in red the comments. The Telit Module needs to download the needed Delta FW from an FTP server In this chapter, we assume that the Telit Module needs to download the needed Delta FW from an FTP server Procedure valid for Telit Modules in Group A // Change the 3 rd parameter with your APN AT+CGDCONT=1,"IP","APN" AT#SCFG=1,1,1460,90,600,50 // Change 3 rd and 4 th parameters with the ones required // by your context activation. // If your context activation doesn t require both parameters // <userid> and <pwd>, please skip the input of both of them. // Try max 3 times, otherwise retry after 15 minutes AT#SGACT=1,1, username, password #SGACT: x.y.w.z AT#FTPTO=2400 // Change 1 st, 2 nd and 3 rd parameter with the ones required by the FTP // server you are going to connect to. // Try max 3 times, otherwise retry after 5 minutes or restart with // AT#SGACT AT#FTPOPEN="FTP_IP_address", FTP_username, FTP_password, NT11347A Rev. 13 Page 11 of

12 AT#FTPTYPE=0 // Change the parameter with the right FTP path of the Delta FW // in the FTP server you are connected to AT#FTPCWD="/GE864/Fwd/" // Try max 3 times, otherwise retry after 5 minutes or restart with // AT#FTPOPEN AT#FTPGETOTA="Delta.bin.env",1 ################################################################## ########################### AT#FTPCLOSE AT#SGACT=1,0 AT+CGDCONT= Procedure valid for Telit Modules in Group B // FOTA is enabled when PDP context is defined properly in accordance // with your carrier // required settings (see +CGDCONT command) to allow data // connection. AT+CGDCONT? +CGDCONT: 1, IPV4V6,,,0,0 +CGDCONT: 2, IP, mobile.vodafone.it,,0,0 +CGDCONT: 4, IPV4V6, vzwapp,,0,0 AT#FTPGETOTAENH=<ftpurl>,<ftpport>,<target file>,<username>,<pwd> 80000NT11347A Rev. 13 Page 12 of

13 //FUMO DM Session started #OTAEV: #907 //Done, Firmware downloaded #OTAEV: #919 //Data Session Release #OTAEV: #DREL The Telit Module can receive the needed Delta FW through a user s port connection Procedure valid for Telit Modules in Group A In this chapter, we assume that the Telit Module can receive the needed Delta FW through a user s serial connection. Recommendation valid for 2G products only: we recommend to set to 1 the CPU Clock Mode and wait at least 10 seconds before continuing the procedure. // (Valid for 2G products only) // We recommend that you first set properly the CPU Clock Mode AT#CPUMODE=1 // Then you have to program a delay of at least 10 seconds before // continuing the procedure // Send the command #OTAUPW to start the injection of the Delta FW // into // module s flash memory AT#OTAUPW CONNECT // Send the Delta FW to the module via user s USB/SERIAL interface // remind to use hardware flow control while sending the file // Once the sending of the file has been terminated, close the // connection through the escape sequence (+++). +++ NO CARRIER Procedure valid for Telit Modules in Group B In this chapter, we assume that the Telit Module can receive the needed Delta FW through a user s serial connection NT11347A Rev. 13 Page 13 of

14 // Send the command #OTAUPW to start the injection of the Delta FW // into module s flash memory AT#OTAUPW CONNECT // Send the Delta FW to the module via user s USB/SERIAL interface // remind to use hardware flow control while sending the file // Once the sending of the file has been terminated, close the // connection through the escape sequence (+++). +++ The Telit Module can receive the needed Delta FW through a user s port connection Once the Delta FW has been downloaded/injected into Telit Module, we send the following sequence of AT Commands to upgrade the FW of the Telit Module itself Procedure valid for Telit Modules in Group A // Next AT Command is to ask the FOTA engine to start the // validation/update process to upgrade the FW of a Telit Module AT#OTAUP=0,0 // URC to inform that FOTA engine has finished its work #OTAEV: Module Upgraded To New Fw // Send the next command to check that the firmware has been updated // successfully AT+CGMR +CGMR: Procedure valid for Telit Modules in Group B // Next AT Command is to ask the FOTA engine to start the // validation/update process to upgrade the FW of a Telit Module AT#OTAUP= NT11347A Rev. 13 Page 14 of

15 // Device is ready after power-up #OTAEV: #000 // FOTA engine has just finished its work #OTAEV: Module Upgraded To New Fw // Send the next command to check that the firmware has been updated // successfully AT+CGMR +CGMR: URC Sequences Delta File Download Process messages for Telit Modules in Group B URC DESCRIPTION #OTAEV: #907 NOTIFICATION - FUMO DM SESSION STARTED SUCCESS CASE #OTAEV: #919 #OTAEV: #DREL NOTIFICATION - DONE, FIRMWARE DOWNLOADED. NOTIFICATION - DATA SESSION RELEASE. #OTAEV: #915 NOTIFICATION GENERIC ERROR HAPPENED WHILE FUMO. FAILURE CASE #OTAEV: #DREL NOTIFICATION - DATA SESSION RELEASE. IT WILL NOT BE SHOWN IF THE DELTA FILE DOWNLOAD PROCESS IS UNSUCCESSFUL IT WILL BE SHOWN ONLY IF THE DELTA FILE DOWNLOAD PROCESS IS SUCCESSFUL BUT THE FILE IS UNUSABLE FOR ANY REASON Update Result messages, valid for Telit Modules in Group A URC DESCRIPTION 80000NT11347A Rev. 13 Page 15 of

16 SUCCESS CASE #OTAEV: Module Upgraded to New Fw NOTIFICATION THE FOTA ENGINE HAS FINISHED ITS WORK SUCCESSFULLY FAILURE CASE #OTAEV: OTA Fw Upgrade Error <ErrCode> NOTIFICATION AN ERROR OCCURRED WHILE THE FOTA ENGINE WAS DOING ITS WORK PARAMETER: <ERRCODE> 1 - GENERAL ERROR 2 - FIRMWARE CORRUPTED, CRC ERROR 3 - FIRMWARE PACKAGE MISMATCH 4 - FIRMWARE SIGNATURE FAILED 5 - AUTHENTICATION FAILED 6 - OUT OF MEMORY RESOURCE Update Result messages, valid for Telit Modules in Group B URC DESCRIPTION #OTAEV: #000 NOTIFICATION DEVICE IS READY AFTER POWER UP SUCCESS CASE #OTAEV: Module Upgraded to New Fw NOTIFICATION THE FOTA ENGINE HAS FINISHED ITS WORK SUCCESSFULLY FAILURE CASE #OTAEV: OTA Fw Upgrade Failed NOTIFICATION AN ERROR OCCURRED WHILE THE FOTA ENGINE WAS DOING ITS WORK 80000NT11347A Rev. 13 Page 16 of

17 3. AT COMMANDS DESCRIPTION AT Commands, for Telit Modules in Group A #FTPGETOTA Command #FTPGETOTA OTA FTP DELTA DOWNLOAD AT#FTPGETOTA=<file name>,<verbose_lev> [,<restart>] Set command starts delta download. Parameter <filename> - delta file name on ftp server, string type. <verbose_lev> 0 hash mark printing disabled during download 1 hash mark printing enabled during download every 4096 bytes <restart> 0 no restart required 1 restart required: previously download of <filename> file will restart from the point it was interrupted. Note: if reboot occurs, restart is also possible but from last sector already written. Note: FTP server must support SIZE command. AT# FTPGETOTA =? Test command returns the result code #OTAUPW Command #OTAUPW OTA DELTA INJECT (WRITE) AT#OTAUPW[= <verbose lev>] Execution command starts delta injection (write). Parameter <verbose lev> 0 hash mark printing disabled during injection 80000NT11347A Rev. 13 Page 17 of

18 1 hash mark printing enabled during injection every 4096 bytes Note: issuing AT#OTAUPW<CR>, the behaviour is the same of AT#OTAUPW=0 AT# OTAUPW=? Test command returns the result code #OTAUP Command #OTAUP OTA CHECK AND START UPDATE AT#OTAUP[=<type> [, <verbose_lev> [, <dbg_baud_rate>]]] Execution command performs validation-update process. Parameter <type> 0 delta validation and start of firmware update 1 delta validation only (not supported on CE910 series) <verbose_lev> 0 no output information during validation/update process (default) 1 minimum output information during validation/update process 2 medium output information during validation/update process 3 full output information during validation/update process < dbg_baud_rate > port speed during update process (default ), allowed values: NT11347A Rev. 13 Page 18 of

19 On success, the command returns and update process starts. Note: issuing AT#OTAUP<CR>, the behaviour is the same of AT#OTAUP=0,0, Note: update process output is valid only for main UART port Note: in some cases (i.e. CE910 series) we recommend to use verbose_lev 1,2 or 3 setting because validation/update process takes long time and it might be misunderstood as a module freezing AT# OTAUP=? Test command returns the result code. AT Commands, for Telit Modules in Group B #FTPGETOTAENH Command #FTPGETOTAENH OTA DELTA FILE INJECTION (DOWNLOAD) AT#FTPGETOTAENH= <ftpurl>, [<ftpport>], <target_file>, [<username>, [<password>]] Execution command is used to download an update package from an FTP server. Passive & Binary modes are used by default and cannot be changed. Parameters <username> and <password> are optional. <target_file> is the complete path to the file to be downloaded. This command will automatically activate the PDP context, download the delta file from the given FTP server and deactivate the PDP context once done. PDP context CID used by this command can be changed using #otacfg command with <ID>=2: at#otacfg=2,<cid> <ftpport> can be ignored by using the following syntax: at#ftpgetotaenh=<ftpurl>,,<target_file> 80000NT11347A Rev. 13 Page 19 of

20 This command will only download the update package, for installation #otaup command shall be used. AT# FTPGETOTAENH =? Test command returns the result code #OTAUPW Command #OTAUPW OTA DELTA FILE INJECTION (WRITE) AT#OTAUPW[= <data_size>] Execution command injects a delta file into the device. This command will only write the file to the device to be ready for installation. In order to install the delta file, you have to send the command #OTAUP (see 3.2.3). You can send #OTAUPW with or without the <data_size> parameter. Once received the command #OTAUPW, the device prints the CONNECT reply and waits for data to be received. Send escape sequence +++ to end data transmission (which will result in response). If <data_size> parameter value was specified, the command will report once all size is received. AT# OTAUPW=? Test command returns the result code. Example // Send the command #OTAUPW to start the // injection of the Delta FW into module s // flash memory AT#OTAUPW CONNECT // Send the Delta FW to the module via // user s USB/SERIAL interface // remind to use hardware flow control while // sending the file // Once the sending of the file has been // terminated, close the connection through // the escape sequence (+++) NT11347A Rev. 13 Page 20 of

21 #OTAUP Command #OTAUP OTA DELTA FILE INSTALLATION AT#OTAUP=2 Execution command installs a previously injected update file. You have to inject an update file into the device before running this command (see both #FTPGETOTAENH and #OTAUPW). The device will reboot and install the update. Currently, this command will accepts a single parameter with fixed value 2. AT# OTAUP=? Test command returns the result code NT11347A Rev. 13 Page 21 of

22 4. GLOSSARY AND ACRONYMS Description TTSC USB HS DTE UMTS WCDMA HSDPA HSUPA UART HSIC SIM SPI ADC DAC I/O GPIO CMOS MOSI MISO CLK MRDY SRDY CS RTC PCB ESR VSWR VNA Telit Technical Support Centre Universal Serial Bus High Speed Data Terminal Equipment Universal Mobile Telecommunication System Wideband Code Division Multiple Access High Speed Downlink Packet Access High Speed Uplink Packet Access Universal Asynchronous Receiver Transmitter High Speed Inter Chip Subscriber Identification Module Serial Peripheral Interface Analog Digital Converter Digital Analog Converter Input Output General Purpose Input Output Complementary Metal Oxide Semiconductor Master Output Slave Input Master Input Slave Output Clock Master Ready Slave Ready Chip Select Real Time Clock Printed Circuit Board Equivalent Series Resistance Voltage Standing Wave Radio Vector Network Analyzer 80000NT11347A Rev. 13 Page 22 of

23 5. DOCUMENT HISTORY Revision Date Changes First registered issue New template adoption: Mod_0809_Application_Note The Document now differentiates both procedures and descriptions as Basic or Specific for LE9x0 Series AT#OTAUP description updated with CE910 requirements Added LE922 and LE910-V Recommendation to use #CPUMODE added to Updated for LE922A6 Series : Added differentiation of Telit Modules in two Groups New title for Chapters 2.1.1, 2.1.2, 2.2.1, 2.2.2, 2.3.1, 2.3.2, 2.4.1, 2.4.2, 2.4.3, 3.1, Adoption of new template: Mod Rev Updated Applicability Table Modified table contents in Updated Applicability Table Updated Applicability Table 80000NT11347A Rev. 13 Page 23 of

24 [ ] Mod Rev.7