mirror of https://github.com/home-assistant/core
92 lines
2.6 KiB
Python
92 lines
2.6 KiB
Python
"""Provides device automations for Lock."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.device_automation import async_validate_entity_schema
|
|
from homeassistant.const import (
|
|
ATTR_ENTITY_ID,
|
|
CONF_DEVICE_ID,
|
|
CONF_DOMAIN,
|
|
CONF_ENTITY_ID,
|
|
CONF_TYPE,
|
|
SERVICE_LOCK,
|
|
SERVICE_OPEN,
|
|
SERVICE_UNLOCK,
|
|
)
|
|
from homeassistant.core import Context, HomeAssistant
|
|
from homeassistant.helpers import entity_registry as er
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import get_supported_features
|
|
from homeassistant.helpers.typing import ConfigType, TemplateVarsType
|
|
|
|
from . import DOMAIN, LockEntityFeature
|
|
|
|
ACTION_TYPES = {"lock", "unlock", "open"}
|
|
|
|
_ACTION_SCHEMA = cv.DEVICE_ACTION_BASE_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_TYPE): vol.In(ACTION_TYPES),
|
|
vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
|
|
}
|
|
)
|
|
|
|
|
|
async def async_validate_action_config(
|
|
hass: HomeAssistant, config: ConfigType
|
|
) -> ConfigType:
|
|
"""Validate config."""
|
|
return async_validate_entity_schema(hass, config, _ACTION_SCHEMA)
|
|
|
|
|
|
async def async_get_actions(
|
|
hass: HomeAssistant, device_id: str
|
|
) -> list[dict[str, str]]:
|
|
"""List device actions for Lock devices."""
|
|
registry = er.async_get(hass)
|
|
actions = []
|
|
|
|
# Get all the integrations entities for this device
|
|
for entry in er.async_entries_for_device(registry, device_id):
|
|
if entry.domain != DOMAIN:
|
|
continue
|
|
|
|
supported_features = get_supported_features(hass, entry.entity_id)
|
|
|
|
# Add actions for each entity that belongs to this integration
|
|
base_action = {
|
|
CONF_DEVICE_ID: device_id,
|
|
CONF_DOMAIN: DOMAIN,
|
|
CONF_ENTITY_ID: entry.id,
|
|
}
|
|
|
|
actions.append({**base_action, CONF_TYPE: "lock"})
|
|
actions.append({**base_action, CONF_TYPE: "unlock"})
|
|
|
|
if supported_features & (LockEntityFeature.OPEN):
|
|
actions.append({**base_action, CONF_TYPE: "open"})
|
|
|
|
return actions
|
|
|
|
|
|
async def async_call_action_from_config(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
variables: TemplateVarsType,
|
|
context: Context | None,
|
|
) -> None:
|
|
"""Execute a device action."""
|
|
service_data = {ATTR_ENTITY_ID: config[CONF_ENTITY_ID]}
|
|
|
|
if config[CONF_TYPE] == "lock":
|
|
service = SERVICE_LOCK
|
|
elif config[CONF_TYPE] == "unlock":
|
|
service = SERVICE_UNLOCK
|
|
elif config[CONF_TYPE] == "open":
|
|
service = SERVICE_OPEN
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN, service, service_data, blocking=True, context=context
|
|
)
|