Skip to content

Firmware Type

Firmware types represent the different types of firmware that can be installed on the devices associated to a device type. This will be used to update the firmware installed on the physical devices.

For example, a device type can have 2 firmware types: - OS: The OS of the device - APP: The application firmware of the device

But you can add as many as needed.

To allow the device to update the installed firmware, the firmware type provides 3 configuration keys that will be applied on the device. These configurations will give the device all the information it needs to download the new version of the specified firmware.

The configurations provided by the firmware type are: - versionKey: Indicates the version of the firmware to download. This information is not actually used to download the firmware but to let the device know which version it is downloading - urlKey: Contains the URL to download the requested firmware version - tokenKey: Contains the token giving the device the authorization to download the requested firmware

When creating a firmware type you have to give a name to each of these properties to avoid conflicts when updating different firmwares at the same time. So each value has to be unique among all the firmware types of one device type.

For example, for the firmware type OS you can define your configurations like this: - versionKey as os_version - urlKey as os_url - tokenKey as os_token

And for the firmware type APP: - versionKey as app_version - urlKey as app_url - tokenKey as app_token

By doing this way, if both firmware types have to be updated at the same time, the devices will not mix the different information together.

To manage firmware types, you need to have the Update.Device Type permission.

You can read more about roles and permissions in the access control guide.

Firmware Type Details

  • name: The name of the firmware type
  • versionKey: The name given to configuration key carrying the version
  • urlKey: The name given to configuration key carrying the url
  • tokenKey: The name given to configuration key carrying the token
  • deviceType: The associated device type

Note: The list of firmware types of a device type is retrieved as a subset when you read a device type.