Menu

Manage firmware

This tutorial describes how to manage firmware and software with Knox E-FOTA Advanced.

The Software Management tab contains tools to manage firmware and software with Knox E-FOTA Advanced. Create software packages and deploy full-version software or delta files to one or more target devices using Campaigns or Policies.

NOTE—This feature is available exclusively for Knox E-FOTA Advanced On-premise.

Add a new firmware

To add a new firmware to your Knox E-FOTA Advanced console:

Full Version

  1. Log into the Knox E-FOTA Advanced portal.
  2. Go to Software Management > Firmware.

  3. ClickNew.

  4. Under Device Model, complete the mandatory fields on the form:
    • Platform—Select the platform from the drop-down list for your target device(s).
    • Device Vendor—Select the device vendor from the drop-down list for your target device(s).
    • Device Model—Select the device model from the drop-down list for your target device(s).
  5. Under Firmware Details, complete the mandatory fields on the form:
    • Name—Enter a unique firmware name to help you identify the firmware.
    • Vendor—Enter the vendor name for the firmware.
  6. Click Save to create a new firmware.
  7. On the New Firmware Version page, complete the fields on the form. The details on this form will be visible to the device users when the firmware update is pushed to a device:
    • Version Name—Enter the firmware's version name.
    • Version Number—Enter the firmware's version number.
    • Tool Version—If applicable, enter the version number the Update Generation tool used to create the update. Note that this field only appears for SCOMO configuration.
    • Short Description—Enter a description of the firmware. Note that HTML tags are enabled in this field. The description entered will be inherited by subsequent versions, which you can later edit.
    • Est. Installation Time (in sec)—Enter the estimated installation time. This value will be used to notify the device user prior to installation. Maximum value is 8 numerical characters.
    • What's New—If applicable, enter what's new in this firmware version from the previous firmware version.
  8. Click Save.
  9. Click Yes or No on the prompt window: Do you want to upload another version?

Once complete, the firmware details will be displayed and the status will be set to Testing by default.

NOTE—This feature is available exclusively for Knox E-FOTA Advanced On-premise.

Delta file

To create a new firmware version, you can manage updates using delta files. This is done by defining the metadata for each version. You're responsible for creating all of the required delta files between each source and target versions.

Once you've generated the required delta files:

  1. Log in to the Knox E-FOTA Advanced portal.
  2. Go to Software Management > Firmware.

  3. Click the name of the target firmware from the firmware list.

  4. On the New Firmware Version screen, click New Version.

  5. Complete the following fields:
    • Version Name—Enter the firmware's version name.
    • Version Number—Enter the firmware's version number.
    • Tool Version—If applicable, enter the version number the Update Generation tool used to create the update. Note that this field only appears for SCOMO configuration.
    • Short Description—Enter a description of the firmware. Note that HTML tags are enabled in this field. The description entered will be inherited by subsequent versions, which you can later edit.
    • Est. Installation Time (in sec)—Enter the estimated installation time. This value will be used to notify the device user prior to installation. The maximum value is 8 numerical characters.
    • What's New—If applicable, enter what's new in this firmware version from the previous firmware version.
  6. Click Save.
  7. Click Yes or No on the prompt window: Do you want to upload another version?

Once saved, a new firmware version is created and the firmware is set to Testing status by default. Once you've completed testing, see how to update firmware status.

Generate update files

Knox E-FOTA Advanced can generate update files, also known as delta files. Once you've created at least 2 firmware versions, you can import the firmware update files generated by the Update Generation Tool.

To generate the update files:

  1. Go to Software Management > Firmware.

  2. Select the target firmware from the firmware list.

  3. Under Update Files, click the import icon.

    Select the file that contains the required source and target versions

  4. On the Import Update File window: Click Browse and select the update file.
  5. (Optional) MD5 checksum value—Enter a value to be used to verify the file's integrity.
  6. Click Import.

Once the file is successfully imported, a confirmation message appears on the top of the screen and the files will be available for testing and deployment. To view the file, select the target firmware. Details will be outlined in the firmware details page under the Update Files table.

NOTE—The update file between the client and server must match. For example, if the client reports an update file without a tool version, the server must also have an update file without a tool version. If the update file doesn't match, the operation will fail.
NOTE—Importing an update file that already exists overwrites the existing version.

Delete firmware

Note that deleting a firmware only deletes that firmware from the current domain. For example, firmware deleted from a root domain won't delete the firmware file from subdomains.

NOTE—If you're authorized to delete the firmware from the root domain and wish to delete the firmware from all domains, you can first edit the firmware and dissociate all subdomains from the firmware before deleting the firmware file from the root domain.

To delete a firmware:

  1. Go to Software Management > Firmware.

  2. Select the target firmware from the firmware list.

  3. Click Delete.

  4. A window will open to verify your selection, click Delete.
  5. Click Import.

Update firmware status

Once you've completed firmware testing, you can update the firmware status in preparation for deployment:

  1. Go to Software Management > Firmware.

  2. Select the target firmware from the firmware list.

  3. Beside Status, click Change.

  4. On the Change Status window, assign a new firmware status:
    • Rejected—The firmware version failed to pass all tests.
    • Approved—The firmware version passed all tests.
    • Active—The firmware version is now available to all device users.

  5. Click Apply.

After applying the new firmware status, the new status will be displayed in the firmware details screen.

Share it: