Mistake on this page? Email us

Updating with Linux microPlatform (LmP)

This section explains how to do the following if you are using LmP:

Generate a delta firmware update package

To create a delta update package, go to the scripts-pelion-edge repository. Follow the instructions about using LmP with OSTree.

Initiate a firmware update campaign

Device Management pushes your firmware update package to a defined set of devices, which unpack the firmware update package and apply the updates within it.

You can initiate a firmware update campaign targeting any registered device from Device Management Portal.

Note: You can also initiate a firmware update campaign using the APIs, as explained in the Pelion Device Management online documentation.

To initiate a firmware update campaign:

  1. Upload the firmware update tar.gz package to Pelion Device Management:

    1. Log in to Device Management Portal.

    2. From the left navigation pane, select Firmware Update > Images.

    3. Click the + Upload Image button.

    4. Follow the instructions on the screen to upload the tar.gz file.

      After you upload the file, Device Management Portal displays a URL from which devices can download the tar.gz file.

  2. Create a firmware update manifest:

    Use the manifest-dev-tool utility to create a manifest file for your firmware update tar.gz package:

    manifest-dev-tool create -u <firmware.url> -p <delta.tar.gz> -o manifest
    

    Where:

    • <firmware.url> is the URL of the firmware update tar.gz package, as shown in Device Management Portal. Devices use this URL to download the firmware update image.
    • <delta.tar.gz> is the firmware update package tar.gz file. The manifest-dev-tool utility calculates a hash from the firmware update tar.gz.
    • Make sure the .manifest-dev-tool/ folder is in the current directory.
  3. Upload the firmware update manifest to Device Management:

    1. From the left navigation pane, select Firmware Update > Manifests.
    2. Click the + Upload Manifest button.
    3. Follow the instructions on the screen to upload the manifest file.
  4. Create a device filter to select a set of registered devices that should receive the firmware update package:

    1. From the left navigation pane, select Device directory > Devices.

    2. In the grey bar above the list of devices, click the arrow next to Filters.

    3. Choose an attribute and operator, and give a value, such as Device ID.

      • To combine multiple attributes in one filter, click Add another.
      • To use a raw string instead, click Advanced view.
    4. Click Save.

      This opens the Filter name popup window.

    5. Give your filter a name.

    6. Click Save filter.

  5. Create the campaign:

    1. From the left navigation pane, select Firmware Update > Update campaigns.
    2. Click the + New Campaign button.
    3. Populate the Name and Description (optional) fields.
    4. From the Manifest dropdown list, select the manifest file uploaded earlier.
    5. From the Filter dropdown list, select the filter that targets the devices you need to update.
    6. Click Finish to start the campaign.