Remove Legacy Works With Nest (#96111)
* Remove Legacy Works With Nest * Simplify nest configuration * Cleanup legacy nest config entries
This commit is contained in:
Allen Porter
GitHub
parent
1c54b2e025
commit
c4a39bbfb1
28 changed files with 704 additions and 2701 deletions
|
|
@ -1,19 +1,357 @@
|
|||
"""Support for Nest climate that dispatches between API versions."""
|
||||
"""Support for Google Nest SDM climate devices."""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any, cast
|
||||
|
||||
from google_nest_sdm.device import Device
|
||||
from google_nest_sdm.device_manager import DeviceManager
|
||||
from google_nest_sdm.device_traits import FanTrait, TemperatureTrait
|
||||
from google_nest_sdm.exceptions import ApiException
|
||||
from google_nest_sdm.thermostat_traits import (
|
||||
ThermostatEcoTrait,
|
||||
ThermostatHeatCoolTrait,
|
||||
ThermostatHvacTrait,
|
||||
ThermostatModeTrait,
|
||||
ThermostatTemperatureSetpointTrait,
|
||||
)
|
||||
|
||||
from homeassistant.components.climate import (
|
||||
ATTR_HVAC_MODE,
|
||||
ATTR_TARGET_TEMP_HIGH,
|
||||
ATTR_TARGET_TEMP_LOW,
|
||||
FAN_OFF,
|
||||
FAN_ON,
|
||||
PRESET_ECO,
|
||||
PRESET_NONE,
|
||||
ClimateEntity,
|
||||
ClimateEntityFeature,
|
||||
HVACAction,
|
||||
HVACMode,
|
||||
)
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import ATTR_TEMPERATURE, UnitOfTemperature
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers.entity import DeviceInfo
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
|
||||
from .climate_sdm import async_setup_sdm_entry
|
||||
from .const import DATA_SDM
|
||||
from .legacy.climate import async_setup_legacy_entry
|
||||
from .const import DATA_DEVICE_MANAGER, DOMAIN
|
||||
from .device_info import NestDeviceInfo
|
||||
|
||||
# Mapping for sdm.devices.traits.ThermostatMode mode field
|
||||
THERMOSTAT_MODE_MAP: dict[str, HVACMode] = {
|
||||
"OFF": HVACMode.OFF,
|
||||
"HEAT": HVACMode.HEAT,
|
||||
"COOL": HVACMode.COOL,
|
||||
"HEATCOOL": HVACMode.HEAT_COOL,
|
||||
}
|
||||
THERMOSTAT_INV_MODE_MAP = {v: k for k, v in THERMOSTAT_MODE_MAP.items()}
|
||||
|
||||
# Mode for sdm.devices.traits.ThermostatEco
|
||||
THERMOSTAT_ECO_MODE = "MANUAL_ECO"
|
||||
|
||||
# Mapping for sdm.devices.traits.ThermostatHvac status field
|
||||
THERMOSTAT_HVAC_STATUS_MAP = {
|
||||
"OFF": HVACAction.OFF,
|
||||
"HEATING": HVACAction.HEATING,
|
||||
"COOLING": HVACAction.COOLING,
|
||||
}
|
||||
|
||||
THERMOSTAT_RANGE_MODES = [HVACMode.HEAT_COOL, HVACMode.AUTO]
|
||||
|
||||
PRESET_MODE_MAP = {
|
||||
"MANUAL_ECO": PRESET_ECO,
|
||||
"OFF": PRESET_NONE,
|
||||
}
|
||||
PRESET_INV_MODE_MAP = {v: k for k, v in PRESET_MODE_MAP.items()}
|
||||
|
||||
FAN_MODE_MAP = {
|
||||
"ON": FAN_ON,
|
||||
"OFF": FAN_OFF,
|
||||
}
|
||||
FAN_INV_MODE_MAP = {v: k for k, v in FAN_MODE_MAP.items()}
|
||||
FAN_INV_MODES = list(FAN_INV_MODE_MAP)
|
||||
|
||||
MAX_FAN_DURATION = 43200 # 15 hours is the max in the SDM API
|
||||
MIN_TEMP = 10
|
||||
MAX_TEMP = 32
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
||||
) -> None:
|
||||
"""Set up the climate platform."""
|
||||
if DATA_SDM not in entry.data:
|
||||
await async_setup_legacy_entry(hass, entry, async_add_entities)
|
||||
return
|
||||
await async_setup_sdm_entry(hass, entry, async_add_entities)
|
||||
"""Set up the client entities."""
|
||||
|
||||
device_manager: DeviceManager = hass.data[DOMAIN][entry.entry_id][
|
||||
DATA_DEVICE_MANAGER
|
||||
]
|
||||
entities = []
|
||||
for device in device_manager.devices.values():
|
||||
if ThermostatHvacTrait.NAME in device.traits:
|
||||
entities.append(ThermostatEntity(device))
|
||||
async_add_entities(entities)
|
||||
|
||||
|
||||
class ThermostatEntity(ClimateEntity):
|
||||
"""A nest thermostat climate entity."""
|
||||
|
||||
_attr_min_temp = MIN_TEMP
|
||||
_attr_max_temp = MAX_TEMP
|
||||
_attr_has_entity_name = True
|
||||
_attr_should_poll = False
|
||||
_attr_name = None
|
||||
|
||||
def __init__(self, device: Device) -> None:
|
||||
"""Initialize ThermostatEntity."""
|
||||
self._device = device
|
||||
self._device_info = NestDeviceInfo(device)
|
||||
|
||||
@property
|
||||
def unique_id(self) -> str | None:
|
||||
"""Return a unique ID."""
|
||||
# The API "name" field is a unique device identifier.
|
||||
return self._device.name
|
||||
|
||||
@property
|
||||
def device_info(self) -> DeviceInfo:
|
||||
"""Return device specific attributes."""
|
||||
return self._device_info.device_info
|
||||
|
||||
@property
|
||||
def available(self) -> bool:
|
||||
"""Return device availability."""
|
||||
return self._device_info.available
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Run when entity is added to register update signal handler."""
|
||||
self._attr_supported_features = self._get_supported_features()
|
||||
self.async_on_remove(
|
||||
self._device.add_update_listener(self.async_write_ha_state)
|
||||
)
|
||||
|
||||
@property
|
||||
def temperature_unit(self) -> str:
|
||||
"""Return the unit of temperature measurement for the system."""
|
||||
return UnitOfTemperature.CELSIUS
|
||||
|
||||
@property
|
||||
def current_temperature(self) -> float | None:
|
||||
"""Return the current temperature."""
|
||||
if TemperatureTrait.NAME not in self._device.traits:
|
||||
return None
|
||||
trait: TemperatureTrait = self._device.traits[TemperatureTrait.NAME]
|
||||
return trait.ambient_temperature_celsius
|
||||
|
||||
@property
|
||||
def target_temperature(self) -> float | None:
|
||||
"""Return the temperature currently set to be reached."""
|
||||
if not (trait := self._target_temperature_trait):
|
||||
return None
|
||||
if self.hvac_mode == HVACMode.HEAT:
|
||||
return trait.heat_celsius
|
||||
if self.hvac_mode == HVACMode.COOL:
|
||||
return trait.cool_celsius
|
||||
return None
|
||||
|
||||
@property
|
||||
def target_temperature_high(self) -> float | None:
|
||||
"""Return the upper bound target temperature."""
|
||||
if self.hvac_mode != HVACMode.HEAT_COOL:
|
||||
return None
|
||||
if not (trait := self._target_temperature_trait):
|
||||
return None
|
||||
return trait.cool_celsius
|
||||
|
||||
@property
|
||||
def target_temperature_low(self) -> float | None:
|
||||
"""Return the lower bound target temperature."""
|
||||
if self.hvac_mode != HVACMode.HEAT_COOL:
|
||||
return None
|
||||
if not (trait := self._target_temperature_trait):
|
||||
return None
|
||||
return trait.heat_celsius
|
||||
|
||||
@property
|
||||
def _target_temperature_trait(
|
||||
self,
|
||||
) -> ThermostatHeatCoolTrait | None:
|
||||
"""Return the correct trait with a target temp depending on mode."""
|
||||
if (
|
||||
self.preset_mode == PRESET_ECO
|
||||
and ThermostatEcoTrait.NAME in self._device.traits
|
||||
):
|
||||
return cast(
|
||||
ThermostatEcoTrait, self._device.traits[ThermostatEcoTrait.NAME]
|
||||
)
|
||||
if ThermostatTemperatureSetpointTrait.NAME in self._device.traits:
|
||||
return cast(
|
||||
ThermostatTemperatureSetpointTrait,
|
||||
self._device.traits[ThermostatTemperatureSetpointTrait.NAME],
|
||||
)
|
||||
return None
|
||||
|
||||
@property
|
||||
def hvac_mode(self) -> HVACMode:
|
||||
"""Return the current operation (e.g. heat, cool, idle)."""
|
||||
hvac_mode = HVACMode.OFF
|
||||
if ThermostatModeTrait.NAME in self._device.traits:
|
||||
trait = self._device.traits[ThermostatModeTrait.NAME]
|
||||
if trait.mode in THERMOSTAT_MODE_MAP:
|
||||
hvac_mode = THERMOSTAT_MODE_MAP[trait.mode]
|
||||
return hvac_mode
|
||||
|
||||
@property
|
||||
def hvac_modes(self) -> list[HVACMode]:
|
||||
"""List of available operation modes."""
|
||||
supported_modes = []
|
||||
for mode in self._get_device_hvac_modes:
|
||||
if mode in THERMOSTAT_MODE_MAP:
|
||||
supported_modes.append(THERMOSTAT_MODE_MAP[mode])
|
||||
return supported_modes
|
||||
|
||||
@property
|
||||
def _get_device_hvac_modes(self) -> set[str]:
|
||||
"""Return the set of SDM API hvac modes supported by the device."""
|
||||
modes = []
|
||||
if ThermostatModeTrait.NAME in self._device.traits:
|
||||
trait = self._device.traits[ThermostatModeTrait.NAME]
|
||||
modes.extend(trait.available_modes)
|
||||
return set(modes)
|
||||
|
||||
@property
|
||||
def hvac_action(self) -> HVACAction | None:
|
||||
"""Return the current HVAC action (heating, cooling)."""
|
||||
trait = self._device.traits[ThermostatHvacTrait.NAME]
|
||||
if trait.status == "OFF" and self.hvac_mode != HVACMode.OFF:
|
||||
return HVACAction.IDLE
|
||||
return THERMOSTAT_HVAC_STATUS_MAP.get(trait.status)
|
||||
|
||||
@property
|
||||
def preset_mode(self) -> str:
|
||||
"""Return the current active preset."""
|
||||
if ThermostatEcoTrait.NAME in self._device.traits:
|
||||
trait = self._device.traits[ThermostatEcoTrait.NAME]
|
||||
return PRESET_MODE_MAP.get(trait.mode, PRESET_NONE)
|
||||
return PRESET_NONE
|
||||
|
||||
@property
|
||||
def preset_modes(self) -> list[str]:
|
||||
"""Return the available presets."""
|
||||
modes = []
|
||||
if ThermostatEcoTrait.NAME in self._device.traits:
|
||||
trait = self._device.traits[ThermostatEcoTrait.NAME]
|
||||
for mode in trait.available_modes:
|
||||
if mode in PRESET_MODE_MAP:
|
||||
modes.append(PRESET_MODE_MAP[mode])
|
||||
return modes
|
||||
|
||||
@property
|
||||
def fan_mode(self) -> str:
|
||||
"""Return the current fan mode."""
|
||||
if (
|
||||
self.supported_features & ClimateEntityFeature.FAN_MODE
|
||||
and FanTrait.NAME in self._device.traits
|
||||
):
|
||||
trait = self._device.traits[FanTrait.NAME]
|
||||
return FAN_MODE_MAP.get(trait.timer_mode, FAN_OFF)
|
||||
return FAN_OFF
|
||||
|
||||
@property
|
||||
def fan_modes(self) -> list[str]:
|
||||
"""Return the list of available fan modes."""
|
||||
if (
|
||||
self.supported_features & ClimateEntityFeature.FAN_MODE
|
||||
and FanTrait.NAME in self._device.traits
|
||||
):
|
||||
return FAN_INV_MODES
|
||||
return []
|
||||
|
||||
def _get_supported_features(self) -> ClimateEntityFeature:
|
||||
"""Compute the bitmap of supported features from the current state."""
|
||||
features = ClimateEntityFeature(0)
|
||||
if HVACMode.HEAT_COOL in self.hvac_modes:
|
||||
features |= ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
|
||||
if HVACMode.HEAT in self.hvac_modes or HVACMode.COOL in self.hvac_modes:
|
||||
features |= ClimateEntityFeature.TARGET_TEMPERATURE
|
||||
if ThermostatEcoTrait.NAME in self._device.traits:
|
||||
features |= ClimateEntityFeature.PRESET_MODE
|
||||
if FanTrait.NAME in self._device.traits:
|
||||
# Fan trait may be present without actually support fan mode
|
||||
fan_trait = self._device.traits[FanTrait.NAME]
|
||||
if fan_trait.timer_mode is not None:
|
||||
features |= ClimateEntityFeature.FAN_MODE
|
||||
return features
|
||||
|
||||
async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
|
||||
"""Set new target hvac mode."""
|
||||
if hvac_mode not in self.hvac_modes:
|
||||
raise ValueError(f"Unsupported hvac_mode '{hvac_mode}'")
|
||||
api_mode = THERMOSTAT_INV_MODE_MAP[hvac_mode]
|
||||
trait = self._device.traits[ThermostatModeTrait.NAME]
|
||||
try:
|
||||
await trait.set_mode(api_mode)
|
||||
except ApiException as err:
|
||||
raise HomeAssistantError(
|
||||
f"Error setting {self.entity_id} HVAC mode to {hvac_mode}: {err}"
|
||||
) from err
|
||||
|
||||
async def async_set_temperature(self, **kwargs: Any) -> None:
|
||||
"""Set new target temperature."""
|
||||
hvac_mode = self.hvac_mode
|
||||
if kwargs.get(ATTR_HVAC_MODE) is not None:
|
||||
hvac_mode = kwargs[ATTR_HVAC_MODE]
|
||||
await self.async_set_hvac_mode(hvac_mode)
|
||||
low_temp = kwargs.get(ATTR_TARGET_TEMP_LOW)
|
||||
high_temp = kwargs.get(ATTR_TARGET_TEMP_HIGH)
|
||||
temp = kwargs.get(ATTR_TEMPERATURE)
|
||||
if ThermostatTemperatureSetpointTrait.NAME not in self._device.traits:
|
||||
raise HomeAssistantError(
|
||||
f"Error setting {self.entity_id} temperature to {kwargs}: "
|
||||
"Unable to find setpoint trait."
|
||||
)
|
||||
trait = self._device.traits[ThermostatTemperatureSetpointTrait.NAME]
|
||||
try:
|
||||
if self.preset_mode == PRESET_ECO or hvac_mode == HVACMode.HEAT_COOL:
|
||||
if low_temp and high_temp:
|
||||
await trait.set_range(low_temp, high_temp)
|
||||
elif hvac_mode == HVACMode.COOL and temp:
|
||||
await trait.set_cool(temp)
|
||||
elif hvac_mode == HVACMode.HEAT and temp:
|
||||
await trait.set_heat(temp)
|
||||
except ApiException as err:
|
||||
raise HomeAssistantError(
|
||||
f"Error setting {self.entity_id} temperature to {kwargs}: {err}"
|
||||
) from err
|
||||
|
||||
async def async_set_preset_mode(self, preset_mode: str) -> None:
|
||||
"""Set new target preset mode."""
|
||||
if preset_mode not in self.preset_modes:
|
||||
raise ValueError(f"Unsupported preset_mode '{preset_mode}'")
|
||||
if self.preset_mode == preset_mode: # API doesn't like duplicate preset modes
|
||||
return
|
||||
trait = self._device.traits[ThermostatEcoTrait.NAME]
|
||||
try:
|
||||
await trait.set_mode(PRESET_INV_MODE_MAP[preset_mode])
|
||||
except ApiException as err:
|
||||
raise HomeAssistantError(
|
||||
f"Error setting {self.entity_id} preset mode to {preset_mode}: {err}"
|
||||
) from err
|
||||
|
||||
async def async_set_fan_mode(self, fan_mode: str) -> None:
|
||||
"""Set new target fan mode."""
|
||||
if fan_mode not in self.fan_modes:
|
||||
raise ValueError(f"Unsupported fan_mode '{fan_mode}'")
|
||||
if fan_mode == FAN_ON and self.hvac_mode == HVACMode.OFF:
|
||||
raise ValueError(
|
||||
"Cannot turn on fan, please set an HVAC mode (e.g. heat/cool) first"
|
||||
)
|
||||
trait = self._device.traits[FanTrait.NAME]
|
||||
duration = None
|
||||
if fan_mode != FAN_OFF:
|
||||
duration = MAX_FAN_DURATION
|
||||
try:
|
||||
await trait.set_timer(FAN_INV_MODE_MAP[fan_mode], duration=duration)
|
||||
except ApiException as err:
|
||||
raise HomeAssistantError(
|
||||
f"Error setting {self.entity_id} fan mode to {fan_mode}: {err}"
|
||||
) from err
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue