climate.py

Go to the documentation of this file.

"""Platform for climate integration."""
 
from __future__ import annotations
 
from datetime import timedelta
from typing import Any
 
from pymelcloud import DEVICE_TYPE_ATA, DEVICE_TYPE_ATW, AtaDevice, AtwDevice
import pymelcloud.ata_device as ata
import pymelcloud.atw_device as atw
from pymelcloud.atw_device import (
    PROPERTY_ZONE_1_OPERATION_MODE,
    PROPERTY_ZONE_2_OPERATION_MODE,
    Zone,
)
import voluptuous as vol
 
from homeassistant.components.climate import (
    ATTR_HVAC_MODE,
    DEFAULT_MAX_TEMP,
    DEFAULT_MIN_TEMP,
    ClimateEntity,
    ClimateEntityFeature,
    HVACAction,
    HVACMode,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_TEMPERATURE, UnitOfTemperature
from homeassistant.core import HomeAssistant
from homeassistant.helpers import config_validation as cv, entity_platform
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import MelCloudDevice
from .const import (
    ATTR_STATUS,
    ATTR_VANE_HORIZONTAL,
    ATTR_VANE_HORIZONTAL_POSITIONS,
    ATTR_VANE_VERTICAL,
    ATTR_VANE_VERTICAL_POSITIONS,
    CONF_POSITION,
    DOMAIN,
    SERVICE_SET_VANE_HORIZONTAL,
    SERVICE_SET_VANE_VERTICAL,
)
 
SCAN_INTERVAL = timedelta(seconds=60)
 
 
ATA_HVAC_MODE_LOOKUP = {
    ata.OPERATION_MODE_HEAT: HVACMode.HEAT,
    ata.OPERATION_MODE_DRY: HVACMode.DRY,
    ata.OPERATION_MODE_COOL: HVACMode.COOL,
    ata.OPERATION_MODE_FAN_ONLY: HVACMode.FAN_ONLY,
    ata.OPERATION_MODE_HEAT_COOL: HVACMode.HEAT_COOL,
}
ATA_HVAC_MODE_REVERSE_LOOKUP = {v: k for k, v in ATA_HVAC_MODE_LOOKUP.items()}
 
 
ATW_ZONE_HVAC_MODE_LOOKUP = {
    atw.ZONE_OPERATION_MODE_HEAT: HVACMode.HEAT,
    atw.ZONE_OPERATION_MODE_COOL: HVACMode.COOL,
}
ATW_ZONE_HVAC_MODE_REVERSE_LOOKUP = {v: k for k, v in ATW_ZONE_HVAC_MODE_LOOKUP.items()}
 
ATW_ZONE_HVAC_ACTION_LOOKUP = {
    atw.STATUS_IDLE: HVACAction.IDLE,
    atw.STATUS_HEAT_ZONES: HVACAction.HEATING,
    atw.STATUS_COOL: HVACAction.COOLING,
    atw.STATUS_STANDBY: HVACAction.IDLE,
    # Heating water tank, so the zone is idle
    atw.STATUS_HEAT_WATER: HVACAction.IDLE,
    atw.STATUS_LEGIONELLA: HVACAction.IDLE,
    # Heat pump cannot heat in this mode, but will be ready soon
    atw.STATUS_DEFROST: HVACAction.PREHEATING,
}
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up MelCloud device climate based on config_entry."""
    mel_devices = hass.data[DOMAIN][entry.entry_id]
    entities: list[AtaDeviceClimate | AtwDeviceZoneClimate] = [
        AtaDeviceClimate(mel_device, mel_device.device)
        for mel_device in mel_devices[DEVICE_TYPE_ATA]
    ]
    entities.extend(
        [
            AtwDeviceZoneClimate(mel_device, mel_device.device, zone)
            for mel_device in mel_devices[DEVICE_TYPE_ATW]
            for zone in mel_device.device.zones
        ]
    )
    async_add_entities(
        entities,
        True,
    )
 
    platform = entity_platform.async_get_current_platform()
    platform.async_register_entity_service(
        SERVICE_SET_VANE_HORIZONTAL,
        {vol.Required(CONF_POSITION): cv.string},
        "async_set_vane_horizontal",
    )
    platform.async_register_entity_service(
        SERVICE_SET_VANE_VERTICAL,
        {vol.Required(CONF_POSITION): cv.string},
        "async_set_vane_vertical",
    )
 
 
class MelCloudClimate(ClimateEntity):
    """Base climate device."""
 
    _attr_temperature_unit = UnitOfTemperature.CELSIUS
    _attr_has_entity_name = True
    _attr_name = None
    _enable_turn_on_off_backwards_compatibility = False
 
    def __init__(self, device: MelCloudDevice) -> None:
        """Initialize the climate."""
        self.apiapi = device
        self._base_device_base_device = self.apiapi.device
 
    async def async_update(self) -> None:
        """Update state from MELCloud."""
        await self.apiapi.async_update()
 
    @property
    def target_temperature_step(self) -> float | None:
        """Return the supported step of target temperature."""
        return self._base_device_base_device.temperature_increment
 
 
class AtaDeviceClimate(MelCloudClimate):
    """Air-to-Air climate device."""
 
    _attr_supported_features = (
        ClimateEntityFeature.FAN_MODE
        | ClimateEntityFeature.TARGET_TEMPERATURE
        | ClimateEntityFeature.SWING_MODE
        | ClimateEntityFeature.TURN_OFF
        | ClimateEntityFeature.TURN_ON
    )
 
    def __init__(self, device: MelCloudDevice, ata_device: AtaDevice) -> None:
        """Initialize the climate."""
        super().__init__(device)
        self._device_device = ata_device
 
        self._attr_unique_id_attr_unique_id = f"{self.api.device.serial}-{self.api.device.mac}"
        self._attr_device_info_attr_device_info = self.apiapi.device_info
 
    @property
    def extra_state_attributes(self) -> dict[str, Any] | None:
        """Return the optional state attributes with device specific additions."""
        attr = {}
 
        if vane_horizontal := self._device_device.vane_horizontal:
            attr.update(
                {
                    ATTR_VANE_HORIZONTAL: vane_horizontal,
                    ATTR_VANE_HORIZONTAL_POSITIONS: self._device_device.vane_horizontal_positions,
                }
            )
 
        if vane_vertical := self._device_device.vane_vertical:
            attr.update(
                {
                    ATTR_VANE_VERTICAL: vane_vertical,
                    ATTR_VANE_VERTICAL_POSITIONS: self._device_device.vane_vertical_positions,
                }
            )
        return attr
 
    @property
    def hvac_mode(self) -> HVACMode | None:
        """Return hvac operation ie. heat, cool mode."""
        mode = self._device_device.operation_mode
        if not self._device_device.power or mode is None:
            return HVACMode.OFF
        return ATA_HVAC_MODE_LOOKUP.get(mode)
 
    def _apply_set_hvac_mode(
        self, hvac_mode: HVACMode, set_dict: dict[str, Any]
    ) -> None:
        """Apply hvac mode changes to a dict used to call _device.set."""
        if hvac_mode == HVACMode.OFF:
            set_dict["power"] = False
            return
 
        operation_mode = ATA_HVAC_MODE_REVERSE_LOOKUP.get(hvac_mode)
        if operation_mode is None:
            raise ValueError(f"Invalid hvac_mode [{hvac_mode}]")
 
        set_dict["operation_mode"] = operation_mode
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.OFF:
            set_dict["power"] = True
 
    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set new target hvac mode."""
        set_dict: dict[str, Any] = {}
        self._apply_set_hvac_mode_apply_set_hvac_mode(hvac_mode, set_dict)
        await self._device_device.set(set_dict)
 
    @property
    def hvac_modes(self) -> list[HVACMode]:
        """Return the list of available hvac operation modes."""
        return [HVACMode.OFF] + [
            ATA_HVAC_MODE_LOOKUP[mode]
            for mode in self._device_device.operation_modes
            if mode in ATA_HVAC_MODE_LOOKUP
        ]
 
    @property
    def current_temperature(self) -> float | None:
        """Return the current temperature."""
        return self._device_device.room_temperature
 
    @property
    def target_temperature(self) -> float | None:
        """Return the temperature we try to reach."""
        return self._device_device.target_temperature
 
    async def async_set_temperature(self, **kwargs: Any) -> None:
        """Set new target temperature."""
        set_dict: dict[str, Any] = {}
        if ATTR_HVAC_MODE in kwargs:
            self._apply_set_hvac_mode_apply_set_hvac_mode(
                kwargs.get(ATTR_HVAC_MODE, self.hvac_modehvac_modehvac_modehvac_modehvac_mode), set_dict
            )
 
        if ATTR_TEMPERATURE in kwargs:
            set_dict["target_temperature"] = kwargs.get(ATTR_TEMPERATURE)
 
        if set_dict:
            await self._device_device.set(set_dict)
 
    @property
    def fan_mode(self) -> str | None:
        """Return the fan setting."""
        return self._device_device.fan_speed
 
    async def async_set_fan_mode(self, fan_mode: str) -> None:
        """Set new target fan mode."""
        await self._device_device.set({"fan_speed": fan_mode})
 
    @property
    def fan_modes(self) -> list[str] | None:
        """Return the list of available fan modes."""
        return self._device_device.fan_speeds
 
    async def async_set_vane_horizontal(self, position: str) -> None:
        """Set horizontal vane position."""
        if position not in self._device_device.vane_horizontal_positions:
            raise ValueError(
                f"Invalid horizontal vane position {position}. Valid positions:"
                f" [{self._device.vane_horizontal_positions}]."
            )
        await self._device_device.set({ata.PROPERTY_VANE_HORIZONTAL: position})
 
    async def async_set_vane_vertical(self, position: str) -> None:
        """Set vertical vane position."""
        if position not in self._device_device.vane_vertical_positions:
            raise ValueError(
                f"Invalid vertical vane position {position}. Valid positions:"
                f" [{self._device.vane_vertical_positions}]."
            )
        await self._device_device.set({ata.PROPERTY_VANE_VERTICAL: position})
 
    @property
    def swing_mode(self) -> str | None:
        """Return vertical vane position or mode."""
        return self._device_device.vane_vertical
 
    async def async_set_swing_mode(self, swing_mode: str) -> None:
        """Set vertical vane position or mode."""
        await self.async_set_vane_verticalasync_set_vane_vertical(swing_mode)
 
    @property
    def swing_modes(self) -> list[str] | None:
        """Return a list of available vertical vane positions and modes."""
        return self._device_device.vane_vertical_positions
 
    async def async_turn_on(self) -> None:
        """Turn the entity on."""
        await self._device_device.set({"power": True})
 
    async def async_turn_off(self) -> None:
        """Turn the entity off."""
        await self._device_device.set({"power": False})
 
    @property
    def min_temp(self) -> float:
        """Return the minimum temperature."""
        min_value = self._device_device.target_temperature_min
        if min_value is not None:
            return min_value
 
        return DEFAULT_MIN_TEMP
 
    @property
    def max_temp(self) -> float:
        """Return the maximum temperature."""
        max_value = self._device_device.target_temperature_max
        if max_value is not None:
            return max_value
 
        return DEFAULT_MAX_TEMP
 
 
class AtwDeviceZoneClimate(MelCloudClimate):
    """Air-to-Water zone climate device."""
 
    _attr_max_temp = 30
    _attr_min_temp = 10
    _attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE
 
    def __init__(
        self, device: MelCloudDevice, atw_device: AtwDevice, atw_zone: Zone
    ) -> None:
        """Initialize the climate."""
        super().__init__(device)
        self._device_device = atw_device
        self._zone_zone = atw_zone
 
        self._attr_unique_id_attr_unique_id = f"{self.api.device.serial}-{atw_zone.zone_index}"
        self._attr_device_info_attr_device_info = self.apiapi.zone_device_info(atw_zone)
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return the optional state attributes with device specific additions."""
        return {
            ATTR_STATUS: ATW_ZONE_HVAC_MODE_LOOKUP.get(
                self._zone_zone.status, self._zone_zone.status
            )
        }
 
    @property
    def hvac_mode(self) -> HVACMode:
        """Return hvac operation ie. heat, cool mode."""
        mode = self._zone_zone.operation_mode
        if not self._device_device.power or mode is None:
            return HVACMode.OFF
        return ATW_ZONE_HVAC_MODE_LOOKUP.get(mode, HVACMode.OFF)
 
    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set new target hvac mode."""
        if hvac_mode == HVACMode.OFF:
            await self._device_device.set({"power": False})
            return
 
        operation_mode = ATW_ZONE_HVAC_MODE_REVERSE_LOOKUP.get(hvac_mode)
        if operation_mode is None:
            raise ValueError(f"Invalid hvac_mode [{hvac_mode}]")
 
        if self._zone_zone.zone_index == 1:
            props = {PROPERTY_ZONE_1_OPERATION_MODE: operation_mode}
        else:
            props = {PROPERTY_ZONE_2_OPERATION_MODE: operation_mode}
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.OFF:
            props["power"] = True
        await self._device_device.set(props)
 
    @property
    def hvac_modes(self) -> list[HVACMode]:
        """Return the list of available hvac operation modes."""
        return [self.hvac_modehvac_modehvac_modehvac_modehvac_mode]
 
    @property
    def hvac_action(self) -> HVACAction | None:
        """Return the current running hvac operation."""
        if not self._device_device.power:
            return HVACAction.OFF
        return ATW_ZONE_HVAC_ACTION_LOOKUP.get(self._device_device.status)
 
    @property
    def current_temperature(self) -> float | None:
        """Return the current temperature."""
        return self._zone_zone.room_temperature
 
    @property
    def target_temperature(self) -> float | None:
        """Return the temperature we try to reach."""
        return self._zone_zone.target_temperature
 
    async def async_set_temperature(self, **kwargs: Any) -> None:
        """Set new target temperature."""
        await self._zone_zone.set_target_temperature(
            kwargs.get("temperature", self.target_temperaturetarget_temperaturetarget_temperature)
        )