Milli Firmware Upgrade Application

A Guide to Upgrading Milli Firmware

Get your Partner tools here.

Overview

Millis delivered to partners may remain in inventory for some time prior to integration with a partner’s device. As a result, it can be necessary to load newer firmware images onto the Milli device to alleviate field issues and/or support new features. Depending on the manufacturing process, it might also be necessary to switch the operating image prior to integration. Typically these steps - especially firmware upgrade - are performed in bulk prior to assembly and test, although it can also be done on the manufacturing line.

The Milli Firmware Updgrade application described below allows users to upgrade firmware images on their Milli devices, as well as execute Set Boot-Set Image commands in a wired mode. Review the following instructions to complete any or all of the following actions:

  • Upload entire firmware image (includes 3 images)
  • Upload single firmware image
  • Set Boot-Set Image

 

Hardware:

  • Milli Module
  • USB/TTL smart cable
  • Micro USB cable

 

Software:

 

To download Milli Firmware Upgrade application

  1. Navigate to the Windows File Explorer path, where the Milli Firmware Upgrade application is visible after download.
    Note: The default path follows this format: Downloads\MilliFWUpgradeInstaller
     
  2. Double click on MilliFWUpgradeInstaller.msi.
     
  3. Follow the prompts to complete the installation.
     
  4. When the installation is complete, a Milli FW Upgrade shortcut and a MilliFWUpgradeSourceCode folder (which contains the source code of the application) appears on the Desktop. 

 

To run the Milli Firmware Upgrade application

  1. Double-click on the application desktop icon to open the app. The first time you open the application, a splash page displays. 
     
  2. Click Accept. Upon clicking Accept, the application launches with the following display:

Tip: Itron recommends you also click Don’t show again for an improved user experience on a subsequent launch of the application.

 

Types of Firmware Image Files

Firmware load files can contain one or more images. The following describes the supported contents:

  1. Entire Firmware Image (Package)

The Entire Firmware Image Package contains the following three images:

  • Hardware test image
    • Uploads to slot 1
    • Becomes the default operating image (to change the default operating image, perform a Set Boot by selecting the corresponding Image slot)
  • Standard Operating image
    • Uploads to slot 2
  • Self-Test image
    • ​Uploads to slot 3
  1. Single Firmware Image

This is commonly used to upgrade the Standard Operating Image, but any of the single images described in 1 above can be loaded to a specific slot. The Single Firmware Image can be used to update a specific image on a specific slot. It is commonly used to upgrade the Standard Operating Image.

 

Upload Complete Firmware Package (3 images)

  1. Click the dropdown under COM Port. Select the COM Port to which the Milli is connected. 
    Note: If the COM Ports do not populate in the dropdown menu, click the Refresh icon and try again. 

     
  2. If Firmware Upgrade needs to be performed on more than one Milli, click the Add icon. Select multiple COM Ports to which the Milli's are connected. 
    Note: Upgrades can be performed on no more than three Millis at a time. 
    Note: To remove a Milli from the Upgrade process, click the Remove icon. The most recently added device is removed.

     
  3. Click Browse. A file explorer opens.
     
  4. Navigate to the folder where the file for the firmware upgrade is stored. 
     
  5. Click Apply. The Milli MAC Address is retrieved and displayed, unless the Milli is running on Standard Operating Image or if there is no Milli connected. In that case, a series of stars ("****************") is displayed instead. 
    Note: A green progress bar to the right of the MAC Address field indicates that the Firmware upload process is either running (if the bar has not filled in completely) or has completely successfully. A red progress bar indicates that the Firmware upload process has failed. 

     
  6. On successful Firmware Upgrade, a FW Upload - Info message displays notifying success. Otherwise, a FW Upload - Error message displays notifying failure. 

 

Upload Single Firmware Image

  1. Click the dropdown under COM Port. Select the COM Port to which the Milli is connected. 
    Note: If the COM Ports do not populate in the dropdown menu, click the refresh icon and try again. 

     
  2. Select the Image Slot from the dropdown menu. 
     
  3. If Firmware Upgrade needs to be performed on more than one Milli, click the Add icon. Select multiple COM Ports to which the Milli's are connected. 
    Note: Upgrades can be performed on no more than three Millis at a time. 
    Note: To remove a Milli from the Upgrade process, click the Remove icon. The most recently added device is removed.

     
  4. Click Browse. A file explorer opens.
     
  5. Navigate to the desired Firmware Image file. Select it. 
     
  6. Click Apply. The Milli MAC Address is retrieved and displayed, unless the Milli is running on Standard Operating Image or if there is no Milli connected. In that case, **************** is displayed instead. 
    Note: A green progress bar to the right of the MAC Address field indicates that the Firmware upload process is either running (if the bar has not filled in completely) or has completely successfully. A red progress bar indicates that the Firmware upload process has failed. 

 

Set Boot – Set Next Operating Image

  1. Click the dropdown under COM Port. Select the COM Port to which the Milli is connected. 
    Note: If the COM Ports do not populate in the dropdown menu, click the refresh icon and try again. 

     
  2. Select the Image Slot from the dropdown menu. 
     
  3. If Set Boot needs to be performed on more than one Milli, click the Add icon. Select multiple COM Ports to which the Milli's are connected. 
    Note: Set Boot can be performed on no more than three Millis at a time. 
    Note: To remove a Milli from the Upgrade process, click the Remove icon. The most recently added device is removed.

     
  4. Click Apply. The Milli MAC Address is retrieved and displayed, unless the Milli is running on Standard Operating Image or if there is no Milli connected. In that case, a series of stars ("****************") is displayed instead. 
    Note: A green progress bar to the right of the MAC Address field indicates that the Firmware upload process is either running (if the bar has not filled in completely) or has completely successfully. A red progress bar indicates that the Firmware upload process has failed. 

 

APIs for the Milli Firmware Upgrade Application

For a detailed description of the APIs for the Milli Firmware Upgrade application, click here.

 

Examples of Success and Failure

The following image illustrates single Firmware Image Upgrades on two Millis, as well as Set Boot-Set Image to three Millis. Both Firmware Image upgrades were successful, while only 2/3 Set Boot-Set Image commands succeeded.