Firmware EMS-ESP 3.5.0 has been available as a beta for quite some time and it had already been loaded on new Gateways since October 2022, the release version of 3.5.0 (stable) is now available as well.
Thanks to a lot of work by Proddy and MichaelDvP and assisted by a number of other contributors, this is one of the most feature rich updates yet.
— Remember the firmware is completely open source —
The the most noticeable new feature is going to be the addition of localization. This means you can now change the language from English to other languages. The release of 3.5.0 will contain English, German, Dutch, Polish, French, Swedish and Norwegian language.
This localization is in all major parts of EMS-ESP: the web interface and MQTT.
There are however some breaking changes. The most important one is that there is now support for multiple Gateways on a single MQTT broker. When enabled, which is now the default, all MQTT Discovery Entity IDs will include the MQTT base name and the shortname of the EMS-ESP device entity. For example what was previously sensor.boiler_actual_boiler_temperature
will now become sensor.ems_esp_boiler_boiltemp
. This means these entities will have to be replaced inside HA. See below. If you still want to use the old format and retain the history and script compatibility in Home Assistant then set this back to the old format.
New features and updates
Summary of new stuff:
- Localization: addition of German, Dutch, Polish, Swedish, French and Norwegian language options.
- Support for multiple Gateways on the same broker (for hybrid systems and for multiple boilers/cascade)
- 100+ bug fixes and new features
- Added initial support for ESP32 C3 and S2 architectures
- Several new board profiles
- Improvements in HA Discovery and MQTT handling
- Addition of new EMS boilers, thermostats and other devices (Greenstar 30, GBH192iT, FW500, BC30)
- Addition of additional parameters of known EMS devices (f.i. RC30 internal temp, 20+ heat pump parameters)
- Improved handling of logic/telegrams of some EMS devices
- Setting the 4 multi-purpose relays/inputs of heatpumps (via API)
Full release notes see: https://emsesp.github.io/docs/#/Release-notes
How to update to 3.5.0
To update to the release version of 3.5.0 depends on which firmware you are on now, and when you purchased a Gateway product. In most cases you should first try out an update via the web interface. If it succeeds, you are on 3.5.0. If it fails you need to flash the Gateway via the internal USB connection on the Gateway board.
Read the instructions below for the correct update procedure for your situation.
If you are currently on any 3.3 or older version you need to use the USB method anyway.
If you are currently on any 3.4 or 3.5 version first try the update via the web interface and if it fails update via the USB port.
Method one: Update via the web interface
Download the 3.5.0 bin file from the repository. Then open the web interface of the Gateway, go to System->Upload and select the bin file you just downloaded.
See: https://bbqkees-electronics.nl/wiki/gateway/firmware-update-and-downgrade.html#updating-firmware-via-the-web-interface
The upload will take about a minute. If the Gateway has installed the firmware and rebooted itself, you should see the login screen again after a while. Press F5 to clear the browser cache. Then login.
Settings should be pertained.
In case you get an error 500 during the upload, you need to move on to method two below.
In case you have an E32 Gateway and it became unreachable after the update, the board profile might have been reset to S32 or Custom. Please login to the ems-esp access point, set the board profile back to E32, save, and reboot. Ethernet will be activated again.
Method two: Update via the USB port
If a lot of cases you need to upload this firmware via the USB port on the inside of the Gateway. It is the only time this is needed, if 3.5.0 is installed once, all future updates can be done via the web interface.
You need to open the Gateway, plug in the USB to a computer and load the firmware via the EMS-ESP flash tool. DO NOT use another flash tool as it will not work.
All settings will be lost after this update, so make a note of all important ones.
(You can also backup your settings and customizations before the update and load them once the update is done).
For the detailed update procedure look here: https://bbqkees-electronics.nl/wiki/gateway/firmware-update-and-downgrade.html#uploading-the-firmware-via-ems-esp-flasher-flashtool
If you have questions about the update you can send me an email via the contact form.
Breaking change: MQTT entity ID’s
For a number of entities in Home Assistant the unique ID has changed in the auto discovery config . This means these entities will have to be replaced inside HA.
This is because there is now support for multiple Gateways on a single MQTT broker. When enabled, which is now the default, all MQTT Discovery Entity IDs will include the MQTT base name and the shortname of the EMS-ESP device entity. For example what was previously sensor.boiler_actual_boiler_temperature
will now become sensor.ems_esp_boiler_boiltemp
. This means these entities will have to be replaced inside HA. See below. If you still want to use the old format and retain the history and script compatibility in Home Assistant then set this back to the old format.
There is a new checkbox in the Settings to keep the ID as in firmware 3.4 for those who do not want to switch now.
Another way is to rename the entity ID’s in the HA database with a script. See: https://github.com/emsesp/EMS-ESP32/issues/804
Possible bugs
After the update to 3.5.0 it is possible that sometimes during loading or viewing of the web interface you’ll get an Error 507.
This is because the new web interface needs a fairly large chunk of memory, which is not always available. You get this error 507 then. All other services on the Gateway will continue to work. See: https://github.com/emsesp/EMS-ESP32/issues/823