Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.climate.device_condition Namespace Reference

Functions

condition.ConditionCheckerType async_condition_from_config (HomeAssistant hass, ConfigType config)
 
dict[str, vol.Schema] async_get_condition_capabilities (HomeAssistant hass, ConfigType config)
 
list[dict[str, str]] async_get_conditions (HomeAssistant hass, str device_id)
 

Variables

 CONDITION_SCHEMA = vol.Any(HVAC_MODE_CONDITION, PRESET_MODE_CONDITION)
 
dictionary CONDITION_TYPES = {"is_hvac_mode", "is_preset_mode"}
 
 HVAC_MODE_CONDITION
 
 PRESET_MODE_CONDITION
 

Detailed Description

Provide the device automations for Climate.

Function Documentation

◆ async_condition_from_config()

condition.ConditionCheckerType homeassistant.components.climate.device_condition.async_condition_from_config ( HomeAssistant  hass,
ConfigType   config 
)
Create a function to test a device condition.

Definition at line 82 of file device_condition.py.

◆ async_get_condition_capabilities()

dict[str, vol.Schema] homeassistant.components.climate.device_condition.async_get_condition_capabilities ( HomeAssistant  hass,
ConfigType   config 
)
List condition capabilities.

Definition at line 106 of file device_condition.py.

◆ async_get_conditions()

list[dict[str, str]] homeassistant.components.climate.device_condition.async_get_conditions ( HomeAssistant  hass,
str   device_id 
)
List device conditions for Climate devices.

Definition at line 52 of file device_condition.py.

Variable Documentation

◆ CONDITION_SCHEMA

homeassistant.components.climate.device_condition.CONDITION_SCHEMA = vol.Any(HVAC_MODE_CONDITION, PRESET_MODE_CONDITION)

Definition at line 49 of file device_condition.py.

◆ CONDITION_TYPES

dictionary homeassistant.components.climate.device_condition.CONDITION_TYPES = {"is_hvac_mode", "is_preset_mode"}

Definition at line 31 of file device_condition.py.

◆ HVAC_MODE_CONDITION

homeassistant.components.climate.device_condition.HVAC_MODE_CONDITION
Initial value:
1 = DEVICE_CONDITION_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
4  vol.Required(CONF_TYPE): "is_hvac_mode",
5  vol.Required(const.ATTR_HVAC_MODE): vol.In(const.HVAC_MODES),
6  }
7 )

Definition at line 33 of file device_condition.py.

◆ PRESET_MODE_CONDITION

homeassistant.components.climate.device_condition.PRESET_MODE_CONDITION
Initial value:
1 = DEVICE_CONDITION_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
4  vol.Required(CONF_TYPE): "is_preset_mode",
5  vol.Required(const.ATTR_PRESET_MODE): str,
6  }
7 )

Definition at line 41 of file device_condition.py.