Home Assistant Unofficial Reference 2024.12.1
climate.py
Go to the documentation of this file.
1 """Support for Homekit climate devices."""
2 
3 from __future__ import annotations
4 
5 import logging
6 from typing import Any, Final
7 
8 from aiohomekit.model.characteristics import (
9  ActivationStateValues,
10  CharacteristicsTypes,
11  CurrentFanStateValues,
12  CurrentHeaterCoolerStateValues,
13  HeatingCoolingCurrentValues,
14  HeatingCoolingTargetValues,
15  SwingModeValues,
16  TargetHeaterCoolerStateValues,
17 )
18 from aiohomekit.model.services import Service, ServicesTypes
19 from aiohomekit.utils import clamp_enum_to_char
20 from propcache import cached_property
21 
23  ATTR_HVAC_MODE,
24  ATTR_TARGET_TEMP_HIGH,
25  ATTR_TARGET_TEMP_LOW,
26  DEFAULT_MAX_TEMP,
27  DEFAULT_MIN_TEMP,
28  FAN_AUTO,
29  FAN_HIGH,
30  FAN_LOW,
31  FAN_MEDIUM,
32  FAN_OFF,
33  FAN_ON,
34  SWING_OFF,
35  SWING_VERTICAL,
36  ClimateEntity,
37  ClimateEntityFeature,
38  HVACAction,
39  HVACMode,
40 )
41 from homeassistant.config_entries import ConfigEntry
42 from homeassistant.const import ATTR_TEMPERATURE, Platform, UnitOfTemperature
43 from homeassistant.core import HomeAssistant, callback
44 from homeassistant.helpers.entity_platform import AddEntitiesCallback
46  percentage_to_ranged_value,
47  ranged_value_to_percentage,
48 )
49 
50 from . import KNOWN_DEVICES
51 from .connection import HKDevice
52 from .entity import HomeKitEntity
53 
54 _LOGGER = logging.getLogger(__name__)
55 
56 # Map of Homekit operation modes to hass modes
57 MODE_HOMEKIT_TO_HASS = {
58  HeatingCoolingTargetValues.OFF: HVACMode.OFF,
59  HeatingCoolingTargetValues.HEAT: HVACMode.HEAT,
60  HeatingCoolingTargetValues.COOL: HVACMode.COOL,
61  HeatingCoolingTargetValues.AUTO: HVACMode.HEAT_COOL,
62 }
63 
64 CURRENT_MODE_HOMEKIT_TO_HASS = {
65  HeatingCoolingCurrentValues.IDLE: HVACAction.IDLE,
66  HeatingCoolingCurrentValues.HEATING: HVACAction.HEATING,
67  HeatingCoolingCurrentValues.COOLING: HVACAction.COOLING,
68 }
69 
70 SWING_MODE_HOMEKIT_TO_HASS = {
71  SwingModeValues.DISABLED: SWING_OFF,
72  SwingModeValues.ENABLED: SWING_VERTICAL,
73 }
74 
75 CURRENT_HEATER_COOLER_STATE_HOMEKIT_TO_HASS = {
76  CurrentHeaterCoolerStateValues.INACTIVE: HVACAction.OFF,
77  CurrentHeaterCoolerStateValues.IDLE: HVACAction.IDLE,
78  CurrentHeaterCoolerStateValues.HEATING: HVACAction.HEATING,
79  CurrentHeaterCoolerStateValues.COOLING: HVACAction.COOLING,
80 }
81 
82 TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS = {
83  TargetHeaterCoolerStateValues.AUTOMATIC: HVACMode.HEAT_COOL,
84  TargetHeaterCoolerStateValues.HEAT: HVACMode.HEAT,
85  TargetHeaterCoolerStateValues.COOL: HVACMode.COOL,
86 }
87 
88 
89 # Map of hass operation modes to homekit modes
90 MODE_HASS_TO_HOMEKIT = {v: k for k, v in MODE_HOMEKIT_TO_HASS.items()}
91 
92 TARGET_HEATER_COOLER_STATE_HASS_TO_HOMEKIT = {
93  v: k for k, v in TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS.items()
94 }
95 
96 SWING_MODE_HASS_TO_HOMEKIT = {v: k for k, v in SWING_MODE_HOMEKIT_TO_HASS.items()}
97 
98 DEFAULT_MIN_STEP: Final = 1.0
99 
100 ROTATION_SPEED_LOW = 33
101 ROTATION_SPEED_MEDIUM = 66
102 ROTATION_SPEED_HIGH = 100
103 
104 HASS_FAN_MODE_TO_HOMEKIT_ROTATION = {
105  FAN_LOW: ROTATION_SPEED_LOW,
106  FAN_MEDIUM: ROTATION_SPEED_MEDIUM,
107  FAN_HIGH: ROTATION_SPEED_HIGH,
108 }
109 
110 
112  hass: HomeAssistant,
113  config_entry: ConfigEntry,
114  async_add_entities: AddEntitiesCallback,
115 ) -> None:
116  """Set up Homekit climate."""
117  hkid: str = config_entry.data["AccessoryPairingID"]
118  conn: HKDevice = hass.data[KNOWN_DEVICES][hkid]
119 
120  @callback
121  def async_add_service(service: Service) -> bool:
122  if not (entity_class := ENTITY_TYPES.get(service.type)):
123  return False
124  info = {"aid": service.accessory.aid, "iid": service.iid}
125  entity: HomeKitEntity = entity_class(conn, info)
126  conn.async_migrate_unique_id(
127  entity.old_unique_id, entity.unique_id, Platform.CLIMATE
128  )
129  async_add_entities([entity])
130  return True
131 
132  conn.add_listener(async_add_service)
133 
134 
136  """The base HomeKit Controller climate entity."""
137 
138  _attr_temperature_unit = UnitOfTemperature.CELSIUS
139  _enable_turn_on_off_backwards_compatibility = False
140 
141  @callback
142  def _async_reconfigure(self) -> None:
143  """Reconfigure entity."""
144  self._async_clear_property_cache_async_clear_property_cache(("supported_features", "fan_modes"))
145  super()._async_reconfigure()
146 
147  def get_characteristic_types(self) -> list[str]:
148  """Define the homekit characteristics the entity cares about."""
149  return [
150  CharacteristicsTypes.TEMPERATURE_CURRENT,
151  CharacteristicsTypes.FAN_STATE_TARGET,
152  ]
153 
154  @property
155  def current_temperature(self) -> float | None:
156  """Return the current temperature."""
157  return self.serviceservice.value(CharacteristicsTypes.TEMPERATURE_CURRENT)
158 
159  @cached_property
160  def fan_modes(self) -> list[str] | None:
161  """Return the available fan modes."""
162  if self.serviceservice.has(CharacteristicsTypes.FAN_STATE_TARGET):
163  return [FAN_ON, FAN_AUTO]
164  return None
165 
166  @property
167  def fan_mode(self) -> str | None:
168  """Return the current fan mode."""
169  fan_mode = self.serviceservice.value(CharacteristicsTypes.FAN_STATE_TARGET)
170  return FAN_AUTO if fan_mode else FAN_ON
171 
172  async def async_set_fan_mode(self, fan_mode: str) -> None:
173  """Turn fan to manual/auto."""
174  await self.async_put_characteristicsasync_put_characteristics(
175  {CharacteristicsTypes.FAN_STATE_TARGET: int(fan_mode == FAN_AUTO)}
176  )
177 
178  @cached_property
179  def supported_features(self) -> ClimateEntityFeature:
180  """Return the list of supported features."""
181  features = ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON
182 
183  if self.serviceservice.has(CharacteristicsTypes.FAN_STATE_TARGET):
184  features |= ClimateEntityFeature.FAN_MODE
185 
186  return features
187 
188 
190  """Representation of a Homekit climate device."""
191 
192  @callback
193  def _async_reconfigure(self) -> None:
194  """Reconfigure entity."""
195  self._async_clear_property_cache_async_clear_property_cache(("hvac_modes", "swing_modes"))
196  super()._async_reconfigure()
197 
198  def get_characteristic_types(self) -> list[str]:
199  """Define the homekit characteristics the entity cares about."""
200  return [
201  *super().get_characteristic_types(),
202  CharacteristicsTypes.ACTIVE,
203  CharacteristicsTypes.CURRENT_HEATER_COOLER_STATE,
204  CharacteristicsTypes.TARGET_HEATER_COOLER_STATE,
205  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD,
206  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD,
207  CharacteristicsTypes.SWING_MODE,
208  CharacteristicsTypes.ROTATION_SPEED,
209  ]
210 
211  def _get_rotation_speed_range(self) -> tuple[float, float]:
212  rotation_speed = self.serviceservice[CharacteristicsTypes.ROTATION_SPEED]
213  return round(rotation_speed.minValue or 0) + 1, round(
214  rotation_speed.maxValue or 100
215  )
216 
217  @cached_property
218  def fan_modes(self) -> list[str]:
219  """Return the available fan modes."""
220  return [FAN_OFF, FAN_LOW, FAN_MEDIUM, FAN_HIGH]
221 
222  @property
223  def fan_mode(self) -> str | None:
224  """Return the current fan mode."""
225  speed_range = self._get_rotation_speed_range_get_rotation_speed_range()
226  speed_percentage = ranged_value_to_percentage(
227  speed_range, self.serviceservice.value(CharacteristicsTypes.ROTATION_SPEED)
228  )
229  # homekit value 0 33 66 100
230  if speed_percentage > ROTATION_SPEED_MEDIUM:
231  return FAN_HIGH
232  if speed_percentage > ROTATION_SPEED_LOW:
233  return FAN_MEDIUM
234  if speed_percentage > 0:
235  return FAN_LOW
236  return FAN_OFF
237 
238  async def async_set_fan_mode(self, fan_mode: str) -> None:
239  """Set new target fan mode."""
240  rotation = HASS_FAN_MODE_TO_HOMEKIT_ROTATION.get(fan_mode, 0)
241  speed_range = self._get_rotation_speed_range_get_rotation_speed_range()
242  speed = round(percentage_to_ranged_value(speed_range, rotation))
243  await self.async_put_characteristicsasync_put_characteristics(
244  {CharacteristicsTypes.ROTATION_SPEED: speed}
245  )
246 
247  async def async_set_temperature(self, **kwargs: Any) -> None:
248  """Set new target temperature."""
249  temp = kwargs.get(ATTR_TEMPERATURE)
250  state = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
251  if state == TargetHeaterCoolerStateValues.COOL:
252  await self.async_put_characteristicsasync_put_characteristics(
253  {CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD: temp}
254  )
255  elif state == TargetHeaterCoolerStateValues.HEAT:
256  await self.async_put_characteristicsasync_put_characteristics(
257  {CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD: temp}
258  )
259  else:
260  hvac_mode = TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS.get(state)
261  _LOGGER.warning(
262  (
263  "HomeKit device %s: Setting temperature in %s mode is not supported"
264  " yet; Consider raising a ticket if you have this device and want"
265  " to help us implement this feature"
266  ),
267  self.entity_identity_id,
268  hvac_mode,
269  )
270 
271  async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
272  """Set new target operation mode."""
273  if hvac_mode == HVACMode.OFF:
274  await self.async_put_characteristicsasync_put_characteristics(
275  {CharacteristicsTypes.ACTIVE: ActivationStateValues.INACTIVE}
276  )
277  return
278  if hvac_mode not in {HVACMode.HEAT, HVACMode.COOL}:
279  _LOGGER.warning(
280  (
281  "HomeKit device %s: Setting temperature in %s mode is not supported"
282  " yet; Consider raising a ticket if you have this device and want"
283  " to help us implement this feature"
284  ),
285  self.entity_identity_id,
286  hvac_mode,
287  )
288  await self.async_put_characteristicsasync_put_characteristics(
289  {
290  CharacteristicsTypes.ACTIVE: ActivationStateValues.ACTIVE,
291  CharacteristicsTypes.TARGET_HEATER_COOLER_STATE: TARGET_HEATER_COOLER_STATE_HASS_TO_HOMEKIT[
292  hvac_mode
293  ],
294  }
295  )
296 
297  @property
298  def target_temperature(self) -> float | None:
299  """Return the temperature we try to reach."""
300  state = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
301  if state == TargetHeaterCoolerStateValues.COOL:
302  return self.serviceservice.value(
303  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
304  )
305  if state == TargetHeaterCoolerStateValues.HEAT:
306  return self.serviceservice.value(
307  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
308  )
309  return None
310 
311  @property
312  def target_temperature_step(self) -> float:
313  """Return the supported step of target temperature."""
314  state = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
315  if state == TargetHeaterCoolerStateValues.COOL and self.serviceservice.has(
316  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
317  ):
318  return (
319  self.serviceservice[CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD].minStep
320  or DEFAULT_MIN_STEP
321  )
322  if state == TargetHeaterCoolerStateValues.HEAT and self.serviceservice.has(
323  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
324  ):
325  return (
326  self.serviceservice[CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD].minStep
327  or DEFAULT_MIN_STEP
328  )
329  return DEFAULT_MIN_STEP
330 
331  @property
332  def min_temp(self) -> float:
333  """Return the minimum target temp."""
334  state = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
335  if state == TargetHeaterCoolerStateValues.COOL and self.serviceservice.has(
336  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
337  ):
338  return (
339  self.serviceservice[
340  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
341  ].minValue
342  or DEFAULT_MIN_TEMP
343  )
344  if state == TargetHeaterCoolerStateValues.HEAT and self.serviceservice.has(
345  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
346  ):
347  return (
348  self.serviceservice[
349  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
350  ].minValue
351  or DEFAULT_MIN_TEMP
352  )
353  return super().min_temp
354 
355  @property
356  def max_temp(self) -> float:
357  """Return the maximum target temp."""
358  state = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
359  if state == TargetHeaterCoolerStateValues.COOL and self.serviceservice.has(
360  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
361  ):
362  return (
363  self.serviceservice[
364  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
365  ].maxValue
366  or DEFAULT_MAX_TEMP
367  )
368  if state == TargetHeaterCoolerStateValues.HEAT and self.serviceservice.has(
369  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
370  ):
371  return (
372  self.serviceservice[
373  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
374  ].maxValue
375  or DEFAULT_MAX_TEMP
376  )
377  return super().max_temp
378 
379  @property
380  def hvac_action(self) -> HVACAction | None:
381  """Return the current running hvac operation."""
382  # This characteristic describes the current mode of a device,
383  # e.g. a thermostat is "heating" a room to 75 degrees Fahrenheit.
384  # Can be 0 - 3 (Off, Idle, Heat, Cool)
385  if (
386  self.serviceservice.value(CharacteristicsTypes.ACTIVE)
387  == ActivationStateValues.INACTIVE
388  ):
389  return HVACAction.OFF
390  value = self.serviceservice.value(CharacteristicsTypes.CURRENT_HEATER_COOLER_STATE)
391  return CURRENT_HEATER_COOLER_STATE_HOMEKIT_TO_HASS.get(value)
392 
393  @property
394  def hvac_mode(self) -> HVACMode:
395  """Return hvac operation ie. heat, cool mode."""
396  # This characteristic describes the target mode
397  # E.g. should the device start heating a room if the temperature
398  # falls below the target temperature.
399  # Can be 0 - 2 (Auto, Heat, Cool)
400  if (
401  self.serviceservice.value(CharacteristicsTypes.ACTIVE)
402  == ActivationStateValues.INACTIVE
403  ):
404  return HVACMode.OFF
405  value = self.serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
406  return TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS[value]
407 
408  @cached_property
409  def hvac_modes(self) -> list[HVACMode]:
410  """Return the list of available hvac operation modes."""
411  valid_values = clamp_enum_to_char(
412  TargetHeaterCoolerStateValues,
413  self.serviceservice[CharacteristicsTypes.TARGET_HEATER_COOLER_STATE],
414  )
415  modes = [
416  TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS[mode] for mode in valid_values
417  ]
418  modes.append(HVACMode.OFF)
419  return modes
420 
421  @property
422  def swing_mode(self) -> str:
423  """Return the swing setting.
424 
425  Requires ClimateEntityFeature.SWING_MODE.
426  """
427  value = self.serviceservice.value(CharacteristicsTypes.SWING_MODE)
428  return SWING_MODE_HOMEKIT_TO_HASS[value]
429 
430  @cached_property
431  def swing_modes(self) -> list[str]:
432  """Return the list of available swing modes.
433 
434  Requires ClimateEntityFeature.SWING_MODE.
435  """
436  valid_values = clamp_enum_to_char(
437  SwingModeValues,
438  self.serviceservice[CharacteristicsTypes.SWING_MODE],
439  )
440  return [SWING_MODE_HOMEKIT_TO_HASS[mode] for mode in valid_values]
441 
442  async def async_set_swing_mode(self, swing_mode: str) -> None:
443  """Set new target swing operation."""
444  await self.async_put_characteristicsasync_put_characteristics(
445  {CharacteristicsTypes.SWING_MODE: SWING_MODE_HASS_TO_HOMEKIT[swing_mode]}
446  )
447 
448  @cached_property
449  def supported_features(self) -> ClimateEntityFeature:
450  """Return the list of supported features."""
451  features = super().supported_features
452 
453  if self.serviceservice.has(CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD):
454  features |= ClimateEntityFeature.TARGET_TEMPERATURE
455 
456  if self.serviceservice.has(CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD):
457  features |= ClimateEntityFeature.TARGET_TEMPERATURE
458 
459  if self.serviceservice.has(CharacteristicsTypes.SWING_MODE):
460  features |= ClimateEntityFeature.SWING_MODE
461 
462  if self.serviceservice.has(CharacteristicsTypes.ROTATION_SPEED):
463  features |= ClimateEntityFeature.FAN_MODE
464 
465  return features
466 
467 
469  """Representation of a Homekit climate device."""
470 
471  @callback
472  def _async_reconfigure(self) -> None:
473  """Reconfigure entity."""
474  self._async_clear_property_cache_async_clear_property_cache(("hvac_modes",))
475  super()._async_reconfigure()
476 
477  def get_characteristic_types(self) -> list[str]:
478  """Define the homekit characteristics the entity cares about."""
479  return [
480  *super().get_characteristic_types(),
481  CharacteristicsTypes.HEATING_COOLING_CURRENT,
482  CharacteristicsTypes.HEATING_COOLING_TARGET,
483  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD,
484  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD,
485  CharacteristicsTypes.TEMPERATURE_TARGET,
486  CharacteristicsTypes.RELATIVE_HUMIDITY_CURRENT,
487  CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET,
488  CharacteristicsTypes.FAN_STATE_CURRENT,
489  ]
490 
491  async def async_set_temperature(self, **kwargs: Any) -> None:
492  """Set new target temperature."""
493  chars: dict[str, Any] = {}
494 
495  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
496  mode = MODE_HOMEKIT_TO_HASS[value]
497 
498  if kwargs.get(ATTR_HVAC_MODE, mode) != mode:
499  mode = kwargs[ATTR_HVAC_MODE]
500  chars[CharacteristicsTypes.HEATING_COOLING_TARGET] = MODE_HASS_TO_HOMEKIT[
501  mode
502  ]
503 
504  temp = kwargs.get(ATTR_TEMPERATURE)
505  heat_temp = kwargs.get(ATTR_TARGET_TEMP_LOW)
506  cool_temp = kwargs.get(ATTR_TARGET_TEMP_HIGH)
507 
508  if (
509  (mode == HVACMode.HEAT_COOL)
510  and (
511  ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self.supported_featuressupported_featuressupported_featuressupported_featuressupported_features
512  )
513  and heat_temp
514  and cool_temp
515  ):
516  if temp is None:
517  temp = (cool_temp + heat_temp) / 2
518  chars.update(
519  {
520  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD: heat_temp,
521  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD: cool_temp,
522  CharacteristicsTypes.TEMPERATURE_TARGET: temp,
523  }
524  )
525  else:
526  chars[CharacteristicsTypes.TEMPERATURE_TARGET] = temp
527 
528  await self.async_put_characteristicsasync_put_characteristics(chars)
529 
530  async def async_set_humidity(self, humidity: int) -> None:
531  """Set new target humidity."""
532  await self.async_put_characteristicsasync_put_characteristics(
533  {CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET: humidity}
534  )
535 
536  async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
537  """Set new target operation mode."""
538  await self.async_put_characteristicsasync_put_characteristics(
539  {
540  CharacteristicsTypes.HEATING_COOLING_TARGET: MODE_HASS_TO_HOMEKIT[
541  hvac_mode
542  ],
543  }
544  )
545 
546  @property
547  def target_temperature(self) -> float | None:
548  """Return the temperature we try to reach."""
549  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
550  if (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT, HVACMode.COOL}) or (
551  (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT_COOL})
552  and ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
554  ):
555  return self.serviceservice.value(CharacteristicsTypes.TEMPERATURE_TARGET)
556  return None
557 
558  @property
559  def target_temperature_high(self) -> float | None:
560  """Return the highbound target temperature we try to reach."""
561  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
562  if (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT_COOL}) and (
563  ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self.supported_featuressupported_featuressupported_featuressupported_featuressupported_features
564  ):
565  return self.serviceservice.value(
566  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
567  )
568  return None
569 
570  @property
571  def target_temperature_low(self) -> float | None:
572  """Return the lowbound target temperature we try to reach."""
573  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
574  if (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT_COOL}) and (
575  ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self.supported_featuressupported_featuressupported_featuressupported_featuressupported_features
576  ):
577  return self.serviceservice.value(
578  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
579  )
580  return None
581 
582  @property
583  def min_temp(self) -> float:
584  """Return the minimum target temp."""
585  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
586  if (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT_COOL}) and (
587  ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self.supported_featuressupported_featuressupported_featuressupported_featuressupported_features
588  ):
589  min_temp = self.serviceservice[
590  CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
591  ].minValue
592  if min_temp is not None:
593  return min_temp
594  elif MODE_HOMEKIT_TO_HASS.get(value) in {
595  HVACMode.HEAT,
596  HVACMode.COOL,
597  HVACMode.HEAT_COOL,
598  }:
599  min_temp = self.serviceservice[CharacteristicsTypes.TEMPERATURE_TARGET].minValue
600  if min_temp is not None:
601  return min_temp
602  return super().min_temp
603 
604  @property
605  def max_temp(self) -> float:
606  """Return the maximum target temp."""
607  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
608  if (MODE_HOMEKIT_TO_HASS.get(value) in {HVACMode.HEAT_COOL}) and (
609  ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self.supported_featuressupported_featuressupported_featuressupported_featuressupported_features
610  ):
611  max_temp = self.serviceservice[
612  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
613  ].maxValue
614  if max_temp is not None:
615  return max_temp
616  elif MODE_HOMEKIT_TO_HASS.get(value) in {
617  HVACMode.HEAT,
618  HVACMode.COOL,
619  HVACMode.HEAT_COOL,
620  }:
621  max_temp = self.serviceservice[CharacteristicsTypes.TEMPERATURE_TARGET].maxValue
622  if max_temp is not None:
623  return max_temp
624  return super().max_temp
625 
626  @property
627  def current_humidity(self) -> int:
628  """Return the current humidity."""
629  return self.serviceservice.value(CharacteristicsTypes.RELATIVE_HUMIDITY_CURRENT)
630 
631  @property
632  def target_humidity(self) -> int:
633  """Return the humidity we try to reach."""
634  return self.serviceservice.value(CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET)
635 
636  @property
637  def min_humidity(self) -> float:
638  """Return the minimum humidity."""
639  min_humidity = self.serviceservice[
640  CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET
641  ].minValue
642  if min_humidity is not None:
643  return int(min_humidity)
644  return super().min_humidity
645 
646  @property
647  def max_humidity(self) -> float:
648  """Return the maximum humidity."""
649  max_humidity = self.serviceservice[
650  CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET
651  ].maxValue
652  if max_humidity is not None:
653  return int(max_humidity)
654  return super().max_humidity
655 
656  @property
657  def hvac_action(self) -> HVACAction | None:
658  """Return the current running hvac operation."""
659  # This characteristic describes the current mode of a device,
660  # e.g. a thermostat is "heating" a room to 75 degrees Fahrenheit.
661  # Can be 0 - 2 (Off, Heat, Cool)
662 
663  # If the HVAC is switched off, it must be idle
664  # This works around a bug in some devices (like Eve radiator valves) that
665  # return they are heating when they are not.
666  target = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
667  if target == HeatingCoolingTargetValues.OFF:
668  return HVACAction.IDLE
669 
670  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_CURRENT)
671  current_hass_value = CURRENT_MODE_HOMEKIT_TO_HASS.get(value)
672 
673  # If a device has a fan state (such as an Ecobee thermostat)
674  # show the Fan state when the device is otherwise idle.
675  if (
676  current_hass_value == HVACAction.IDLE
677  and self.serviceservice.has(CharacteristicsTypes.FAN_STATE_CURRENT)
678  and self.serviceservice.value(CharacteristicsTypes.FAN_STATE_CURRENT)
679  == CurrentFanStateValues.ACTIVE
680  ):
681  return HVACAction.FAN
682 
683  return current_hass_value
684 
685  @property
686  def hvac_mode(self) -> HVACMode:
687  """Return hvac operation ie. heat, cool mode."""
688  # This characteristic describes the target mode
689  # E.g. should the device start heating a room if the temperature
690  # falls below the target temperature.
691  # Can be 0 - 3 (Off, Heat, Cool, Auto)
692  value = self.serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
693  return MODE_HOMEKIT_TO_HASS[value]
694 
695  @cached_property
696  def hvac_modes(self) -> list[HVACMode]:
697  """Return the list of available hvac operation modes."""
698  valid_values = clamp_enum_to_char(
699  HeatingCoolingTargetValues,
700  self.serviceservice[CharacteristicsTypes.HEATING_COOLING_TARGET],
701  )
702  return [MODE_HOMEKIT_TO_HASS[mode] for mode in valid_values]
703 
704  @cached_property
705  def supported_features(self) -> ClimateEntityFeature:
706  """Return the list of supported features."""
707  features = super().supported_features
708 
709  if self.serviceservice.has(CharacteristicsTypes.TEMPERATURE_TARGET):
710  features |= ClimateEntityFeature.TARGET_TEMPERATURE
711 
712  if self.serviceservice.has(
713  CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
714  ) and self.serviceservice.has(CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD):
715  features |= ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
716 
717  if self.serviceservice.has(CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET):
718  features |= ClimateEntityFeature.TARGET_HUMIDITY
719 
720  return features
721 
722 
723 ENTITY_TYPES = {
724  ServicesTypes.HEATER_COOLER: HomeKitHeaterCoolerEntity,
725  ServicesTypes.THERMOSTAT: HomeKitClimateEntity,
726 }
ClimateEntityFeature supported_features(self)
Definition: __init__.py:945
None async_put_characteristics(self, dict[str, Any] characteristics)
Definition: entity.py:125
None _async_clear_property_cache(self, tuple[str,...] properties)
Definition: entity.py:79
int|None supported_features(self)
Definition: entity.py:861
None async_setup_entry(HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
Definition: climate.py:115
float percentage_to_ranged_value(tuple[float, float] low_high_range, float percentage)
Definition: percentage.py:81
int ranged_value_to_percentage(tuple[float, float] low_high_range, float value)
Definition: percentage.py:64