Sensor Firmware Releases: Summary of Features

This article summarizes the firmware release features for each firmware version. For detailed release notes, click on the corresponding Firmware Release Notes link of each release.

Gen 5 Sensors

The table below summarizes the new features and defect fixes for the latest Gen 5 sensor firmware releases. Consult the release notes links (release notes access available only for partners and customers) in the table for additional information. 

Firmware Version

New Features

Bug Fixes

Upgrade Path

5.13.4 Release Notes

  • None
NA Direct upgrade from any 5.x version

5.12.11 Release Notes

  • EnOcean Switch
NA Direct upgrade from any 5.x version

5.11.8 Release Notes 

NA Direct upgrade from any 5.x version

 5.9.4 Release Notes

  • All 2-wire drivers must support log dimming per the DALI standard.
  • Smart Ramp Feature to target ambient light level over 3 seconds
  • BLE Tag Events to report BLE tag button press events and BLE tag battery status events.
  • 4.2 ALPUS ERC
 NA Direct upgrade from any 5.x version

 5.5.14 Release Notes

  • DALI 2 support for Tunable White DALI Type 8 commands
  • Motion algorithm updated
  • DALI device type 51 (energy reporting) support
  • Support for 2-wire drivers that do not support energy reporting
  • Support for additional 2-wire sensors
  • Supports the Micro Sensor (SU- 5E) rev 2 board
  • Default ENL One task tune level
  • Default profile when not commissioned
  • Resolved Interface detection discovery
  • Fixed a wiring test problem
  • Default active motion changed to 15 minutes
  • Improved wiring test
  • Support for 2-wire drivers that do not support energy reporting
  • The sensor does not return the correct value for the last motion
Direct upgrade from any 5.x version

5.4.59 Release Notes

  • Enlighted One or connected sensors support.
  • Tunable White fixtures
  • Color scene settings for Tunable White
  • Improved Laser Discover Strobing
  • Added default profile when sensors are not commissioned
  • Modified PIR detection algorithm
  • Daylight harvesting undesirable light levels
  • Improved robustness of the sensor
  • The sensor does not force occupancy sensitivity to 1 in a dark room
  • The sensor reports the correct time since the last motion detection
  • Sensor ignores duplicate discovery requests
  • Fixed LED state when the hopper sensor is moved to the default channel during discovery.
Direct upgrade from any 5.x version

5.3.21 Release Notes

  • Discovery response sent when strobed by green laser
  • Improved sensitivity to green laser strobe
  • Default profile for all uncommissioned sensors (see release notes for details)
  • The sensor will exit the post wiring test 2 minute hold if it receives a message from the EM or ERC
  • Protection against inadvertent EM commands that enable or disable the hopper setting when there is an active discovery process
  • PIR motion detection algorithm modification to reduce the number of false motion events
  • Correctly reports the time since sensor detected local motion
  • Motion sensitivity filter fixed to handle the situation when tick timer is rolling over
  • Corrected Manual On switch group behavior when using the ERC Auto button.
  • Modified switch group behavior to behave independently of motion group behavior. 
Direct upgrade from any 5.x version

 5.1.64 Release Notes

  •  None
  • Incorrect message format was putting Plug Load Controller (PLC) in Safety Mode
  • New period events no longer cause lights to come on ("sticky off" state)
 

 5.1.62 Release Notes

  •  None
  • Fixed issue with Virtual Switch Scene Requests on the sensor 
  • Hopping of Group Messages in switch and motions groups fixed
  • Dim and Linger timing corrected - lights dim to off as required
Direct upgrade to 5.1.64

5.1.59 Release Notes

  • Profile start and end times may be synchronized with local sunrise and sunset (Astronomical Clock)
  • Daylight Harvesting Groups respond to daylight uniformly
  • Blinking blue LED wiring test result for non-metered configurations
  • Strobe detection level calibrated to support 1mW GREEN laser pointer (EU compliance)
  • Support for the Initiate Driver Discovery Request command from the EM
  • Fixed non-linear dimming behavior (from 5.0.20 FW)
  • Manual AUTO and SCENE button behavior in ERC corrected 
  • Dim and Linger Behavior corrected when using ERC
  • Removed premature dimming truncation from dimming ramp up and downtimes
  • Daylight Harvesting slew rate supports a wider range of values
  • ERC AUTO button now correctly turns lights on to profile maximum when lights are off
  • Lighting control correctly operates when both Min and Max light levels are zero 
  • Daylight harvesting now works when the sensor detects no occupancy
  • Ambient light calibration fixed to correctly operate when lights are manually set to full-on (100%)
Direct upgrade to 5.1.64

5.0.20 Release Notes

 

  • Compatible with Where 2.x (no longer compatible with Where 1.x)
  • The sensor will not transmit BLE tag data reports until a time synch message has been received from the Energy Manager (EM).  
  • The sensor supports the initiate driver discovery request command from Energy Manager.
  • Driver discovery performs auto-detection of Control Units and drivers that support ESI v4.8.
  • When BLE Beaconing is enabled by a command from the EM, the sensor will beacon at a 500msec interval and at 0dBm TX output power level.
  • Blue LED shut off when the light level is anything other than 100%
  • Sensor motion data is sent synchronized with the local clock
  • The sensor returns to factory defaults on de-commissioning
  • Startup sequence stays at 100% light level for two minutes at the end of the wiring test before going to the 65% default level
  • Modified wiring test so lighting control works even when no drivers are found during discovery or test fails
  • A workaround has been added to ensure that Ruggedized sensors get the correct Time-To-Live (TTL) max. setting of 15
Direct upgrade to 5.1.64

Gen 4 Sensors

The table below summarizes the new features and defect fixes for the latest Gen 4 sensor firmware releases.  Consult the release notes links in the table for additional information.

Firmware Version

New Features Bug Fixes Upgrade Path

5.6.2

(5.6.2 Release Notes)

  • Fixed the driver count that was occasionally incorrect after power loss.
  • Fixed the temperature readings that were occasionally incorrect after reaching high-temperature levels.
  • The ERC Auto button action is made consistent across all sensor states.  

Direct upgrade from 3.6.6 version

5.5.0

(5.5.0 Release Notes)

  • SU-5E sensors will have a 65% default output but will dim to 20% if motion is not seen for 19 minutes. SU-5S sensors have 100% default output and will dim to 20% if motion is not seen for 19 minutes.
  • Un-commissioned sensors will transmit a discovery response when strobed by a green laser.
  •  improves sensitivity to the green laser strobe. 
  • PIR motion detection algorithm modified
  • Fixed issues causing sensors in daylight harvesting groups to cycle slowly at undesirable light levels
  • Sensor no longer forces occupancy sensitivity to 1 when in a dark room 
  • Sensor ignores duplicate discovery requests
  • The sensor reports the time since the sensor detected motion to the Energy Manager.
  • Fixed issue that was causing the LED state to be temporarily incorrect when commissioned sensor which is in hopper mode is temporarily moved to the default channel during discovery or commissioning.
  • Protection added against inadvertent commands from the EM that enable or disable the hopper setting of a commissioned sensor
  • Improved robustness of the sensor during special states of operation.

Direct upgrade from 3.6.6 version

5.1.34

(5.1.34 Release Notes)

  • Profile start and end times may be synchronized with local sunrise and sunset (Astronomical Clock)
  • Daylight Harvesting Groups respond to daylight uniformly
  • Blinking blue LED wiring test result for non-metered configurations
  • Strobe detection level calibrated to support 1mW GREEN laser pointer (EU compliance)
  • Support for the Initiate Driver Discovery Request command from the EM
  • Compatible with Where 2.x (no longer compatible with Where 1.x)
  • The sensor will not transmit BLE tag data reports until a time synch message has been received from the Energy Manager (EM).  
  • The sensor supports the initiate driver discovery request command from Energy Manager.
  • Wiring test support for non-metered configurations
  • Sensor reset to the factory default configuration when decommissioned
  • Post wiring test behavior has been modified to hold the dimming output at full bright (100%) for 2 minutes before going to the default setting (65%)
  • Blue LED turned on by manually setting the light level to 100% and turned off by setting a light level other than 100%.
  • The LED blinking patterns (blue, red, green LEDs) are consistent with the SU-5 sensor family.
  • Daylight Harvesting light level reduction ramp is now 1% per 10 seconds
  • Daylight harvesting dimming Back-off timer prevents oscillation of light levels
  • Defaults light behavior on wiring test failure
  • Fixed issue with Virtual Switch Scene Requests on the sensor 
  • Hopping of Group Messages in switch and motions groups fixed
  • Dim and Linger timing corrected - lights dim to off as required
  • Manual AUTO and SCENE button behavior in ERC corrected 
  • Dim and Linger Behavior corrected when using ERC
  • Removed premature dimming truncation from dimming ramp up and downtimes
  • Daylight Harvesting slew rate supports a wider range of values
  • ERC AUTO button now correctly turns lights on to profile maximum when lights are off
  • Lighting control correctly operates when both Min and Max light levels are zero 
  • Daylight harvesting now works when the sensor detects no occupancy
  • Ambient light calibration fixed to correctly operate when lights are manually set to full-on (100%)
  • Modified wiring test so lighting control works even when no drivers are found during discovery or test fails
  • A workaround has been added to ensure that Ruggedized sensors get the correct Time-To-Live (TTL) max. setting of 15.

Gen 4 Sensors (6-wire):
SU-4E-01
SU-4S-H/SU-4S-L
SU-4S-HRW/HRB
SU-4S-LRW/LRB

Upgrade any FW 3.x.x --> 3.6.6 --> 5.1.34

Upgrade path for 2-wire  CS-D2/FS-D22:

Upgrade any 3.x --> 5.1.34

3.8

(3.8 Release Notes)

  • None
  • Fixes problem that caused continuous sensor resets when operating with multiple Philips XSR drivers 

Release for 2-wire CS-D2/FS-D22 sensors ONLY

Upgrade any 3.x.x --> 3.8

3.6.6

(3.6.6 Release Notes)

  • Sets of up to 20 CS-D2-FL sensors can be connected to a single power supply (PWR-NF) in series.
  • Network Performance Testing feature compatible with Energy Manager versions 3.8 and higher
  • Resolved EEPROM Corruption issue that was causing some sensors to behave incorrectly
 

Recommended articles:

 

 

Allowing EM v3.7.1 to Communicate with Gateway Firmware below v2.8

Compatibility Overview

To enhance security, Energy Manager v3.7 and above will not by default discover, upgrade, nor communicate with Gateways with firmware prior to version 2.8. In Energy Manager 3.8 and Manage 4.0 and above, it is possible to turn off this security setting in Administration > System Management > Security Settings.

mceclip0.png

For Energy Manager 3.7.1, follow the instructions below to turn off the security setting and enable discovery, upgrade, and communication with Gateways firmware versions prior to 2.8.

Update Gateway firmware to version 2.8.36 prior to upgrading EM to 3.7 and above.

Discovering and Communicating with Gateway Firmware Below 2.8

1.    Update System Configuration Values

Click Administration > System Management > System Configuration Values. In the  ‘Edit SystemConfig Value’   window, type “security.protocols” in Name and “TLSv1.2, TLSv1” in Value and click Save.

2.    Restart Tomcat

  1. Using putty, connect to Energy Manager using the IP address.
  2. Execute the command below to restart Tomcat
    ~$ sudo service tomcat restart
  3. Wait till Tomcat restarts successfully

To verify if Gateways are communicating with Energy Manager, select the floor in the left panel, and click Devices > Gateways tabs. Choose a Gateway on the floor and click Edit to view Gateway Details. Check the Last Communication field to see if the Gateway is communicating with the Energy Manager. You can also mouse hover on Gateway (from Floor plan) and check if it shows green.

Upgrading Gateway Firmware Below 2.8

If you did not upgrade Gateway firmware prior to upgrading to EM 3.7.1, it is still possible to perform the upgrade using a script:

  1. Secure Copy (SCP) the script provided by Enlighted, sh, into EM server in /home/enlighted directory.
  2. Run the script using sudo ./enabledisableoldgwupgrade .sh.
  3. Follow the regular Gateway upgrade method by going to Administration, Image Upgrade, and uploading and upgrading to the 2.8.36 gateway firmware.
  4. The upgrade should be successful and should be blinking Green and communicating.

Upgrading Gateway Firmware from v2.6.x to v2.8.36

Overview

This article describes the procedure for upgrading Gateway (GW) devices running Application versions 2.6.x and above for Energy Manager versions before 3.7.

Note: Upgrade Gateways before upgrading the Energy Manager to 3.7 and higher. If upgrading Gateways from Firmware before version 2.8, Energy Manager versions 3.7 and higher require additional steps to temporarily disable security enhancements (Refer to Instructions for allowing EM3.7.1 to Discover, Upgrade, and Communicate with Gateway Firmware below 2.8).

The Gateway firmware image upgrade process requires three steps:

  1. Determine the Gateway Application version
  2. Upload the Gateway Image
  3. Upgrade the Gateway Image

1.    Determine the Gateway Application Version

To determine which release runs on your gateway, login to Energy Manager (EM) GUI using HTTPS://<EM_IP_address_or_hostname> in a web browser with your username and password.

3_Login.png

Figure 1: Energy Manager Sign In

  1. Select a floor in the Facilities Left panel.
  2. Select Facilities > Devices > Gateways. The list of gateways on the floor is displayed.
  3. Select a Gateway and click Edit.

 GW_1.png

Figure 2: Select Gateways

This will result in the Gateway Details window. 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.

GW_2_version.png

Figure 3: Gateway Details

Note: The Application version in this example is 2.6.1, 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.

Download Gateway Image File

Based on the Application and Firmware versions running on the Gateway, obtain the necessary Gateway image files from Enlighted Support to upgrade the device.

  1. If your Gateway has an Application Version earlier than v2.6.1, Gateway updates are not possible. Return the Gateway to Enlighted for replacement.
  2. If your Gateway has Application v2.6.1 or v2.6.2, an intermediate upgrade to v2.6.3 is required prior to any further updates. Download 3538_gw.tar, upgrade the Gateway to Application v2.6.3 and proceed to the next step.
  3. If your Gateway has an Application version between 2.6.3 and 2.8.34, then upgrade the Gateway with 4033_gw.tar. This is an intermediate update, and after this update, the Firmware version should be 2.8.21.b4027.
  4. Upload the final 2.8.36 Gateway build (4034_gw.tar) and upgrade the Gateway to Application version 2.8.36.b4075.
Current App Ver on GW Current FW Ver on GW Use Image File Description
Earlier than 2.6.1 ̶ ̶ Return the device to Enlighted
2.6.1 or 2.6.2 ̶ 3538_gw.tar This image will upgrade the GW from Application Version 2.6.1 to Application Version 2.6.3
2.6.3 b2742 2.6.3 b2742 4033_gw.tar 4033_gw.tar is the intermediate image file that will upgrade the GW to App Version:2.8.34 b4072 and  FW Version: 2.6.3 b2742.
Note: This intermediate image file does not change the Firmware Version.
2.8.34 b4072 2.6.3 b2742 4034_gw.tar 4034_gw.tar will upgrade the GW to App Version: 2.8.36 b4075 and  FW Version: 2.8.21 b4027.


Note: After each image upgrade, confirm that the Gateway Details window, Figure 3, shows the updated Application version and Firmware version of the image.

2.    Upload Gateway Image

Download or obtain the appropriate Gateway firmware image file from Enlighted Support. Read the Prerequisites section.

Only the System Administrator can upload and upgrade image files running on a Gateway.

  1. Log in as an Administrator to the Energy Manager, HTTPS://<EM_IP_address_or_hostname> with your username and password.

 3_Login.png

Figure 4: Energy Manager Sign In

  1. After you are logged in, navigate to Administration > Image Upgrade.
  2. In the Image Upgrade screen, click Choose File to upload the image file to EM.
  3. Click the Upload to EM.

The following screen shows the Image Upgrade screen when the Administration > Image Upgrade is selected:

1_Image_Upgrade_Step1.png

Figure 5: Upload Gateway Image

If you have more than one Gateway image file to be uploaded, repeat the process until all image files are uploaded. 

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. Select all sensors, right-click, Set BLE Mode, Off. For more information, see Set Bluetooth (BLE) Mode.

To upgrade the Gateway image file,

  1. In the Image Upgrade window, click Upgrade.
  2. In the Facilities left panel, select a floor.
  3. Select the Gateway tab from the list of devices: Sensor, Gateway, ERC, Plugload.
  4. On the floor plan, choose one or more Gateways running the same Application Version to upgrade.
  5. Click the button to add the selected Gateways to the table. This step can be repeated.
  6. Select the image file from the Select a Gateway Image drop-down list.
  7. Click Start Upgrade to initiate the upgrade process.
  8. Check the status of the upgrade process by clicking Image Job History.
  9. 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:

1_Image_Upload_1.2.png

Figure 6: Gateway Image Upgrade

To check the status of the upgrade process, click Devices > Gateways within the Facilities display:

GW_Status.png

Figure 7: Gateway Upgrade Status

The Upgrade Status is displayed as Success or Fail.

  • Success — Gateway upgrade is successful.
  • Fail — Gateway upgrade failed.

If the status is displayed as Fail, verify the Application version and Firmware version in the Gateway Details window. Refer to section 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. Open the Gateway Details window again and verify the Application version and Firmware version.

GW_2_version.png

Figure 8: Gateway Details

If the Application version shows the updated image version number, the Gateway upgrade process is complete. Otherwise, repeat the upgrade procedure described in Upgrade the Gateway Firmware Image.

If the Gateway is not upgraded, check the Last Communication field in the Gateway Details window above. If the Gateway has not been communicating with the EM for several hours,  troubleshoot the Gateway connectivity with Energy Manager or contact Enlighted Support.  

The process described in this document should be repeated for all Gateways that are running Application version 2.6.x until all Gateways are updated to 2.8.36 and above. 

Recommended articles: