Skip to main content

Changelog

Added​

  • Added diagnostics. The host, the credentials and the serial number are redacted.
  • Updated the IP address of a configured control unit when Home Assistant discovers it with a new IP address. A configured hostname is kept.
  • Removed the devices that the control unit no longer provides (e.g. a removed buffer tank) with their entities when the integration is set up.
  • Added a preview image to the documentation for links shared on social media.

Changed​

  • Required keba_keenergy_api 2.13.0b9, which needs fewer requests to set up the integration.
  • Moved the documentation to Docusaurus on https://superbox-dev.github.io/keba_keenergy/, styled after the integration pages of Home Assistant, with all information on one page. The domain superbox.one is no longer used.
  • Shortened the README.md to the installation and moved the details to the documentation.
  • Linked the GitHub release notes to the matching section of the changelog.
  • Extended the issue templates with the environment and debug logs.
  • Moved the static entity icons to icons.json. The icons are unchanged, but the entities no longer have an icon state attribute.
  • Wrote the HVAC mode of a heating circuit only if it differs from the current operating mode.
  • Translated the error message of failed data updates.
  • Requested the time zone of the Web HMI for a preset mode change of a heating circuit only if the away date range changes.
  • Provided the exact values of the energy, operating time and runtime sensors that are converted to kWh and hours, instead of rounding them to two decimals. They are still displayed with two decimals.
  • Wrote the points of the keba_keenergy.set_heating_curve_points action only if they differ from the points of the heating curve.
  • Showed the documentation only in the light theme with the colors of the integration pages on home-assistant.io, the "My Home Assistant" button to add the integration below the logo and a wider right column on smaller screens.
  • Focused the search of the documentation with / instead of Ctrl/Cmd + K, styled the search like home-assistant.io and made the header translucent.

Fixed​

  • Fixed entities showing a new value until the next update, although writing it to the control unit failed.
  • Fixed a new value of an entity jumping back to the previous value until the next update, if the value was set while the integration was reading the values of the control unit.
  • Fixed the error Platform keba_keenergy does not generate unique IDs in the log of heating circuits with cooling and photovoltaics, the number excess_energy_cooling_limit_day was defined twice.
  • Fixed the missing translations of the states of the excess_energy_mode and mixer_position sensors.
  • Fixed the missing state icons of the operating mode sensors since 1.10.0.
  • Fixed the away date range being written to the control unit even if it did not change. (Issue #23)
  • Fixed the target temperature of a hot water tank being written to the control unit even if it did not change.
  • Fixed an error of the climate entity if a heating circuit is in the operating mode external or room_control.
  • Fixed a pending change of a number, climate or water heater entity being written after the integration was unloaded.
  • Fixed an untranslated error of the keba_keenergy.set_heating_curve_points action if the Web HMI is not reachable.
  • Fixed an untranslated error of the keba_keenergy.set_away_date_range action for an invalid date.
  • Fixed an error of number, climate and water heater entities if the Web HMI provides no limits.
  • Fixed a second switch Use cooling curve for heating circuits that heat and cool. Both switches changed the same setting, so these heating circuits now only have the switch Use heating curve. The switch Use cooling curve of such a heating circuit is no longer provided and can be deleted.
  • Fixed the entity ID of the switch Use cooling curve, which ended in use_heating_curve instead of use_cooling_curve. Only newly added switches get the new entity ID, existing ones keep theirs.
  • Fixed the icon of the climate entity, which showed off for a heating circuit in the HVAC mode auto, cool or heat_cool. The icon is now in icons.json, so the climate entities no longer have an icon state attribute.
  • Fixed the keba_keenergy.set_heating_curve_points action accepting an empty list of points, which wrote a heating curve with 7 points of 0 °C.
  • Fixed an error with a traceback in the log if a delayed write of a number, climate or water heater entity failed, e.g. of a temperature set with a slider. It is logged as a warning now.
  • Fixed values of sensors and failure inputs that the control unit reports as not in use (e.g. not connected), such as a failure of the binary sensor has_compressor_failure without a connected input. These sensors are now unknown and the climate and water heater entities leave out their values. The sensors and binary sensors have the message ID of the control unit as attribute message_id (0 means in use), which is read with one more request per update. (Issue #67)

Security​

  • Removed the serial number of the control unit from the debug log of the discovery and of removed devices.

1.10.4 - 2026-09-30​

Changed​

  • Required Home Assistant 2026.9.4 or newer.

Fixed​

  • Fixed Home Assistant device registry deprecation warnings by linking the devices to the control unit with via_device_id instead of via_device.
  • Fixed an error when opening the options if the control unit has no photovoltaics. (Issue #66)

1.10.3 - 2026-07-28​

Fixed​

  • Required Home Assistant 2026.7.0 or newer, which includes aiohttp 3.14 with encode_basic_auth(). (Issue #65)

1.10.2 - 2026-07-18​

Changed​

  • Updated keba_keenergy_api to 2.12.2. (Issue #63)

Fixed​

  • Fixed the missing "Auto cool" option of the control unit operating mode select. (Issue #60)

1.10.1 - 2026-05-21​

Fixed​

  • Fixed the missing translation of the photovoltaics device.
  • Fixed the missing API error message and improved the error logging. (Issue #59)
  • Fixed API requests for values that the control unit or its software version does not provide. These values are now filtered before the first update. (Issue #59)

1.10.0 - 2026-05-19​

Added​

  • Added numbers and sensors for the heating limits (day and night) of the heating circuits. (Issue #46)
  • Added support for heating circuits with active or passive cooling: the climate entity supports the cool mode, and the heating circuits got the cooling curve select, the cooling curve offset and slope, the cooling limits, the target room cooling temperatures and the cool request sensor. (Issue #47)
  • Added the passive cooling device with temperature, switch valve position, circulation pump speed and mixer sensors. (Issue #47)
  • Added the sensor "Return flow temperature (mixer)" to the heating circuit.
  • Added the photovoltaics device with the sensors "Excess power", "Daily energy" and "Total energy". (Issue #55)
  • Added the entities to use the excess energy (PV surplus) of photovoltaics: "PV surplus" binary sensors, "Use PV surplus" switches, target temperatures, hystereses and heating and cooling limits for PV surplus, the electricity consumption from PV surplus and the operating hours, maximum runtime and activation counter during PV surplus. (Issue #55)
  • Added the sensor "Mixer" and the binary sensor "Pump state" to the heating circuit. (Issue #57)
  • Added attributes to the mixer position sensor. (Issue #58)

Changed​

  • Required Python 3.14 and Home Assistant 2026.3.0 or newer.
  • Updated keba_keenergy_api to 2.12.0.
  • Hid the sensors that are not available in the heat pump setup, e.g. room temperature, room humidity, mixer, pump, return flow temperature, fresh water module and outdoor temperature. (Issue #47)
  • Moved the coefficient of performance, the seasonal performance factors and other technical sensors to the diagnostic entity category.
  • Renamed the heat pump sensor "Circulation pump" to "Circulation pump speed". Existing entity IDs are not changed.
  • Updated the English and German translations.

Fixed​

  • Fixed the state of the control unit "Operating mode" select being updated with a delay.
  • Fixed connection failures with .local hostnames by using IPv4 for the HTTP client.
  • Fixed duplicate entities.
  • Fixed the wrong detection of the heating circuit pump. (Issue #57)

1.9.1 - 2026-04-03​

Security​

  • Updated keba_keenergy_api to 2.10.2, which updates aiohttp from 3.13.3 to 3.13.4. (CVE-2026-34513)

1.9.0 - 2026-03-15​

Added​

  • Added the "Scan interval" option and an update multiplier option for each device type, to update the values of a device only every n-th scan interval. The options only show the device types of the heat pump setup. (Issue #30)
  • Added the sensor "Pump speed" to the heating circuit. (Issue #34)
  • Added reauthentication. If the Web HMI rejects the credentials, Home Assistant asks for the new credentials. (Issue #35)
  • Added the reconfiguration flow to change the host and the credentials. (Issue #35)

Changed​

  • Implemented rules of the Home Assistant integration quality scale: runtime-data, config-entry-unloading, action-setup, parallel-updates, entity-category, icon-translations, strict-typing and descriptions for all config flow fields. (Issue #35)
  • Added support for Python 3.14.
  • Updated keba_keenergy_api to 2.10.1.

1.8.1 - 2026-02-20​

Fixed​

  • Fixed the missing names of the heating curves. (Issue #36)

1.8.0 - 2026-02-17​

Added​

  • Added the sensors "Target overheating", "Current overheating" and "Expansion valve position" to the heat pump. (Issue #29)
  • Added the sensor "Circulation return temperature" (disabled by default) and the binary sensor "Circulation pump state" to the hot water tank. (Issue #24)
  • Added the select "Heating curve", the numbers "Heating curve offset" and "Heating curve slope" and the switch "Use heating curve" to the heating circuit. (Issue #24)
  • Added the set_heating_curve_points action to set up to 16 points of a heating curve. (Issue #24)
  • Added the sensor "Heating curve" with the points of the heating curve as attributes. (Issue #28)

Changed​

  • Updated keba_keenergy_api to 2.9.0.
  • Rejected an end date before the start date in the set_away_date_range action.
  • Translated the error messages of the actions and of failed write requests.
  • Added a default display precision to the sensors without a unit.
  • Improved the entity icons and disabled some rarely used entities by default.
  • Updated the English and German translations.

Fixed​

  • Fixed the unit of the solar circuit sensors "Heating energy" and "Daily energy", which showed J as kWh. (Issue #32)
  • Fixed the translation of the switch valve position. (Issue #31)

1.7.0 - 2026-01-31​

Added​

  • Added the set_away_date_range action to set the away period of the heating circuits. (Issue #20)
  • Added a blueprint to set the away date range from a calendar event. (Issue #20)
  • Added a repair issue if more than 30 write operations are performed in a week, because frequent writes reduce the lifetime of the flash memory of the control unit. The counter is kept across restarts. (Issue #23)

Changed​

  • Wrote values only if they changed, and wrote changes of numbers, target temperatures and the climate entity after a short delay, so several quick changes result in one write operation. (Issue #23)
  • Disabled the numbers that are rarely changed by default. (Issue #23)
  • Updated keba_keenergy_api to 2.8.1.
  • Changed the documentation link to https://superbox.one.

Fixed​

  • Fixed the missing English translations.

1.6.1 - 2026-01-24​

Added​

  • Added the sensor "Target room temperature (selected)" to the heating circuit. It always shows the current target temperature (day, night, ...) without the offset.

Changed​

  • Updated keba_keenergy_api to 2.8.0.

Fixed​

  • Fixed the slow update of entities after a change, e.g. of the operating mode or the preset mode of the climate entity.
  • Fixed the wrong target temperature of the climate entity. (Issue #19)
  • Fixed the preset mode "away" of the climate entity. (Issue #21)

1.6.0 - 2026-01-18​

Added​

  • Added support for switch valves.
  • Added the diagnostic binary sensors "Compressor", "Source actuator", "Source", "Source pressure", "Three-phase" and "Variable drive frequency" to the heat pump to show failures.

Changed​

  • Read values that never change, e.g. the number of heating circuits, only once on setup.
  • Skipped API requests that the KEBA software version does not support.
  • Updated keba_keenergy_api to 2.7.0.

1.5.0 - 2026-01-11​

Added​

  • Added support for buffer tanks.
  • Added the sensors "Source pump speed", "Vaporization temperature", "Condensation temperature" and "Substate" to the heat pump.
  • Added the number "Compressor speed (night)" and the switch "Compressor speed limit (night)" to the heat pump.
  • Added the switch "Priority 1 before 2" to the solar circuit.

Changed​

  • Enabled more sensors by default.
  • Updated keba_keenergy_api to 2.6.0.

Fixed​

  • Fixed the authentication with umlauts in the credentials.

1.4.0 - 2026-01-03​

Added​

  • Added support for solar circuits.

Changed​

  • Updated keba_keenergy_api to 2.4.0.

1.3.1 - 2025-12-09​

Fixed​

  • Fixed the missing heat request states of the heating circuit in the HVAC action of the climate entity.

1.3.0 - 2025-10-29​

Added​

  • Added the diagnostic sensors "CPU usage", "WebView CPU usage", "WebServer CPU usage", "Control CPU usage", "RAM usage" and "Free RAM" to the control unit.

Changed​

  • Attached keba_keenergy.zip to the GitHub releases, HACS installs the integration from it.

1.2.2 - 2025-10-19​

Changed​

  • Requested only the values that the hardware and software version of the Web HMI support.
  • Removed the discovery of AP 420 control units.
  • Updated keba_keenergy_api to 2.3.1.
  • Updated the English and German translations.

Fixed​

  • Fixed API errors for devices that are not installed, e.g. if there is no external heat source.

1.2.1 - 2025-10-15​

Added​

  • Added the discovery of AP 420 control units and of all AP 440 control units.

Changed​

  • Logged the authentication check of the config flow as debug message instead of error.

Fixed​

  • Fixed requests to API endpoints that some control units, e.g. AP 420/H-A, do not support.

1.2.0 - 2025-10-15​

Added​

  • Added the username and password for Web HMIs with login, required by newer software versions.
  • Added the number "Target room temperature (offset)" to the heating circuit.
  • Added support for external heat sources with operating mode, target temperature, heat request, operating hours, maximum runtime and activation counter.
  • Added the sensors "Operating hours", "Maximum runtime" and "Activation counter" to the heat pump.
  • Added the flow and return flow temperature sensors of the heating circuits.
  • Added the manufacturer "ino" to the device info.

Changed​

  • Disabled the sensors that not all heat pumps support by default.
  • Disabled the SSL certificate verification, because newer software versions of the Web HMI use self-signed certificates.
  • Changed the device class of the operating hours to duration.
  • Updated keba_keenergy_api to 2.2.0.
  • Updated the English and German translations.

Removed​

  • Removed the entities to limit the compressor speed at night, for compatibility with older software versions.

Fixed​

  • Fixed the state class of sensors.

1.1.0 - 2025-09-30​

Added​

  • Added the energy management sensors to the heat pump, e.g. power, energy, electricity consumption and coefficient of performance.
  • Added selects for the operating modes of the control unit, heating circuits and hot water tanks.
  • Added the number and switch to limit the compressor speed at night.
  • Added the sensors "Hot water flow", "Fresh water module temperature" and "Flow temperature setpoint".
  • Added the heat request state "Off (room temperature reached)" of the heating circuit.

Changed​

  • Translated the manufacturer and model name of the heat pump device.
  • Logged API errors as errors instead of debug messages.
  • Updated keba_keenergy_api to 2.0.0.
  • Updated the English and German translations.

Fixed​

  • Fixed the slow update after changing a number.
  • Fixed the upper target temperature of the water heater.

1.0.1 - 2025-09-12​

Added​

  • Added German translations, also for the heating circuit and hot water tank devices.

Fixed​

  • Fixed the wrong unit of the room humidity sensor.

1.0.0 - 2025-09-01​

Added​

  • Added the config flow with host and SSL, and the discovery of AP 440 control units.
  • Added the control unit, heat pump, heating circuit and hot water tank devices.
  • Added the climate entities of the heating circuits and the water heater entities of the hot water tanks.
  • Added the numbers for the target temperatures of the heating circuits (day, night, holiday) and the hot water tanks.
  • Added the sensors for the outdoor temperature, the operating modes, the heat pump state, temperatures, pressures and compressor, and the binary sensor for the heat request.