Software Updates
Important: For a seamless upgrade experience in upcoming releases, it's essential to follow the correct upgrade path. Begin by upgrading from version 3.5.6 to 3.11.6, then proceed to 3.16.2 before making any further updates if you are on 3.5.x versions. If you are on 3.11.6 proceed with 3.16.2. Skipping these key LTS versions may cause issues that can disrupt the upgrade process, so it is highly recommended to follow this sequence.
You have several options to upgrade Litmus Edge. If you need to download an updated version of Litmus Edge, visit the Litmus Central portal.
The upgrade process preserves your data and existing configurations. After the Litmus Edge software has been installed on a device, this upgrade process can be used throughout the lifetime of the device.
- You can't downgrade a lower version.
- If needed, you can upgrade to the same version you're currently on. For example, if your current version is 3.3.1, you can upload the 3.3.1 UPD file again to your Litmus Edge instance.
- An upgrade to an internal pre-release version is possible, but contains a warning. Pre-release versions are not upgradeable.
- Creating a backup prior to upgrading is recommended.
- You cannot upgrade if your controller is IDE. You must have a SATA controller to upgrade.
- Software upgrades haven’t been validated yet on VirtualBox 6.1.x. An upgrade attempt running on VirtualBox 6.1.x may result in a corrupted and unrecoverable Litmus Edge instance.
- If you want the same edge device configuration and setup on a fresh installation or with an update, you can use a template. See Templates for more information.
Caution: Software upgrades haven’t been validated yet on VirtualBox 6.1.x. An upgrade attempt running on VirtualBox 6.1.x may result in a corrupted and unrecoverable Litmus Edge instance.
Important: Before upgrading, make sure to review the list of planned Deprecated Drivers so that you can migrate to any recommended replacement drivers.
Review the following information for the required upgrade path of Litmus Edge versions.
You can follow this simplified upgrade path:
Earlier Litmus Edge version > 3.5.6 > 3.11.6 > Latest Litmus Edge version
For more detailed upgrade paths for specific versions of Litmus Edge, see below.
Refer to the table below for specific upgrade paths depending on your current version and the latest Litmus Edge version.
Target version (right) | 3.16.2 |
|---|---|
Current version (below) | |
3.2.x | 3.2.3 > 3.2.8 > 3.2.11 > 3.2.12 > 3.5.6 > 3.11.6 > 3.16.2 |
3.3.1 | 3.5.6 > 3.11.6 > 3.16.2 |
3.3.2 | 3.5.6 > 3.11.6 > 3.16.2 |
3.5.4 | 3.5.6 > 3.11.6 > 3.16.2 |
3.5.5 | 3.5.6 > 3.11.6 > 3.16.2 |
3.5.6 | 3.11.6 > 3.16.2 |
3.11.0 | 3.11.6 > 3.16.2 |
3.11.1 | 3.11.6 > 3.16.2 |
3.11.3 | 3.11.6 > 3.16.2 |
3.11.4 | 3.11.6 > 3.16.2 |
Refer to the following table to review which versions of Litmus Edge and Litmus Edge Manager are compatible.
You have three options for upgrading Litmus Edge.
For backup purposes, you have the option of downloading a backup while doing an upgrade. All configurations and settings are maintained and carried over after upgrading to a new version.
Download all tags in a CSV file from DeviceHub > Tags. See Manage Tags.
Download flows files from Flows Manager. See Manage a Flows Manager.
Export all flows from your Analytics groups. See Manage Processors and Analytics Flows for more information.
Export the OPC UA hierarchy configuration JSON file from the OPC > Hierarchy pane. See Manage Nodes for more information.
Create a Template from the Template tab in System > Backup / Restore. See the Download a Template section in Manage Templates.
Create a support bundle from the Support section in System > Support. See Support.
Make a backup of your system from the Backup / Restore Configuration section in Settings > Backup / Restore. See Back Up a Device.
This is the recommended upgrade method.
- Verify the current software version running on Litmus Edge in System > Info under the General section.
- Download the correct version of the UPD file you want to upgrade to from the Central Portal. If needed, review the Upgrade Paths section above.
Once you have the correct UPD file, complete the following steps to upload it to your Litmus Edge instance.
To upload a new version of Litmus Edge:
- In Litmus Edge, navigate to System > Device Management. The Device Management pane appears.
From the Software Update section, click Upload File.
Software Update section- Select the UPD file and click Open.
- Click Ok. Follow the prompts to download a backup before proceeding with the upgrade. You have the option to skip the downloading of a backup but is not recommended. The software loads and installs. The progress of the upload will display. Once finished, the system reboots.
- Once the system has restarted, close your browser and open the browser again.
- Clear your browser cache.
- Log in to Litmus Edge and navigate to System > Info. Verify the software version is the updated version.
If you have access to Litmus Edge Manager, see the following for upgrading remotely:
If the two options above are not available, then you can download the upgrade file from a URL.
Visit the Central Portal to download the correct UPD file locally to your computer and get the Checksum value you will need. Then, upload the file to your preferred file storage service. You will use the URL to access the file when entering the Download URL in Litmus Edge.
To download the upgrade file in Litmus Edge:
- In Litmus Edge, navigate to System > Device Management. The Device Management pane appears.
In the Software Update section, click Download from URL. The Download Software Update dialog box appears.
Download from URL link- Enter or paste the Download URL and Checksum value in the required fields. Then, click Start download. When the download successfully completes, the file displays in the Update Files section.
- For the downloaded file, click Update. Follow the prompts to download a backup before proceeding with the upgrade. You have the option to skip the downloading of a backup but is not recommended.