mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
cbb28b6943
* Cache device triggers on startup * reorg zha init * don't reuse gateway * don't nuke yaml configuration * review comments * Add unit tests * Do not cache device and entity registries * [WIP] Wrap ZHA data in a dataclass * [WIP] Get unit tests passing * Use a helper function for getting the gateway object to fix annotations * Remove `bridge_id` * Fix typing issues with entity references in group websocket info * Use `Platform` instead of `str` for entity platform matching * Use `get_zha_gateway` in a few more places * Fix flaky unit test * Use `slots` for ZHA data Co-authored-by: J. Nick Koston <nick@koston.org> --------- Co-authored-by: David F. Mulcahey <david.mulcahey@icloud.com> Co-authored-by: J. Nick Koston <nick@koston.org>
114 lines
3.7 KiB
Python
114 lines
3.7 KiB
Python
"""Provides device automations for ZHA devices that emit events."""
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.device_automation import DEVICE_TRIGGER_BASE_SCHEMA
|
|
from homeassistant.components.device_automation.exceptions import (
|
|
InvalidDeviceAutomationConfig,
|
|
)
|
|
from homeassistant.components.homeassistant.triggers import event as event_trigger
|
|
from homeassistant.const import CONF_DEVICE_ID, CONF_DOMAIN, CONF_PLATFORM, CONF_TYPE
|
|
from homeassistant.core import CALLBACK_TYPE, HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.trigger import TriggerActionType, TriggerInfo
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
from . import DOMAIN as ZHA_DOMAIN
|
|
from .core.const import ZHA_EVENT
|
|
from .core.helpers import async_get_zha_device, get_zha_data
|
|
|
|
CONF_SUBTYPE = "subtype"
|
|
DEVICE = "device"
|
|
DEVICE_IEEE = "device_ieee"
|
|
|
|
TRIGGER_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend(
|
|
{vol.Required(CONF_TYPE): str, vol.Required(CONF_SUBTYPE): str}
|
|
)
|
|
|
|
|
|
def _get_device_trigger_data(hass: HomeAssistant, device_id: str) -> tuple[str, dict]:
|
|
"""Get device trigger data for a device, falling back to the cache if possible."""
|
|
|
|
# First, try checking to see if the device itself is accessible
|
|
try:
|
|
zha_device = async_get_zha_device(hass, device_id)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
return str(zha_device.ieee), zha_device.device_automation_triggers
|
|
|
|
# If not, check the trigger cache but allow any `KeyError`s to propagate
|
|
return get_zha_data(hass).device_trigger_cache[device_id]
|
|
|
|
|
|
async def async_validate_trigger_config(
|
|
hass: HomeAssistant, config: ConfigType
|
|
) -> ConfigType:
|
|
"""Validate config."""
|
|
config = TRIGGER_SCHEMA(config)
|
|
|
|
# Trigger validation will not occur if the config entry is not loaded
|
|
_, triggers = _get_device_trigger_data(hass, config[CONF_DEVICE_ID])
|
|
|
|
trigger = (config[CONF_TYPE], config[CONF_SUBTYPE])
|
|
if trigger not in triggers:
|
|
raise InvalidDeviceAutomationConfig(f"device does not have trigger {trigger}")
|
|
|
|
return config
|
|
|
|
|
|
async def async_attach_trigger(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
action: TriggerActionType,
|
|
trigger_info: TriggerInfo,
|
|
) -> CALLBACK_TYPE:
|
|
"""Listen for state changes based on configuration."""
|
|
|
|
try:
|
|
ieee, triggers = _get_device_trigger_data(hass, config[CONF_DEVICE_ID])
|
|
except KeyError as err:
|
|
raise HomeAssistantError(
|
|
f"Unable to get zha device {config[CONF_DEVICE_ID]}"
|
|
) from err
|
|
|
|
trigger_key: tuple[str, str] = (config[CONF_TYPE], config[CONF_SUBTYPE])
|
|
|
|
if trigger_key not in triggers:
|
|
raise HomeAssistantError(f"Unable to find trigger {trigger_key}")
|
|
|
|
event_config = event_trigger.TRIGGER_SCHEMA(
|
|
{
|
|
event_trigger.CONF_PLATFORM: "event",
|
|
event_trigger.CONF_EVENT_TYPE: ZHA_EVENT,
|
|
event_trigger.CONF_EVENT_DATA: {DEVICE_IEEE: ieee, **triggers[trigger_key]},
|
|
}
|
|
)
|
|
return await event_trigger.async_attach_trigger(
|
|
hass, event_config, action, trigger_info, platform_type="device"
|
|
)
|
|
|
|
|
|
async def async_get_triggers(
|
|
hass: HomeAssistant, device_id: str
|
|
) -> list[dict[str, str]]:
|
|
"""List device triggers.
|
|
|
|
Make sure the device supports device automations and return the trigger list.
|
|
"""
|
|
try:
|
|
_, triggers = _get_device_trigger_data(hass, device_id)
|
|
except KeyError as err:
|
|
raise InvalidDeviceAutomationConfig from err
|
|
|
|
return [
|
|
{
|
|
CONF_DEVICE_ID: device_id,
|
|
CONF_DOMAIN: ZHA_DOMAIN,
|
|
CONF_PLATFORM: DEVICE,
|
|
CONF_TYPE: trigger,
|
|
CONF_SUBTYPE: subtype,
|
|
}
|
|
for trigger, subtype in triggers
|
|
]
|