Awesome

DEPRECATED

This repository is deprecated and no longer maintained, please use the following forks:

• Android: NordicSemiconductor/Android-nRF-Connect-Device-Manager
• iOS: NordicSemiconductor/IOS-nRF-Connect-Device-Manager

McuManager Android

A transport agnostic implementation of the McuManager protocol. Contains a default implementation for BLE transport.

Gradle Install

Note: For the faster firmware upgrade implementation, use version 0.12.0-beta4 (this version is less stable and should be tested thoroughly with your app and device before being released into a production environment)

McuManager BLE (Recommended)

Contains the core and a BLE transport implementation using Nordic's Android-BLE-Library v2.

implementation 'io.runtime.mcumgr:mcumgr-ble:0.11.0'

McuManager Core

Core dependency only. Use if you want to provide your own transport implementation.

implementation 'io.runtime.mcumgr:mcumgr-core:0.11.0'

Introduction

McuManager is an application layer protocol used to manage and monitor microcontrollers running Apache Mynewt and Zephyr. More specifically, McuManagr implements over-the-air (OTA) firmware upgrades, log and stat collection, and file-system and configuration management.

Command Groups

McuManager are organized by functionality into command groups. In mcumgr-android, command groups are called managers and extend the McuManager class. The managers (groups) implemented in mcumgr-android are:

• DefaultManager: Contains commands relevent to the OS. This includes task and memory pool statistics, device time read & write, and device reset.
• ImageManager: Manage image state on the device and perform image uploads.
• StatsManager: Read stats from the device.
• ConfigManager: Read/Write config values on the device.
• LogManager: Collect logs from the device.
• FsManager: Download/upload files from the device file system.

Firmware Upgrade

Firmware upgrade is generally a four step process performed using commands from the image and default commands groups: upload, test, reset, and confirm.

This library provides a FirmwareUpgradeManager as a convenience for upgrading the image running on a device.

Example

// Initialize the BLE transporter with context and a BluetoothDevice
McuMgrTransport transport = new McuMgrBleTransport(context, bluetoothDevice);

// Initialize the FirmwareUpgradeManager
FirmwareUpgradeManager dfuManager = new FirmwareUpgradeManager(transport, dfuCallback)

// Start the firmware upgrade with the image data
dfuManager.start(imageData);

FirmwareUpgradeManager

A FirmwareUpgradeManager provides an easy way to perform firmware upgrades on a device. A FirmwareUpgradeManager must be initialized with an McuMgrTransport which defines the transport scheme and device. Once initialized, a FirmwareUpgradeManager can perform one firmware upgrade at a time. Firmware upgrades are started using the start(byte[] imageData) method and can be paused, resumed, and canceled using pause(), resume(), and cancel() respectively.

Firmware Upgrade Mode

McuManager firmware upgrades can actually be performed in few different ways. These different upgrade modes determine the commands sent after the upload step. The FirmwareUpgradeManager can be configured to perform these different methods using setMode(FirmwareUpgradeManager.Mode mode). The different firmware upgrade modes are as follows:

• TEST_AND_CONFIRM: This mode is the default and recommended mode for performing upgrades due to it's ability to recover from a bad firmware upgrade. The process for this mode is UPLOAD, TEST, RESET, CONFIRM.
• CONFIRM_ONLY: This mode is not recommended. If the device fails to boot into the new image, it will not be able to recover and will need to be re-flashed. The process for this mode is UPLOAD, CONFIRM, RESET.
• TEST_ONLY: This mode is useful if you want to run tests on the new image running before confirming it manually as the primary boot image. The process for this mode is UPLOAD, TEST, RESET.

Firmware Upgrade State

FirmwareUpgradeManager acts as a simple, mostly linear state machine which is determined by the Mode. As the manager moves through the firmware upgrade process, state changes are provided through the FirmwareUpgradeCallback's onStateChanged method.

The FirmwareUpgradeManager contains an additional state, VALIDATE, which precedes the upload. The VALIDATE state checks the current image state of the device in an attempt to bypass certain states of the firmware upgrade. For example, if the image to upload is already in slot 1 on the device, the State will skip UPLOAD and move directly to TEST (or CONFIRM if Mode.CONFIRM_ONLY has been set). If the uploaded image is already active, and confirmed in slot 0, the upgrade will succeed immediately. The VALIDATE state makes it easy to reattempt an upgrade without needing to re-upload the image or manually determine where to start.

License

This library is licensed under the Apache 2.0 license. For more info, see the LICENSE file.