climate.py

Go to the documentation of this file.

"""Support for Ecobee Thermostats."""
 
from __future__ import annotations
 
import collections
from typing import Any
 
import voluptuous as vol
 
from homeassistant.components.climate import (
    ATTR_TARGET_TEMP_HIGH,
    ATTR_TARGET_TEMP_LOW,
    FAN_AUTO,
    FAN_ON,
    PRESET_AWAY,
    PRESET_HOME,
    PRESET_NONE,
    PRESET_SLEEP,
    ClimateEntity,
    ClimateEntityFeature,
    HVACAction,
    HVACMode,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
    ATTR_ENTITY_ID,
    ATTR_TEMPERATURE,
    PRECISION_HALVES,
    PRECISION_TENTHS,
    STATE_OFF,
    STATE_ON,
    UnitOfTemperature,
)
from homeassistant.core import HomeAssistant, ServiceCall
from homeassistant.exceptions import ServiceValidationError
from homeassistant.helpers import device_registry as dr, entity_platform
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.unit_conversion import TemperatureConverter
 
from . import EcobeeData
from .const import (
    _LOGGER,
    ATTR_ACTIVE_SENSORS,
    ATTR_AVAILABLE_SENSORS,
    DOMAIN,
    ECOBEE_AUX_HEAT_ONLY,
    ECOBEE_MODEL_TO_NAME,
    MANUFACTURER,
)
from .util import ecobee_date, ecobee_time, is_indefinite_hold
 
ATTR_COOL_TEMP = "cool_temp"
ATTR_END_DATE = "end_date"
ATTR_END_TIME = "end_time"
ATTR_FAN_MIN_ON_TIME = "fan_min_on_time"
ATTR_FAN_MODE = "fan_mode"
ATTR_HEAT_TEMP = "heat_temp"
ATTR_RESUME_ALL = "resume_all"
ATTR_START_DATE = "start_date"
ATTR_START_TIME = "start_time"
ATTR_VACATION_NAME = "vacation_name"
ATTR_DST_ENABLED = "dst_enabled"
ATTR_MIC_ENABLED = "mic_enabled"
ATTR_AUTO_AWAY = "auto_away"
ATTR_FOLLOW_ME = "follow_me"
ATTR_SENSOR_LIST = "device_ids"
ATTR_PRESET_MODE = "preset_mode"
 
DEFAULT_RESUME_ALL = False
PRESET_AWAY_INDEFINITELY = "away_indefinitely"
PRESET_TEMPERATURE = "temp"
PRESET_VACATION = "vacation"
PRESET_HOLD_NEXT_TRANSITION = "next_transition"
PRESET_HOLD_INDEFINITE = "indefinite"
HAS_HEAT_PUMP = "hasHeatPump"
 
DEFAULT_MIN_HUMIDITY = 15
DEFAULT_MAX_HUMIDITY = 50
HUMIDIFIER_MANUAL_MODE = "manual"
 
# Order matters, because for reverse mapping we don't want to map HEAT to AUX
ECOBEE_HVAC_TO_HASS = collections.OrderedDict(
    [
        ("heat", HVACMode.HEAT),
        ("cool", HVACMode.COOL),
        ("auto", HVACMode.HEAT_COOL),
        ("off", HVACMode.OFF),
        (ECOBEE_AUX_HEAT_ONLY, HVACMode.HEAT),
    ]
)
# Reverse key/value pair, drop auxHeatOnly as it doesn't map to specific HASS mode
HASS_TO_ECOBEE_HVAC = {
    v: k for k, v in ECOBEE_HVAC_TO_HASS.items() if k != ECOBEE_AUX_HEAT_ONLY
}
 
ECOBEE_HVAC_ACTION_TO_HASS = {
    # Map to None if we do not know how to represent.
    "heatPump": HVACAction.HEATING,
    "heatPump2": HVACAction.HEATING,
    "heatPump3": HVACAction.HEATING,
    "compCool1": HVACAction.COOLING,
    "compCool2": HVACAction.COOLING,
    "auxHeat1": HVACAction.HEATING,
    "auxHeat2": HVACAction.HEATING,
    "auxHeat3": HVACAction.HEATING,
    "fan": HVACAction.FAN,
    "humidifier": None,
    "dehumidifier": HVACAction.DRYING,
    "ventilator": HVACAction.FAN,
    "economizer": HVACAction.FAN,
    "compHotWater": None,
    "auxHotWater": None,
    "compWaterHeater": None,
}
 
ECOBEE_TO_HASS_PRESET = {
    "Away": PRESET_AWAY,
    "Home": PRESET_HOME,
    "Sleep": PRESET_SLEEP,
}
HASS_TO_ECOBEE_PRESET = {v: k for k, v in ECOBEE_TO_HASS_PRESET.items()}
 
PRESET_TO_ECOBEE_HOLD = {
    PRESET_HOLD_NEXT_TRANSITION: "nextTransition",
    PRESET_HOLD_INDEFINITE: "indefinite",
}
 
SERVICE_CREATE_VACATION = "create_vacation"
SERVICE_DELETE_VACATION = "delete_vacation"
SERVICE_RESUME_PROGRAM = "resume_program"
SERVICE_SET_FAN_MIN_ON_TIME = "set_fan_min_on_time"
SERVICE_SET_DST_MODE = "set_dst_mode"
SERVICE_SET_MIC_MODE = "set_mic_mode"
SERVICE_SET_OCCUPANCY_MODES = "set_occupancy_modes"
SERVICE_SET_SENSORS_USED_IN_CLIMATE = "set_sensors_used_in_climate"
 
DTGROUP_START_INCLUSIVE_MSG = (
    f"{ATTR_START_DATE} and {ATTR_START_TIME} must be specified together"
)
 
DTGROUP_END_INCLUSIVE_MSG = (
    f"{ATTR_END_DATE} and {ATTR_END_TIME} must be specified together"
)
 
CREATE_VACATION_SCHEMA = vol.Schema(
    {
        vol.Required(ATTR_ENTITY_ID): cv.entity_id,
        vol.Required(ATTR_VACATION_NAME): vol.All(cv.string, vol.Length(max=12)),
        vol.Required(ATTR_COOL_TEMP): vol.Coerce(float),
        vol.Required(ATTR_HEAT_TEMP): vol.Coerce(float),
        vol.Inclusive(
            ATTR_START_DATE, "dtgroup_start", msg=DTGROUP_START_INCLUSIVE_MSG
        ): ecobee_date,
        vol.Inclusive(
            ATTR_START_TIME, "dtgroup_start", msg=DTGROUP_START_INCLUSIVE_MSG
        ): ecobee_time,
        vol.Inclusive(
            ATTR_END_DATE, "dtgroup_end", msg=DTGROUP_END_INCLUSIVE_MSG
        ): ecobee_date,
        vol.Inclusive(
            ATTR_END_TIME, "dtgroup_end", msg=DTGROUP_END_INCLUSIVE_MSG
        ): ecobee_time,
        vol.Optional(ATTR_FAN_MODE, default="auto"): vol.Any("auto", "on"),
        vol.Optional(ATTR_FAN_MIN_ON_TIME, default=0): vol.All(
            int, vol.Range(min=0, max=60)
        ),
    }
)
 
DELETE_VACATION_SCHEMA = vol.Schema(
    {
        vol.Required(ATTR_ENTITY_ID): cv.entity_id,
        vol.Required(ATTR_VACATION_NAME): vol.All(cv.string, vol.Length(max=12)),
    }
)
 
RESUME_PROGRAM_SCHEMA = vol.Schema(
    {
        vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
        vol.Optional(ATTR_RESUME_ALL, default=DEFAULT_RESUME_ALL): cv.boolean,
    }
)
 
SET_FAN_MIN_ON_TIME_SCHEMA = vol.Schema(
    {
        vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
        vol.Required(ATTR_FAN_MIN_ON_TIME): vol.Coerce(int),
    }
)
 
 
SUPPORT_FLAGS = (
    ClimateEntityFeature.TARGET_TEMPERATURE
    | ClimateEntityFeature.PRESET_MODE
    | ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
    | ClimateEntityFeature.FAN_MODE
)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the ecobee thermostat."""
 
    data = hass.data[DOMAIN]
    entities = []
 
    for index in range(len(data.ecobee.thermostats)):
        thermostat = data.ecobee.get_thermostat(index)
        if thermostat["modelNumber"] not in ECOBEE_MODEL_TO_NAME:
            _LOGGER.error(
                (
                    "Model number for ecobee thermostat %s not recognized. "
                    "Please visit this link to open a new issue: "
                    "https://github.com/home-assistant/core/issues "
                    "and include the following information: "
                    "Unrecognized model number: %s"
                ),
                thermostat["name"],
                thermostat["modelNumber"],
            )
        entities.append(Thermostat(data, index, thermostat, hass))
 
    async_add_entities(entities, True)
 
    platform = entity_platform.async_get_current_platform()
 
    def create_vacation_service(service: ServiceCall) -> None:
        """Create a vacation on the target thermostat."""
        entity_id = service.data[ATTR_ENTITY_ID]
 
        for thermostat in entities:
            if thermostat.entity_id == entity_id:
                thermostat.create_vacation(service.data)
                thermostat.schedule_update_ha_state(True)
                break
 
    def delete_vacation_service(service: ServiceCall) -> None:
        """Delete a vacation on the target thermostat."""
        entity_id = service.data[ATTR_ENTITY_ID]
        vacation_name = service.data[ATTR_VACATION_NAME]
 
        for thermostat in entities:
            if thermostat.entity_id == entity_id:
                thermostat.delete_vacation(vacation_name)
                thermostat.schedule_update_ha_state(True)
                break
 
    def fan_min_on_time_set_service(service: ServiceCall) -> None:
        """Set the minimum fan on time on the target thermostats."""
        entity_id = service.data.get(ATTR_ENTITY_ID)
        fan_min_on_time = service.data[ATTR_FAN_MIN_ON_TIME]
 
        if entity_id:
            target_thermostats = [
                entity for entity in entities if entity.entity_id in entity_id
            ]
        else:
            target_thermostats = entities
 
        for thermostat in target_thermostats:
            thermostat.set_fan_min_on_time(str(fan_min_on_time))
 
            thermostat.schedule_update_ha_state(True)
 
    def resume_program_set_service(service: ServiceCall) -> None:
        """Resume the program on the target thermostats."""
        entity_id = service.data.get(ATTR_ENTITY_ID)
        resume_all = service.data.get(ATTR_RESUME_ALL)
 
        if entity_id:
            target_thermostats = [
                entity for entity in entities if entity.entity_id in entity_id
            ]
        else:
            target_thermostats = entities
 
        for thermostat in target_thermostats:
            thermostat.resume_program(resume_all)
 
            thermostat.schedule_update_ha_state(True)
 
    hass.services.async_register(
        DOMAIN,
        SERVICE_CREATE_VACATION,
        create_vacation_service,
        schema=CREATE_VACATION_SCHEMA,
    )
 
    hass.services.async_register(
        DOMAIN,
        SERVICE_DELETE_VACATION,
        delete_vacation_service,
        schema=DELETE_VACATION_SCHEMA,
    )
 
    hass.services.async_register(
        DOMAIN,
        SERVICE_SET_FAN_MIN_ON_TIME,
        fan_min_on_time_set_service,
        schema=SET_FAN_MIN_ON_TIME_SCHEMA,
    )
 
    hass.services.async_register(
        DOMAIN,
        SERVICE_RESUME_PROGRAM,
        resume_program_set_service,
        schema=RESUME_PROGRAM_SCHEMA,
    )
 
    platform.async_register_entity_service(
        SERVICE_SET_DST_MODE,
        {vol.Required(ATTR_DST_ENABLED): cv.boolean},
        "set_dst_mode",
    )
 
    platform.async_register_entity_service(
        SERVICE_SET_MIC_MODE,
        {vol.Required(ATTR_MIC_ENABLED): cv.boolean},
        "set_mic_mode",
    )
 
    platform.async_register_entity_service(
        SERVICE_SET_OCCUPANCY_MODES,
        {
            vol.Optional(ATTR_AUTO_AWAY): cv.boolean,
            vol.Optional(ATTR_FOLLOW_ME): cv.boolean,
        },
        "set_occupancy_modes",
    )
 
    platform.async_register_entity_service(
        SERVICE_SET_SENSORS_USED_IN_CLIMATE,
        {
            vol.Optional(ATTR_PRESET_MODE): cv.string,
            vol.Required(ATTR_SENSOR_LIST): cv.ensure_list,
        },
        "set_sensors_used_in_climate",
    )
 
 
class Thermostat(ClimateEntity):
    """A thermostat class for Ecobee."""
 
    _attr_precision = PRECISION_TENTHS
    _attr_temperature_unit = UnitOfTemperature.FAHRENHEIT
    _attr_min_humidity = DEFAULT_MIN_HUMIDITY
    _attr_max_humidity = DEFAULT_MAX_HUMIDITY
    _attr_fan_modes = [FAN_AUTO, FAN_ON]
    _attr_name = None
    _attr_has_entity_name = True
    _enable_turn_on_off_backwards_compatibility = False
    _attr_translation_key = "ecobee"
 
    def __init__(
        self,
        data: EcobeeData,
        thermostat_index: int,
        thermostat: dict,
        hass: HomeAssistant,
    ) -> None:
        """Initialize the thermostat."""
        self.datadata = data
        self.thermostat_indexthermostat_index = thermostat_index
        self.thermostatthermostat = thermostat
        self._attr_unique_id_attr_unique_id = self.thermostatthermostat["identifier"]
        self.vacationvacation = None
        self._last_active_hvac_mode_last_active_hvac_mode = HVACMode.HEAT_COOL
        self._last_hvac_mode_before_aux_heat_last_hvac_mode_before_aux_heat = HVACMode.HEAT_COOL
        self._hass_hass = hass
 
        self._attr_hvac_modes_attr_hvac_modes = []
        if self.settingssettings["heatStages"] or self.settingssettings["hasHeatPump"]:
            self._attr_hvac_modes_attr_hvac_modes.append(HVACMode.HEAT)
        if self.settingssettings["coolStages"]:
            self._attr_hvac_modes_attr_hvac_modes.append(HVACMode.COOL)
        if len(self._attr_hvac_modes_attr_hvac_modes) == 2:
            self._attr_hvac_modes_attr_hvac_modes.insert(0, HVACMode.HEAT_COOL)
        self._attr_hvac_modes_attr_hvac_modes.append(HVACMode.OFF)
        self._sensors_sensors = self.remote_sensorsremote_sensors
        self._preset_modes_preset_modes = {
            comfort["climateRef"]: comfort["name"]
            for comfort in self.thermostatthermostat["program"]["climates"]
        }
        self.update_without_throttleupdate_without_throttle = False
 
    async def async_update(self) -> None:
        """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.hvac_modehvac_modehvac_modehvac_modehvac_mode != HVACMode.OFF:
            self._last_active_hvac_mode_last_active_hvac_mode = self.hvac_modehvac_modehvac_modehvac_modehvac_mode
 
    @property
    def available(self) -> bool:
        """Return if device is available."""
        return self.thermostatthermostat["runtime"]["connected"]
 
    @property
    def supported_features(self) -> ClimateEntityFeature:
        """Return the list of supported features."""
        supported = SUPPORT_FLAGS
        if self.has_humidifier_controlhas_humidifier_control:
            supported = supported | ClimateEntityFeature.TARGET_HUMIDITY
        if len(self.hvac_modeshvac_modes) > 1 and HVACMode.OFF in self.hvac_modeshvac_modes:
            supported = (
                supported | ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON
            )
        return supported
 
    @property
    def device_info(self) -> DeviceInfo:
        """Return device information for this ecobee thermostat."""
        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 current_temperature(self) -> float:
        """Return the current temperature."""
        return self.thermostatthermostat["runtime"]["actualTemperature"] / 10.0
 
    @property
    def target_temperature_low(self) -> float | None:
        """Return the lower bound temperature we try to reach."""
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.HEAT_COOL:
            return self.thermostatthermostat["runtime"]["desiredHeat"] / 10.0
        return None
 
    @property
    def target_temperature_high(self) -> float | None:
        """Return the upper bound temperature we try to reach."""
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.HEAT_COOL:
            return self.thermostatthermostat["runtime"]["desiredCool"] / 10.0
        return None
 
    @property
    def target_temperature_step(self) -> float:
        """Set target temperature step to halves."""
        return PRECISION_HALVES
 
    @property
    def settings(self) -> dict[str, Any]:
        """Return the settings of the thermostat."""
        return self.thermostatthermostat["settings"]
 
    @property
    def has_humidifier_control(self) -> bool:
        """Return true if humidifier connected to thermostat and set to manual/on mode."""
        return (
            bool(self.settingssettings.get("hasHumidifier"))
            and self.settingssettings.get("humidifierMode") == HUMIDIFIER_MANUAL_MODE
        )
 
    @property
    def target_humidity(self) -> int | None:
        """Return the desired humidity set point."""
        if self.has_humidifier_controlhas_humidifier_control:
            return self.thermostatthermostat["runtime"]["desiredHumidity"]
        return None
 
    @property
    def target_temperature(self) -> float | None:
        """Return the temperature we try to reach."""
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.HEAT_COOL:
            return None
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.HEAT:
            return self.thermostatthermostat["runtime"]["desiredHeat"] / 10.0
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.COOL:
            return self.thermostatthermostat["runtime"]["desiredCool"] / 10.0
        return None
 
    @property
    def fan(self):
        """Return the current fan status."""
        if "fan" in self.thermostatthermostat["equipmentStatus"]:
            return STATE_ON
        return STATE_OFF
 
    @property
    def fan_mode(self):
        """Return the fan setting."""
        return self.thermostatthermostat["runtime"]["desiredFanMode"]
 
    @property
    def preset_mode(self) -> str | None:
        """Return current preset mode."""
        events = self.thermostatthermostat["events"]
        for event in events:
            if not event["running"]:
                continue
 
            if event["type"] == "hold":
                if event["holdClimateRef"] == "away" and is_indefinite_hold(
                    event["startDate"], event["endDate"]
                ):
                    return PRESET_AWAY_INDEFINITELY
 
                if name := self.comfort_settingscomfort_settings.get(event["holdClimateRef"]):
                    return ECOBEE_TO_HASS_PRESET.get(name, name)
 
                # Any hold not based on a climate is a temp hold
                return PRESET_TEMPERATURE
            if event["type"].startswith("auto"):
                # All auto modes are treated as holds
                return event["type"][4:].lower()
            if event["type"] == "vacation":
                self.vacationvacation = event["name"]
                return PRESET_VACATION
 
        if name := self.comfort_settingscomfort_settings.get(
            self.thermostatthermostat["program"]["currentClimateRef"]
        ):
            return ECOBEE_TO_HASS_PRESET.get(name, name)
 
        return None
 
    @property
    def hvac_mode(self):
        """Return current operation."""
        return ECOBEE_HVAC_TO_HASS[self.settingssettings["hvacMode"]]
 
    @property
    def current_humidity(self) -> int | None:
        """Return the current humidity."""
        try:
            return int(self.thermostatthermostat["runtime"]["actualHumidity"])
        except KeyError:
            return None
 
    @property
    def hvac_action(self):
        """Return current HVAC action.
 
        Ecobee returns a CSV string with different equipment that is active.
        We are prioritizing any heating/cooling equipment, otherwise look at
        drying/fanning. Idle if nothing going on.
 
        We are unable to map all actions to HA equivalents.
        """
        if self.thermostatthermostat["equipmentStatus"] == "":
            return HVACAction.IDLE
 
        actions = [
            ECOBEE_HVAC_ACTION_TO_HASS[status]
            for status in self.thermostatthermostat["equipmentStatus"].split(",")
            if ECOBEE_HVAC_ACTION_TO_HASS[status] is not None
        ]
 
        for action in (
            HVACAction.HEATING,
            HVACAction.COOLING,
            HVACAction.DRYING,
            HVACAction.FAN,
        ):
            if action in actions:
                return action
 
        return HVACAction.IDLE
 
    _unrecorded_attributes = frozenset({ATTR_AVAILABLE_SENSORS, ATTR_ACTIVE_SENSORS})
 
    @property
    def extra_state_attributes(self) -> dict[str, Any] | None:
        """Return device specific state attributes."""
        status = self.thermostatthermostat["equipmentStatus"]
        return {
            "fan": self.fanfan,
            "climate_mode": self.comfort_settingscomfort_settings.get(
                self.thermostatthermostat["program"]["currentClimateRef"]
            ),
            "equipment_running": status,
            "fan_min_on_time": self.settingssettings["fanMinOnTime"],
            ATTR_AVAILABLE_SENSORS: self.remote_sensor_devicesremote_sensor_devices,
            ATTR_ACTIVE_SENSORS: self.active_sensor_devices_in_preset_modeactive_sensor_devices_in_preset_mode,
        }
 
    @property
    def remote_sensors(self) -> list:
        """Return the remote sensor names of the thermostat."""
        sensors_info = self.thermostatthermostat.get("remoteSensors", [])
        return [sensor["name"] for sensor in sensors_info if sensor.get("name")]
 
    @property
    def remote_sensor_devices(self) -> list:
        """Return the remote sensor device name_by_user or name for the thermostat."""
        return sorted(
            [
                f'{item["name_by_user"]} ({item["id"]})'
                for item in self.remote_sensor_ids_namesremote_sensor_ids_names
            ]
        )
 
    @property
    def remote_sensor_ids_names(self) -> list:
        """Return the remote sensor device id and name_by_user for the thermostat."""
        sensors_info = self.thermostatthermostat.get("remoteSensors", [])
        device_registry = dr.async_get(self._hass_hass)
 
        return [
            {
                "id": device.id,
                "name_by_user": device.name_by_user
                if device.name_by_user
                else device.name,
            }
            for device in device_registry.devices.values()
            for sensor_info in sensors_info
            if device.name == sensor_info["name"]
        ]
 
    @property
    def active_sensors_in_preset_mode(self) -> list:
        """Return the currently active/participating sensors."""
        # https://support.ecobee.com/s/articles/SmartSensors-Sensor-Participation
        # During a manual hold, the ecobee will follow the Sensor Participation
        # rules for the Home Comfort Settings
        mode = self._preset_modes_preset_modes.get(self.preset_modepreset_modepreset_modepreset_mode, "Home")
        return self._sensors_in_preset_mode_sensors_in_preset_mode(mode)
 
    @property
    def active_sensor_devices_in_preset_mode(self) -> list:
        """Return the currently active/participating sensor devices."""
        # https://support.ecobee.com/s/articles/SmartSensors-Sensor-Participation
        # During a manual hold, the ecobee will follow the Sensor Participation
        # rules for the Home Comfort Settings
        mode = self._preset_modes_preset_modes.get(self.preset_modepreset_modepreset_modepreset_mode, "Home")
        return self._sensor_devices_in_preset_mode_sensor_devices_in_preset_mode(mode)
 
    def set_preset_mode(self, preset_mode: str) -> None:
        """Activate a preset."""
        preset_mode = HASS_TO_ECOBEE_PRESET.get(preset_mode, preset_mode)
 
        if preset_mode == self.preset_modepreset_modepreset_modepreset_mode:
            return
 
        self.update_without_throttleupdate_without_throttle = True
 
        # If we are currently in vacation mode, cancel it.
        if self.preset_modepreset_modepreset_modepreset_mode == PRESET_VACATION:
            self.datadata.ecobee.delete_vacation(self.thermostat_indexthermostat_index, self.vacationvacation)
 
        if preset_mode == PRESET_AWAY_INDEFINITELY:
            self.datadata.ecobee.set_climate_hold(
                self.thermostat_indexthermostat_index, "away", "indefinite", self.hold_hourshold_hours()
            )
 
        elif preset_mode == PRESET_TEMPERATURE:
            self.set_temp_holdset_temp_hold(self.current_temperaturecurrent_temperaturecurrent_temperature)
 
        elif preset_mode in (PRESET_HOLD_NEXT_TRANSITION, PRESET_HOLD_INDEFINITE):
            self.datadata.ecobee.set_climate_hold(
                self.thermostat_indexthermostat_index,
                PRESET_TO_ECOBEE_HOLD[preset_mode],
                self.hold_preferencehold_preference(),
                self.hold_hourshold_hours(),
            )
 
        elif preset_mode == PRESET_NONE:
            self.datadata.ecobee.resume_program(self.thermostat_indexthermostat_index)
 
        else:
            for climate_ref, name in self.comfort_settingscomfort_settings.items():
                if name == preset_mode:
                    preset_mode = climate_ref
                    break
            else:
                _LOGGER.warning("Received unknown preset mode: %s", preset_mode)
 
            self.datadata.ecobee.set_climate_hold(
                self.thermostat_indexthermostat_index,
                preset_mode,
                self.hold_preferencehold_preference(),
                self.hold_hourshold_hours(),
            )
 
    @property
    def preset_modes(self) -> list[str] | None:
        """Return available preset modes."""
        # Return presets provided by the ecobee API, and an indefinite away
        # preset which we handle separately in set_preset_mode().
        return [
            ECOBEE_TO_HASS_PRESET.get(name, name)
            for name in self.comfort_settingscomfort_settings.values()
        ] + [PRESET_AWAY_INDEFINITELY]
 
    @property
    def comfort_settings(self) -> dict[str, str]:
        """Return ecobee API comfort settings."""
        return {
            comfort["climateRef"]: comfort["name"]
            for comfort in self.thermostatthermostat["program"]["climates"]
        }
 
    def set_auto_temp_hold(self, heat_temp, cool_temp):
        """Set temperature hold in auto mode."""
        if cool_temp is not None:
            cool_temp_setpoint = cool_temp
        else:
            cool_temp_setpoint = self.thermostatthermostat["runtime"]["desiredCool"] / 10.0
 
        if heat_temp is not None:
            heat_temp_setpoint = heat_temp
        else:
            heat_temp_setpoint = self.thermostatthermostat["runtime"]["desiredCool"] / 10.0
 
        self.datadata.ecobee.set_hold_temp(
            self.thermostat_indexthermostat_index,
            cool_temp_setpoint,
            heat_temp_setpoint,
            self.hold_preferencehold_preference(),
            self.hold_hourshold_hours(),
        )
        _LOGGER.debug(
            "Setting ecobee hold_temp to: heat=%s, is=%s, cool=%s, is=%s",
            heat_temp,
            isinstance(heat_temp, (int, float)),
            cool_temp,
            isinstance(cool_temp, (int, float)),
        )
 
        self.update_without_throttleupdate_without_throttle = True
 
    def set_fan_mode(self, fan_mode: str) -> None:
        """Set the fan mode.  Valid values are "on" or "auto"."""
        if fan_mode.lower() not in (FAN_ON, FAN_AUTO):
            error = "Invalid fan_mode value:  Valid values are 'on' or 'auto'"
            _LOGGER.error(error)
            return
 
        self.datadata.ecobee.set_fan_mode(
            self.thermostat_indexthermostat_index,
            fan_mode,
            self.hold_preferencehold_preference(),
            holdHours=self.hold_hourshold_hours(),
        )
 
        _LOGGER.debug("Setting fan mode to: %s", fan_mode)
 
    def set_temp_hold(self, temp):
        """Set temperature hold in modes other than auto.
 
        Ecobee API: It is good practice to set the heat and cool hold
        temperatures to be the same, if the thermostat is in either heat, cool,
        auxHeatOnly, or off mode. If the thermostat is in auto mode, an
        additional rule is required. The cool hold temperature must be greater
        than the heat hold temperature by at least the amount in the
        heatCoolMinDelta property.
        https://www.ecobee.com/home/developer/api/examples/ex5.shtml
        """
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode in (HVACMode.HEAT, HVACMode.COOL):
            heat_temp = temp
            cool_temp = temp
        else:
            delta = self.settingssettings["heatCoolMinDelta"] / 10.0
            heat_temp = temp - delta
            cool_temp = temp + delta
        self.set_auto_temp_holdset_auto_temp_hold(heat_temp, cool_temp)
 
    def set_temperature(self, **kwargs: Any) -> None:
        """Set new target temperature."""
        low_temp = kwargs.get(ATTR_TARGET_TEMP_LOW)
        high_temp = kwargs.get(ATTR_TARGET_TEMP_HIGH)
        temp = kwargs.get(ATTR_TEMPERATURE)
 
        if self.hvac_modehvac_modehvac_modehvac_modehvac_mode == HVACMode.HEAT_COOL and (
            low_temp is not None or high_temp is not None
        ):
            self.set_auto_temp_holdset_auto_temp_hold(low_temp, high_temp)
        elif temp is not None:
            self.set_temp_holdset_temp_hold(temp)
        else:
            _LOGGER.error("Missing valid arguments for set_temperature in %s", kwargs)
 
    def set_humidity(self, humidity: int) -> None:
        """Set the humidity level."""
        if not (0 <= humidity <= 100):
            raise ValueError(
                f"Invalid set_humidity value (must be in range 0-100): {humidity}"
            )
 
        self.datadata.ecobee.set_humidity(self.thermostat_indexthermostat_index, int(humidity))
        self.update_without_throttleupdate_without_throttle = True
 
    def set_hvac_mode(self, hvac_mode: HVACMode) -> None:
        """Set HVAC mode (auto, auxHeatOnly, cool, heat, off)."""
        ecobee_value = HASS_TO_ECOBEE_HVAC.get(hvac_mode)
        if ecobee_value is None:
            _LOGGER.error("Invalid mode for set_hvac_mode: %s", hvac_mode)
            return
        self.datadata.ecobee.set_hvac_mode(self.thermostat_indexthermostat_index, ecobee_value)
        self.update_without_throttleupdate_without_throttle = True
 
    def set_fan_min_on_time(self, fan_min_on_time):
        """Set the minimum fan on time."""
        self.datadata.ecobee.set_fan_min_on_time(self.thermostat_indexthermostat_index, fan_min_on_time)
        self.update_without_throttleupdate_without_throttle = True
 
    def resume_program(self, resume_all):
        """Resume the thermostat schedule program."""
        self.datadata.ecobee.resume_program(
            self.thermostat_indexthermostat_index, "true" if resume_all else "false"
        )
        self.update_without_throttleupdate_without_throttle = True
 
    def set_sensors_used_in_climate(
        self, device_ids: list[str], preset_mode: str | None = None
    ) -> None:
        """Set the sensors used on a climate for a thermostat."""
        if preset_mode is None:
            preset_mode = self.preset_modepreset_modepreset_modepreset_mode
 
        # Check if climate is an available preset option.
        elif preset_mode not in self._preset_modes_preset_modes.values():
            if self.preset_modespreset_modespreset_modes:
                raise ServiceValidationError(
                    translation_domain=DOMAIN,
                    translation_key="invalid_preset",
                    translation_placeholders={
                        "options": ", ".join(self._preset_modes_preset_modes.values())
                    },
                )
 
        # Get device name from device id.
        device_registry = dr.async_get(self.hasshass)
        sensor_names: list[str] = []
        sensor_ids: list[str] = []
        for device_id in device_ids:
            device = device_registry.async_get(device_id)
            if device and device.name:
                r_sensors = self.thermostatthermostat.get("remoteSensors", [])
                ecobee_identifier = next(
                    (
                        identifier
                        for identifier in device.identifiers
                        if identifier[0] == "ecobee"
                    ),
                    None,
                )
                if ecobee_identifier:
                    code = ecobee_identifier[1]
                    for r_sensor in r_sensors:
                        if (  # occurs if remote sensor
                            len(code) == 4 and r_sensor.get("code") == code
                        ) or (  # occurs if thermostat
                            len(code) != 4 and r_sensor.get("type") == "thermostat"
                        ):
                            sensor_ids.append(r_sensor.get("id"))  # noqa: PERF401
                    sensor_names.append(device.name)
 
        # Ensure sensors provided are available for thermostat or not empty.
        if not set(sensor_names).issubset(set(self._sensors_sensors)) or not sensor_names:
            raise ServiceValidationError(
                translation_domain=DOMAIN,
                translation_key="invalid_sensor",
                translation_placeholders={
                    "options": ", ".join(
                        [
                            f'{item["name_by_user"]} ({item["id"]})'
                            for item in self.remote_sensor_ids_namesremote_sensor_ids_names
                        ]
                    )
                },
            )
 
        # Check that an id was found for each sensor
        if len(device_ids) != len(sensor_ids):
            raise ServiceValidationError(
                translation_domain=DOMAIN, translation_key="sensor_lookup_failed"
            )
 
        # Check if sensors are currently used on the climate for the thermostat.
        current_sensors_in_climate = self._sensors_in_preset_mode_sensors_in_preset_mode(preset_mode)
        if set(sensor_names) == set(current_sensors_in_climate):
            _LOGGER.debug(
                "This action would not be an update, current sensors on climate (%s) are: %s",
                preset_mode,
                ", ".join(current_sensors_in_climate),
            )
            return
 
        _LOGGER.debug(
            "Setting sensors %s to be used on thermostat %s for program %s",
            sensor_names,
            self.device_infodevice_infodevice_info.get("name"),
            preset_mode,
        )
        self.datadata.ecobee.update_climate_sensors(
            self.thermostat_indexthermostat_index, preset_mode, sensor_ids=sensor_ids
        )
        self.update_without_throttleupdate_without_throttle = True
 
    def _sensors_in_preset_mode(self, preset_mode: str | None) -> list[str]:
        """Return current sensors used in climate."""
        climates = self.thermostatthermostat["program"]["climates"]
        for climate in climates:
            if climate.get("name") == preset_mode:
                return [sensor["name"] for sensor in climate["sensors"]]
 
        return []
 
    def _sensor_devices_in_preset_mode(self, preset_mode: str | None) -> list[str]:
        """Return current sensor device name_by_user or name used in climate."""
        device_registry = dr.async_get(self._hass_hass)
        sensor_names = self._sensors_in_preset_mode_sensors_in_preset_mode(preset_mode)
        return sorted(
            [
                device.name_by_user if device.name_by_user else device.name
                for device in device_registry.devices.values()
                for sensor_name in sensor_names
                if device.name == sensor_name
            ]
        )
 
    def hold_preference(self):
        """Return user preference setting for hold time."""
        # Values returned from thermostat are:
        #   "useEndTime2hour", "useEndTime4hour"
        #   "nextPeriod", "askMe"
        #   "indefinite"
        device_preference = self.settingssettings["holdAction"]
        # Currently supported pyecobee holdTypes:
        #   dateTime, nextTransition, indefinite, holdHours
        hold_pref_map = {
            "useEndTime2hour": "holdHours",
            "useEndTime4hour": "holdHours",
            "indefinite": "indefinite",
        }
        return hold_pref_map.get(device_preference, "nextTransition")
 
    def hold_hours(self):
        """Return user preference setting for hold duration in hours."""
        # Values returned from thermostat are:
        #   "useEndTime2hour", "useEndTime4hour"
        #   "nextPeriod", "askMe"
        #   "indefinite"
        device_preference = self.settingssettings["holdAction"]
        hold_hours_map = {
            "useEndTime2hour": 2,
            "useEndTime4hour": 4,
        }
        return hold_hours_map.get(device_preference)
 
    def create_vacation(self, service_data):
        """Create a vacation with user-specified parameters."""
        vacation_name = service_data[ATTR_VACATION_NAME]
        cool_temp = TemperatureConverter.convert(
            service_data[ATTR_COOL_TEMP],
            self.hasshass.config.units.temperature_unit,
            UnitOfTemperature.FAHRENHEIT,
        )
        heat_temp = TemperatureConverter.convert(
            service_data[ATTR_HEAT_TEMP],
            self.hasshass.config.units.temperature_unit,
            UnitOfTemperature.FAHRENHEIT,
        )
        start_date = service_data.get(ATTR_START_DATE)
        start_time = service_data.get(ATTR_START_TIME)
        end_date = service_data.get(ATTR_END_DATE)
        end_time = service_data.get(ATTR_END_TIME)
        fan_mode = service_data[ATTR_FAN_MODE]
        fan_min_on_time = service_data[ATTR_FAN_MIN_ON_TIME]
 
        kwargs = {
            key: value
            for key, value in {
                "start_date": start_date,
                "start_time": start_time,
                "end_date": end_date,
                "end_time": end_time,
                "fan_mode": fan_mode,
                "fan_min_on_time": fan_min_on_time,
            }.items()
            if value is not None
        }
 
        _LOGGER.debug(
            (
                "Creating a vacation on thermostat %s with name %s, cool temp %s, heat"
                " temp %s, and the following other parameters: %s"
            ),
            self.namename,
            vacation_name,
            cool_temp,
            heat_temp,
            kwargs,
        )
        self.datadata.ecobee.create_vacation(
            self.thermostat_indexthermostat_index, vacation_name, cool_temp, heat_temp, **kwargs
        )
 
    def delete_vacation(self, vacation_name):
        """Delete a vacation with the specified name."""
        _LOGGER.debug(
            "Deleting a vacation on thermostat %s with name %s",
            self.namename,
            vacation_name,
        )
        self.datadata.ecobee.delete_vacation(self.thermostat_indexthermostat_index, vacation_name)
 
    def turn_on(self) -> None:
        """Set the thermostat to the last active HVAC mode."""
        _LOGGER.debug(
            "Turning on ecobee thermostat %s in %s mode",
            self.namename,
            self._last_active_hvac_mode_last_active_hvac_mode,
        )
        self.set_hvac_modeset_hvac_modeset_hvac_mode(self._last_active_hvac_mode_last_active_hvac_mode)
 
    def set_dst_mode(self, dst_enabled):
        """Enable/disable automatic daylight savings time."""
        self.datadata.ecobee.set_dst_mode(self.thermostat_indexthermostat_index, dst_enabled)
 
    def set_mic_mode(self, mic_enabled):
        """Enable/disable Alexa mic (only for Ecobee 4)."""
        self.datadata.ecobee.set_mic_mode(self.thermostat_indexthermostat_index, mic_enabled)
 
    def set_occupancy_modes(self, auto_away=None, follow_me=None):
        """Enable/disable Smart Home/Away and Follow Me modes."""
        self.datadata.ecobee.set_occupancy_modes(
            self.thermostat_indexthermostat_index, auto_away, follow_me
        )