Securely Transfering Files to my devices

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

  2. Click Create new package.
    The Firmware Package screen is displayed. Add a name to your package.

  3. Click Manage test devices.
    The Manage Test Devices page is displayed.

  4. Choose a Device Template and select a small number of devices to deploy this firmware as a pilot deployment.
    Important: These devices must be from the same Device Template.
    Tip: Try a lower number of devices during transfers, to make troubleshooting easier.

  1. Click Apply.

  2. Click Add Files.
    The Add New File screen is displayed.

  3. Name the file.

  4. Input the revision string which can be any value.

  5. input the URL of firmware you want to push to the devices.

Important: Maximum size per file is 8MB.

Note: Multiple files can be added but only up to 16 file


Download URL must point directly to the file

The download link you've set needs to be publicly accessible, and it must point to the file directly. Sometimes, a suffix needs to be added to the URL so it downloads the file instead of responding with a webpage.

The URL must have a command to download a file in it, For example, Dropbox links must have the suffix dl=1

If the link is set correctly, accessing it on your browser should immediately start to download the file.

Note: The version of this package will be used as a unique identifier throughout the app to indicate which is the latest package deployed to a device.


Updating files in an existing deployment

If you update the file in the hosting service, you must create a new deployment. Even if the file's URL remains the same.

  1. Add a Checksum for the Firmware package. In order to adhere to your device's capabilities, any checksum algorithm can be used.

Important: The Checksum must be encoded with base64. If you have a hexadecimal checksum, you can decode it to binary and re-encode it to base64 using online tools like this one.


Calculating Checksums

The checksum is just a summary of file content. It is used to ensure the integrity of the data transferred.

You can generate a 32 character length hex string using a command line/terminal command. For example, on OS X we can create a SHA256 hash like this:

openssl sha -sha256 <FIRMWARE FILE>

That will give you a hex-encoded checksum that you can feed to the hex-base64 converter.

If your system has the tools, you can use this command to get the base64 checksum directly:

openssl sha -sha256 <FIRMWARE FILE> | awk '{print $2}' | xxd -r -p | base64
  1. Click Add.
    Tip: Multiple files can be added to the one test package (up to 16 files) but only one firmware update can be done at a time.
  1. Confirm that you are ready to perform a test deployment to these devices and click Run Test. Devices receive the file as soon as they next come online.

Updated 2 years ago

Securely Transfering Files to my devices

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.