Software Updates
The upgrade process preserves your data and existing configurations. However, we recommend that you create a backup. After you install Litmus Edge software on a device, you can use this upgrade process throughout the lifetime of your device.
You have several options to upgrade Litmus Edge. If you need to download an updated version of Litmus Edge, visit Central Portal.
Important: For a seamless upgrade experience, you must follow the correct upgrade path. Skipping a significant LTS version may cause issues with the upgrade process.
When you upgrade, you must upgrade to version 3.16.10, 3.16.11, or 4.0.15. For specific upgrade paths, see Upgrade Paths.
Important
Before you upgrade, note that you can:
- Upgrade to an internal prerelease version. However, if you do so remember that you will not be able to upgrade again from that prerelease version.
- Upgrade to the same version you're currently on, if needed. 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.
- Use a template to apply configuration and setup settings from an existing edge device to a fresh installation or to update another device. See Templates for more information.
You cannot:
- Downgrade to a lower version.
- Upgrade if your controller is IDE. You must have a SATA controller to upgrade.
Caution: Software upgrades on unvalidated VirtualBox versions may result in a corrupted and unrecoverable Litmus Edge instance. Litmus Edge supports Oracle VirtualBox versions up to version 7.2.0.
Upgrade Paths
Refer to the following table for specific upgrade paths depending on your current version. The general upgrade path is earlier Litmus Edge version > 3.5.6 > 3.11.6 > 3.16.11 > 4.0.8 latest Litmus Edge version.
Important: Before upgrading, review the list of planned Deprecated Drivers so that you can migrate to any recommended replacement drivers.
Current version | Latest version (4.0.15) |
|---|---|
3.2.x | 3.2.3 > 3.2.8 > 3.2.11 > 3.2.12 > 3.5.6 > 3.11.6 > 3.16.11 |
3.3.1 and 3.3.2 | 3.5.6 > 3.11.6 > 3.16.11 |
3.5.4 and 3.5.5 | 3.5.6 > 3.11.6 > 3.16.11 |
3.5.6 | 3.11.6 > 3.16.11 |
3.11.0 to 3.11.5 | 3.11.6 > 3.16.11 |
3.16.x | 3.16.11 |
3.16.11 | 4.0.8 |
4.0.4 | 4.0.8 |
4.0.8 | 4.0.15 |
Litmus Edge-Litmus Edge Manager Compatibility
Refer to the following table to review which versions of Litmus Edge and Litmus Edge Manager are compatible.
Litmus Edge version (right) | 3.0.x | 3.1.x | 3.2.x | 3.3.x | 3.5.x | 3.11.x | 3.16.x | 4.0.x |
|---|---|---|---|---|---|---|---|---|
Litmus Edge Manager version (below) | | | | | | | | |
2.x | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
Upgrade Litmus Edge
You have three options for upgrading Litmus Edge.
- Uploading a local file. This is the recommended method.
- Upgrading through Litmus Edge Manager.
- Downloading an upgrade file. Choose this when the first two methods are unavailable.
Uploading the Litmus Edge UPD file in a Chrome browser can sometimes cause an Out of Memory error. If this occurs, use a different browser or the Download with URL option in Litmus Edge.
Backup Checklist
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.
Option 1: Upload Local File
This is the recommended upgrade method.
Before You Begin
- 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.
Upload a New Version of Litmus Edge Software
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.
- 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.
Option 2: Upgrade Through Litmus Edge Manager
If you have access to Litmus Edge Manager, see the following for upgrading remotely:
Option 3: Download Upgrade File
If the two options above are not available, then you can download the upgrade file from a URL.
Before You Begin
Visit 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.
Download the Upgrade File 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.
- 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.