humidifier.py

Go to the documentation of this file.

"""Support for using humidifier with ecobee thermostats."""
 
from __future__ import annotations
 
from datetime import timedelta
 
from homeassistant.components.humidifier import (
    DEFAULT_MAX_HUMIDITY,
    DEFAULT_MIN_HUMIDITY,
    MODE_AUTO,
    HumidifierDeviceClass,
    HumidifierEntity,
    HumidifierEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN, ECOBEE_MODEL_TO_NAME, MANUFACTURER
 
SCAN_INTERVAL = timedelta(minutes=3)
 
MODE_MANUAL = "manual"
MODE_OFF = "off"
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the ecobee thermostat humidifier entity."""
    data = hass.data[DOMAIN]
    entities = []
    for index in range(len(data.ecobee.thermostats)):
        thermostat = data.ecobee.get_thermostat(index)
        if thermostat["settings"]["hasHumidifier"]:
            entities.append(EcobeeHumidifier(data, index))
 
    async_add_entities(entities, True)
 
 
class EcobeeHumidifier(HumidifierEntity):
    """A humidifier class for an ecobee thermostat with humidifier attached."""
 
    _attr_supported_features = HumidifierEntityFeature.MODES
    _attr_available_modes = [MODE_OFF, MODE_AUTO, MODE_MANUAL]
    _attr_device_class = HumidifierDeviceClass.HUMIDIFIER
    _attr_min_humidity = DEFAULT_MIN_HUMIDITY
    _attr_max_humidity = DEFAULT_MAX_HUMIDITY
    _attr_has_entity_name = True
    _attr_name = None
 
    def __init__(self, data, thermostat_index):
        """Initialize ecobee humidifier platform."""
        self.datadata = data
        self.thermostat_indexthermostat_index = thermostat_index
        self.thermostatthermostat = self.datadata.ecobee.get_thermostat(self.thermostat_indexthermostat_index)
        self._attr_unique_id_attr_unique_id = self.thermostatthermostat["identifier"]
        self._last_humidifier_on_mode_last_humidifier_on_mode = MODE_MANUAL
 
        self.update_without_throttleupdate_without_throttle = False
 
    @property
    def device_info(self) -> DeviceInfo:
        """Return device information for the ecobee humidifier."""
        model: str | None
        try:
            model = f"{ECOBEE_MODEL_TO_NAME[self.thermostat['modelNumber']]} Thermostat"
        except KeyError:
            # Ecobee model is not in our list
            model = None
 
        return DeviceInfo(
            identifiers={(DOMAIN, self.thermostatthermostat["identifier"])},
            manufacturer=MANUFACTURER,
            model=model,
            name=self.thermostatthermostat["name"],
        )
 
    @property
    def available(self):
        """Return if device is available."""
        return self.thermostatthermostat["runtime"]["connected"]
 
    async def async_update(self):
        """Get the latest state from the thermostat."""
        if self.update_without_throttleupdate_without_throttle:
            await self.datadata.update(no_throttle=True)
            self.update_without_throttleupdate_without_throttle = False
        else:
            await self.datadata.update()
        self.thermostatthermostat = self.datadata.ecobee.get_thermostat(self.thermostat_indexthermostat_index)
        if self.modemodemode != MODE_OFF:
            self._last_humidifier_on_mode_last_humidifier_on_mode = self.modemodemode
 
    @property
    def is_on(self):
        """Return True if the humidifier is on."""
        return self.modemodemode != MODE_OFF
 
    @property
    def mode(self):
        """Return the current mode, e.g., off, auto, manual."""
        return self.thermostatthermostat["settings"]["humidifierMode"]
 
    @property
    def target_humidity(self) -> int:
        """Return the desired humidity set point."""
        return int(self.thermostatthermostat["runtime"]["desiredHumidity"])
 
    @property
    def current_humidity(self) -> int | None:
        """Return the current humidity."""
        try:
            return int(self.thermostatthermostat["runtime"]["actualHumidity"])
        except KeyError:
            return None
 
    def set_mode(self, mode):
        """Set humidifier mode (auto, off, manual)."""
        if mode.lower() not in (self.available_modesavailable_modes):
            raise ValueError(
                f"Invalid mode value: {mode}  Valid values are"
                f" {', '.join(self.available_modes)}."
            )
 
        self.datadata.ecobee.set_humidifier_mode(self.thermostat_indexthermostat_index, mode)
        self.update_without_throttleupdate_without_throttle = True
 
    def set_humidity(self, humidity: int) -> None:
        """Set the humidity level."""
        self.datadata.ecobee.set_humidity(self.thermostat_indexthermostat_index, humidity)
        self.update_without_throttleupdate_without_throttle = True
 
    def turn_off(self, **kwargs):
        """Set humidifier to off mode."""
        self.set_modeset_modeset_mode(MODE_OFF)
 
    def turn_on(self, **kwargs):
        """Set humidifier to on mode."""
        self.set_modeset_modeset_mode(self._last_humidifier_on_mode_last_humidifier_on_mode)