Manufacturing Tools for Milli 5

An Itron Partner's Guide to the Milli Application

Get your Partner tools here.

Milli Manufacturing Tools Application

Introduction 

Milli modules are unique in that they leave the factory with no custom settings, and are therefore highly customizable. A partner integrating their sensor with the Milli5 needs a method to personalize each Milli, where personalization includes:

  • 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. 
     

The Milli Manufacturing Tools Application was designed to provide multiple tools within one program. On installation, the application includes the following features: 

  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. Milli Personalization
    • Personalize a Milli using a configuration file without running the RF test. 
  3. 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. 

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

The following diagram identifies the specific areas of personalization described later in this page.

 


 

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

 

Pre-requisites for Milli Manufacturing Tools Application

Before installing and operating the Milli Manufacturing Tools Application, ensure that 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 from the Document Center

 

Files

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

  •  Milli Personalization profile document (JSON file) 

 

Installing the Milli Manufacturing Tools Application

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

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

 

Launch the Application

To run the Milli Manufacturing Tools 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 this 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.

 

 


RF Test and Personalization Tab

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
  • Personalization: This test configures the Milli to be able to communicate with the network. Configuration includes setting country code, network id, CoAP URI, etc.

In addition to these tests, this tab also provides these options:

  • View Logs: View the logs generated during the RF Test and Personalization process.
  • View Source: View the source code of the Milli Manufacturing Tools application

 

To perform an RF Test:

  1. Launch the Milli Manufacturing Tools Application.
     
  2. Click the RF Test and Personalization tab.
     
  3. Click the dropdown menu under Serial Settings – Unit Under Test. Select the COM port the Unit Under test is connected to.
     
  4. Click the dropdown menu under Serial Settings – Known Good Unit. Select the COM port the Known Good Unit is connected to.​

Note: If the desired COM ports are not available in the dropdown menu, click the Green refresh arrow to the right of the dropdown option, and check again.

  1. Leave the Configuration File field blank, unless you also want to personalize the Milli. For more information on personalizing the Milli, see the next section describing how to perform an RF Test and Personalization.
     
  2. Click Start. The RF Test executes.

Note: The status of the RF test and which task (“UUT connected”, “RF Test Started”, “RF Test Completed”) is being executed can be seen in the progress bar.

 

 

To perform both the RF Test and Personalization:

  1. Launch the Milli Manufacturing Tools Application.
     
  2. Click the RF Test and Personalization tab.
     
  3. Click the dropdown menu under Serial Settings – Unit Under Test. Select the COM port the Unit Under test is connected to.
     
  4. Click the dropdown menu under Serial Settings – Known Good Unit. Select the COM port the Known Good Unit is connected to.

Note: If the desired COM ports are not available in the dropdown menu, click the green refresh arrow to the right of the dropdown option, and check again.

  1. Click Browse and navigate to the configuration file on your machine (a JSON file). 
     
  2. Select the configuration file and click Ok. The Configuration File field populates with the file path. 
     
  3. Click Start. The RF Test and personalization executes.

 

To view logs:

  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

 

To view source: 

  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.

  1. Click the folder labeled MilliManufacturingToolsSourceCode. The source files will be available.

 


Milli Personalization Tab

This tab is used to personalize the Milli. This test configures the Milli to be able to communicate with the network. Configuration options include: 

  • Country Code
  • Network ID
  • CoAP URI
  • and more

To personalize your Milli with a personalized configuration file:

  1. Launch the Milli Manufacturing Tools application.
     
  2. Click the Milli Personalization tab.
     
  3. Click the dropdown under COM Port. Select the COM Port the Unit Under Test is connected to.

Note: If the desired COM ports are not available in the dropdown menu, click Refresh and check again.

  1. Click Browse and navigate to the configuration file on your machine (a JSON file).
     
  2. Select the configuration file and click Ok. The Configuration File field populates with the file path.
     
  3. Click Personalize. A progress bar displays.
     
  4. On successful personalization, a Verify button displays (see image below).
     
  5. Click Verify to verify correct personalization of the Milli.

 

 


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. 

 

 


APIs for the Milli Manufacturing Tools Application

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

 

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: 

  • 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 needs to be powered up using a 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