Home Assistant Unofficial Reference 2024.12.1
trigger.py
Go to the documentation of this file.
1 """Z-Wave JS trigger dispatcher."""
2 
3 from __future__ import annotations
4 
5 from homeassistant.const import CONF_PLATFORM
6 from homeassistant.core import CALLBACK_TYPE, HomeAssistant
8  TriggerActionType,
9  TriggerInfo,
10  TriggerProtocol,
11 )
12 from homeassistant.helpers.typing import ConfigType
13 
14 from .triggers import event, value_updated
15 
16 TRIGGERS = {
17  "value_updated": value_updated,
18  "event": event,
19 }
20 
21 
22 def _get_trigger_platform(config: ConfigType) -> TriggerProtocol:
23  """Return trigger platform."""
24  platform_split = config[CONF_PLATFORM].split(".", maxsplit=1)
25  if len(platform_split) < 2 or platform_split[1] not in TRIGGERS:
26  raise ValueError(f"Unknown Z-Wave JS trigger platform {config[CONF_PLATFORM]}")
27  return TRIGGERS[platform_split[1]]
28 
29 
31  hass: HomeAssistant, config: ConfigType
32 ) -> ConfigType:
33  """Validate config."""
34  platform = _get_trigger_platform(config)
35  return await platform.async_validate_trigger_config(hass, config)
36 
37 
39  hass: HomeAssistant,
40  config: ConfigType,
41  action: TriggerActionType,
42  trigger_info: TriggerInfo,
43 ) -> CALLBACK_TYPE:
44  """Attach trigger of specified platform."""
45  platform = _get_trigger_platform(config)
46  return await platform.async_attach_trigger(hass, config, action, trigger_info)
TriggerProtocol _get_trigger_platform(ConfigType config)
Definition: trigger.py:22
CALLBACK_TYPE async_attach_trigger(HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
Definition: trigger.py:43
ConfigType async_validate_trigger_config(HomeAssistant hass, ConfigType config)
Definition: trigger.py:32