ENF0000AN002 FOTA. Application Note

Transcription

1 ENF0000AN002 FOTA Application Note Version: December, 2013

2 General TERMS OF USE OF NEW MATERIALS - PLEASE READ CAREFULLY From time to time, Novatel Wireless M2M, in its sole discretion, may make available for download on its website ( or may transmit via mail or , updates or upgrades to, or new releases of, the firmware, software or documentation for its products (collectively, 'New Materials'). Use of such New Materials is subject to the terms and conditions set forth below, and may be subject to additional terms and conditions as set forth in Novatel Wireless M2M's Technical Support Policy (posted on its website) and/or any written agreement between the user and Novatel Wireless M2M. All New Materials are provided AS IS. Novatel Wireless M2M makes no warranty or representation with respect to the merchantability, suitability, functionality, accuracy or completeness of any such New Materials. The user of such New Materials assumes all risk (known or unknown) of such use. Novatel Wireless M2M reserves all rights in such New Materials. The user shall have only a revocable and limited license to use such New Materials in connection with the products for which they are intended. Distribution or modification of any New Materials without Novatel Wireless M2M's consent is strictly prohibited. IN NO EVENT WILL Novatel Wireless M2M BE RESPONSIBLE FOR ANY INCIDENTAL, INDIRECT, CONSEQUENTIAL OR SPECIAL DAMAGES AS A RESULT OF THE USE OF ANY NEW MATERIALS. Novatel Wireless M2M'S MAXIMUM LIABILITY FOR ANY CLAIM BASED ON THE NEW MATERIALS SHALL NOT EXCEED FIFTY U.S. DOLLARS ($50). Version Verification Please ensure you have the latest version of this document by downloading it from i novatelwireless.com

3 Copyright 2013 Novatel Wireless, Inc. All rights reserved. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording or otherwise), or for any purpose, without the express written permission of Novatel Wireless, Inc. Novatel Wireless M2M and the Novatel Wireless M2M logo are either registered trademarks or trademarks of Novatel Wireless, Inc. in the United States. 251 Renner Pkwy Richardson, TX USA Phone: (972) Fax: (972) info@nvtl.com ii novatelwireless.com

4 Table of Contents 1 Introduction 1 Prerequisites 2 FOTA Upgrade Server 2 FTP Server 2 Firmware Upgrade Files 3 GSM Devices 3 CDMA Devices 3 2 FOTA Process 4 Automatic Mode 5 Manual Mode 5 Typical FOTA Upgrade Time 6 3 AT Commands 7 FOTA Specific AT Commands 8 AT$FOTACFG Configure Firmware Upgrade 9 AT$FOTACFG Configure Firmware Upgrade 11 AT$FOTAGET Get Firmware Upgrade OTA 12 AT$FOTAUPG Upgrade Current Firmware 14 AT$FOTAUPG Upgrade Current Firmware 16 AT$UPSTATUS Status Of Last Upgrade 17 4 Examples 19 CDMA Devices 27 GSM Devices 27 iii novatelwireless.com

5 1 Introduction Prerequisites 1 novatelwireless.com

6 This document explains the configuration and execution of the Firmware Over The Air (FOTA) features. These instructions are for devices with current firmware of PKG 47 and later. Please contact Technical Support for instructions for devices with earlier firmware versions. Prerequisites You need the following to configure FOTA for your device(s): FOTA Upgrade Server File Transfer Protocol (FTP) Server Firmware Upgrade Files FOTA Upgrade Server The FOTA Upgrade Server controls and initiates the FOTA configuration on the modem. The FOTA Upgrade Server should be capable of the following: 1. Delivering Over the Air (OTA) AT commands to the modem 2. Receiving OTA AT command responses from the modem 3. Receiving OTA Unsolicited Response Codes (URCs) from the modem For the FOTA Upgrade Server to receive final FOTA status after an interrupted FOTA transfer, the FOTA Upgrade Server must be configured to support the specific FOTA status messages. FTP Server The FTP server delivers the firmware upgrade files OTA using File Transfer Protocol. The FTP server does not need to be co-located with the FOTA Upgrade Server. The modem will access the FTP server via a TCP connection to transfer the FOTA file. FOTA can restart an interrupted FTP file transfer. Novatel Wireless M2M products support the following methods of sending AT commands remotely OTA: UDP API TCP API 2 novatelwireless.com

7 Firmware Upgrade Files Novatel Wireless M2M provides firmware upgrade files which should be stored on the FTP server. We recommend you create a directory named Novatel Wireless M2M in the root FTP directory, then create another one within that directory and name it: "FOTA". For example: <ftprootdirectory>/novatel Wireless M2M/FOTA The firmware upgrade file is dependent upon the current firmware version. Use the AT$PKG Command to determine the current firmware version on your modem and contact Novatel Wireless M2M Technical Support to get the proper firmware upgrade file. GSM Devices The average firmware upgrade delta file is 250K bytes. The maximum firmware upgrade delta file size is 500K bytes. CDMA Devices The average firmware upgrade delta file is 500K bytes. The maximum firmware upgrade delta file size is 1792K bytes 3 novatelwireless.com

8 2 FOTA Process Automatic Mode Manual Mode Typical FOTA Upgrade Time 4 novatelwireless.com

9 You can execute the FOTA process in Manual or Automatic Mode. You can obtain the current version of the device firmware by using the AT$PKG Command. Automatic Mode The default (recommended) mode for the FOTA process is Automatic, which has the following steps: 1. Get the FOTA upgrade file and verify it is applicable to your device. 2. Copy the FOTA upgrade file to the FTP server. 3. Ensure your device is connected to the server. 4. Configure the modem with the FOTA configuration parameters using the AT$FOTACFG command. 5. Initiate the FOTA file transfer using the AT$FOTAGET command. The AT$FOTAGET command will complete the FOTA upgrade process and no further commands are necessary. The modem will automatically restart with the new firmware after the FOTA file is complete. Manual Mode Novatel Wireless M2M does not recommend using this optional manual mode. Manual Mode requires the same steps as Automatic Mode; however, the AT$FOTAGET command will stop after the FTP transfer of the FOTA file is complete. The AT$FOTAGET command confirms that the FOTA file has successfully transferred to the modem's flash memory. Use the AT$FFS command to verify that the FOTA delta file is in the Flash File System of the modem. Use the AT$FOTAUPG command to complete the FOTA upgrade process. The AT$FOTAUPG applies the upgrade file and restarts the modem with the new firmware. 5 novatelwireless.com

10 Typical FOTA Upgrade Time Some of the factors that affect FOTA upgrade time are: Size of the FOTA file Signal strength Network congestion Cellular service availability 6 novatelwireless.com

11 3 AT Commands FOTA Specific AT Commands 7 novatelwireless.com

12 FOTA Specific AT Commands For GSM devices prior to PKG 47 please contact Technical Support for assistance. The following AT Commands are specific to the FOTA process: AT$FOTACFG - Configure Firmware Upgrade AT$FOTAGET - Get Firmware Upgrade OTA AT$FOTAUPG - Upgrade Current Firmware AT$UPSTATUS - Status of Last Upgrade Any parameter may be left unspecified by using a comma separator to step to the next parameter, which leaves either the default value or the pre-existing saved value active. 8 novatelwireless.com

13 AT$FOTACFG Configure Firmware Upgrade AT$FOTACFG Command Function Configure Firmware Upgrade This command allows the user to configure the modem Firmware Over The Air (FOTA) Server. Syntax Query Syntax AT$FOTACFG=? $FOTACFG: "host",( ),"username","password",(0,1),(0-20),(0,1),(0,1),(0,1) OK Write Syntax Write Response AT$FOTACFG=< ftpserverhostname >,<ftpport>,< ftpusername >, < ftppassword >,<ftpmode>,<retries>,<reportmode>,<upgrademode>, <upgradestatus> OK Read Syntax Read Response Execute Syntax Execute Response Unsolicited Response AT$FOTACFG? $FOTACFG: < ftpserverhostname >,<ftpport>,< ftpusername >, < ftppassword >,<ftpmode>,<retries>,<reportmode>,<upgrademode>, <upgradestatus> Parameter Values <ftpserverhostname> Either Fully Qualified Domain Name (FQDN) or a dotted-decimal IP address of the FTP server. The FQDN is resolved by DNS immediately prior to opening IP connection to FTP server. The FQDN may be up to a maximum of 63 characters. Default value: none. <ftpport> The TCP port number on the FTP server. Port range: Default value: 21 <ftpusername> FTP login name on the FTP server. The username may be up to a maximum of 31 characters. Default value: none. <ftppassword> The FTP password for the FTP user. The password may be an empty string if the FTP user does not have a password. The password may be up to a maximum of 31 characters. Default value: none. <ftpmode> The FTP mode is used for data connections. FTP data connections may be active or passive. Passive mode is generally better to use with FTP servers located behind firewalls. Values: 9 novatelwireless.com

14 AT$FOTACFG Configure Firmware Upgrade 0 = active 1 = passive Default value: 1 (passive mode). <retries> This is the maximum number of FTP file resumes to attempt before giving up on the original AT$FOTAGET command. The range of retries is Default Value: 0. <reportmode> The reporting mode is used to control the level of status reporting during the FOTA process. Normal reporting mode sends only critical status updates, extended reporting mode sends informative and critical status updates. The command parameters are: 0 = normal reporting 1 = extended reporting Default value: 0 (normal reporting mode). <upgrademode> The system behavior following successful FOTA file transfer to modem. The upgrade Mode may be either Automatic or Manual. Auto mode will immediately initiate FOTA upgrade when file transfer completes. Manual mode will wait after file transfer and an explicit upgrade command is issued (AT$FOTAUPG). The command line parameters are: 0 = auto 1 = manual Default value: 0 (automatic mode). <upgradestatus> Controls the generation of FOTA Finish status. FOTA Finish status is reported after the modem reboots from a FOTA upgrade or as a result of a fatal error. This status is only returned OTA. The command line parameters are: 0 = disabled 1 = enabled FOTA finish status is disabled by default. Notes Refer to Novatel Wireless M2M Application Note ENF000AN002 for more information on FOTA operations 10 novatelwireless.com

15 AT$FOTACFG Configure Firmware Upgrade AT$FOTACFG Command Function Configure Firmware Upgrade This command allows the user to configure the modem Firmware Over The Air (FOTA) Server. Syntax Query Syntax AT$FOTACFG=? $FOTACFG: "host",( ),"username","password",(0,1),(0-20),(0,1),(0,1),(0,1) OK Write Syntax Write Response AT$FOTACFG=< ftpserverhostname >,<ftpport>,< ftpusername >, < ftppassword >,<ftpmode>,<retries>,<reportmode>,<upgrademode>, <upgradestatus> OK Read Syntax Read Response Execute Syntax Execute Response Unsolicited Response Parameter Values <ftpserverhostname> Either Fully Qualified Domain Name (FQDN) or a dotted-decimal IP address of the FTP server. The FQDN is resolved by DNS immediately prior to opening IP connection to FTP server. The FQDN may be up to a maximum of 63 characters. Default value: none. <ftpport> The TCP port number on the FTP server. Port range: , Default value: 21 <ftpusername> <ftppassword> <ftpmode> <retries> <reportmode> FTP login name on the FTP server. The username may be up to a maximum of 31 characters. Default value: none. The FTP password for the FTP user. The password may be an empty string if the FTP user does not have a password. The password may be up to a maximum of 31 characters. Default value: none. The FTP mode to use for data connections. FTP data connections may be active or passive. Passive mode is generally better to use with FTP servers located behind firewalls. Values: 0 = active, 1 = passive. Default value: 0 (active mode). This is the maximum number of FTP file resumes to attempt before giving up on the original AT$FOTAGET command. The range of retries is Default Value: 0. The reporting mode is used to control the level of status reporting during the FOTA process. Normal reporting mode sends only critical status updates. Extended reporting mode sends informative and critical status updates. The command parameters are: 0 = normal reporting, 1 = extended reporting. Default value: 0 (normal reporting mode). 11 novatelwireless.com

16 AT$FOTACFG <upgrademode> <upgradestatus> Notes Configure Firmware Upgrade The system behavior following successful FOTA file transfer to modem. The upgrade Mode may be either Automatic or Manual. Auto mode will immediately initiate FOTA upgrade when file transfer completes. Manual mode will wait after file transfer until an explicit upgrade command is issued (AT$FOTAUPG). The command line parameters are: 0 = auto, 1 = manual. Default value: 0 (automatic mode). Controls the generation of FOTA Finish status. FOTA Finish status is reported after the modem reboots from a FOTA upgrade or as a result of a fatal error. This status is only returned OTA. The command line parameters are 0 = disabled and 1 = enabled. FOTA finish status is disabled by default. Refer to Novatel Wireless M2M Application Note ENF000AN002 for more information on FOTA operations AT$FOTAGET Get Firmware Upgrade OTA AT$FOTAGET Command Function Syntax Query Syntax Get Firmware Upgrade OTA This command will initiate a connection to the FOTA Server to download the FOTA Delta File. The FOTA Server is defined with the $FOTACFG command. AT$FOTAGET=? $FOTAGET: "remotefilename" OK Write Syntax Write Response AT$FOTAGET=<"remotefilename"> OK Read Syntax Read Response AT$FOTAGET? $FOTAGET: <fotastate>,<"remotefilename">,<retriesremaining>, <fotacompletionstatus>,<uaerrorcode> Execute Syntax Execute Response Unsolicited Response Parameter Values <fotastate> Current FOTA mode indicating if FOTA is in the process of transferring a FOTA file. 0 = IDLE 1 = BUSY <"remotefilename"> <retriesremaining> The upgrade package file name. The number of FTP resumes remaining before terminating file transfer. This number starts with the retries specified in the AT$FOTACFG command and is decremented for each FOTA restart which occurs. 12 novatelwireless.com

17 AT$FOTAGET <fotacompletionstatus> Get Firmware Upgrade OTA Status of the last FOTA result. 0 = Success 1 = Failure, specific error not specified 2 =FTP Server configured 3 = File transfer started 4 = File transfer in progress 5 = File transfer complete 6 = File transfer restarted 7 = File transfer error 8 = Upgrade failed 9 = Upgrade completed successfully 10 = Upgrade initiated 11 = Network error 12 = File error 13 = Authorization error 14 = DNS error 15 = Timeout error 16 = Retry count exceeded 17 = Flash size error 18 = FTP busy error Notes Refer to Novatel Wireless M2M Application Note ENF000AN002 for more information on FOTA operations 13 novatelwireless.com

18 AT$FOTAGET will generate various Unsolicited Result Codes (URCs) to provide status information to the user during the FOTA process. These URCs will be of either $FOTAGET: <status> or $FOTAUPG: <status>. The configured Reporting Mode (extended reporting or normal reporting) will affect which URCs are displayed. Normal reporting mode is limited to errors and important changes in status. The extended reporting mode will report all the normal reporting mode values and additional status URCs. The status values for both the $FOTAGET and $FOTAUPG URCs are shown in Appendix A. AT$FOTAUPG Upgrade Current Firmware AT$FOTAUPG Command Function Upgrade Current Firmware This manual command is used to initiate a FOTA upgrade after FOTA file has been successfully transferred to the modem. This command should only be used if the manual mode is selected by AT$FOTACFG or if the FOTA delta file is transferred to the modem manually using FTP or some other method. AT$FOTAUPG should not be used if automatic mode is configured in AT$FOTACFG because the upgrade process is started by the modem in automatic mode. AT$FOTAUPG resets the modem and starts the FOTA upgrade agent process. Syntax Query Syntax AT$FOTAUPG=? OK Write Syntax Write Response Read Syntax Read Response Execute Syntax Execute Response Unsolicited Response Parameter Values AT$FOTAUPG OK Notes Refer to Novatel Wireless M2M Application Note ENF000AN002 for more information on FOTA operations. Refer to AT$FOTACFG for automatic versus manual upgrade mode description. Example 14 novatelwireless.com

19 15 novatelwireless.com

20 AT$FOTAUPG Upgrade Current Firmware AT$FOTAUPG Command Function Syntax Query Syntax Upgrade Current Firmware This function is used to initiate the FOTA upgrade process. It assumes that a binary delta file exists in the FFS with the name current_delta.bin. This file will typically be moved to the FFS via FTP functions or other FOTA specific functions. Write Syntax Write Response Read Syntax Read Response Execute Syntax Execute Response Unsolicited Response Parameter Values AT$FOTAUPG OK Notes Example Refer to Novatel Wireless M2M Application Note ENF000AN002 for more information on FOTA operations 16 novatelwireless.com

21 AT$UPSTATUS Status Of Last Upgrade AT$UPSTATUS Command Function Syntax Query Syntax Status of Last Upgrade This function may be used after the FOTA upgrade process. If the upgrade process was successful it will return Write Syntax Write Response Read Syntax Read Response Execute Syntax AT$UPSTATUS Execute Response OK Unsolicited Response Parameter Values <option> Notes 17 novatelwireless.com

22 18 novatelwireless.com

23 4 Examples 19 novatelwireless.com

24 Example Scenario (GSM Devices) The following is an example scenario for a successful FOTA upgrade: AT$FOTACFG="ftpServer,21, user, password,0,0,1,0 <- FOTA configured AT$FOTAGET="fota.bin" <- FOTA file transfer initiated OK $FOTAGET: 2 <- indicates FTP server is configured $FOTAGET: 5 <- indicates file transfer is complete $FOTAUPG: 10 <- indicates upgrade initiated AT-Command Interpreter ready <- system restarted due to auto mode AT$FOTAGET? <- query upgrade status $FOTAGET: 0, fota.bin, 0, 0,0 <- indicates upgrade successful The following is an example error scenario illustrating FOTAGET requesting an incorrect FOTA file: AT$FOTAGET= wrongfota.bin" OK $FOTAGET: 2 $FOTAGET: 5 $FOTAUPG: 10 AT-Command Interpreter ready AT$FOTAGET? $FOTAGET: 0, wrongfota.bin, 0, 0, 176 <- FOTA file transfer initiated <- indicates FTP server is configured <- indicates file transfer is complete <- indicates upgrade initiated <- system restarted due to auto mode <- query upgrade status <- 176 indicates upgrade failed due to checksum validation mismatch Example Scenario (CDMA Devices) The following is an example scenario for a successful FOTA upgrade: AT$FOTACFG="ftpServer,21, user, password,0,0,0,0 <- FOTA configured for automatic mode AT$FOTAGET="fota.bin" OK <- FOTA file transfer initiated $FOTAGET: 2 <- URC indicates FTP server is configured $FOTAGET: 5 <- URC indicates file transfer is complete $FOTAUPG: 10 <- URC indicates upgrade initiated AT-Command Interpreter ready <- system restarted due to auto mode AT$FOTAGET? <- query upgrade status $FOTAGET: 0, fota.bin, 0, 0,0 <- indicates upgrade successful 20 novatelwireless.com

25 Appendix A - Unsolicited Result Codes FOTA URC Status The Unsolicited Result Code values for both the $FOTAGET and $FOTAUPG URCs are as follows: Status Value Meaning Type 0 Success Status, normal reporting and extended reporting 1 Failure, specific error not specified Error 2 FTP Server configured Status, extended reporting 3 FOTA file transfer started Status, extended reporting 4 FOTA file transfer in progress Status, extended reporting 5 FOTA file transfer complete Status, normal reporting and extended reporting 6 FOTA file transfer restarted Status, normal reporting and extended reporting 7 FOTA file transfer error Error 8 FOTA upgrade failed Error 9 FOTA upgrade complete Status, normal reporting and extended reporting 10 FOTA upgrade initiated Status, normal reporting and extended reporting 11 FOTA file transfer network error Error 12 FOTA file transfer file error Error 13 FOTA FTP authentication error Error 14 FOTA DNS error Error 15 FOTA timeout exceeded Error 16 FOTA maximum retries exceeded Error 17 FOTA flash file system error Error 18 FOTA upgrade failed due to FTP client is busy Error FOTA Finish URC (GSM Devices Only) A status report of the FOTA upgrade can be requested. The status report is called FOTA Finish URC and is returned when the modem reboots after a FOTA upgrade.this status is only returned over the air. The format of the FOTA Finish URC is $FOTAFIN: <status>,<package> and is described here: status Indicates the success or failure of the FOTA upgrade. Section 1.8 describes the values 21 novatelwireless.com

26 package reported in this parameter. This is the post-upgrade Novatel Wireless M2M package string (AT$PKG) and reflects the currently executing software version. 22 novatelwireless.com

27 FOTAGET Upgrade Status Values FOTA upgrade status values are displayed by using the AT$FOTAGET? query. The status values are set by the upgrade process after the system restarts and are valid for the previous upgrade attempt. The most common error, 176, results from attempting to perform a FOTA upgrade with a FOTA file not specifically created for the target platform. Status Value Meaning 0 Success GSM FOTAGET Upgrade Status Values 32 Failure to open the checksum interface, which generally means that memory could not be allocated for it. 33 Failure to open the Update Package. 34 Failure to perform a self backup of the Update Agent. 48 Invalid Update Package ID. This is most likely caused by no package existing. 49 Invalid Update Package format ID. 50 Invalid Update Header. The package is most likely corrupted. 51 Invalid Update checksum verification. The Update Package is probably corrupt. 52 Invalid Update Package file size. 56 Invalid Update Package, usually caused by corrupt data. 64 Failed to parse Update Package. 73 Failed to decode Update Package. 76 Failed to read Update Package file. 80 Failed to open Update Package file. 81 Failed to read Update Package file. 82 Insufficient memory to decode Update Package. 83 Error decoding Update Package. 97 Failure to allocate memory to process Update Package. 144 Lost synchronization during decoding of Update Package. 152 Failure in decoder to locate decompress data. 153 Error in flash erase. 154 Error in flash write. 155 Failure to locate required predictor. 156 Error in internal consistency error found by predictor. 160 Failure of updater to write backup data. 161 Failure of update to write data. 163 Failure to erase cleanup data. 23 novatelwireless.com

28 GSM FOTAGET Upgrade Status Values 176 Checksum validation mismatch. 177 Backup checksum mismatch. 178 Checksum mismatch. 192 Failure of Update Package validation. 193 Failure of Update Package updater. 208 Dispatcher read error. 209 Decoder read error. 210 Update read recovery error. 211 Updater read error. 212 Update backup read error. 213 Updater read verify backup error. 214 Updater read verify error. 215 Validator read error. 224 Updater compress error. 225 Updater compress open error. -1 General Status Error -2 Device not supported -3 File Access Error -4 File Open Error -5 File Size Error -6 File Read Error -7 File Close Error -8 File Access Error -9 Install Error -10 Checksum Error CDMA FOTAGET Upgrade Status Values Status Value Meaning 0 Success FOTA Delta file corrupted FOTA Delta file does not match currently installed firmware version Memory allocation failed Configuration data corrupted 24 novatelwireless.com

29 CDMA FOTAGET Upgrade Status Values Installed firmware is corrupted Security not supported Device API error Device layout not supported Busy, try again later FOTA file processing error, usually a result of attempting to use a mismatched delta file. 25 novatelwireless.com

30 FOTA Restart FOTA uses FTP as the underlying file transfer mechanism. If an FTP file transfer is interrupted, FOTA will automatically restart the FTP file transfer from the interrupted point repeatedly until the file is transferred. This automatic restart occurs when the system re-acquires an IP address. FOTA restart uses the FTP file resume feature specified in RFC3659. The FTP server must support FTP File Restart command (REST) in STREAMS mode as specified in RFC3659. FOTA is initiated with an Over-the-Air (OTA) AT command, so the user normally has an interactive terminal to the modem command window; however an interrupted FOTA file transfer usually results in terminating the original OTA AT Command connection. On the subsequent IP address acquisition, the FOTA process (if configured) will attempt to restart the interrupted FTP file transfer but no longer will have a remote OTA connection to send status URCs. FOTA supports notifications by enabling FOTA input events and an appropriate Event Engine script. 26 novatelwireless.com

31 FOTA Finish Notification FOTA can be initiated OTA by sending AT commands using Novatel Wireless M2M s proprietary messages over UDPAPI, TCPAPI, and SMS transports. While some intermediate FOTA status messages are returned OTA, final status, and specifically terminal or fatal errors have not been sent OTA in prior releases. The FOTA Finish Status support is platform specific as described in the following sections. CDMA Devices Two major phases of a FOTA operation: FTP transfer of the FOTA delta file Replacement of the firmware and subsequent system restart with the new firmware The FOTA process works with the Event Engine to provide customer defined actions of these two phases. At the end of each phase, FOTA sends the appropriate input event to the Event Engine. Any available output event can be triggered using an Event Engine script. The most common Event Engine script could send a UDPAPI message to a remote host. See the AT$EVENT command for more information. GSM Devices The Modem will restart with the new firmware following a FOTA operation. When the Modem acquires an IP address, a "FOTA Complete" message (UDPAPI) will be sent to the first server in the FRIENDS list. The "FOTA Complete" message contains the Modem ID, the Restart Cause Code (which is set to FOTA Restart), and the new Firmware Version Number. FOTA upgrades initiated over UDPAPI, TCPAPI, or SMS can return FOTA restart status, FOTA Finish status, and all terminal or fatal errors. Collectively, these status messages are called FOTA Finish status. FOTA Finish status is enabled using a new parameter in the AT$FOTACFG command. FOTA Finish status is an OTA message sent to the user that reports the status of a FOTA upgrade attempt (whether it succeeds or fails). The FOTA Finish message consists of ASCII string-based URC s. Message $FOTAGET $FOTAUPG $FOTAFIN Description <status> reports fatal FTP errors and File Transfer Complete <status> reports fatal errors found in the FOTA upgrade file <status>,<version> reports fatal errors that are discovered after the FOTA upgrade has been initiated. The main use for this URC is to report successful FOTA upgrades 27 novatelwireless.com

32 Some Novatel Wireless M2M integrated products contain a power management CPU with upgradeable software. For these products, the FOTA Finish status appears after the successful upgrade of the power management CPU. 28 novatelwireless.com

33 FOTA Message Transports (GSM Devices Only) FOTA is configured and initiated using AT commands described in this document. While FOTA upgrades can be configured and initiated from a directly connected RS-232 or USB terminal, the primary communications method is OTA. Novatel Wireless M2M products support three methods of sending AT commands remotely OTA. UDPAPI TCPAPI SMS When you get a FOTA Restart or a FOTA Finish status returned, it means the original communications channel has been lost due to a modem reset. A returned FOTA Finish status uses preconfigured information in the modem along with information saved when the FOTA upgrade was initiated. A FOTA Finish status will return over the same communications transport that initiated the FOTA upgrade. A FOTA Finish status is sent according to these rules: UDPAPI/TCPAPI FOTA Finish status is sent to the first server listed in the AT$FRIENDS list. The header format is selected using AT$APIOPT. The format of these messages is explained in GSM0308UG001 Novatel Wireless M2M GSM/GPRS Family API Reference. SMS FOTA Finish status is sent to each entry in the AT$SMSDA list. The format of SMS messages is described in GSM0308AN001 Novatel Wireless M2M Enabler IIIG AT Commands Over SMS. 29 novatelwireless.com