Software update package examples

The contents of your software update packages is very flexible and depends on how you decide to manage your IoT solution, including the product software and the applications.

A software update package can be as simple as updating 1 file on the gateways to as complex as updating the product software, similar to doing a product Update Firmware function, and updating your applications all in one package.

If there are multiple deviceWISE product and platform types, and different applications in your IoT solution (Asset Gateway, Enterprise Gateway, Windows, Linux, etc.), you may need to create separate SUPs for the different gateway types.

The example SUP files and actions show some of the flexibility available when updating your gateways.

Add File

Add a file to a gateway's file system.

  1. Add File from Package action
    1. The deviceWISE runtime does not need to be stopped and then restarted.
    2. The source file is selected from the Local Directory specified in step 1 of the Creating a software update package process.
    3. The destination file's path and filename on the gateway where the file will be added (copied) is platform specific. Use the appropriate Linux or Windows based conventions.

Install Package

Install a new device driver .pkg file on the gateway.

  1. Stop Runtime action
    This action is used because the new device driver does not get installed until the runtime is restarted.
  2. Install Package action
    1. Filename - select the device driver .pkg file from the Local Directory specified in step 1 of the Creating a software update package process.

  3. Start Runtime action
    When the runtime starts, the new device driver files will be installed and initialized.

Firmware Update

Update the deviceWISE Asset Gateway product on the gateway.

  1. Stop Runtime action
    This action is used to shutdown the runtime and the application.
  2. Firmware Update action
    1. Filename - select the deviceWISE Asset Gateway firmware update .dwu file from the Local Directory specified in step 1 of the Creating a software update package process.

  3. Start Runtime action
    When the runtime starts, the new deviceWISE Asset Gateway products files will be installed and initialized. The application is not changed, it will be initialized and start executing.

Update application, Write Master DB

Update the application (projects, triggers, devices, etc.) on the gateway.

  • The Write Master DB action is used when the target gateway is using Deployment mode.
  • The Write Core DB action is used when the gateway is not using Deployment mode, and a reset of the application to a previous defined level is desired.

For more information see: Database Deployment.

  1. Stop Runtime action
    This action is used to shutdown the runtime and the application.
  2. Write Master DB action
    1. Filename - select the Master DB .db file from the Local Directory specified in step 1 of the Creating a software update package process.

  3. Start Runtime action
    When the runtime starts, the new application will be initialized and start executing.

Update application, Write Master DB, Install Package, Firmware Update

Update the application (projects, triggers, devices, etc.) on the gateway.

  • The Write Master DB action is used when the target gateway is using Deployment mode.
  • The Write Core DB action is used when the gateway is not using Deployment mode, and a reset of the application to a previous defined level is desired.

For more information see: Database Deployment.

  1. Stop Runtime action
    This action is used to shutdown the runtime and the application.
  2. Write Master DB action
    1. Filename - select the Master DB .db file from the Local Directory specified in step 1 of the Creating a software update package process.

  3. Install Package action
    1. Filename - select the device driver .pkg file from the Local Directory specified in step 1 of the Creating a software update package process.

  4. Firmware Update action
    1. Filename - select the deviceWISE Asset Gateway firmware update .dwu file from the Local Directory specified in step 1 of the Creating a software update package process.

  5. Start Runtime action
    When the runtime starts,the new deviceWISE Asset Gateway products files will be installed and initialized and the new application will be initialized and start executing.