Manufacturing Tools for Milli 5

An Itron Partner's Guide to the Milli Application

Get your Partner tools here.

Introduction

 Milli modules leave the factory with no custom settings and are therefore highly customizable. The Milli Manufacturing Tools (MMT) Application provides multiple customization tools within one program, including:

  1. One Click 
    1. RF Test and Personalization
      •  Run RF Tests which validates the RF functionality of a Unit Under Test against a reference device. The optional personalization aspect of this tab executes a test that configures the Milli to communicate with the network. Configuration settings include the country code, network ID, CoAP, URI, etc. 
    2. ​​Current Draw Test Tab
      • Changes the Milli to Idle mode to support measuring current draw.
    3. Milli Personalization
      • Personalize a Milli using a configuration file without running the RF test. 
    • ​​​RSSI Values

      • ​​RSSI Max, RSSI Min, RSSI Avg valuescan be changed from this tab. Users can set Standard Value, Standard Upper Limit, Standard Lower Limit for RSSI Upper\Min\Avg. 
    • Test Report
      • Generate a test report that aggregates and sorts the data associated with one or more Milli device performance. 
      • For a detailed description of the generated test report, click here. 

    Generally, the MMT is designed to help partners with:

    • configuring network settings and Milli module settings to enable the Milli module to join the intended network
    • setting power consumption
    • setting persistent URIs
    • deciding how CoAP messages are brokered

     

    For definitions of the terms used throughout this guide, see the table at the bottom of this page.


    Prerequesites for MMT Application

    The sections below describe the pre-requisites for installing and running MMT. Follow the instructions below to complete the RF Test and Milli Personalization.

    Before installing and operating MMT, ensure you have the following:

    Hardware

    • 2 Milli5 units 
      • Known Good Unit (KGU) 
      • Unit Under Test (UUT)
    • USB/TTL smart cable
    • Micro USB Cable
       

    Software

    • Operating System: Windows 7, Windows 8, or Windows 10
    • Milli Manufacturing Tools Application Windows Installer Package, available for download here.
       

    Images on Milli

    • If you intend to personalize your Milli device, ensure that the Hardware Test Image is on Slot 1 of the Milli.
    • If you intend to perform RF Test, ensure that the Self Test Image is on Slot 3 of the Milli. 
      Note: In this documentation, "Image" and "Mode" mean the same thing, that is, the operating state of the Milli. 

       

    Files

    If you intend to personalize your Milli device, make sure you have access to the following:

    •  Milli Personalization profile document (JSON file) . These are explained and downloadable from here or from Document Center.

    Installing

    The Milli Manufacturing installer package contains the MMT Application executable. To install MMT: 

    1. Download the Mill Manufacturing Tools Application Installer from here.
    2. Navigate to the Windows File Explorer path, where the Milli Manufacturing Package is visible after download.
      Note: The default path follows this format:​ Downloads\MilliManufacturingToolsInstaller.
    3. Double click on MilliManufacturing Tools.Installer.
    4. Follow the prompts to complete the installation.
      When the installation is complete, a shortcut to the application and a folder containing the source code of the application appears on the Desktop. 

    Launching

    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 to the main screen.
      Tip: Itron recommends you also click 'Don’t show me this again' for an improved user experience on a subsequent launch of the application.

    One Click Tab

    This tab allows users to perform all the tests from same tab on a single button click.

    When a Milli is integrated with a sensor, two set of tests are typically executed on the integrated device:

    • RF Test: This test is done to validate the RF functionality of a Unit Under Test against a reference device
      Note: The RF Test is performed in Self Test mode/ Image mode. After the test is complete, the Milli is left in Self Test mode / Image mode.
    • Personalization: This test configures the Milli to be able to communicate with the network. Configuration includes setting country code, network id, CoAP URI, etc.

    To Perform All Three Tests

    1. Launch the Milli Manufacturing Tools Application.
    2. Click the dropdown menu next to UUT COM PORT. Select the COM port the Unit Under test is connected to.
    3. In the Draw Test section, cick the Power Configuration dropdown menu, and select from the following options:
      1. Wake up after a time period 
        • This requires configuring Wake up time.
      2. Wake up with a pin change
        • This requires selecting the Wakeup pin DIO ID and configuring the Logic State.
    4.  In the RF Test section, click the COM PORT dropdown menu, and select the COM port for the Known Good unit. 
      Note: If the COM ports are not populated, click the Refresh button. 
    5. In the Personalization section, click Browse
    6. Locate and select the metadta json file to be used for Personalization. 
    7. Click Start. The tests begin to execute in the following order: 
      1. Draw Test
      2. RF Test
      3. Personalization 


    Test Execution Flow

    When this test executes, the following actions are performed in order.  

    Draw Test

    1. MMT checks whether UUT is running hardware test image to configure Milli for Draw Test.  
      • If not, MMT asks user to click OK, then restarts Milli unit to perform Set Boot process to switch to hardware test image.
    2. Once the Milli is on hardware test, MMT configures Milli for current draw test using the input values provided by user in step 2 above.
    3. If configured successfully, a Succes dialog box displays and the user is prompted to click one of the following: 
      • PASS. This saves the draw test results for later and begins the Draw Test. 
      • FAIL. This fails the test, and stops further execution. 
      • CANCEL. This cancels all tests, and does not save the draw test results. 
    4. After the Draw Test ends, Milli operates on the hardware test image.

     

    RF Test

    1. MMT checks whether UUT is running in Self-test image. 
      • If not, MMT asks user to click OK, then restarts Milli unit to perform Set Boot process to switch to Self-test image. 
    2. Once the Milli is on Self-test image, MMT starts the RF Test. 
      • The packet success percentage displays as the test is executed. 
      • The status of each step displays in the progress bar, as well as status updates in the status bar.
      • MMT displays any errors in a dialog box with the error. If an error is generated, RF test execution halts.
    3. After the RF test ends, Milli operates on Self-test image. 

     

    Personalization 

    1. MMT checks whether UUT is running hardware test image to configure Milli for Draw Test for Personalization.
      1. If not, MMT asks user to click OK, then restarts Milli unit to perform Set Boot process to switch to hardware test image.
    2. Once the Milli is on hardware test, MMT reads the data from the metadata configuration file uses it to start the personalization process.
    3. If personalized successful, the Mili switches to production/standard operating image on reboot.
      • The status of each step displays in the progress bar, as well as status updates in the status bar.
      • MMT displays any errors in a dialog box with the error.
      • If an error is generated, the Milli remains in hardware test mode.
    4. After Personalization successfully completes, Milli runs on Production/standard operating image on reboot.

    Viewing Logs

    View the logs generated during the RF Test and Personalization process.

    1. Click View Logs. This will open the location where the Logs folder resides on your machine. 
    2. Click the folder labeled Logs. The folder contains the following documents: 
      • RMALib.log
      • Milli Personalization.log

    Viewing Source

    View the source code of the Milli Manufacturing Tools application.

    1. Click View Source. This will open the location where the source code for the application is present.
      Note: A folder with the name MilliManufacturingToolsSourceCode will be available on the Desktop post the installation.
    2. Click the folder labeled MilliManufacturingToolsSourceCode. The source files will be available.

    RSSI Values Tab

    The RSSI Values functionality of the Milli Manufacturing Tools application allows users to edit  RSSI Max, RSSI Min, RSSI Avg values.

    RSSI Values Tab

    1. Launch the Milli Manufacturing Tools application.
    2. Click the RSSI Values tab. 
    3. Set the RSSI Max, RSSI Min, and the RSSI Avg for the following values and limits: 
    • Standard Value
    • Standard Upper Limit
    • Standard Lower Limit for RSSI Upper
    1. Click Save. The changes are saved to the database. 


    Test Report Tab

    The Test Report functionality of the Milli Manufacturing Tools application gives users the ability to view details of the tests conducted on multiple Milli devices. For a detailed description of the generated test report, click here.

    To Generate a Test Report

    1. Launch the Milli Manufacturing Tools application.
    2. Click the Test Report tab.
    3. Click the dropdown under Start Date and select the date from which you want the test to include data.
    4. Click the dropdown under End Date and select the date at which you want the test to stop including data.
    5. Click the dropdown under Product and select the device you are running the test for.
    6. Click Generate Report. A CSV file called TestReport generates. You can save this file on your machine. ​


     

    Preset Configuration Profiles

    Preset Configuration Profiles that accommodate “standard” configurations are provided automatically. For example, the Milli5 HDK, which is not powered by a battery, has less latency and higher performance. The preset profiles can be loaded into the personalization editor and modified by using the available UI.

    Sample preset profiles that can be used to personalize the Milli include the following: 

    • Leaf Node Aggressive (Dev Kit) – recommended configuration for Developer Kits with more aggressive discovery and listening cycles
    • Leaf Node Long Battery Life CoAP Observe – recommended discovery and listening cycles for long (5-20) battery life 
      • Sensor initiated messages to be retrieved with a CoAP client making an Observe request to the device using the CoAP API
    • Leaf Node Long Battery Life MQTT Bubble Up - recommended discovery and listening cycles for long (5-20) battery life
      • Sensor initiated messages to be retrieved with MQTT client subscribing to the topic of interest using the MQTT API

     

    Itron's Milli5 firmware is designed to have the ability to operate in more than one environment. Configuration settings that affect Milli behavior vary accordingly. Newer versions of firmware may support new settings. If the target firmware has changed, it is possible to open and save an existing profile and overwrite existing settings per the new version of the firmware.


    Setting Up the Milli

    The following pins must be connected to the Milli5.

    The Milli5 requires 3.3v power supply.  The pins for this are:

    • Pin1 (power)
    • Pin2 (ground)
       

    The configuration UART for the Milli5 uses:

    • GPIO_26_ADC4 - pin14 (RX)
    • GPIO_27_ADC5 -  pin18 (TX)
    • Any ground pin
       

    To reset the Milli5:

    • Reset pin (Milli pin 53, RSET_N).  The reset pin is asserted by pulling it low (shorting to ground)

    Milli5 Pin Information

     

    Pin
    Name
    Direction from Milli5
    Information
    3
    TX
    out
    This pin is driven from the Milli5 and is for the coap interface.
    4
    RXD
    in
    This pin is an input to the Milli5 and is for the coap interface.
    5
    32KHz clock
    out
    A 32KHz clock comes out of this pin.  If anything is connected, the Milli5 uses extra current, but this clock could be used by a partner. For more information, contact Itron.
    6
    HWCCBYpass
    out
    This pin goes high in service mode and low other times.
    10
    BoostEn
    out
    This pin could be used to extend the voltage operating range.  Normal range is from 3.1V to 3.6V but this could be extended to 2.5V to 3.6 when the BoostEn signal is low and 3.1 to 3.6V when BoostEn is high.
    14
    gpio_26
    off normally, out during SIO load
    This is the debug uart TX pin. 
    18
    gpio_27
    off normally, out during SIO load
    This is the debug uart TX pin.
    19
    serviceMode
    in
    This is the service mode and tamper pin. This is an edge sensitive wakeup pin and is used to put the Milli5 is service mode. If this pin is held low for longer than five seconds, it generates a tamper message. If used, this pin should have a pull up or pull down.  It could also be tied to a rail.
    20
    coulombCount
    in
    This pin should be tied high or low.
    35
    security chip
     
     
    36
    security chip
     
     
    37
    gpio_5
    out
    This pin is part of the coap interface. It is driven by the Milli5 and is active low. When this pin is low, the MLILI5 is trying to wake up the host processor.
    38
    security chip
     
     
    42
    gpio_6
    in --> at boot
    out --> after boot
    This pin needs to be pulled high when powered on. After power on this pin can be left floating. This pin can drive an LED and is used to indicate service mode for the Milli5. 
    44
    gipo_7
    in
    This pin is part of the coap interface. It is an input pin to the MO;;O5 and is used to wake up the Milli5 so the host processor can send a message. This signal is active low.
    50
    nReset
     
     
    52
    jtag clk
     
     
    53
    jtag tms
     
     

     

    Terms and Definitions 

    Refer to the following table for terms used throughout this user guide. To return to the top of the page, click here. 

    Term
    Definition
    UUT
    Unit under test
    Personalization
    Applying customer-specific settings to the Milli
    Known Good Unit (KGU)
    A Milli known to operate within acceptable tolerances
    OTA
    Over The Air
    UI
    User Interface, here, of a Windows based application

    Areas of Personalization

     

     

    MMT APIs

    For a detailed description of the APIs for the Milli Manufacturing Tools Application, click here.