934 lines
32 KiB
Python
934 lines
32 KiB
Python
import math
|
|
import logging
|
|
|
|
from datetime import timedelta
|
|
|
|
from homeassistant.core import (
|
|
HomeAssistant,
|
|
callback,
|
|
CoreState,
|
|
DOMAIN as HA_DOMAIN,
|
|
CALLBACK_TYPE,
|
|
)
|
|
from homeassistant.components.climate import PLATFORM_SCHEMA, ClimateEntity
|
|
from homeassistant.helpers.restore_state import RestoreEntity
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from homeassistant.helpers.event import (
|
|
async_track_state_change_event,
|
|
async_track_time_interval,
|
|
async_call_later,
|
|
)
|
|
|
|
from homeassistant.exceptions import ConditionError
|
|
from homeassistant.helpers import condition
|
|
|
|
from homeassistant.components.climate.const import (
|
|
ATTR_PRESET_MODE,
|
|
ATTR_FAN_MODE,
|
|
CURRENT_HVAC_COOL,
|
|
CURRENT_HVAC_HEAT,
|
|
CURRENT_HVAC_IDLE,
|
|
CURRENT_HVAC_OFF,
|
|
HVAC_MODE_COOL,
|
|
HVAC_MODE_HEAT,
|
|
HVAC_MODE_OFF,
|
|
PRESET_ACTIVITY,
|
|
PRESET_AWAY,
|
|
PRESET_BOOST,
|
|
PRESET_COMFORT,
|
|
PRESET_ECO,
|
|
PRESET_HOME,
|
|
PRESET_NONE,
|
|
PRESET_SLEEP,
|
|
SUPPORT_PRESET_MODE,
|
|
SUPPORT_TARGET_TEMPERATURE,
|
|
)
|
|
|
|
from homeassistant.const import (
|
|
UnitOfTemperature,
|
|
ATTR_TEMPERATURE,
|
|
TEMP_CELSIUS,
|
|
TEMP_FAHRENHEIT,
|
|
CONF_NAME,
|
|
CONF_UNIQUE_ID,
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
STATE_OFF,
|
|
STATE_ON,
|
|
EVENT_HOMEASSISTANT_START,
|
|
ATTR_ENTITY_ID,
|
|
SERVICE_TURN_OFF,
|
|
SERVICE_TURN_ON,
|
|
)
|
|
|
|
from .const import (
|
|
DOMAIN,
|
|
CONF_HEATER,
|
|
CONF_POWER_SENSOR,
|
|
CONF_TEMP_SENSOR,
|
|
CONF_MAX_POWER_SENSOR,
|
|
CONF_WINDOW_SENSOR,
|
|
CONF_WINDOW_DELAY,
|
|
CONF_MOTION_SENSOR,
|
|
CONF_MOTION_DELAY,
|
|
CONF_MOTION_PRESET,
|
|
CONF_NO_MOTION_PRESET,
|
|
CONF_DEVICE_POWER,
|
|
CONF_PRESETS,
|
|
CONF_CYCLE_MIN,
|
|
CONF_PROP_FUNCTION,
|
|
CONF_PROP_BIAS,
|
|
SUPPORT_FLAGS,
|
|
PRESET_POWER,
|
|
)
|
|
|
|
from .prop_algorithm import PropAlgorithm
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the VersatileThermostat thermostat with config flow."""
|
|
_LOGGER.debug(
|
|
"Calling async_setup_entry entry=%s, data=%s", entry.entry_id, entry.data
|
|
)
|
|
|
|
unique_id = entry.entry_id
|
|
name = entry.data.get(CONF_NAME)
|
|
heater_entity_id = entry.data.get(CONF_HEATER)
|
|
cycle_min = entry.data.get(CONF_CYCLE_MIN)
|
|
proportional_function = entry.data.get(CONF_PROP_FUNCTION)
|
|
proportional_bias = entry.data.get(CONF_PROP_BIAS)
|
|
temp_sensor_entity_id = entry.data.get(CONF_TEMP_SENSOR)
|
|
power_sensor_entity_id = entry.data.get(CONF_POWER_SENSOR)
|
|
max_power_sensor_entity_id = entry.data.get(CONF_MAX_POWER_SENSOR)
|
|
window_sensor_entity_id = entry.data.get(CONF_WINDOW_SENSOR)
|
|
window_delay_sec = entry.data.get(CONF_WINDOW_DELAY)
|
|
motion_sensor_entity_id = entry.data.get(CONF_MOTION_SENSOR)
|
|
motion_delay_sec = entry.data.get(CONF_MOTION_DELAY)
|
|
motion_preset = entry.data.get(CONF_MOTION_PRESET)
|
|
no_motion_preset = entry.data.get(CONF_NO_MOTION_PRESET)
|
|
device_power = entry.data.get(CONF_DEVICE_POWER)
|
|
|
|
presets = {}
|
|
for (key, value) in CONF_PRESETS.items():
|
|
_LOGGER.debug("looking for key=%s, value=%s", key, value)
|
|
if value in entry.data:
|
|
presets[key] = entry.data.get(value)
|
|
else:
|
|
_LOGGER.debug("value %s not found in Entry", value)
|
|
|
|
async_add_entities(
|
|
[
|
|
VersatileThermostat(
|
|
unique_id,
|
|
name,
|
|
heater_entity_id,
|
|
cycle_min,
|
|
proportional_function,
|
|
proportional_bias,
|
|
temp_sensor_entity_id,
|
|
power_sensor_entity_id,
|
|
max_power_sensor_entity_id,
|
|
window_sensor_entity_id,
|
|
window_delay_sec,
|
|
motion_sensor_entity_id,
|
|
motion_delay_sec,
|
|
motion_preset,
|
|
no_motion_preset,
|
|
presets,
|
|
device_power,
|
|
)
|
|
],
|
|
True,
|
|
)
|
|
|
|
|
|
class VersatileThermostat(ClimateEntity, RestoreEntity):
|
|
"""Representation of a Versatile Thermostat device."""
|
|
|
|
_name: str
|
|
_heater_entity_id: str
|
|
_prop_algorithm: PropAlgorithm
|
|
_async_cancel_cycle: CALLBACK_TYPE
|
|
|
|
def __init__(
|
|
self,
|
|
unique_id,
|
|
name,
|
|
heater_entity_id,
|
|
cycle_min,
|
|
proportional_function,
|
|
proportional_bias,
|
|
temp_sensor_entity_id,
|
|
power_sensor_entity_id,
|
|
max_power_sensor_entity_id,
|
|
window_sensor_entity_id,
|
|
window_delay_sec,
|
|
motion_sensor_entity_id,
|
|
motion_delay_sec,
|
|
motion_preset,
|
|
no_motion_preset,
|
|
presets,
|
|
device_power,
|
|
) -> None:
|
|
"""Initialize the thermostat."""
|
|
|
|
super().__init__()
|
|
|
|
self._unique_id = unique_id
|
|
self._name = name
|
|
self._heater_entity_id = heater_entity_id
|
|
self._cycle_min = cycle_min
|
|
self._proportional_function = proportional_function
|
|
self._proportional_bias = proportional_bias
|
|
self._temp_sensor_entity_id = temp_sensor_entity_id
|
|
self._power_sensor_entity_id = power_sensor_entity_id
|
|
self._max_power_sensor_entity_id = max_power_sensor_entity_id
|
|
self._window_sensor_entity_id = window_sensor_entity_id
|
|
self._window_delay_sec = window_delay_sec
|
|
self._window_delay_sec = window_delay_sec
|
|
self._motion_sensor_entity_id = motion_sensor_entity_id
|
|
self._motion_delay_sec = motion_delay_sec
|
|
self._motion_preset = motion_preset
|
|
self._no_motion_preset = no_motion_preset
|
|
|
|
# TODO if self.ac_mode:
|
|
# self.hvac_list = [HVAC_MODE_COOL, HVAC_MODE_OFF]
|
|
# else:
|
|
self._hvac_list = [HVAC_MODE_HEAT, HVAC_MODE_OFF]
|
|
self._unit = TEMP_CELSIUS
|
|
# Will be restored if possible
|
|
self._hvac_mode = None # HVAC_MODE_OFF
|
|
self._saved_hvac_mode = self._hvac_mode
|
|
|
|
self._support_flags = SUPPORT_FLAGS
|
|
if len(presets):
|
|
self._support_flags = SUPPORT_FLAGS | SUPPORT_PRESET_MODE
|
|
self._attr_preset_modes = (
|
|
[PRESET_NONE] + list(presets.keys()) + [PRESET_ACTIVITY]
|
|
)
|
|
_LOGGER.debug("Set preset_modes to %s", self._attr_preset_modes)
|
|
else:
|
|
_LOGGER.debug("No preset_modes")
|
|
self._attr_preset_modes = [PRESET_NONE]
|
|
self._presets = presets
|
|
_LOGGER.debug("%s - presets are set to: %s", self, self._presets)
|
|
# Will be restored if possible
|
|
self._attr_preset_mode = None
|
|
self._saved_preset_mode = None
|
|
|
|
# Power management
|
|
self._device_power = device_power
|
|
if (
|
|
self._max_power_sensor_entity_id
|
|
and self._power_sensor_entity_id
|
|
and self._device_power
|
|
):
|
|
self._pmax_on = True
|
|
self._current_power = -1
|
|
self._current_power_max = -1
|
|
else:
|
|
self._pmax_on = False
|
|
|
|
# will be restored if possible
|
|
self._target_temp = None
|
|
self._saved_target_temp = PRESET_NONE
|
|
self._humidity = None
|
|
self._ac_mode = False
|
|
self._fan_mode = None
|
|
self._swing_mode = None
|
|
self._cur_temp = None
|
|
|
|
# Initiate the ProportionalAlgorithm
|
|
self._prop_algorithm = PropAlgorithm(
|
|
self._proportional_function, self._proportional_bias, self._cycle_min
|
|
)
|
|
|
|
self._async_cancel_cycle = None
|
|
self._window_call_cancel = None
|
|
self._motion_call_cancel = None
|
|
|
|
_LOGGER.debug(
|
|
"%s - Creation of a new VersatileThermostat entity: unique_id=%s heater_entity_id=%s",
|
|
self,
|
|
self.unique_id,
|
|
heater_entity_id,
|
|
)
|
|
|
|
def __str__(self):
|
|
return f"VersatileThermostat-{self.name}"
|
|
|
|
@property
|
|
def unique_id(self):
|
|
return self._unique_id
|
|
|
|
@property
|
|
def should_poll(self):
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
return self._name
|
|
|
|
@property
|
|
def hvac_modes(self):
|
|
"""List of available operation modes."""
|
|
return self._hvac_list
|
|
|
|
@property
|
|
def temperature_unit(self):
|
|
"""Return the unit of measurement."""
|
|
return self._unit
|
|
|
|
@property
|
|
def hvac_mode(self):
|
|
"""Return current operation."""
|
|
return self._hvac_mode
|
|
|
|
@property
|
|
def hvac_action(self):
|
|
"""Return the current running hvac operation if supported.
|
|
|
|
Need to be one of CURRENT_HVAC_*.
|
|
"""
|
|
if self._hvac_mode == HVAC_MODE_OFF:
|
|
return CURRENT_HVAC_OFF
|
|
if not self._is_device_active:
|
|
return CURRENT_HVAC_IDLE
|
|
if self._ac_mode:
|
|
return CURRENT_HVAC_COOL
|
|
return CURRENT_HVAC_HEAT
|
|
|
|
@property
|
|
def target_temperature(self):
|
|
"""Return the temperature we try to reach."""
|
|
return self._target_temp
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Return the list of supported features."""
|
|
return self._support_flags
|
|
|
|
@property
|
|
def _is_device_active(self):
|
|
"""If the toggleable device is currently active."""
|
|
if not self.hass.states.get(self._heater_entity_id):
|
|
return None
|
|
|
|
return self.hass.states.is_state(self._heater_entity_id, STATE_ON)
|
|
|
|
@property
|
|
def current_temperature(self):
|
|
"""Return the sensor temperature."""
|
|
return self._cur_temp
|
|
|
|
async def async_set_hvac_mode(self, hvac_mode):
|
|
"""Set new target hvac mode."""
|
|
_LOGGER.info("%s - Set hvac mode: %s", self, hvac_mode)
|
|
if hvac_mode == HVAC_MODE_HEAT:
|
|
self._hvac_mode = HVAC_MODE_HEAT
|
|
await self._async_control_heating()
|
|
elif hvac_mode == HVAC_MODE_COOL:
|
|
self._hvac_mode = HVAC_MODE_COOL
|
|
await self._async_control_heating()
|
|
elif hvac_mode == HVAC_MODE_OFF:
|
|
self._hvac_mode = HVAC_MODE_OFF
|
|
# TODO self.prop_current_phase = PROP_PHASE_NONE
|
|
# if self._is_device_active:
|
|
# await self._async_heater_turn_off()
|
|
else:
|
|
_LOGGER.error("Unrecognized hvac mode: %s", hvac_mode)
|
|
return
|
|
# Ensure we update the current operation after changing the mode
|
|
self.async_write_ha_state()
|
|
|
|
async def async_set_preset_mode(self, preset_mode):
|
|
"""Set new preset mode."""
|
|
await self._async_set_preset_mode_internal(preset_mode)
|
|
await self._async_control_heating()
|
|
|
|
async def _async_set_preset_mode_internal(self, preset_mode):
|
|
"""Set new preset mode."""
|
|
_LOGGER.info("%s - Set preset_mode: %s", self, preset_mode)
|
|
if preset_mode not in (self._attr_preset_modes or []):
|
|
raise ValueError(
|
|
f"Got unsupported preset_mode {preset_mode}. Must be one of {self._attr_preset_modes}"
|
|
)
|
|
|
|
if preset_mode == self._attr_preset_mode:
|
|
# I don't think we need to call async_write_ha_state if we didn't change the state
|
|
return
|
|
if preset_mode == PRESET_NONE:
|
|
self._attr_preset_mode = PRESET_NONE
|
|
if self._saved_target_temp:
|
|
self._target_temp = self._saved_target_temp
|
|
elif preset_mode == PRESET_ACTIVITY:
|
|
self._attr_preset_mode = PRESET_ACTIVITY
|
|
self._target_temp = self._presets[self._no_motion_preset]
|
|
else:
|
|
if self._attr_preset_mode == PRESET_NONE:
|
|
self._saved_target_temp = self._target_temp
|
|
self._attr_preset_mode = preset_mode
|
|
self._target_temp = self._presets[preset_mode]
|
|
|
|
if preset_mode != PRESET_POWER:
|
|
self._saved_preset_mode = self._attr_preset_mode
|
|
|
|
self.async_write_ha_state()
|
|
self._prop_algorithm.calculate(self._target_temp, self._cur_temp)
|
|
|
|
async def async_set_fan_mode(self, fan_mode):
|
|
"""Set new target fan mode."""
|
|
_LOGGER.info("%s - Set fan mode: %s", self, fan_mode)
|
|
if fan_mode is None:
|
|
return
|
|
self._fan_mode = fan_mode
|
|
self.async_write_ha_state()
|
|
|
|
async def async_set_humidity(self, humidity: int):
|
|
"""Set new target humidity."""
|
|
_LOGGER.info("%s - Set fan mode: %s", self, humidity)
|
|
if humidity is None:
|
|
return
|
|
self._humidity = humidity
|
|
|
|
async def async_set_swing_mode(self, swing_mode):
|
|
"""Set new target swing operation."""
|
|
_LOGGER.info("%s - Set fan mode: %s", self, swing_mode)
|
|
if swing_mode is None:
|
|
return
|
|
self._swing_mode = swing_mode
|
|
self.async_write_ha_state()
|
|
|
|
async def async_set_temperature(self, **kwargs):
|
|
"""Set new target temperature."""
|
|
temperature = kwargs.get(ATTR_TEMPERATURE)
|
|
_LOGGER.info("%s - Set target temp: %s", self, temperature)
|
|
if temperature is None:
|
|
return
|
|
self._target_temp = temperature
|
|
self._attr_preset_mode = PRESET_NONE
|
|
self._prop_algorithm.calculate(self._target_temp, self._cur_temp)
|
|
self.async_write_ha_state()
|
|
|
|
@callback
|
|
async def entry_update_listener(
|
|
self, hass: HomeAssistant, config_entry: ConfigEntry
|
|
) -> None:
|
|
"""Called when the entry have changed in ConfigFlow"""
|
|
_LOGGER.info("%s - Change entry with the values: %s", self, config_entry.data)
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Run when entity about to be added."""
|
|
_LOGGER.debug("Calling async_added_to_hass")
|
|
|
|
await super().async_added_to_hass()
|
|
|
|
# Add listener
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass, [self._heater_entity_id], self._async_switch_changed
|
|
)
|
|
)
|
|
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass,
|
|
[self._temp_sensor_entity_id],
|
|
self._async_temperature_changed,
|
|
)
|
|
)
|
|
if self._window_sensor_entity_id:
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass,
|
|
[self._window_sensor_entity_id],
|
|
self._async_windows_changed,
|
|
)
|
|
)
|
|
if self._motion_sensor_entity_id:
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass,
|
|
[self._motion_sensor_entity_id],
|
|
self._async_motion_changed,
|
|
)
|
|
)
|
|
|
|
if self._cycle_min:
|
|
self.async_on_remove(
|
|
async_track_time_interval(
|
|
self.hass,
|
|
self._async_control_heating,
|
|
interval=timedelta(minutes=self._cycle_min),
|
|
)
|
|
)
|
|
|
|
if self._power_sensor_entity_id:
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass,
|
|
[self._power_sensor_entity_id],
|
|
self._async_power_changed,
|
|
)
|
|
)
|
|
|
|
if self._max_power_sensor_entity_id:
|
|
self.async_on_remove(
|
|
async_track_state_change_event(
|
|
self.hass,
|
|
[self._max_power_sensor_entity_id],
|
|
self._async_max_power_changed,
|
|
)
|
|
)
|
|
|
|
await self.async_startup()
|
|
|
|
async def async_startup(self):
|
|
"""Triggered on startup, used to get old state and set internal states accordingly"""
|
|
_LOGGER.debug("%s - Calling async_startup", self)
|
|
|
|
@callback
|
|
def _async_startup_internal(*_):
|
|
_LOGGER.debug("%s - Calling async_startup_internal", self)
|
|
need_write_state = False
|
|
temperature_state = self.hass.states.get(self._temp_sensor_entity_id)
|
|
if temperature_state and temperature_state.state not in (
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
):
|
|
_LOGGER.debug(
|
|
"%s - temperature sensor have been retrieved: %.1f",
|
|
self,
|
|
float(temperature_state.state),
|
|
)
|
|
self._async_update_temp(temperature_state)
|
|
need_write_state = True
|
|
|
|
switch_state = self.hass.states.get(self._heater_entity_id)
|
|
if switch_state and switch_state.state not in (
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
):
|
|
self.hass.create_task(self._check_switch_initial_state())
|
|
|
|
if self._pmax_on:
|
|
# try to acquire current power and power max
|
|
current_power_state = self.hass.states.get(self._power_sensor_entity_id)
|
|
if current_power_state and current_power_state.state not in (
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
):
|
|
self._current_power = float(current_power_state.state)
|
|
_LOGGER.debug(
|
|
"%s - Current power have been retrieved: %.3f",
|
|
self,
|
|
self._current_power,
|
|
)
|
|
need_write_state = True
|
|
|
|
# Try to acquire power max
|
|
current_power_max_state = self.hass.states.get(
|
|
self._max_power_sensor_entity_id
|
|
)
|
|
if current_power_max_state and current_power_max_state.state not in (
|
|
STATE_UNAVAILABLE,
|
|
STATE_UNKNOWN,
|
|
):
|
|
self._current_power_max = float(current_power_max_state.state)
|
|
_LOGGER.debug(
|
|
"%s - Current power max have been retrieved: %.3f",
|
|
self,
|
|
self._current_power_max,
|
|
)
|
|
need_write_state = True
|
|
|
|
if need_write_state:
|
|
self.async_write_ha_state()
|
|
self._prop_algorithm.calculate(self._target_temp, self._cur_temp)
|
|
self.hass.create_task(self._async_control_heating())
|
|
|
|
if self.hass.state == CoreState.running:
|
|
_async_startup_internal()
|
|
else:
|
|
self.hass.bus.async_listen_once(
|
|
EVENT_HOMEASSISTANT_START, _async_startup_internal
|
|
)
|
|
|
|
await self.get_my_previous_state()
|
|
|
|
async def get_my_previous_state(self):
|
|
"""Try to get my previou state"""
|
|
# Check If we have an old state
|
|
old_state = await self.async_get_last_state()
|
|
_LOGGER.debug(
|
|
"%s - Calling get_my_previous_state old_state is %s", self, old_state
|
|
)
|
|
if old_state is not None:
|
|
# If we have no initial temperature, restore
|
|
if self._target_temp is None:
|
|
# If we have a previously saved temperature
|
|
if old_state.attributes.get(ATTR_TEMPERATURE) is None:
|
|
if self._ac_mode:
|
|
self._target_temp = self.max_temp
|
|
else:
|
|
self._target_temp = self.min_temp
|
|
_LOGGER.warning(
|
|
"%s - Undefined target temperature, falling back to %s",
|
|
self,
|
|
self._target_temp,
|
|
)
|
|
else:
|
|
self._target_temp = float(old_state.attributes[ATTR_TEMPERATURE])
|
|
|
|
if old_state.attributes.get(ATTR_PRESET_MODE) in self._attr_preset_modes:
|
|
self._attr_preset_mode = old_state.attributes.get(ATTR_PRESET_MODE)
|
|
|
|
if not self._hvac_mode and old_state.state:
|
|
self._hvac_mode = old_state.state
|
|
|
|
else:
|
|
# No previous state, try and restore defaults
|
|
if self._target_temp is None:
|
|
if self._ac_mode:
|
|
self._target_temp = self.max_temp
|
|
else:
|
|
self._target_temp = self.min_temp
|
|
_LOGGER.warning(
|
|
"No previously saved temperature, setting to %s", self._target_temp
|
|
)
|
|
|
|
self._saved_target_temp = self._target_temp
|
|
|
|
# Set default state to off
|
|
if not self._hvac_mode:
|
|
self._hvac_mode = HVAC_MODE_OFF
|
|
|
|
_LOGGER.info(
|
|
"%s - restored state is target_temp=%.1f, preset_mode=%s, hvac_mode=%s",
|
|
self,
|
|
self._target_temp,
|
|
self._attr_preset_mode,
|
|
self._hvac_mode,
|
|
)
|
|
|
|
@callback
|
|
async def _async_temperature_changed(self, event):
|
|
"""Handle temperature changes."""
|
|
new_state = event.data.get("new_state")
|
|
_LOGGER.info(
|
|
"%s - Temperature changed. Event.new_state is %s",
|
|
self,
|
|
new_state,
|
|
)
|
|
if new_state is None or new_state.state in (STATE_UNAVAILABLE, STATE_UNKNOWN):
|
|
return
|
|
|
|
self._async_update_temp(new_state)
|
|
self._prop_algorithm.calculate(self._target_temp, self._cur_temp)
|
|
self.async_write_ha_state()
|
|
|
|
@callback
|
|
async def _async_windows_changed(self, event):
|
|
"""Handle window changes."""
|
|
new_state = event.data.get("new_state")
|
|
old_state = event.data.get("old_state")
|
|
_LOGGER.info(
|
|
"%s - Window changed. Event.new_state is %s, _hvac_mode=%s, _saved_hvac_mode=%s",
|
|
self,
|
|
new_state,
|
|
self._hvac_mode,
|
|
self._saved_hvac_mode,
|
|
)
|
|
if new_state is None or old_state is None or new_state.state == old_state.state:
|
|
return
|
|
|
|
# Check delay condition
|
|
async def try_window_condition(_):
|
|
try:
|
|
long_enough = condition.state(
|
|
self.hass,
|
|
self._window_sensor_entity_id,
|
|
new_state.state,
|
|
timedelta(seconds=self._window_delay_sec),
|
|
)
|
|
except ConditionError:
|
|
long_enough = False
|
|
|
|
if not long_enough:
|
|
_LOGGER.debug(
|
|
"Window delay condition is not satisfied. Ignore window event"
|
|
)
|
|
return
|
|
|
|
_LOGGER.debug("%s - Window delay condition is satisfied", self)
|
|
if not self._saved_hvac_mode:
|
|
self._saved_hvac_mode = self._hvac_mode
|
|
|
|
if new_state.state == STATE_OFF:
|
|
_LOGGER.info(
|
|
"%s - Window is closed. Restoring hvac_mode '%s'",
|
|
self,
|
|
self._saved_hvac_mode,
|
|
)
|
|
await self.async_set_hvac_mode(self._saved_hvac_mode)
|
|
elif new_state.state == STATE_ON:
|
|
_LOGGER.info(
|
|
"%s - Window is open. Set hvac_mode to '%s'", self, HVAC_MODE_OFF
|
|
)
|
|
self._saved_hvac_mode = self._hvac_mode
|
|
await self.async_set_hvac_mode(HVAC_MODE_OFF)
|
|
|
|
if self._window_call_cancel:
|
|
self._window_call_cancel()
|
|
self._window_call_cancel = None
|
|
self._window_call_cancel = async_call_later(
|
|
self.hass, timedelta(seconds=self._window_delay_sec), try_window_condition
|
|
)
|
|
|
|
@callback
|
|
async def _async_motion_changed(self, event):
|
|
"""Handle motion changes."""
|
|
new_state = event.data.get("new_state")
|
|
_LOGGER.info(
|
|
"%s - Motion changed. Event.new_state is %s, _attr_preset_mode=%s, activity=%s",
|
|
self,
|
|
new_state,
|
|
self._attr_preset_mode,
|
|
PRESET_ACTIVITY,
|
|
)
|
|
if self._attr_preset_mode != PRESET_ACTIVITY:
|
|
return
|
|
if new_state is None or new_state.state not in (STATE_OFF, STATE_ON):
|
|
return
|
|
|
|
# Check delay condition
|
|
async def try_motion_condition(_):
|
|
try:
|
|
long_enough = condition.state(
|
|
self.hass,
|
|
self._motion_sensor_entity_id,
|
|
new_state.state,
|
|
timedelta(seconds=self._motion_delay_sec),
|
|
)
|
|
except ConditionError:
|
|
long_enough = False
|
|
|
|
if not long_enough:
|
|
_LOGGER.debug(
|
|
"Motion delay condition is not satisfied. Ignore motion event"
|
|
)
|
|
return
|
|
|
|
_LOGGER.debug("%s - Motion delay condition is satisfied", self)
|
|
new_preset = (
|
|
self._motion_preset
|
|
if new_state.state == STATE_ON
|
|
else self._no_motion_preset
|
|
)
|
|
_LOGGER.info(
|
|
"%s - Motion condition have changes. New preset temp will be %s",
|
|
self,
|
|
new_preset,
|
|
)
|
|
self._target_temp = self._presets[new_preset]
|
|
self._prop_algorithm.calculate(self._target_temp, self._cur_temp)
|
|
self.async_write_ha_state()
|
|
|
|
if self._motion_call_cancel:
|
|
self._motion_call_cancel()
|
|
self._motion_call_cancel = None
|
|
self._motion_call_cancel = async_call_later(
|
|
self.hass, timedelta(seconds=self._motion_delay_sec), try_motion_condition
|
|
)
|
|
|
|
@callback
|
|
async def _check_switch_initial_state(self):
|
|
"""Prevent the device from keep running if HVAC_MODE_OFF."""
|
|
_LOGGER.debug("%s - Calling _check_switch_initial_state", self)
|
|
if self._hvac_mode == HVAC_MODE_OFF and self._is_device_active:
|
|
_LOGGER.warning(
|
|
"The climate mode is OFF, but the switch device is ON. Turning off device %s",
|
|
self._heater_entity_id,
|
|
)
|
|
await self._async_heater_turn_off()
|
|
|
|
@callback
|
|
def _async_switch_changed(self, event):
|
|
"""Handle heater switch state changes."""
|
|
new_state = event.data.get("new_state")
|
|
old_state = event.data.get("old_state")
|
|
if new_state is None:
|
|
return
|
|
if old_state is None:
|
|
self.hass.create_task(self._check_switch_initial_state())
|
|
self.async_write_ha_state()
|
|
|
|
@callback
|
|
def _async_update_temp(self, state):
|
|
"""Update thermostat with latest state from sensor."""
|
|
try:
|
|
cur_temp = float(state.state)
|
|
if math.isnan(cur_temp) or math.isinf(cur_temp):
|
|
raise ValueError(f"Sensor has illegal state {state.state}")
|
|
self._cur_temp = cur_temp
|
|
except ValueError as ex:
|
|
_LOGGER.error("Unable to update temperature from sensor: %s", ex)
|
|
|
|
@callback
|
|
async def _async_power_changed(self, event):
|
|
"""Handle power changes."""
|
|
_LOGGER.debug("Thermostat %s - Receive new Power event", self.name)
|
|
_LOGGER.debug(event)
|
|
new_state = event.data.get("new_state")
|
|
old_state = event.data.get("old_state")
|
|
if new_state is None or (
|
|
old_state is not None and new_state.state == old_state.state
|
|
):
|
|
return
|
|
|
|
try:
|
|
current_power = float(new_state.state)
|
|
if math.isnan(current_power) or math.isinf(current_power):
|
|
raise ValueError(f"Sensor has illegal state {new_state.state}")
|
|
self._current_power = current_power
|
|
|
|
except ValueError as ex:
|
|
_LOGGER.error("Unable to update current_power from sensor: %s", ex)
|
|
|
|
@callback
|
|
async def _async_max_power_changed(self, event):
|
|
"""Handle power max changes."""
|
|
_LOGGER.debug("Thermostat %s - Receive new Power Max event", self.name)
|
|
_LOGGER.debug(event)
|
|
new_state = event.data.get("new_state")
|
|
old_state = event.data.get("old_state")
|
|
if new_state is None or new_state.state == old_state.state:
|
|
return
|
|
|
|
try:
|
|
current_power_max = float(new_state.state)
|
|
if math.isnan(current_power_max) or math.isinf(current_power_max):
|
|
raise ValueError(f"Sensor has illegal state {new_state.state}")
|
|
self._current_power_max = current_power_max
|
|
|
|
except ValueError as ex:
|
|
_LOGGER.error("Unable to update current_power from sensor: %s", ex)
|
|
|
|
async def _async_heater_turn_on(self):
|
|
"""Turn heater toggleable device on."""
|
|
data = {ATTR_ENTITY_ID: self._heater_entity_id}
|
|
await self.hass.services.async_call(
|
|
HA_DOMAIN, SERVICE_TURN_ON, data, context=self._context
|
|
)
|
|
|
|
async def _async_heater_turn_off(self):
|
|
"""Turn heater toggleable device off."""
|
|
data = {ATTR_ENTITY_ID: self._heater_entity_id}
|
|
await self.hass.services.async_call(
|
|
HA_DOMAIN, SERVICE_TURN_OFF, data, context=self._context
|
|
)
|
|
|
|
async def check_overpowering(self) -> bool:
|
|
"""Check the overpowering condition
|
|
Turn the preset_mode of the heater to 'power' if power conditions are exceeded
|
|
"""
|
|
_LOGGER.debug(
|
|
"%s - overpowering check: power=%.3f, max_power=%.3f heater power=%.3f",
|
|
self,
|
|
self._current_power,
|
|
self._current_power_max,
|
|
self._device_power,
|
|
)
|
|
overpowering: bool = (
|
|
self._current_power + self._device_power >= self._current_power_max
|
|
)
|
|
if overpowering:
|
|
_LOGGER.warning(
|
|
"%s - overpowering is detected. Heater preset will be set to 'power'",
|
|
self,
|
|
)
|
|
await self._async_set_preset_mode_internal(PRESET_POWER)
|
|
return overpowering
|
|
|
|
# Check if we need to remove the POWER preset
|
|
if self._attr_preset_mode == PRESET_POWER and not overpowering:
|
|
_LOGGER.warning(
|
|
"%s - end of overpowering is detected. Heater preset will be restored to '%s'",
|
|
self,
|
|
self._saved_preset_mode,
|
|
)
|
|
await self.async_set_preset_mode(
|
|
self._saved_preset_mode if self._saved_preset_mode else PRESET_NONE
|
|
)
|
|
|
|
async def _async_control_heating(self, time=None):
|
|
"""The main function used to run the calculation at each cycle"""
|
|
|
|
overpowering: bool = await self.check_overpowering()
|
|
if overpowering:
|
|
_LOGGER.debug(
|
|
"%s - The max power is exceeded. Heater will not be started. preset_mode is now '%s'",
|
|
self,
|
|
self._attr_preset_mode,
|
|
)
|
|
return
|
|
|
|
on_time_sec: int = self._prop_algorithm.on_time_sec
|
|
off_time_sec: int = self._prop_algorithm.off_time_sec
|
|
_LOGGER.info(
|
|
"%s - Running new cycle at %s. on_time_sec=%.0f, off_time_sec=%.0f",
|
|
self,
|
|
time,
|
|
on_time_sec,
|
|
off_time_sec,
|
|
)
|
|
|
|
# Cancel eventual previous cycle if any
|
|
if self._async_cancel_cycle is not None:
|
|
_LOGGER.debug("Cancelling the previous cycle that was running")
|
|
self._async_cancel_cycle()
|
|
self._async_cancel_cycle = None
|
|
await self._async_heater_turn_off()
|
|
|
|
if self._hvac_mode == HVAC_MODE_HEAT and on_time_sec > 0:
|
|
_LOGGER.info(
|
|
"%s - start heating for %d min %d sec ",
|
|
self,
|
|
on_time_sec // 60,
|
|
on_time_sec % 60,
|
|
)
|
|
|
|
await self._async_heater_turn_on()
|
|
|
|
async def _turn_off(_):
|
|
_LOGGER.info(
|
|
"%s - stop heating for %d min %d sec",
|
|
self,
|
|
off_time_sec // 60,
|
|
off_time_sec % 60,
|
|
)
|
|
await self._async_heater_turn_off()
|
|
self._async_cancel_cycle = None
|
|
|
|
# Program turn off
|
|
self._async_cancel_cycle = async_call_later(
|
|
self.hass,
|
|
on_time_sec,
|
|
_turn_off,
|
|
)
|
|
|
|
@callback
|
|
def async_registry_entry_updated(self):
|
|
"""update the entity if the config entry have been updated
|
|
Note: this don't work either
|
|
"""
|
|
_LOGGER.info("%s - The config entry have been updated.")
|