climate.py

Go to the documentation of this file.

"""Climate platform for Advantage Air integration."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from homeassistant.components.climate import (
    ATTR_TARGET_TEMP_HIGH,
    ATTR_TARGET_TEMP_LOW,
    FAN_AUTO,
    FAN_HIGH,
    FAN_LOW,
    FAN_MEDIUM,
    ClimateEntity,
    ClimateEntityFeature,
    HVACMode,
)
from homeassistant.const import ATTR_TEMPERATURE, PRECISION_WHOLE, UnitOfTemperature
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import ServiceValidationError
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import AdvantageAirDataConfigEntry
from .const import (
    ADVANTAGE_AIR_AUTOFAN_ENABLED,
    ADVANTAGE_AIR_STATE_CLOSE,
    ADVANTAGE_AIR_STATE_OFF,
    ADVANTAGE_AIR_STATE_ON,
    ADVANTAGE_AIR_STATE_OPEN,
)
from .entity import AdvantageAirAcEntity, AdvantageAirZoneEntity
from .models import AdvantageAirData
 
ADVANTAGE_AIR_HVAC_MODES = {
    "heat": HVACMode.HEAT,
    "cool": HVACMode.COOL,
    "vent": HVACMode.FAN_ONLY,
    "dry": HVACMode.DRY,
    "myauto": HVACMode.HEAT_COOL,
}
HASS_HVAC_MODES = {v: k for k, v in ADVANTAGE_AIR_HVAC_MODES.items()}
 
ADVANTAGE_AIR_MYZONE = "MyZone"
ADVANTAGE_AIR_MYAUTO = "MyAuto"
ADVANTAGE_AIR_MYAUTO_ENABLED = "myAutoModeEnabled"
ADVANTAGE_AIR_MYTEMP = "MyTemp"
ADVANTAGE_AIR_MYTEMP_ENABLED = "climateControlModeEnabled"
ADVANTAGE_AIR_HEAT_TARGET = "myAutoHeatTargetTemp"
ADVANTAGE_AIR_COOL_TARGET = "myAutoCoolTargetTemp"
ADVANTAGE_AIR_MYFAN = "autoAA"
 
HVAC_MODES = [
    HVACMode.OFF,
    HVACMode.COOL,
    HVACMode.HEAT,
    HVACMode.FAN_ONLY,
    HVACMode.DRY,
]
HVAC_MODES_MYAUTO = [*HVAC_MODES, HVACMode.HEAT_COOL]
SUPPORTED_FEATURES = (
    ClimateEntityFeature.FAN_MODE
    | ClimateEntityFeature.TURN_OFF
    | ClimateEntityFeature.TURN_ON
)
SUPPORTED_FEATURES_MYZONE = SUPPORTED_FEATURES | ClimateEntityFeature.TARGET_TEMPERATURE
SUPPORTED_FEATURES_MYAUTO = (
    SUPPORTED_FEATURES | ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
)
 
PARALLEL_UPDATES = 0
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: AdvantageAirDataConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up AdvantageAir climate platform."""
 
    instance = config_entry.runtime_data
 
    entities: list[ClimateEntity] = []
    if aircons := instance.coordinator.data.get("aircons"):
        for ac_key, ac_device in aircons.items():
            entities.append(AdvantageAirAC(instance, ac_key))
            for zone_key, zone in ac_device["zones"].items():
                # Only add zone climate control when zone is in temperature control
                if zone["type"] > 0:
                    entities.append(AdvantageAirZone(instance, ac_key, zone_key))
    async_add_entities(entities)
 
 
class AdvantageAirAC(AdvantageAirAcEntity, ClimateEntity):
    """AdvantageAir AC unit."""
 
    _attr_fan_modes = [FAN_LOW, FAN_MEDIUM, FAN_HIGH, FAN_AUTO]
    _attr_temperature_unit = UnitOfTemperature.CELSIUS
    _attr_target_temperature_step = PRECISION_WHOLE
    _attr_max_temp = 32
    _attr_min_temp = 16
    _attr_name = None
    _enable_turn_on_off_backwards_compatibility = False
    _support_preset = ClimateEntityFeature(0)
 
    def __init__(self, instance: AdvantageAirData, ac_key: str) -> None:
        """Initialize an AdvantageAir AC unit."""
        super().__init__(instance, ac_key)
 
        self._attr_preset_modes_attr_preset_modes = [ADVANTAGE_AIR_MYZONE]
 
        # Add "MyTemp" preset if available
        if ADVANTAGE_AIR_MYTEMP_ENABLED in self._ac_ac:
            self._attr_preset_modes_attr_preset_modes += [ADVANTAGE_AIR_MYTEMP]
            self._support_preset_support_preset = ClimateEntityFeature.PRESET_MODE
 
        # Add "MyAuto" preset if available
        if ADVANTAGE_AIR_MYAUTO_ENABLED in self._ac_ac:
            self._attr_preset_modes_attr_preset_modes += [ADVANTAGE_AIR_MYAUTO]
            self._support_preset_support_preset = ClimateEntityFeature.PRESET_MODE
 
        # Setup attributes based on current preset
        self._async_configure_preset_async_configure_preset()
 
    def _async_configure_preset(self) -> None:
        """Configure attributes based on preset."""
 
        # Preset Changes
        if self._ac_ac.get(ADVANTAGE_AIR_MYAUTO_ENABLED):
            # MyAuto
            self._attr_preset_mode_attr_preset_mode = ADVANTAGE_AIR_MYAUTO
            self._attr_hvac_modes_attr_hvac_modes = HVAC_MODES_MYAUTO
            self._attr_supported_features_attr_supported_features = (
                SUPPORTED_FEATURES_MYAUTO | self._support_preset_support_preset
            )
        elif self._ac_ac.get(ADVANTAGE_AIR_MYTEMP_ENABLED):
            # MyTemp
            self._attr_preset_mode_attr_preset_mode = ADVANTAGE_AIR_MYTEMP
            self._attr_hvac_modes_attr_hvac_modes = HVAC_MODES
            self._attr_supported_features_attr_supported_features = SUPPORTED_FEATURES | self._support_preset_support_preset
        else:
            # MyZone
            self._attr_preset_mode_attr_preset_mode = ADVANTAGE_AIR_MYZONE
            self._attr_hvac_modes_attr_hvac_modes = HVAC_MODES
            self._attr_supported_features_attr_supported_features = (
                SUPPORTED_FEATURES_MYZONE | self._support_preset_support_preset
            )
 
    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
        self._async_configure_preset_async_configure_preset()
        super()._handle_coordinator_update()
 
    @property
    def current_temperature(self) -> float | None:
        """Return the selected zones current temperature."""
        if self._myzone_myzone:
            return self._myzone_myzone["measuredTemp"]
        return None
 
    @property
    def target_temperature(self) -> float | None:
        """Return the current target temperature."""
        # If the system is in MyZone mode, and a zone is set, return that temperature instead.
        if self._myzone_myzone and self.preset_modepreset_modepreset_mode == ADVANTAGE_AIR_MYZONE:
            return self._myzone_myzone["setTemp"]
        return self._ac_ac["setTemp"]
 
    @property
    def hvac_mode(self) -> HVACMode | None:
        """Return the current HVAC modes."""
        if self._ac_ac["state"] == ADVANTAGE_AIR_STATE_ON:
            return ADVANTAGE_AIR_HVAC_MODES.get(self._ac_ac["mode"])
        return HVACMode.OFF
 
    @property
    def fan_mode(self) -> str | None:
        """Return the current fan modes."""
        return FAN_AUTO if self._ac_ac["fan"] == ADVANTAGE_AIR_MYFAN else self._ac_ac["fan"]
 
    @property
    def target_temperature_high(self) -> float | None:
        """Return the temperature cool mode is enabled."""
        return self._ac_ac.get(ADVANTAGE_AIR_COOL_TARGET)
 
    @property
    def target_temperature_low(self) -> float | None:
        """Return the temperature heat mode is enabled."""
        return self._ac_ac.get(ADVANTAGE_AIR_HEAT_TARGET)
 
    async def async_turn_on(self) -> None:
        """Set the HVAC State to on."""
        await self.async_update_acasync_update_ac({"state": ADVANTAGE_AIR_STATE_ON})
 
    async def async_turn_off(self) -> None:
        """Set the HVAC State to off."""
        await self.async_update_acasync_update_ac(
            {
                "state": ADVANTAGE_AIR_STATE_OFF,
            }
        )
 
    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set the HVAC Mode and State."""
        if hvac_mode == HVACMode.OFF:
            await self.async_turn_offasync_turn_offasync_turn_off()
            return
        if hvac_mode == HVACMode.HEAT_COOL and self.preset_modepreset_modepreset_mode != ADVANTAGE_AIR_MYAUTO:
            raise ServiceValidationError("Heat/Cool is not supported in this mode")
        await self.async_update_acasync_update_ac(
            {
                "state": ADVANTAGE_AIR_STATE_ON,
                "mode": HASS_HVAC_MODES.get(hvac_mode),
            }
        )
 
    async def async_set_fan_mode(self, fan_mode: str) -> None:
        """Set the Fan Mode."""
        if fan_mode == FAN_AUTO and self._ac_ac.get(ADVANTAGE_AIR_AUTOFAN_ENABLED):
            mode = ADVANTAGE_AIR_MYFAN
        else:
            mode = fan_mode
        await self.async_update_acasync_update_ac({"fan": mode})
 
    async def async_set_temperature(self, **kwargs: Any) -> None:
        """Set the Temperature."""
        if ATTR_TEMPERATURE in kwargs:
            await self.async_update_acasync_update_ac({"setTemp": kwargs[ATTR_TEMPERATURE]})
        if ATTR_TARGET_TEMP_LOW in kwargs and ATTR_TARGET_TEMP_HIGH in kwargs:
            await self.async_update_acasync_update_ac(
                {
                    ADVANTAGE_AIR_COOL_TARGET: kwargs[ATTR_TARGET_TEMP_HIGH],
                    ADVANTAGE_AIR_HEAT_TARGET: kwargs[ATTR_TARGET_TEMP_LOW],
                }
            )
 
    async def async_set_preset_mode(self, preset_mode: str) -> None:
        """Set the preset mode."""
        change = {}
        if ADVANTAGE_AIR_MYTEMP_ENABLED in self._ac_ac:
            change[ADVANTAGE_AIR_MYTEMP_ENABLED] = preset_mode == ADVANTAGE_AIR_MYTEMP
        if ADVANTAGE_AIR_MYAUTO_ENABLED in self._ac_ac:
            change[ADVANTAGE_AIR_MYAUTO_ENABLED] = preset_mode == ADVANTAGE_AIR_MYAUTO
        if change:
            await self.async_update_acasync_update_ac(change)
 
 
class AdvantageAirZone(AdvantageAirZoneEntity, ClimateEntity):
    """AdvantageAir MyTemp Zone control."""
 
    _attr_hvac_modes = [HVACMode.OFF, HVACMode.HEAT_COOL]
    _attr_supported_features = (
        ClimateEntityFeature.TARGET_TEMPERATURE
        | ClimateEntityFeature.TURN_OFF
        | ClimateEntityFeature.TURN_ON
    )
    _attr_temperature_unit = UnitOfTemperature.CELSIUS
    _attr_target_temperature_step = PRECISION_WHOLE
    _attr_max_temp = 32
    _attr_min_temp = 16
    _enable_turn_on_off_backwards_compatibility = False
 
    def __init__(self, instance: AdvantageAirData, ac_key: str, zone_key: str) -> None:
        """Initialize an AdvantageAir Zone control."""
        super().__init__(instance, ac_key, zone_key)
        self._attr_name_attr_name = self._zone_zone["name"]
 
    @property
    def hvac_mode(self) -> HVACMode:
        """Return the current state as HVAC mode."""
        if self._zone_zone["state"] == ADVANTAGE_AIR_STATE_OPEN:
            return HVACMode.HEAT_COOL
        return HVACMode.OFF
 
    @property
    def current_temperature(self) -> float | None:
        """Return the current temperature."""
        return self._zone_zone["measuredTemp"]
 
    @property
    def target_temperature(self) -> float:
        """Return the target temperature."""
        return self._zone_zone["setTemp"]
 
    async def async_turn_on(self) -> None:
        """Set the HVAC State to on."""
        await self.async_update_zoneasync_update_zone({"state": ADVANTAGE_AIR_STATE_OPEN})
 
    async def async_turn_off(self) -> None:
        """Set the HVAC State to off."""
        await self.async_update_zoneasync_update_zone({"state": ADVANTAGE_AIR_STATE_CLOSE})
 
    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set the HVAC Mode and State."""
        if hvac_mode == HVACMode.OFF:
            await self.async_turn_offasync_turn_offasync_turn_off()
        else:
            await self.async_turn_onasync_turn_onasync_turn_on()
 
    async def async_set_temperature(self, **kwargs: Any) -> None:
        """Set the Temperature."""
        temp = kwargs.get(ATTR_TEMPERATURE)
        await self.async_update_zoneasync_update_zone({"setTemp": temp})