climate.py

Go to the documentation of this file.

"""Climate platform that offers a climate device for the TFIAC protocol."""
 
from __future__ import annotations
 
from concurrent import futures
from datetime import timedelta
import logging
from typing import Any
 
from pytfiac import Tfiac
import voluptuous as vol
 
from homeassistant.components.climate import (
    FAN_AUTO,
    FAN_HIGH,
    FAN_LOW,
    FAN_MEDIUM,
    PLATFORM_SCHEMA as CLIMATE_PLATFORM_SCHEMA,
    SWING_BOTH,
    SWING_HORIZONTAL,
    SWING_OFF,
    SWING_VERTICAL,
    ClimateEntity,
    ClimateEntityFeature,
    HVACMode,
)
from homeassistant.const import ATTR_TEMPERATURE, CONF_HOST, UnitOfTemperature
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
SCAN_INTERVAL = timedelta(seconds=60)
 
PLATFORM_SCHEMA = CLIMATE_PLATFORM_SCHEMA.extend({vol.Required(CONF_HOST): cv.string})
 
_LOGGER = logging.getLogger(__name__)
 
MIN_TEMP = 61
MAX_TEMP = 88
 
HVAC_MAP = {
    HVACMode.HEAT: "heat",
    HVACMode.AUTO: "selfFeel",
    HVACMode.DRY: "dehumi",
    HVACMode.FAN_ONLY: "fan",
    HVACMode.COOL: "cool",
    HVACMode.OFF: "off",
}
 
HVAC_MAP_REV = {v: k for k, v in HVAC_MAP.items()}
 
SUPPORT_FAN = [FAN_AUTO, FAN_HIGH, FAN_MEDIUM, FAN_LOW]
SUPPORT_SWING = [SWING_OFF, SWING_HORIZONTAL, SWING_VERTICAL, SWING_BOTH]
 
CURR_TEMP = "current_temp"
TARGET_TEMP = "target_temp"
OPERATION_MODE = "operation"
FAN_MODE = "fan_mode"
SWING_MODE = "swing_mode"
ON_MODE = "is_on"
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the TFIAC climate device."""
    tfiac_client = Tfiac(config[CONF_HOST])
    try:
        await tfiac_client.update()
    except futures.TimeoutError:
        _LOGGER.error("Unable to connect to %s", config[CONF_HOST])
        return
    async_add_entities([TfiacClimate(hass, tfiac_client)])
 
 
class TfiacClimate(ClimateEntity):
    """TFIAC class."""
 
    _attr_supported_features = (
        ClimateEntityFeature.FAN_MODE
        | ClimateEntityFeature.SWING_MODE
        | ClimateEntityFeature.TARGET_TEMPERATURE
        | ClimateEntityFeature.TURN_OFF
        | ClimateEntityFeature.TURN_ON
    )
    _attr_temperature_unit = UnitOfTemperature.FAHRENHEIT
    _enable_turn_on_off_backwards_compatibility = False
 
    def __init__(self, hass, client):
        """Init class."""
        self._client_client = client
        self._available_available = True
 
    @property
    def available(self):
        """Return if the device is available."""
        return self._available_available
 
    async def async_update(self) -> None:
        """Update status via socket polling."""
        try:
            await self._client_client.update()
            self._available_available = True
        except futures.TimeoutError:
            self._available_available = False
 
    @property
    def min_temp(self):
        """Return the minimum temperature."""
        return MIN_TEMP
 
    @property
    def max_temp(self):
        """Return the maximum temperature."""
        return MAX_TEMP
 
    @property
    def name(self):
        """Return the name of the climate device."""
        return self._client_client.name
 
    @property
    def target_temperature(self):
        """Return the temperature we try to reach."""
        return self._client_client.status["target_temp"]
 
    @property
    def current_temperature(self):
        """Return the current temperature."""
        return self._client_client.status["current_temp"]
 
    @property
    def hvac_mode(self) -> HVACMode | None:
        """Return hvac operation ie. heat, cool mode.
 
        Need to be one of HVAC_MODE_*.
        """
        if self._client_client.status[ON_MODE] != "on":
            return HVACMode.OFF
 
        state = self._client_client.status["operation"]
        return HVAC_MAP_REV.get(state)
 
    @property
    def hvac_modes(self) -> list[HVACMode]:
        """Return the list of available hvac operation modes.
 
        Need to be a subset of HVAC_MODES.
        """
        return list(HVAC_MAP)
 
    @property
    def fan_mode(self):
        """Return the fan setting."""
        return self._client_client.status["fan_mode"].lower()
 
    @property
    def fan_modes(self):
        """Return the list of available fan modes."""
        return SUPPORT_FAN
 
    @property
    def swing_mode(self):
        """Return the swing setting."""
        return self._client_client.status["swing_mode"].lower()
 
    @property
    def swing_modes(self):
        """List of available swing modes."""
        return SUPPORT_SWING
 
    async def async_set_temperature(self, **kwargs: Any) -> None:
        """Set new target temperature."""
        if (temp := kwargs.get(ATTR_TEMPERATURE)) is not None:
            await self._client_client.set_state(TARGET_TEMP, temp)
 
    async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set new target hvac mode."""
        if hvac_mode == HVACMode.OFF:
            await self._client_client.set_state(ON_MODE, "off")
        else:
            await self._client_client.set_state(OPERATION_MODE, HVAC_MAP[hvac_mode])
 
    async def async_set_fan_mode(self, fan_mode: str) -> None:
        """Set new fan mode."""
        await self._client_client.set_state(FAN_MODE, fan_mode.capitalize())
 
    async def async_set_swing_mode(self, swing_mode: str) -> None:
        """Set new swing mode."""
        await self._client_client.set_swing(swing_mode.capitalize())
 
    async def async_turn_on(self) -> None:
        """Turn device on."""
        await self._client_client.set_state(OPERATION_MODE)
 
    async def async_turn_off(self) -> None:
        """Turn device off."""
        await self._client_client.set_state(ON_MODE, "off")