For Partners & Customers.
Overview
This article describes how to upgrade your Gateway (GW) devices, running Application version 2.8.36 to any v3.x.
Prerequisites
- If your Enlighted Gateway runs firmware version earlier than v2.8.36, refer to the Upgrading Gateway Firmware from 2.6.x to 2.8.36 article for instructions on how to upgrade your Gateway's firmware before upgrading it further from v2.8.36 to any v3.x version.
- Recommend reading the Gateway Firmware Release Notes and downloading the corresponding firmware image from the Release Notes article before upgrading to 3.x.
Upgrading Gateway from v2.8.36 to v3.x
To update your Gateway from v2.8.36 to any v3.x and above it is necessary to either
- Configure the switch port speed to 10-Full, or
- Match the switch port speed and Gateway port speed.
There are three possible scenarios. See below which one applies to your specific situation and proceed with the upgrade.
Scenario 1: For Gateways connected to Switches in Auto-negotiate Mode but unable to change Switch Settings
Scenario 2: For Gateways connected to Switches configured to 10-full
Scenario 3: For Gateways connected to Switches in Auto-negotiate Mode
Recommended Upgrade Path:
Scenario 1: For Gateways connected to Switches in Auto-negotiate Mode but unable to change Switch Settings:
Enlighted has a patch that allows the Gateway to match port speeds with the switch to ensure proper version updates. Use this path if you are unsure of your switch configuration. To apply the patch,
- Use the image file 2_8_99_gw.tar to patch your Gateway with v2.8.36 by following Steps 1 through 3 in the Gateway Image Upgrade Process section of this article.
- Allow some time for the Gateway to start responding. Double-click the Gateway icon in the Floor plan view. The Gateway Details window identifies the current Application and Firmware versions running on the Gateway device. However, the patch version (2_8_99) will not show up in the Gateway Details window as the current version until the next reboot.
- Use the Gateway image file for version 3.x (3_x_x_gw.tar), upgrade the Gateway from v2.8.36 to v3.x by following Steps 1 through 3. First, download and unzip the image file (3_x_x_gw.tar), or submit a request to Enlighted Support.
Note: Failing to identify the right case poses no risk to the Gateway. However, the firmware upgrade will fail, and the process will need to be repeated using the correct case.
Scenario 2: For Gateways connected to Switches configured to 10-full:
- Use the Gateway image file for version 3.x (3_x_x_gw.tar), upgrade from v2.8.36 to v3.x by following Steps 1 through 3. We recommend reading the Gateway Firmware Release Notes and downloading the corresponding firmware image from the Release Notes article before upgrading to 3.x.
Scenario 3: For Gateways connected to Switches in Auto-negotiate Mode:
- Configure the switch port speed to 10 Mbps, full-duplex mode.
- Use the image file 3_x_x_gw.tar to upgrade the Gateway by following Steps 1 through 3.
- After the Gateway is upgraded, configure the switch port speed back to Auto-negotiate mode.
Note: If you are unsure of the Switch configuration, please follow the first recommended upgrade path using the 2_8_99 patch.
Gateway Image Upgrade Process
The Gateway firmware image upgrade process requires three steps:
Step 1: Determine the Gateway Application Version
To determine which release is running on the Gateway, login to Manage, HTTPS:// with your username and password.
- Select a floor in the Facilities Left panel.
- Select Devices > Gateways. The list of Gateways on the floor is displayed.
- Select a Gateway and click Edit.
The Gateway Details window identifies the current Application and Firmware versions running on the Gateway device. Note the Application version and Firmware version running on the Gateway.
Note: The Application version in this example is 2.8.32, and the Firmware version is 2.8.20. Depending on the combination of these two, you will need to upgrade the Gateway until the required application and firmware version for the image is displayed.
Step 2: Upload the Gateway Image
Download or obtain the appropriate Gateway firmware image file from Enlighted Support.
Only the System Administrator can upload and upgrade image files running on a Gateway.
- Log in to Manage as an administrator using HTTPS:// with your username and password.
- After you are logged in, navigate to Administration > Firmware Upgrade.
- In the Firmware Upgrade screen below, click Add Firmware to upload the image file. Next, choose the firmware image from your system to upload.
When the image file is uploaded successfully, the file is listed in the table.
If you have more than one Gateway image file to be uploaded, repeat the process until all image files are uploaded.
Step 3: Upgrade the Gateway Image
Before upgrading the Gateway image, turn off the sensors' BLE scan mode. By default, the BLE scan mode is set to off. But, if it was turned on, you can turn it off at Facility > Floor plan View: Bluetooth Mode. Then, select all sensors, right-click, Set BLE Mode, Off. For more information, see Set Bluetooth (BLE) Mode.
To upgrade the Gateway image file,
- In the Image Upgrade window, click Manual Upgrade.
- In the Facilities left panel, select a floor containing the Gateways.
- Select the Gateway tab from the list of devices: Sensor, Gateway, ERC, Plugload.
- On the floor plan, choose one or more gateways running the same Application Version to upgrade.
- Click the button to add the selected Gateways to the table. This step can be repeated.
- Select the image file from the Select a Gateway Image drop-down list.
- Click Start Upgrade to initiate the upgrade process.
- Check the status of the upgrade process by clicking Image Job History.
For Gateways located on another facility item, repeat steps 2 – 8.
The following screen shows the above steps, which are performed on the Image Upgrade screen:
To check the upgrade process status, refer to the Viewing Job History and Device Firmware Upgrade Status. The Upgrade Status for the device is displayed as Success or Fail.
- Success — GW upgrade is successful.
- Fail — GW upgrade failed.
If the status is displayed as Fail, verify the Application version and Firmware version in the Gateway Details window. Refer to section Step 1: Determine the Gateway Application Version to get to the Gateway Details window.
In the Gateway Details window, click the Reboot button to reset Gateway and wait for five minutes. Then, open the Gateway Details window again and verify the Application version and Firmware version.
If the Application version shows the updated image version number (v3.4.0), the Gateway upgrade process is complete. Otherwise, repeat the upgrade procedure described in Step 3: Upgrade the Gateway Image.
If the Gateway is not upgraded, check the Last Communication field in the Gateway Details window. If the Gateway has not communicated with Manage for several hours, troubleshoot the Gateway connectivity or contact Enlighted Support.
Downloads:
Refer to the appropriate release notes and download the image.
Gateway Firmware v3.4.1 Release Notes and download the Image.
