climate.py

Go to the documentation of this file.

"""Support for XS1 climate devices."""
 
from __future__ import annotations
 
from typing import Any
 
from xs1_api_client.api_constants import ActuatorType
 
from homeassistant.components.climate import (
    ClimateEntity,
    ClimateEntityFeature,
    HVACMode,
)
from homeassistant.const import ATTR_TEMPERATURE
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import ACTUATORS, DOMAIN as COMPONENT_DOMAIN, SENSORS
from .entity import XS1DeviceEntity
 
MIN_TEMP = 8
MAX_TEMP = 25
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the XS1 thermostat platform."""
    actuators = hass.data[COMPONENT_DOMAIN][ACTUATORS]
    sensors = hass.data[COMPONENT_DOMAIN][SENSORS]
 
    thermostat_entities = []
    for actuator in actuators:
        if actuator.type() == ActuatorType.TEMPERATURE:
            # Search for a matching sensor (by name)
            actuator_name = actuator.name()
 
            matching_sensor = None
            for sensor in sensors:
                if actuator_name in sensor.name():
                    matching_sensor = sensor
                    break
 
            thermostat_entities.append(XS1ThermostatEntity(actuator, matching_sensor))
 
    add_entities(thermostat_entities)
 
 
class XS1ThermostatEntity(XS1DeviceEntity, ClimateEntity):
    """Representation of a XS1 thermostat."""
 
    _attr_hvac_mode = HVACMode.HEAT
    _attr_hvac_modes = [HVACMode.HEAT]
    _attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE
    _enable_turn_on_off_backwards_compatibility = False
 
    def __init__(self, device, sensor):
        """Initialize the actuator."""
        super().__init__(device)
        self.sensorsensor = sensor
 
    @property
    def name(self):
        """Return the name of the device if any."""
        return self.devicedevice.name()
 
    @property
    def current_temperature(self):
        """Return the current temperature."""
        if self.sensorsensor is None:
            return None
 
        return self.sensorsensor.value()
 
    @property
    def temperature_unit(self) -> str:
        """Return the unit of measurement used by the platform."""
        return self.devicedevice.unit()
 
    @property
    def target_temperature(self):
        """Return the current target temperature."""
        return self.devicedevice.new_value()
 
    @property
    def min_temp(self):
        """Return the minimum temperature."""
        return MIN_TEMP
 
    @property
    def max_temp(self):
        """Return the maximum temperature."""
        return MAX_TEMP
 
    def set_temperature(self, **kwargs: Any) -> None:
        """Set new target temperature."""
        temp = kwargs.get(ATTR_TEMPERATURE)
 
        self.devicedevice.set_value(temp)
 
        if self.sensorsensor is not None:
            self.schedule_update_ha_stateschedule_update_ha_state()
 
    def set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set new target hvac mode."""
 
    async def async_update(self) -> None:
        """Also update the sensor when available."""
        await super().async_update()
        if self.sensorsensor is not None:
            await self.hasshass.async_add_executor_job(self.sensorsensor.update)