mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
232 lines
8.4 KiB
Python
232 lines
8.4 KiB
Python
"""Plugwise Climate component for Home Assistant."""
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from homeassistant.components.climate import (
|
|
ATTR_HVAC_MODE,
|
|
ATTR_TARGET_TEMP_HIGH,
|
|
ATTR_TARGET_TEMP_LOW,
|
|
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_platform import AddEntitiesCallback
|
|
|
|
from .const import DOMAIN, MASTER_THERMOSTATS
|
|
from .coordinator import PlugwiseDataUpdateCoordinator
|
|
from .entity import PlugwiseEntity
|
|
from .util import plugwise_command
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Smile Thermostats from a config entry."""
|
|
coordinator = hass.data[DOMAIN][config_entry.entry_id]
|
|
async_add_entities(
|
|
PlugwiseClimateEntity(coordinator, device_id)
|
|
for device_id, device in coordinator.data.devices.items()
|
|
if device["dev_class"] in MASTER_THERMOSTATS
|
|
)
|
|
|
|
|
|
class PlugwiseClimateEntity(PlugwiseEntity, ClimateEntity):
|
|
"""Representation of a Plugwise thermostat."""
|
|
|
|
_attr_has_entity_name = True
|
|
_attr_name = None
|
|
_attr_temperature_unit = UnitOfTemperature.CELSIUS
|
|
_attr_translation_key = DOMAIN
|
|
|
|
_previous_mode: str = "heating"
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: PlugwiseDataUpdateCoordinator,
|
|
device_id: str,
|
|
) -> None:
|
|
"""Set up the Plugwise API."""
|
|
super().__init__(coordinator, device_id)
|
|
self._attr_extra_state_attributes = {}
|
|
self._attr_unique_id = f"{device_id}-climate"
|
|
self.cdr_gateway = coordinator.data.gateway
|
|
gateway_id: str = coordinator.data.gateway["gateway_id"]
|
|
self.gateway_data = coordinator.data.devices[gateway_id]
|
|
# Determine supported features
|
|
self._attr_supported_features = ClimateEntityFeature.TARGET_TEMPERATURE
|
|
if (
|
|
self.cdr_gateway["cooling_present"]
|
|
and self.cdr_gateway["smile_name"] != "Adam"
|
|
):
|
|
self._attr_supported_features = (
|
|
ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
|
|
)
|
|
if presets := self.device.get("preset_modes"):
|
|
self._attr_supported_features |= ClimateEntityFeature.PRESET_MODE
|
|
self._attr_preset_modes = presets
|
|
|
|
self._attr_min_temp = self.device["thermostat"]["lower_bound"]
|
|
self._attr_max_temp = min(self.device["thermostat"]["upper_bound"], 35.0)
|
|
# Ensure we don't drop below 0.1
|
|
self._attr_target_temperature_step = max(
|
|
self.device["thermostat"]["resolution"], 0.1
|
|
)
|
|
|
|
def _previous_action_mode(self, coordinator: PlugwiseDataUpdateCoordinator) -> None:
|
|
"""Return the previous action-mode when the regulation-mode is not heating or cooling.
|
|
|
|
Helper for set_hvac_mode().
|
|
"""
|
|
# When no cooling available, _previous_mode is always heating
|
|
if (
|
|
"regulation_modes" in self.gateway_data
|
|
and "cooling" in self.gateway_data["regulation_modes"]
|
|
):
|
|
mode = self.gateway_data["select_regulation_mode"]
|
|
if mode in ("cooling", "heating"):
|
|
self._previous_mode = mode
|
|
|
|
@property
|
|
def current_temperature(self) -> float:
|
|
"""Return the current temperature."""
|
|
return self.device["sensors"]["temperature"]
|
|
|
|
@property
|
|
def target_temperature(self) -> float:
|
|
"""Return the temperature we try to reach.
|
|
|
|
Connected to the HVACMode combination of AUTO-HEAT.
|
|
"""
|
|
|
|
return self.device["thermostat"]["setpoint"]
|
|
|
|
@property
|
|
def target_temperature_high(self) -> float:
|
|
"""Return the temperature we try to reach in case of cooling.
|
|
|
|
Connected to the HVACMode combination of AUTO-HEAT_COOL.
|
|
"""
|
|
return self.device["thermostat"]["setpoint_high"]
|
|
|
|
@property
|
|
def target_temperature_low(self) -> float:
|
|
"""Return the heating temperature we try to reach in case of heating.
|
|
|
|
Connected to the HVACMode combination AUTO-HEAT_COOL.
|
|
"""
|
|
return self.device["thermostat"]["setpoint_low"]
|
|
|
|
@property
|
|
def hvac_mode(self) -> HVACMode:
|
|
"""Return HVAC operation ie. auto, cool, heat, heat_cool, or off mode."""
|
|
if (mode := self.device.get("mode")) is None or mode not in self.hvac_modes:
|
|
return HVACMode.HEAT
|
|
return HVACMode(mode)
|
|
|
|
@property
|
|
def hvac_modes(self) -> list[HVACMode]:
|
|
"""Return a list of available HVACModes."""
|
|
hvac_modes: list[HVACMode] = []
|
|
if "regulation_modes" in self.gateway_data:
|
|
hvac_modes.append(HVACMode.OFF)
|
|
|
|
if self.device["available_schedules"] != ["None"]:
|
|
hvac_modes.append(HVACMode.AUTO)
|
|
|
|
if self.cdr_gateway["cooling_present"]:
|
|
if "regulation_modes" in self.gateway_data:
|
|
if self.gateway_data["select_regulation_mode"] == "cooling":
|
|
hvac_modes.append(HVACMode.COOL)
|
|
if self.gateway_data["select_regulation_mode"] == "heating":
|
|
hvac_modes.append(HVACMode.HEAT)
|
|
else:
|
|
hvac_modes.append(HVACMode.HEAT_COOL)
|
|
else:
|
|
hvac_modes.append(HVACMode.HEAT)
|
|
|
|
return hvac_modes
|
|
|
|
@property
|
|
def hvac_action(self) -> HVACAction:
|
|
"""Return the current running hvac operation if supported."""
|
|
# Keep track of the previous action-mode
|
|
self._previous_action_mode(self.coordinator)
|
|
|
|
# Adam provides the hvac_action for each thermostat
|
|
if (control_state := self.device.get("control_state")) == "cooling":
|
|
return HVACAction.COOLING
|
|
if control_state == "heating":
|
|
return HVACAction.HEATING
|
|
if control_state == "preheating":
|
|
return HVACAction.PREHEATING
|
|
if control_state == "off":
|
|
return HVACAction.IDLE
|
|
|
|
heater: str = self.coordinator.data.gateway["heater_id"]
|
|
heater_data = self.coordinator.data.devices[heater]
|
|
if heater_data["binary_sensors"]["heating_state"]:
|
|
return HVACAction.HEATING
|
|
if heater_data["binary_sensors"].get("cooling_state", False):
|
|
return HVACAction.COOLING
|
|
|
|
return HVACAction.IDLE
|
|
|
|
@property
|
|
def preset_mode(self) -> str | None:
|
|
"""Return the current preset mode."""
|
|
return self.device.get("active_preset")
|
|
|
|
@plugwise_command
|
|
async def async_set_temperature(self, **kwargs: Any) -> None:
|
|
"""Set new target temperature."""
|
|
data: dict[str, Any] = {}
|
|
if ATTR_TEMPERATURE in kwargs:
|
|
data["setpoint"] = kwargs.get(ATTR_TEMPERATURE)
|
|
if ATTR_TARGET_TEMP_HIGH in kwargs:
|
|
data["setpoint_high"] = kwargs.get(ATTR_TARGET_TEMP_HIGH)
|
|
if ATTR_TARGET_TEMP_LOW in kwargs:
|
|
data["setpoint_low"] = kwargs.get(ATTR_TARGET_TEMP_LOW)
|
|
|
|
for temperature in data.values():
|
|
if temperature is None or not (
|
|
self._attr_min_temp <= temperature <= self._attr_max_temp
|
|
):
|
|
raise ValueError("Invalid temperature change requested")
|
|
|
|
if mode := kwargs.get(ATTR_HVAC_MODE):
|
|
await self.async_set_hvac_mode(mode)
|
|
|
|
await self.coordinator.api.set_temperature(self.device["location"], data)
|
|
|
|
@plugwise_command
|
|
async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
|
|
"""Set the hvac mode."""
|
|
if hvac_mode not in self.hvac_modes:
|
|
raise HomeAssistantError("Unsupported hvac_mode")
|
|
|
|
if hvac_mode == self.hvac_mode:
|
|
return
|
|
|
|
if hvac_mode == HVACMode.OFF:
|
|
await self.coordinator.api.set_regulation_mode(hvac_mode)
|
|
else:
|
|
await self.coordinator.api.set_schedule_state(
|
|
self.device["location"],
|
|
"on" if hvac_mode == HVACMode.AUTO else "off",
|
|
)
|
|
if self.hvac_mode == HVACMode.OFF:
|
|
await self.coordinator.api.set_regulation_mode(self._previous_mode)
|
|
|
|
@plugwise_command
|
|
async def async_set_preset_mode(self, preset_mode: str) -> None:
|
|
"""Set the preset mode."""
|
|
await self.coordinator.api.set_preset(self.device["location"], preset_mode)
|