-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Use proper entity for water heater
This is a breaking change: it will remove the climate entity used to represent water heater state) to be replaced by dedicated heater Implementation is much simpler than before but also has less feature for now: - we can't start/stop the heater - we can't know the state of the heater (heating or not)
- Loading branch information
1 parent
3ed7aca
commit 49c5859
Showing
3 changed files
with
165 additions
and
177 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| from __future__ import annotations | ||
| import logging | ||
|
|
||
| from homeassistant.config_entries import ConfigEntry | ||
| from homeassistant.core import HomeAssistant, callback | ||
| from homeassistant.helpers.entity_platform import AddEntitiesCallback | ||
| from homeassistant.util import slugify | ||
| from homeassistant.components import mqtt | ||
| from homeassistant.components.mqtt.client import async_publish | ||
|
|
||
| from homeassistant.components.water_heater import ( | ||
| WaterHeaterEntityEntityDescription, | ||
| WaterHeaterEntity, | ||
| WaterHeaterEntityFeature, | ||
| STATE_ECO, | ||
| STATE_HIGH_DEMAND, | ||
| ) | ||
|
|
||
| from .definitions import lookup_by_value, OperatingMode | ||
| from . import build_device_info | ||
| from .const import DeviceType | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| async def async_setup_entry( | ||
| hass: HomeAssistant, | ||
| config_entry: ConfigEntry, | ||
| async_add_entities: AddEntitiesCallback, | ||
| ) -> None: | ||
| discovery_prefix = config_entry.data[ | ||
| "discovery_prefix" | ||
| ] # TODO: handle migration of entities | ||
| _LOGGER.debug( | ||
| f"Starting bootstrap of water heater entities with prefix '{discovery_prefix}'" | ||
| ) | ||
| """Set up HeishaMon water heater from config entry.""" | ||
| description = WaterHeaterEntityEntityDescription( | ||
| key=f"{discovery_prefix}main/DHW_Target_Temp", | ||
| name="Aquarea Domestic Water Heater", | ||
| ) | ||
| async_add_entities([HeishaMonDHW(hass, description, config_entry)]) | ||
|
|
||
|
|
||
| PRESET_COMFORT = "comfort" | ||
| PRESET_NONE = "none" | ||
|
|
||
|
|
||
| class HeishaMonDHW(WaterHeaterEntity): | ||
| """Representation of a HeishaMon sensor that is updated via MQTT.""" | ||
|
|
||
| operation_modes_temps = { | ||
| "52": STATE_ECO, | ||
| "60": STATE_HIGH_DEMAND, | ||
| } | ||
|
|
||
| def __init__( | ||
| self, | ||
| hass: HomeAssistant, | ||
| description: WaterHeaterEntityEntityDescription, | ||
| config_entry: ConfigEntry, | ||
| ) -> None: | ||
| """Initialize the water heater entity.""" | ||
| self.config_entry_entry_id = config_entry.entry_id | ||
| self.entity_description = description | ||
| self.hass = hass | ||
| self.discovery_prefix = config_entry.data[ | ||
| "discovery_prefix" | ||
| ] # TODO: handle migration of entities | ||
|
|
||
| slug = slugify(self.entity_description.key.replace("/", "_")) | ||
| self.entity_id = f"climate.{slug}" | ||
| self._attr_unique_id = f"{config_entry.entry_id}.water_heater" | ||
|
|
||
| self._attr_temperature_unit = "°C" | ||
| self._attr_supported_features = ( | ||
| WaterHeaterEntityFeature.TARGET_TEMPERATURE | ||
| | WaterHeaterEntityFeature.ON_OFF | ||
| | WaterHeaterEntityFeature.OPERATION_MODE | ||
| ) | ||
| self._attr_current_operation = STATE_ECO | ||
| self._attr_min_temp = 40 | ||
| self._attr_max_temp = 65 | ||
| self._attr_precision = 1 | ||
| self._attr_operation_list = [STATE_ECO, STATE_HIGH_DEMAND] | ||
| self._heat_delta = 0 | ||
|
|
||
| async def async_set_temperature(self, **kwargs) -> None: | ||
| temperature = kwargs.get("temperature") | ||
| _LOGGER.debug(f"Changing {self.name} target temperature to {temperature})") | ||
| payload = str(temperature) | ||
| self.update_temperature_bounds() # optimistic update | ||
| await async_publish( | ||
| self.hass, | ||
| f"{self.discovery_prefix}commands/SetDHWTemp", | ||
| payload, | ||
| 0, | ||
| False, | ||
| "utf-8", | ||
| ) | ||
|
|
||
| async def async_set_operation_mode(self, operation_mode: str): | ||
| temp = lookup_by_value(HeishaMonDHW.operation_modes_temps, operation_mode) | ||
| if temp is None: | ||
| _LOGGER.warn( | ||
| f"No target temperature implemented for {operation_mode}, ignoring" | ||
| ) | ||
| return | ||
| await self.async_set_temperature(temperature=float(temp)) | ||
|
|
||
| def update_temperature_bounds(self) -> None: | ||
| self._attr_target_temperature_high = self._attr_target_temperature | ||
| self._attr_target_temperature_low = ( | ||
| self._heat_delta + self._attr_target_temperature | ||
| ) | ||
|
|
||
| async def async_added_to_hass(self) -> None: | ||
| """Subscribe to MQTT events.""" | ||
|
|
||
| @callback | ||
| def current_temperature_message_received(message): | ||
| self._attr_current_temperature = float(message.payload) | ||
| self.async_write_ha_state() | ||
|
|
||
| await mqtt.async_subscribe( | ||
| self.hass, | ||
| f"{self.discovery_prefix}main/DHW_Temp", | ||
| current_temperature_message_received, | ||
| 1, | ||
| ) | ||
|
|
||
| @callback | ||
| def target_temperature_message_received(message): | ||
| self._attr_target_temperature = float(message.payload) | ||
| self.update_temperature_bounds() # optimistic update | ||
| self._attr_current_operation = HeishaMonDHW.operation_modes_temps.get( | ||
| str(int(self._attr_target_temperature)), PRESET_NONE | ||
| ) | ||
| self.async_write_ha_state() | ||
|
|
||
| await mqtt.async_subscribe( | ||
| self.hass, | ||
| f"{self.discovery_prefix}main/DHW_Target_Temp", | ||
| target_temperature_message_received, | ||
| 1, | ||
| ) | ||
|
|
||
| @callback | ||
| def heat_delta_received(message): | ||
| self._heat_delta = int(message.payload) | ||
| self.update_temperature_bounds() | ||
| self.async_write_ha_state() | ||
|
|
||
| await mqtt.async_subscribe( | ||
| self.hass, | ||
| f"{self.discovery_prefix}main/DHW_Heat_Delta", | ||
| heat_delta_received, | ||
| 1, | ||
| ) | ||
|
|
||
| @property | ||
| def device_info(self): | ||
| return build_device_info(DeviceType.HEATPUMP, self.discovery_prefix) |