Documentation

Mistake on this page? Email us

Updating device firmware

There are two methods to update device firmware:

Before you follow this tutorial, make sure you have met all prerequisites.

The update process

Although the processes to set up an updatable development or production device are different, the process to update each is the same:

  1. Upload your firmware image.
  2. Upload your manifest.
  3. Define and create your campaign.
  4. Run the campaign.
  5. Campaign completion and further actions.
    1. Archive a campaign.
    2. View campaign statistics.

Upload the firmware image to Device Management

  1. Log in to Device Management Portal.
  2. Select Firmware update from the left menu.
  3. Select the Images menu option.
  4. Click the Upload image button at the top right.
  5. Enter a name and description for the image.
  6. Click the Choose file button, and select the file.
  7. Click the Upload firmware image button.

Upload the manifest to Device Management

Upload the firmware manifest to Device Management to use it with the firmware update service:

  1. Log in to Device Management Portal.
  2. Select Firmware update from the left menu.
  3. Select the Manifests menu option.
  4. Click the Upload manifest button.
  5. Enter a name and description for the manifest.
  6. Click the Choose file button, and select the file.
  7. Click the Upload firmware manifest button.

Create a device filter

To distribute a firmware update to remote devices as part of an update campaign, you need to specify which devices this update targets. A device filter lets you select which devices to target based on their attributes or identity.

In Device Management Portal:

  1. Click Device directory on the menu bar on the left.
  2. In the grey bar above the list of devices, click the arrow next to Filters. The default is Simple view.
  3. From left to right, choose an attribute and operator, and give a value, such as Device ID.
    • Click Add another if you want to combine multiple attributes in one filter.
    • You can also choose an attribute that applies to multiple devices.
    • If you want to use a raw string instead, click Advanced view.
  4. Click the small Save disk icon.
  5. Give your filter a name.
  6. Click Save filter.

Your filter is automatically applied and lists the devices matching your selected attributes.

Create an update campaign

After you have created a device filter, you can create an update campaign.

In Device Management Portal:

  1. Click the Firmware update option from the menu bar on the left.
  2. Click Update campaigns.
  3. Click New campaign.
    1. Enter a Name and a Description.
    2. Select your manifest file from the dropdown list.
    3. Select your device filter from the filter dropdown list.
    4. Click Save.

Note: Device Management Portal refers to the estimated number of devices included in a campaign. This is because the filter only includes registered devices when the campaign starts. If a device deregisters in the meantime, it is not included in the campaign.

Consult our troubleshooting information if you encounter any issues with the update process.

Editing an update campaign

The above steps create the update campaign as a Draft.

In Device Management Portal:

  1. Click Firmware update.
  2. Select a campaign you created in the previous step.
  3. A pane opens to the right.
  4. Click Edit.

You can now edit your campaign.

Start the update campaign

After you are happy with the update campaign parameters, such as which manifest to use and targeted devices, you can start the campaign.

Note: After your campaign enters this phase, it locks. You cannot change information such as the selected manifest or targeted devices.

In Device Management Portal:

  1. Go to Firmware update > Update campaigns, and select your active campaign.
  2. A pane opens to the right.
  3. Click Start.

Manually stopping a campaign

Note: Manually stopping the campaign is not a required step, unless you have reason to stop it before it would normally finish.

In Device Management Portal:

  1. Go to Firmware update > Update campaigns and select your active campaign.
  2. A pane opens to the right.
  3. Click Stop.

Archiving a campaign

After you archive a campaign, you cannot de-archive it. You can then delete archived campaigns if you want.

In Device Management Portal:

  1. Go to Firmware update > Update campaigns, and select your active campaign.
  2. A pane opens to the right.
  3. Click Archive.