Firmware updates (admin side)

The phases of a firmware deployment

Firmware deployments are created and managed throughout their lifecycle from the "Firmware updates" section of the management app. Admins with the proper permissions are capable of creating new deployments and managing them as they pass through QA and production rollout.

There are 3 stages that a deployment can be in:

  1. Test deployment, when a package is being deployed to a selection of devices in a pilot run
  2. Production deployment, when a package is being automatically distributed to an entire fleet of devices (either immediately after promotion from test, or on a schedule)
  3. Archived deployment, when a package is either successfully deployed or canceled for any reason

Running a test deployment

  1. Under "Devices", go the the "Firmware deployment" section

  2. Choose a small number of devices to deploy this firmware to as a pilot deploym

    • These devices must be from the same template
    • It is recommended to try a lower number of devices during test deployments, to make troubleshooting easier
  1. Select the files that you want to include in this firmware package (and provide a name and version)
    • The version of this package will be used as a unique identifier throughout the app to indicate what the latest package deployed to a device is
  1. Confirm that you are ready to perform a test deployment to these devices and click Run Test

    • Devices will be informed of the availability of new files the next time they check with the broker. There is no 24-hour rollout schedule for test deployments.
    • Devices need not be online at the time you initiate a deployment.

Rolling out a production deployment

When you are satisfied with a test deployment, admins can roll out the firmware package to every device of the device template.

  1. Find the deployment and click "Deploy"
  2. Choose whether to roll out immediately, or on at a time and date in the future.

Monitoring a production rollout

The firmware update availability to devices takes place over 24 hours, so some devices will not learn of the available update for up to 24 hours.

While a new package is being deployed to the fleet, admins can track the status of the rollout using the firmware dashboard.

This view will show the percentage of the devices in the template family that have received and acknowledged the new firmware package. From here, you can also cancel the deployment.

Leveraging firmware deployments and device logs

When a device reports the successful receipt and verification of a new file package, a log event is added to that Device's log.

This is particularly useful if the devices themselves are also using device logs to report regular status and error messages, as it allows you to have a full report of the diagnostic and operational health of each device that can also be queried programmatically at a fleet level.

Archived deployments

A deployment is moved to "Archived" in the following conditions:

  • A production deployment completes successfully
  • A production deployment is canceled
  • A test deployment is moved to Archived before being transitioned to a production deployment

Firmware updates (admin side)