Home Assistant Unofficial Reference 2024.12.1
device_trigger.py
Go to the documentation of this file.
1 """Triggers for WeMo devices."""
2 
3 from __future__ import annotations
4 
5 from pywemo.subscribe import EVENT_TYPE_LONG_PRESS
6 import voluptuous as vol
7 
8 from homeassistant.components.device_automation import DEVICE_TRIGGER_BASE_SCHEMA
9 from homeassistant.components.homeassistant.triggers import event as event_trigger
10 from homeassistant.const import CONF_DEVICE_ID, CONF_DOMAIN, CONF_PLATFORM, CONF_TYPE
11 from homeassistant.core import CALLBACK_TYPE, HomeAssistant
12 from homeassistant.helpers.trigger import TriggerActionType, TriggerInfo
13 from homeassistant.helpers.typing import ConfigType
14 
15 from .const import DOMAIN as WEMO_DOMAIN, WEMO_SUBSCRIPTION_EVENT
16 from .coordinator import async_get_coordinator
17 
18 TRIGGER_TYPES = {EVENT_TYPE_LONG_PRESS}
19 
20 TRIGGER_SCHEMA = DEVICE_TRIGGER_BASE_SCHEMA.extend(
21  {
22  vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES),
23  }
24 )
25 
26 
28  hass: HomeAssistant, device_id: str
29 ) -> list[dict[str, str]]:
30  """Return a list of triggers."""
31 
32  wemo_trigger = {
33  # Required fields of TRIGGER_BASE_SCHEMA
34  CONF_PLATFORM: "device",
35  CONF_DOMAIN: WEMO_DOMAIN,
36  CONF_DEVICE_ID: device_id,
37  }
38 
39  coordinator = async_get_coordinator(hass, device_id)
40  triggers = []
41 
42  # Check for long press support.
43  if coordinator.supports_long_press:
44  triggers.append(
45  {
46  # Required fields of TRIGGER_SCHEMA
47  CONF_TYPE: EVENT_TYPE_LONG_PRESS,
48  **wemo_trigger,
49  }
50  )
51 
52  return triggers
53 
54 
56  hass: HomeAssistant,
57  config: ConfigType,
58  action: TriggerActionType,
59  trigger_info: TriggerInfo,
60 ) -> CALLBACK_TYPE:
61  """Attach a trigger."""
62  event_config = event_trigger.TRIGGER_SCHEMA(
63  {
64  event_trigger.CONF_PLATFORM: "event",
65  event_trigger.CONF_EVENT_TYPE: WEMO_SUBSCRIPTION_EVENT,
66  event_trigger.CONF_EVENT_DATA: {
67  CONF_DEVICE_ID: config[CONF_DEVICE_ID],
68  CONF_TYPE: config[CONF_TYPE],
69  },
70  }
71  )
72  return await event_trigger.async_attach_trigger(
73  hass, event_config, action, trigger_info, platform_type="device"
74  )
PrivateDevicesCoordinator async_get_coordinator(HomeAssistant hass)
Definition: coordinator.py:235
list[dict[str, str]] async_get_triggers(HomeAssistant hass, str device_id)
CALLBACK_TYPE async_attach_trigger(HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)