core/homeassistant/components/lcn/device_trigger.py

107 lines
3.4 KiB
Python

"""Provides device triggers for LCN."""
from __future__ import annotations
import voluptuous as vol
from homeassistant.components.device_automation import DEVICE_TRIGGER_BASE_SCHEMA
from homeassistant.components.homeassistant.triggers import event
from homeassistant.const import CONF_DEVICE_ID, CONF_DOMAIN, CONF_PLATFORM, CONF_TYPE
from homeassistant.core import CALLBACK_TYPE, HomeAssistant
from homeassistant.helpers import config_validation as cv, device_registry as dr
from homeassistant.helpers.trigger import TriggerActionType, TriggerInfo
from homeassistant.helpers.typing import ConfigType
from .const import DOMAIN, KEY_ACTIONS, SENDKEYS
TRIGGER_TYPES = {"transmitter", "transponder", "fingerprint", "codelock", "send_keys"}
LCN_DEVICE_TRIGGER_BASE_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend(
{vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES)}
)
ACCESS_CONTROL_SCHEMA = {vol.Optional("code"): vol.All(vol.Lower, cv.string)}
TRANSMITTER_SCHEMA = {
**ACCESS_CONTROL_SCHEMA,
vol.Optional("level"): cv.positive_int,
vol.Optional("key"): cv.positive_int,
vol.Optional("action"): vol.In([action.lower() for action in KEY_ACTIONS]),
}
SENDKEYS_SCHEMA = {
vol.Optional("key"): vol.In([key.lower() for key in SENDKEYS]),
vol.Optional("action"): vol.In([action.lower() for action in KEY_ACTIONS]),
}
TRIGGER_SCHEMA = vol.Any(
LCN_DEVICE_TRIGGER_BASE_SCHEMA.extend(ACCESS_CONTROL_SCHEMA),
LCN_DEVICE_TRIGGER_BASE_SCHEMA.extend(TRANSMITTER_SCHEMA),
LCN_DEVICE_TRIGGER_BASE_SCHEMA.extend(SENDKEYS_SCHEMA),
)
TYPE_SCHEMAS = {
"transmitter": {"extra_fields": vol.Schema(TRANSMITTER_SCHEMA)},
"transponder": {"extra_fields": vol.Schema(ACCESS_CONTROL_SCHEMA)},
"fingerprint": {"extra_fields": vol.Schema(ACCESS_CONTROL_SCHEMA)},
"codelock": {"extra_fields": vol.Schema(ACCESS_CONTROL_SCHEMA)},
"send_keys": {"extra_fields": vol.Schema(SENDKEYS_SCHEMA)},
}
async def async_get_triggers(
hass: HomeAssistant, device_id: str
) -> list[dict[str, str]]:
"""List device triggers for LCN devices."""
device_registry = dr.async_get(hass)
if (device := device_registry.async_get(device_id)) is None:
return []
identifier = next(iter(device.identifiers))
if (identifier[1].count("-") != 1) or device.model.startswith("LCN group"): # type: ignore[union-attr]
return []
base_trigger = {
CONF_PLATFORM: "device",
CONF_DOMAIN: DOMAIN,
CONF_DEVICE_ID: device_id,
}
return [{**base_trigger, CONF_TYPE: type_} for type_ in TRIGGER_TYPES]
async def async_attach_trigger(
hass: HomeAssistant,
config: ConfigType,
action: TriggerActionType,
trigger_info: TriggerInfo,
) -> CALLBACK_TYPE:
"""Attach a trigger."""
event_data = {
CONF_DEVICE_ID: config[CONF_DEVICE_ID],
**{
key: config[key]
for key in ("code", "level", "key", "action")
if key in config
},
}
event_config = event.TRIGGER_SCHEMA(
{
event.CONF_PLATFORM: "event",
event.CONF_EVENT_TYPE: f"lcn_{config[CONF_TYPE]}",
event.CONF_EVENT_DATA: event_data,
}
)
return await event.async_attach_trigger(
hass, event_config, action, trigger_info, platform_type="device"
)
async def async_get_trigger_capabilities(
hass: HomeAssistant, config: ConfigType
) -> dict[str, vol.Schema]:
"""List trigger capabilities."""
return TYPE_SCHEMAS.get(config[CONF_TYPE], {})