User Guide

MI301 Software Update Tool

Version 2.1.0

1
1 Introduction

This document contains a user guide to a PC tool that can be used to upgrade the software in an
MI301 Mobile Interface. This PC tool is a Grundfos proprietary tool developed solely for this
maintenance purpose.

If you need help from Grundfos Service and Solutions go to www.grundfos.com for contact
information.

The PC tool is delivered as an executable Windows installer file called Mi301UpdateTool-

2.1.0_setup.exe. Included in the package is the latest MI301 software update called
MI301_SoftwareUpdate__v230.bin. During the installation procedure this software update file is
placed in a subdirectory of the PC Tool installation directory.

You will need the following to perform the SW update of your MI301:

1. Windows PC. The PC Tool has been tested with Windows 7 and Windows 10 PCs. It does
not work on Windows XP (or older). Also, it is known to not work properly on some
Microsoft Surface Pro tablets, introducing some GUI glitches.
2. USB cable. A standard USB-A connector to Micro USB-B connector cable is required
(pictured below).
3. Your MI301 Mobile Interface.

Connect your MI301 to the PC’s USB port using the USB cable before you start the PC tool.

2
2 Step by Step Guide

2.1 Installation guide

The PC Tool requires a Java Runtime Environment of version 8 (1.8) to run, it is recommended to
install this prior to installing the PC tool, although it can also be done afterwards.
The recommended and tested JRE is Amazon Coretto 8.
Please note, that running the program with any other versions of JRE than 8, might introduce
issues.

Installing the JRE

The JRE can be either found packaged alongside the PC tool and is named: amazon-corretto-
8.212.04.2-windows-x64.msi.

Alternatively, use the direct link below to access the page that contain the download of Amazon
Coretto 8:
https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html

1 - On the download list choose the .msi package under Windows x64 JDK.

Note: The version number might have incremented since the above screenshot.

Simply run the installer and follow the on-screen instructions to install the JRE.

Installing the PC tool

Once the JRE has been installed, the Mi301UpdateTool-2.1.0_setup.exe file can be run to install
the Grundfos GO MI301 Update Tool. From here follow the onscreen instructions.

3
2.2 Starting the PC Tool
To start using the MI301 Software Update Tool, navigate to G in the Windows Start Menu and
select the MI301 Update Tool from the Grundfos PC Tools folder:

Once the PC Tool is up and running, the following main window will be displayed:

Note that the button labelled Start Software Update is disabled. This button will be enabled once
an MI301 device has been successfully detected.

4
2.3 Selecting the MI301 Software Update File
When the PC Tool is started for the first time, it automatically loads the MI301 software update
file supplied with the PC Tool. The main window shows the MI301 software update file currently
selected:

If necessary, it is possible to use a different MI301 software update file. Go to the main menu
item: File -> Select MI301 software file:

5
This will bring up a file selection dialog titled Select MI301 software file to load:

Normally, only the software update file supplied with the PC Tool is available for selection. If
additional MI301 software update files are available, they will be listed in the file selection dialog
shown above. Select the desired software update file and click the Open button. The main
window will show the currently selected software update file.

2.4 COM Port Detection and Selection

When an MI301 Device is connected to the PC via USB it will become available as a USB virtual
serial port, denoted as COMx in Windows. To find the appropriate serial port the tool provides a
full list of available serial ports and indicates potential MI301 devices:

6
In case of multiple MI301 candidates one may simply try and select one to see if an MI301 device
is actually connected or plug/unplug the desired device and pressing the refresh button to see
which device appear/disappear.

Once a serial port with a functioning MI301 device attached has been selected, the tool will
inquire the attached MI for the type and version and the main window will be updated to display
this information:

Also, note that the button labelled Start Software Update is now enabled.

In the event that no MI301 device is attached to the selected serial port, the PC Tool will fail to
acquire the device information. After a short period of time during which the PC Tool is
attempting to communicate with the (non-existent) MI301 device, the resulting failure will be
shown in the main window:

7
If this should happen, simply try to select a different serial port until an MI301 device is finally
detected.

2.5 Starting the Software Update

Once an MI301 device has been successfully detected and an appropriate software update file
selected the software update may commence by pressing the Start Software Update button. The
progress of the update may be followed by observing the status text and the progress bar in the
main window:

8
The update procedure should be completed in approximately 5 minutes. If the update process
completed successfully, the Status message indicates that the update is complete and that the
MI301 device must be reset manually:

In order to ensure a full reset of the MI301, first disconnect the USB cable and then press and
hold the button on the MI301 for at least 3 seconds until the LED is turned off.

9
Finally, click the button (now labeled Prepare for New Software Update) in order to bring the PC
Tool back to its initial state. The PC Tool is now ready to perform another software update.

10
3 Failure Scenarios
3.1 Connection Timeout from MI301
The update procedure may fail for various reasons. For example, the MI301 could fail to validate
the checksum of the new software update or the USB connection fails – for instance if the USB
cable is unplugged by mistake. If the update procedure fails, the PC Tool allows the user to retry
the software update. To do this, manually reset the MI301 device using the HW button and then
press the button labeled Prepare for New Software Update:

3.2 Salvaging the MI301 from Bootloader State

In case of errors during the software update it is highly likely that the previous software was
erased from the FLASH memory – either partially or entirely. The MI301 software contains two
different components: A bootloader (or Self-programmer) and the actual MI301 application part.

In the event of errors during the update process, the bootloader will probably still be functional
and, if this is the case, it will still be possible to salvage the MI301. In such a case, the selection of
a MI301 device in the Serial Port selector will make the PC Tool attempt to validate the MI type
and retrieve the current software version. However, this will fail since the bootloader does not
have this information and is incapable of understanding the protocol used by the PC Tool in this
case. Furthermore, the application part of the MI301 software and the bootloader part employ
different communication speeds (baud rates). Thus, the attempt to retrieve this information will
timeout and the PC Tool will proceed to attempt to communicate directly with the bootloader. In
most cases, this will succeed and the resulting user interface will appear as follows:

11
In order to proceed to attempt to salvage the MI301, click the Start Software Update button. The
software update should then proceed as normal:

12
4 Known Issues
4.1 COM Port not Detected by the PC Tool
In some cases the PC Tool fails to detect a new serial port when an MI301 device is connected via
USB cable to the PC. Furthermore, clicking the refresh button and restarting the PC Tool does not
always fix this issue. In this case, it may be necessary to restart your Windows PC.

4.2 PC Tool Fails to Communicate with the MI301 due to a Bug in Device Driver
If the PC Tool fails to properly detect the MI301, the main window will be updated with this
information:

Should this happen, your first option is to make sure that the correct COM port has been selected.
Please use the method described in section 2.4 COM Port Detection and Selection.

If the issue persists, it may be caused by a known bug in the USB Serial Port device driver used by
Windows to present the MI301 as a serial port (COMx). This bug corrupts data transmitted from
the PC Tool to the MI301 thereby braking down the communication protocol used between the
PC Tool and the MI301.

A version of the USB Serial Port device driver known to have fixed this bug is bundled with the
MI301 Software Update Tool download package. This version of the device driver is suitable for
both 32 bit and 64 bit Windows operating systems and is installed by running the setup EXE file
called CDM21226_Setup.exe. Simply follow the installation instructions provided by this setup EXE
file.

13
Advanced users may check the release date of their current device driver to determine if it is
necessary to install the one bundled with the PC Tool. To do this, open the Properties window of
the corresponding USB Serial Port from within the Windows Device Manager. Then select the
Driver tab in the Properties window to reveal the date the driver was released. Your Driver Date
should not be prior to 28-09-2016:

Even though some drivers released prior to this date may not contain this critical bug, it is highly
recommended to update to the latest driver. Please note that, attempting to update the driver
from the Properties window (using the Update Driver… button) may not successfully find a newer
version of the driver. It should not do any harm to attempt this though, but if unsuccessful please
use the bundled driver installer instead.

4.3 The Main Window of the PC Tool is rendered incorrectly

On some Windows devices, the MI301 Software Update Tool is not displayed correctly. The
symptoms can be blurry text, misplaced or misaligned text and buttons and other UI glitches.
Worst case it can hinder functionality of the program.

In most cases the glitches can be remedied by the following hotfix.

14
4.3.1 Hotfix
Open the installation folder of the program. By default is will be installed in C:\Program Files
(x86)\Grundfos\Mi301UpdateTool

Right click the Mi301UpdateTool.exe file and change setting:

1. Click the Compatibility ribbon and

2. select Change high DPI settings
3. Check the Override high DPI scaling behavior.
4. Under Scaling performed by: select Application
5. Click OK

15