Add additional device conditions to cover (#27830)
* Add additional device conditions to cover * Add default value * Add test * Use numeric_state condition instead of template condition
This commit is contained in:
1 parent
d44bfa8e88
commit
7fee44b8c5
4 files changed
+689
-60
No files matched your search
@@ -4,6 +4,9 @@ import voluptuous as vol
|
||||
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
ATTR_SUPPORTED_FEATURES,
|
||||
CONF_ABOVE,
|
||||
CONF_BELOW,
|
||||
CONF_CONDITION,
|
||||
CONF_DOMAIN,
|
||||
CONF_TYPE,
|
||||
@@ -15,20 +18,50 @@ from homeassistant.const import (
|
||||
STATE_CLOSING,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers import condition, config_validation as cv, entity_registry
|
||||
from homeassistant.helpers import (
|
||||
condition,
|
||||
config_validation as cv,
|
||||
entity_registry,
|
||||
template,
|
||||
)
|
||||
from homeassistant.helpers.typing import ConfigType, TemplateVarsType
|
||||
from homeassistant.helpers.config_validation import DEVICE_CONDITION_BASE_SCHEMA
|
||||
from . import DOMAIN
|
||||
from . import (
|
||||
DOMAIN,
|
||||
SUPPORT_CLOSE,
|
||||
SUPPORT_OPEN,
|
||||
SUPPORT_SET_POSITION,
|
||||
SUPPORT_SET_TILT_POSITION,
|
||||
)
|
||||
|
||||
CONDITION_TYPES = {"is_open", "is_closed", "is_opening", "is_closing"}
|
||||
POSITION_CONDITION_TYPES = {"is_position", "is_tilt_position"}
|
||||
STATE_CONDITION_TYPES = {"is_open", "is_closed", "is_opening", "is_closing"}
|
||||
|
||||
CONDITION_SCHEMA = DEVICE_CONDITION_BASE_SCHEMA.extend(
|
||||
POSITION_CONDITION_SCHEMA = vol.All(
|
||||
DEVICE_CONDITION_BASE_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
||||
vol.Required(CONF_TYPE): vol.In(POSITION_CONDITION_TYPES),
|
||||
vol.Optional(CONF_ABOVE): vol.All(
|
||||
vol.Coerce(int), vol.Range(min=0, max=100)
|
||||
),
|
||||
vol.Optional(CONF_BELOW): vol.All(
|
||||
vol.Coerce(int), vol.Range(min=0, max=100)
|
||||
),
|
||||
}
|
||||
),
|
||||
cv.has_at_least_one_key(CONF_BELOW, CONF_ABOVE),
|
||||
)
|
||||
|
||||
STATE_CONDITION_SCHEMA = DEVICE_CONDITION_BASE_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_ENTITY_ID): cv.entity_id,
|
||||
vol.Required(CONF_TYPE): vol.In(CONDITION_TYPES),
|
||||
vol.Required(CONF_TYPE): vol.In(STATE_CONDITION_TYPES),
|
||||
}
|
||||
)
|
||||
|
||||
CONDITION_SCHEMA = vol.Any(POSITION_CONDITION_SCHEMA, STATE_CONDITION_SCHEMA)
|
||||
|
||||
|
||||
async def async_get_conditions(hass: HomeAssistant, device_id: str) -> List[dict]:
|
||||
"""List device conditions for Cover devices."""
|
||||
@@ -40,64 +73,133 @@ async def async_get_conditions(hass: HomeAssistant, device_id: str) -> List[dict
|
||||
if entry.domain != DOMAIN:
|
||||
continue
|
||||
|
||||
state = hass.states.get(entry.entity_id)
|
||||
if not state or ATTR_SUPPORTED_FEATURES not in state.attributes:
|
||||
continue
|
||||
|
||||
supported_features = state.attributes[ATTR_SUPPORTED_FEATURES]
|
||||
supports_open_close = supported_features & (SUPPORT_OPEN | SUPPORT_CLOSE)
|
||||
|
||||
# Add conditions for each entity that belongs to this integration
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_open",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_closed",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_opening",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_closing",
|
||||
}
|
||||
)
|
||||
if supports_open_close:
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_open",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_closed",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_opening",
|
||||
}
|
||||
)
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_closing",
|
||||
}
|
||||
)
|
||||
if supported_features & SUPPORT_SET_POSITION:
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_position",
|
||||
}
|
||||
)
|
||||
if supported_features & SUPPORT_SET_TILT_POSITION:
|
||||
conditions.append(
|
||||
{
|
||||
CONF_CONDITION: "device",
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_ENTITY_ID: entry.entity_id,
|
||||
CONF_TYPE: "is_tilt_position",
|
||||
}
|
||||
)
|
||||
|
||||
return conditions
|
||||
|
||||
|
||||
async def async_get_condition_capabilities(hass: HomeAssistant, config: dict) -> dict:
|
||||
"""List condition capabilities."""
|
||||
if config[CONF_TYPE] not in ["is_position", "is_tilt_position"]:
|
||||
return {}
|
||||
|
||||
return {
|
||||
"extra_fields": vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_ABOVE, default=0): vol.All(
|
||||
vol.Coerce(int), vol.Range(min=0, max=100)
|
||||
),
|
||||
vol.Optional(CONF_BELOW, default=100): vol.All(
|
||||
vol.Coerce(int), vol.Range(min=0, max=100)
|
||||
),
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
def async_condition_from_config(
|
||||
config: ConfigType, config_validation: bool
|
||||
) -> condition.ConditionCheckerType:
|
||||
"""Create a function to test a device condition."""
|
||||
if config_validation:
|
||||
config = CONDITION_SCHEMA(config)
|
||||
if config[CONF_TYPE] == "is_open":
|
||||
state = STATE_OPEN
|
||||
elif config[CONF_TYPE] == "is_closed":
|
||||
state = STATE_CLOSED
|
||||
elif config[CONF_TYPE] == "is_opening":
|
||||
state = STATE_OPENING
|
||||
elif config[CONF_TYPE] == "is_closing":
|
||||
state = STATE_CLOSING
|
||||
|
||||
def test_is_state(hass: HomeAssistant, variables: TemplateVarsType) -> bool:
|
||||
"""Test if an entity is a certain state."""
|
||||
return condition.state(hass, config[ATTR_ENTITY_ID], state)
|
||||
if config[CONF_TYPE] in STATE_CONDITION_TYPES:
|
||||
if config[CONF_TYPE] == "is_open":
|
||||
state = STATE_OPEN
|
||||
elif config[CONF_TYPE] == "is_closed":
|
||||
state = STATE_CLOSED
|
||||
elif config[CONF_TYPE] == "is_opening":
|
||||
state = STATE_OPENING
|
||||
elif config[CONF_TYPE] == "is_closing":
|
||||
state = STATE_CLOSING
|
||||
|
||||
return test_is_state
|
||||
def test_is_state(hass: HomeAssistant, variables: TemplateVarsType) -> bool:
|
||||
"""Test if an entity is a certain state."""
|
||||
return condition.state(hass, config[ATTR_ENTITY_ID], state)
|
||||
|
||||
return test_is_state
|
||||
|
||||
if config[CONF_TYPE] == "is_position":
|
||||
position = "current_position"
|
||||
if config[CONF_TYPE] == "is_tilt_position":
|
||||
position = "current_tilt_position"
|
||||
min_pos = config.get(CONF_ABOVE, None)
|
||||
max_pos = config.get(CONF_BELOW, None)
|
||||
value_template = template.Template( # type: ignore
|
||||
f"{{{{ state.attributes.{position} }}}}"
|
||||
)
|
||||
|
||||
def template_if(hass: HomeAssistant, variables: TemplateVarsType = None) -> bool:
|
||||
"""Validate template based if-condition."""
|
||||
value_template.hass = hass
|
||||
|
||||
return condition.async_numeric_state(
|
||||
hass, config[ATTR_ENTITY_ID], max_pos, min_pos, value_template
|
||||
)
|
||||
|
||||
return template_if
|
||||
@@ -4,7 +4,9 @@
|
||||
"is_open": "{entity_name} is open",
|
||||
"is_closed": "{entity_name} is closed",
|
||||
"is_opening": "{entity_name} is opening",
|
||||
"is_closing": "{entity_name} is closing"
|
||||
"is_closing": "{entity_name} is closing",
|
||||
"is_position": "{entity_name} position is",
|
||||
"is_tilt_position": "{entity_name} tilt position is"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user