Documentation

Mistake on this page? Email us

End to end Device Management Update development tutorials

These tutorials provide an introduction to the Update development workflow. They show you how to use Device Management Portal to create and manage firmware update campaigns, including:

  • Preparing your environment for building update firmware. This tutorial covers:
    • Getting a device certificate.
    • Getting an API key.
    • Creating the default authentication certificates for Device Management Update.
      • Installing and initializing the manifest tool.
  • Integrating Device Management Update client into your user application. This tutorial covers:
    • Configuring the user application to use Device Management Update client.
    • Authorizing the user application to install the firmware update.
    • Using callbacks to monitor the download progress of the firmware update.
    • Handling errors from Device Management Update client.
  • Building an update image on an Mbed OS device and on a Raspberry Pi 3. This tutorial covers:
    • Creating the firmware image (the OS, application file and Update client).
    • Creating the update image (the firmware image, its metadata and the bootloader).
  • Creating a firmware manifest: This tutorial covers:
    • Creating manifests using the manifest tool.
    • Testing a firmware update on a single device.
    • Preparing a manifest file for use in a campaign.
  • Creating an update campaign. This tutorial covers:
    • Creating a device filter to target specific devices.
    • Creating an update campaign.
    • Monitoring campaign phases.
    • Seeing campaign detailed metrics.

Assumptions

The tutorials assume:

  • You have a single device and are testing your application on it, rather than deploying many devices to production and updating firmware on devices deployed in the field.
  • You have not yet connected your device to Device Management.
  • You are using Device Management Portal. If you do not want to use Device Management Portal, you can use the Device Management APIs or SDKs to update your devices.

Resources

These tutorials use:

  • An Mbed OS device or Raspberry Pi 3.
  • An example application project, Device Management Update client, available in the mbed-cloud-client-example repository. If you do not have permission to access this repository, contact your account manager.
  • A developer certificate (rather than a production certificate).

Prerequisites

Before you start these tutorials, you should have: