1 """Support for Homekit climate devices."""
3 from __future__
import annotations
6 from typing
import Any, Final
8 from aiohomekit.model.characteristics
import (
11 CurrentFanStateValues,
12 CurrentHeaterCoolerStateValues,
13 HeatingCoolingCurrentValues,
14 HeatingCoolingTargetValues,
16 TargetHeaterCoolerStateValues,
18 from aiohomekit.model.services
import Service, ServicesTypes
19 from aiohomekit.utils
import clamp_enum_to_char
20 from propcache
import cached_property
24 ATTR_TARGET_TEMP_HIGH,
46 percentage_to_ranged_value,
47 ranged_value_to_percentage,
50 from .
import KNOWN_DEVICES
51 from .connection
import HKDevice
52 from .entity
import HomeKitEntity
54 _LOGGER = logging.getLogger(__name__)
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,
64 CURRENT_MODE_HOMEKIT_TO_HASS = {
65 HeatingCoolingCurrentValues.IDLE: HVACAction.IDLE,
66 HeatingCoolingCurrentValues.HEATING: HVACAction.HEATING,
67 HeatingCoolingCurrentValues.COOLING: HVACAction.COOLING,
70 SWING_MODE_HOMEKIT_TO_HASS = {
71 SwingModeValues.DISABLED: SWING_OFF,
72 SwingModeValues.ENABLED: SWING_VERTICAL,
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,
82 TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS = {
83 TargetHeaterCoolerStateValues.AUTOMATIC: HVACMode.HEAT_COOL,
84 TargetHeaterCoolerStateValues.HEAT: HVACMode.HEAT,
85 TargetHeaterCoolerStateValues.COOL: HVACMode.COOL,
90 MODE_HASS_TO_HOMEKIT = {v: k
for k, v
in MODE_HOMEKIT_TO_HASS.items()}
92 TARGET_HEATER_COOLER_STATE_HASS_TO_HOMEKIT = {
93 v: k
for k, v
in TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS.items()
96 SWING_MODE_HASS_TO_HOMEKIT = {v: k
for k, v
in SWING_MODE_HOMEKIT_TO_HASS.items()}
98 DEFAULT_MIN_STEP: Final = 1.0
100 ROTATION_SPEED_LOW = 33
101 ROTATION_SPEED_MEDIUM = 66
102 ROTATION_SPEED_HIGH = 100
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,
113 config_entry: ConfigEntry,
114 async_add_entities: AddEntitiesCallback,
116 """Set up Homekit climate."""
117 hkid: str = config_entry.data[
"AccessoryPairingID"]
118 conn: HKDevice = hass.data[KNOWN_DEVICES][hkid]
121 def async_add_service(service: Service) -> bool:
122 if not (entity_class := ENTITY_TYPES.get(service.type)):
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
132 conn.add_listener(async_add_service)
136 """The base HomeKit Controller climate entity."""
138 _attr_temperature_unit = UnitOfTemperature.CELSIUS
139 _enable_turn_on_off_backwards_compatibility =
False
143 """Reconfigure entity."""
148 """Define the homekit characteristics the entity cares about."""
150 CharacteristicsTypes.TEMPERATURE_CURRENT,
151 CharacteristicsTypes.FAN_STATE_TARGET,
156 """Return the current temperature."""
157 return self.
serviceservice.value(CharacteristicsTypes.TEMPERATURE_CURRENT)
161 """Return the available fan modes."""
162 if self.
serviceservice.has(CharacteristicsTypes.FAN_STATE_TARGET):
163 return [FAN_ON, FAN_AUTO]
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
173 """Turn fan to manual/auto."""
175 {CharacteristicsTypes.FAN_STATE_TARGET:
int(fan_mode == FAN_AUTO)}
180 """Return the list of supported features."""
181 features = ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON
183 if self.
serviceservice.has(CharacteristicsTypes.FAN_STATE_TARGET):
184 features |= ClimateEntityFeature.FAN_MODE
190 """Representation of a Homekit climate device."""
194 """Reconfigure entity."""
199 """Define the homekit characteristics the entity cares about."""
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,
212 rotation_speed = self.
serviceservice[CharacteristicsTypes.ROTATION_SPEED]
213 return round(rotation_speed.minValue
or 0) + 1, round(
214 rotation_speed.maxValue
or 100
219 """Return the available fan modes."""
220 return [FAN_OFF, FAN_LOW, FAN_MEDIUM, FAN_HIGH]
224 """Return the current fan mode."""
227 speed_range, self.
serviceservice.value(CharacteristicsTypes.ROTATION_SPEED)
230 if speed_percentage > ROTATION_SPEED_MEDIUM:
232 if speed_percentage > ROTATION_SPEED_LOW:
234 if speed_percentage > 0:
239 """Set new target fan mode."""
240 rotation = HASS_FAN_MODE_TO_HOMEKIT_ROTATION.get(fan_mode, 0)
244 {CharacteristicsTypes.ROTATION_SPEED: speed}
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:
253 {CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD: temp}
255 elif state == TargetHeaterCoolerStateValues.HEAT:
257 {CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD: temp}
260 hvac_mode = TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS.get(state)
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"
272 """Set new target operation mode."""
273 if hvac_mode == HVACMode.OFF:
275 {CharacteristicsTypes.ACTIVE: ActivationStateValues.INACTIVE}
278 if hvac_mode
not in {HVACMode.HEAT, HVACMode.COOL}:
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"
290 CharacteristicsTypes.ACTIVE: ActivationStateValues.ACTIVE,
291 CharacteristicsTypes.TARGET_HEATER_COOLER_STATE: TARGET_HEATER_COOLER_STATE_HASS_TO_HOMEKIT[
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
305 if state == TargetHeaterCoolerStateValues.HEAT:
306 return self.
serviceservice.value(
307 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
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
319 self.
serviceservice[CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD].minStep
322 if state == TargetHeaterCoolerStateValues.HEAT
and self.
serviceservice.has(
323 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
326 self.
serviceservice[CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD].minStep
329 return DEFAULT_MIN_STEP
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
340 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
344 if state == TargetHeaterCoolerStateValues.HEAT
and self.
serviceservice.has(
345 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
349 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
353 return super().min_temp
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
364 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
368 if state == TargetHeaterCoolerStateValues.HEAT
and self.
serviceservice.has(
369 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
373 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
377 return super().max_temp
381 """Return the current running hvac operation."""
386 self.
serviceservice.value(CharacteristicsTypes.ACTIVE)
387 == ActivationStateValues.INACTIVE
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)
395 """Return hvac operation ie. heat, cool mode."""
401 self.
serviceservice.value(CharacteristicsTypes.ACTIVE)
402 == ActivationStateValues.INACTIVE
405 value = self.
serviceservice.value(CharacteristicsTypes.TARGET_HEATER_COOLER_STATE)
406 return TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS[value]
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],
416 TARGET_HEATER_COOLER_STATE_HOMEKIT_TO_HASS[mode]
for mode
in valid_values
418 modes.append(HVACMode.OFF)
423 """Return the swing setting.
425 Requires ClimateEntityFeature.SWING_MODE.
427 value = self.
serviceservice.value(CharacteristicsTypes.SWING_MODE)
428 return SWING_MODE_HOMEKIT_TO_HASS[value]
432 """Return the list of available swing modes.
434 Requires ClimateEntityFeature.SWING_MODE.
436 valid_values = clamp_enum_to_char(
438 self.
serviceservice[CharacteristicsTypes.SWING_MODE],
440 return [SWING_MODE_HOMEKIT_TO_HASS[mode]
for mode
in valid_values]
443 """Set new target swing operation."""
445 {CharacteristicsTypes.SWING_MODE: SWING_MODE_HASS_TO_HOMEKIT[swing_mode]}
450 """Return the list of supported features."""
451 features = super().supported_features
453 if self.
serviceservice.has(CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD):
454 features |= ClimateEntityFeature.TARGET_TEMPERATURE
456 if self.
serviceservice.has(CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD):
457 features |= ClimateEntityFeature.TARGET_TEMPERATURE
459 if self.
serviceservice.has(CharacteristicsTypes.SWING_MODE):
460 features |= ClimateEntityFeature.SWING_MODE
462 if self.
serviceservice.has(CharacteristicsTypes.ROTATION_SPEED):
463 features |= ClimateEntityFeature.FAN_MODE
469 """Representation of a Homekit climate device."""
473 """Reconfigure entity."""
478 """Define the homekit characteristics the entity cares about."""
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,
492 """Set new target temperature."""
493 chars: dict[str, Any] = {}
495 value = self.
serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
496 mode = MODE_HOMEKIT_TO_HASS[value]
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[
504 temp = kwargs.get(ATTR_TEMPERATURE)
505 heat_temp = kwargs.get(ATTR_TARGET_TEMP_LOW)
506 cool_temp = kwargs.get(ATTR_TARGET_TEMP_HIGH)
509 (mode == HVACMode.HEAT_COOL)
517 temp = (cool_temp + heat_temp) / 2
520 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD: heat_temp,
521 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD: cool_temp,
522 CharacteristicsTypes.TEMPERATURE_TARGET: temp,
526 chars[CharacteristicsTypes.TEMPERATURE_TARGET] = temp
531 """Set new target humidity."""
533 {CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET: humidity}
537 """Set new target operation mode."""
540 CharacteristicsTypes.HEATING_COOLING_TARGET: MODE_HASS_TO_HOMEKIT[
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
555 return self.
serviceservice.value(CharacteristicsTypes.TEMPERATURE_TARGET)
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 (
565 return self.
serviceservice.value(
566 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
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 (
577 return self.
serviceservice.value(
578 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
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 (
589 min_temp = self.
serviceservice[
590 CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD
592 if min_temp
is not None:
594 elif MODE_HOMEKIT_TO_HASS.get(value)
in {
599 min_temp = self.
serviceservice[CharacteristicsTypes.TEMPERATURE_TARGET].minValue
600 if min_temp
is not None:
602 return super().min_temp
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 (
611 max_temp = self.
serviceservice[
612 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
614 if max_temp
is not None:
616 elif MODE_HOMEKIT_TO_HASS.get(value)
in {
621 max_temp = self.
serviceservice[CharacteristicsTypes.TEMPERATURE_TARGET].maxValue
622 if max_temp
is not None:
624 return super().max_temp
628 """Return the current humidity."""
629 return self.
serviceservice.value(CharacteristicsTypes.RELATIVE_HUMIDITY_CURRENT)
633 """Return the humidity we try to reach."""
634 return self.
serviceservice.value(CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET)
638 """Return the minimum humidity."""
639 min_humidity = self.
serviceservice[
640 CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET
642 if min_humidity
is not None:
643 return int(min_humidity)
644 return super().min_humidity
648 """Return the maximum humidity."""
649 max_humidity = self.
serviceservice[
650 CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET
652 if max_humidity
is not None:
653 return int(max_humidity)
654 return super().max_humidity
658 """Return the current running hvac operation."""
666 target = self.
serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
667 if target == HeatingCoolingTargetValues.OFF:
668 return HVACAction.IDLE
670 value = self.
serviceservice.value(CharacteristicsTypes.HEATING_COOLING_CURRENT)
671 current_hass_value = CURRENT_MODE_HOMEKIT_TO_HASS.get(value)
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
681 return HVACAction.FAN
683 return current_hass_value
687 """Return hvac operation ie. heat, cool mode."""
692 value = self.
serviceservice.value(CharacteristicsTypes.HEATING_COOLING_TARGET)
693 return MODE_HOMEKIT_TO_HASS[value]
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],
702 return [MODE_HOMEKIT_TO_HASS[mode]
for mode
in valid_values]
706 """Return the list of supported features."""
707 features = super().supported_features
709 if self.
serviceservice.has(CharacteristicsTypes.TEMPERATURE_TARGET):
710 features |= ClimateEntityFeature.TARGET_TEMPERATURE
713 CharacteristicsTypes.TEMPERATURE_COOLING_THRESHOLD
714 )
and self.
serviceservice.has(CharacteristicsTypes.TEMPERATURE_HEATING_THRESHOLD):
715 features |= ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
717 if self.
serviceservice.has(CharacteristicsTypes.RELATIVE_HUMIDITY_TARGET):
718 features |= ClimateEntityFeature.TARGET_HUMIDITY
724 ServicesTypes.HEATER_COOLER: HomeKitHeaterCoolerEntity,
725 ServicesTypes.THERMOSTAT: HomeKitClimateEntity,
ClimateEntityFeature supported_features(self)
list[str] get_characteristic_types(self)
float|None current_temperature(self)
list[str]|None fan_modes(self)
None _async_reconfigure(self)
None async_set_fan_mode(self, str fan_mode)
ClimateEntityFeature supported_features(self)
float|None target_temperature_high(self)
int target_humidity(self)
float|None target_temperature(self)
ClimateEntityFeature supported_features(self)
HVACAction|None hvac_action(self)
list[HVACMode] hvac_modes(self)
None async_set_hvac_mode(self, HVACMode hvac_mode)
None async_set_temperature(self, **Any kwargs)
float|None target_temperature_low(self)
list[str] get_characteristic_types(self)
int current_humidity(self)
None async_set_humidity(self, int humidity)
None _async_reconfigure(self)
None async_set_hvac_mode(self, HVACMode hvac_mode)
ClimateEntityFeature supported_features(self)
float|None target_temperature(self)
None async_set_swing_mode(self, str swing_mode)
HVACAction|None hvac_action(self)
None _async_reconfigure(self)
None async_set_temperature(self, **Any kwargs)
float target_temperature_step(self)
None async_set_fan_mode(self, str fan_mode)
list[str] get_characteristic_types(self)
list[str] swing_modes(self)
tuple[float, float] _get_rotation_speed_range(self)
list[HVACMode] hvac_modes(self)
list[str] fan_modes(self)
None async_put_characteristics(self, dict[str, Any] characteristics)
None _async_clear_property_cache(self, tuple[str,...] properties)
int|None supported_features(self)
None async_setup_entry(HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
float percentage_to_ranged_value(tuple[float, float] low_high_range, float percentage)
int ranged_value_to_percentage(tuple[float, float] low_high_range, float value)