Adding Firmware Image Files

The software running on a sensor, gateway, ERC, or plugload is called a firmware image. Only the system admin can update firmware images on devices. Each device has a specific type of image that is replaced when a firmware image is upgraded.

Prerequisites:

  1. Please read the Release notes, download the latest sensor firmware image, and save it to your system. Only registered partners and customers will be able to access and download firmware images from the portal.
  2. All approved sensor firmware image upgrade paths for sensors are listed in the Firmware Compatibility List. Download and add the XML Compatibility List to Manage before upgrading the sensor firmware to determine if you can upgrade the sensors to the new version. A warning message is displayed if you try to upgrade sensor firmware via a path that is not in the Compatibility list. 

To add or upload the Firmware image file to Manage,

  1. Go to Administration-> Firmware Upgrade.
  2. Click the Add Firmware button to upload the image file. The firmware image files are extracted and listed in the Available Firmware Images for each device type.

1.png

If you have more than one image file to be uploaded, repeat the process until all image files are uploaded. You can then either perform a manual firmware upgrade or schedule an automatic firmware upgrade to occur on specific days and times for multiple floors at a time. 

Recommended articles:

Automatic Image Upgrade for Sensors

Note: Only users with role administrators are allowed to do an image upgrade.

An automatic firmware image upgrade is available only for sensors. For all other device image upgrade, refer to the Manual Firmware Image Upgrade for Sensors, Gateways, and Other Devices.

You can schedule an automatic firmware image upgrade of sensors to occur on specific days and time for multiple floors at a time.  The sensors will be upgraded to the most up-to-date firmware available in  Manage using the Compatibility List paths.

Prerequisites:

  1. Please read the Release Notes, and download the latest sensor or device firmware image, and save it to your system. Only registered partners and customers have access to download firmware images.
  2. Upload or add the firmware image file to Manage before scheduling an automatic firmware image upgrade.
  3. Download and Add the XML Compatibility List to Manage before upgrading the sensor firmware to determine if you can upgrade the sensors to the new version. All approved sensor firmware image upgrade paths are listed in the Compatibility List, determining if you can upgrade the sensors to the new version. A warning message will be displayed if you try to upgrade sensor firmware via a path that is not in the Compatibility List.
  4. Before upgrading any image on a sensor, turn off the BLE scan mode on the sensors to minimize the chances of errors for a successful upgrade.  

Follow these steps to upgrade the firmware image automatically to the sensors:

  1. Go to Administration-> Firmware Upgrade.
  2. Click Auto-Upgrade Settings

2.png

3. Click Edit to edit settings.

4. Select one or more floors in the Facilities left panel.

5. Check Auto-Upgrade On to enable auto-upgrade of firmware for the selected floors.

6. Choose days of the week the firmware upgrade jobs should start when new firmware is available.

7. Choose a start time for the upgrade to start.

8. Set the maximum duration for the upgrade jobs to finish. The maximum duration must be between 1
    and 24 hours.

9. Click Apply to save the details for auto-upgrade.

The sensor will be upgraded to the most up-to-date firmware available using the paths in the Compatibility List on the next scheduled day and time. In some cases, multiple upgrades will occur automatically to get to the most up-to-date firmware. Manage will continue upgrading all the sensors on all selected floors until all sensors have the most up-to-date firmware. After three failed attempts to upgrade a sensor during the scheduled upgrade time, the sensor will additionally be set to upgrade the next time that the sensor reboots.

Note: If the upgrade does not finish within the maximum duration, the upgrade will stop and then continue at the next scheduled start day and time.

To view the status of the firmware upgrade, see Viewing Job History and Device Firmware Upgrade Status.

Recommended articles:

Manual Image Upgrade for Sensors, Gateways, and Plugloads

This procedure describes how to upgrade the firmware image on sensors, gateways, and plugloads.

Prerequisites:

Before proceeding with the upgrade, 

  1. Please read the Release Notes, and download the latest sensor or device firmware image, and save it to your system. Only registered partners and customers have access to download firmware images.
  2. Upload or add the firmware image file to Manage.
  3. Download and Add the XML Compatibility List to Manage before upgrading the sensor firmware to determine if you can upgrade the sensors to the new version. 
  4. Before upgrading any image on a sensor, turn off the BLE scan mode on the sensors to minimize the chances of errors for a successful upgrade.  

Note: Only users with role administrators are allowed to upgrade the firmware image files.

To upgrade firmware image on a sensor, gateway, or plugload device, navigate to Administration -> Firmware Upgrade. 

  1. In the Firmware Upgrade window, click the Manual Upgrade tab.
  2. In the Facilities left panel, select a floor containing the devices.
  3. On the floor plan, choose one or more devices of the same type to upgrade. To select multiple devices such as sensors or gateways not next to each other, hold down the Ctrl key as you click on each device until all are chosen. To select sensors or devices from multiple floors, click the floor name and select one or more devices.
  4. Click the  button to add them to the table of selected devices. This step can be repeated.
  5. Select the firmware image file from the corresponding device firmware image drop-down list. For example, select an image from the Select a fixture image drop-down list.
  6. Click Start Upgrade to initiate the upgrade process.
  7. Check the status of the upgrade process by clicking Upgrade Job History
  8. For devices located on another facility item or a different device type, repeat steps 2 – 8.

The following screen shows the above steps performed on the Upgrade Image screen:

Manual_FirmwareUpgrade_Sensors_Plugloads_Gateways.png

Note: By mistake, if the same type of device is not selected, the upgrade will fail. 

To view the firmware upgrade status, see Viewing Job History and Device Firmware Upgrade Status.

Recommended articles:

Manual Image Upgrade for ERCs

Note: Only users with role administrators are allowed to upgrade Firmware images.

This procedure describes how to upgrade the firmware image on Enlighted Room Control (ERCs). Read the Release notes, contact Support for obtaining the ERC Firmware Image file, and add the firmware image file to Manage before starting the upgrade. 

To upgrade the firmware image on an ERC, navigate to Administration -> Firmware Upgrade. 

  1. In the Firmware Upgrade window, click the Manual Upgrade tab.
  2. In the Facilities left panel, select a floor containing the ERCs.
  3. Select the ERC tab as the device type to upgrade.
  4. On the floor plan, choose one or more ERCs of the same type to upgrade. To select multiple ERCs hold down the Ctrl key as you click on each ERC until all are chosen. To select ERCs from multiple floors, click the floor name and select one or more ERCs.
  5. Click the mceclip0.png button to add them to the table of selected devices.
  6. Select the required firmware image from the Select an ERC image drop-down list.

Manual_FirmwareUpgrade_ERC.png

Preparing the ERC Switch for Upgrade

To prepare the ERC switch to be upgraded:

  • Simultaneously press buttons 2 and 4 for five seconds and confirm that the switch LED starts to slow blink in green.

                                  Buttons_New.png

Note: Do not use the ERC until the upgrade is completed.

  1. Click Start Upgrade to initiate the upgrade process.
  2. Check the status of the upgrade process by clicking Upgrade Job History. See Viewing Job History and Device Firmware Status.
  3. For devices located on another facility item or a different device type, repeat steps 2 – 8.

The following screen shows the above steps performed on the Upgrade Image screen:

Manual_FirmwareUpgrade_ERC_1.png

Note that if devices of the same type are not selected, the upgrade will fail. To view the upgrade status, see Viewing Job History and Device Firmware Status

To confirm the ERC upgrade status,

  1. Log in to Manage and click on the relevant Floor.
  2. Click on Devices > ERCs tab.
  3. Check the Upgrade Status for each ERC that was upgraded.  The status should show Success

ERC_upgrade_Success.png

Recommended articles: 

 

Adding XML Firmware Upgrade Compatibility List

Before upgrading the sensor firmware, download the XML Compatibility List file from the link at the bottom of the article and upload it to Manage. The Firmware Compatibility List determines if you can upgrade the sensors to the new version. A warning message is displayed when upgrading sensor firmware via a path not in the Compatibility list.  

Adding the Downloaded Compatibility List  

Download and save the XML Compatibility List file to your system. To upload the Compatibility List file in Manage,

  1. Go to Administration-> Firmware Upgrade.
  2. Click the Add Compatibility List button available in the lower half of the window to the right to upload the file. After the file is uploaded, the files are extracted and listed in the Firmware Compatibility List.

The Compatibility List extracts and shows the range of approved upgrade paths, as shown below.

The Compatibility List determines if you can upgrade the sensor listed in the Allowed Versions column with the corresponding firmware image file in the Filename column. Any unsupported upgrade path will warn you not to proceed with the upgrade displaying a warning message when upgrading sensor firmware via a path not in the Compatibility list.   

2_Add_Comptaibility_List_S.png

To upgrade the sensor firmware image,

  1. Download the corresponding Gen 5/4 sensor firmware image file.
  2. Add the firmware image file to Manage, and  
  3. Perform either an automatic or a manual firmware upgrade.

Recommended articles:

Downloads:

Viewing Job History and Device Firmware Upgrade Status

You can monitor the firmware upgrade status of a device in the Firmware Upgrade screen. Navigate to Administration -> Firmware Upgrade.

In the Firmware Upgrade screen, click the Upgrade Job History tab to view the firmware image upgrade process's status. If the upgrading job fails, a Resubmit Now button appears in the Action column. Click Resubmit Now to upgrade the devices on which the upgrade failed immediately regardless of whether the upgrade was initiated automatically or manually.

The system automatically restarts the upgrade on the devices that failed, and the status for that job changes to Fail Retried. Continue the process until all devices in the selected job are upgraded. Clicking Abort cancels the job. To view the upgrade status of individual devices within a job, click on the Job Name.

View_FW_upgrade.png

The Job Name expands, showing each device's upgrade status within the job in the Status column.

4_Firmware_Status_1.1.png

Recommended articles: