Firmware
A Firmware is a file you uploaded on the platform in order to be downloadable by the authorized devices.
A firmware is associated with a firmware type. The firmware type will define on which device type the firmware can be installed and which configuration keys will be used to do so.
There can be multiple firmwares associated to one firmware type. Each of them represents a different version. Each version has to be unique for one firmware type. Firmwares are segregated by tenant.
Once uploaded, the required information to download the firmware on the device will be available.
The uploaded file cannot be updated. In order to update the binary you have to upload a new firmware with your new file.
Note: This feature is mainly used to upload firmwares, but it can be used for any kind of file the device might need to download.
Firmware Details
- firmwareType: The associated firmware type
- description: A short description of the firmware
- version: The version of the firmware. Has to be unique for the firmware type
- url: The URL to download the software
- token: The token allowing the device to download the firmware
- fileName: The complete name of the file in the storage service
- size: The size of the uploaded firmware
Access Rights
List Firmwares
Permission - Read.Firmware
Feature - A user can list all the firmwares on a tenant for a specified firmware type
Read a Firmware
Permission - Read.Firmware
Feature - A user can read the details of a firmware, including the download information
Create a Firmware
Permission - Create.Firmware
Feature - A user can create a firmware, by providing the file and the mandatory properties
Update a Firmware
Permission - Update.Firmware
Feature - A user can update the description of a firmware
Delete a Firmware
Permission - Delete.Firmware
Feature - A user can delete a firmware. The file will also be removed from the storage service.
Check if file exists
Permission - Read.Firmware
Feature - A user can check if the file associated to the firmware exists in storage service. - This feature can be used in case some manual modification has been made on the storage service and you want to confirm that the file still exists.