Add device triggers for Hue remotes (#33476)
* Store device_registry entry id in HueEvent so it can be retrieved with that key when using device triggers * Add device_trigger for hue_event from hue remotes * supporting Hue dimmer switch & Hue Tap * State mapping and strings are copied from deCONZ * refactor mock_bridge for hue tests and also share `setup_bridge_for_sensors` for test_sensor_base and test_device_trigger. * Add tests for device triggers with hue remotes * Remove some triggers
This commit is contained in:
1 parent
400602a8b3
commit
71aaf2d809
8 files changed
+443
-120
No files matched your search
@@ -27,5 +27,22 @@
|
||||
}
|
||||
},
|
||||
"title": "Philips Hue"
|
||||
},
|
||||
"device_automation": {
|
||||
"trigger_subtype": {
|
||||
"button_1": "First button",
|
||||
"button_2": "Second button",
|
||||
"button_3": "Third button",
|
||||
"button_4": "Fourth button",
|
||||
"dim_down": "Dim down",
|
||||
"dim_up": "Dim up",
|
||||
"turn_off": "Turn off",
|
||||
"turn_on": "Turn on"
|
||||
},
|
||||
"trigger_type": {
|
||||
"remote_button_long_release": "\"{subtype}\" button released after long press",
|
||||
"remote_button_short_press": "\"{subtype}\" button pressed",
|
||||
"remote_button_short_release": "\"{subtype}\" button released"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,149 @@
|
||||
"""Provides device automations for Philips Hue events."""
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.components.automation.event as event
|
||||
from homeassistant.components.device_automation import TRIGGER_BASE_SCHEMA
|
||||
from homeassistant.components.device_automation.exceptions import (
|
||||
InvalidDeviceAutomationConfig,
|
||||
)
|
||||
from homeassistant.const import (
|
||||
CONF_DEVICE_ID,
|
||||
CONF_DOMAIN,
|
||||
CONF_EVENT,
|
||||
CONF_PLATFORM,
|
||||
CONF_TYPE,
|
||||
)
|
||||
|
||||
from . import DOMAIN
|
||||
from .hue_event import CONF_HUE_EVENT, CONF_UNIQUE_ID
|
||||
|
||||
_LOGGER = logging.getLogger(__file__)
|
||||
|
||||
CONF_SUBTYPE = "subtype"
|
||||
|
||||
CONF_SHORT_PRESS = "remote_button_short_press"
|
||||
CONF_SHORT_RELEASE = "remote_button_short_release"
|
||||
CONF_LONG_RELEASE = "remote_button_long_release"
|
||||
|
||||
CONF_TURN_ON = "turn_on"
|
||||
CONF_TURN_OFF = "turn_off"
|
||||
CONF_DIM_UP = "dim_up"
|
||||
CONF_DIM_DOWN = "dim_down"
|
||||
CONF_BUTTON_1 = "button_1"
|
||||
CONF_BUTTON_2 = "button_2"
|
||||
CONF_BUTTON_3 = "button_3"
|
||||
CONF_BUTTON_4 = "button_4"
|
||||
|
||||
|
||||
HUE_DIMMER_REMOTE_MODEL = "Hue dimmer switch" # RWL020/021
|
||||
HUE_DIMMER_REMOTE = {
|
||||
(CONF_SHORT_RELEASE, CONF_TURN_ON): {CONF_EVENT: 1002},
|
||||
(CONF_LONG_RELEASE, CONF_TURN_ON): {CONF_EVENT: 1003},
|
||||
(CONF_SHORT_RELEASE, CONF_DIM_UP): {CONF_EVENT: 2002},
|
||||
(CONF_LONG_RELEASE, CONF_DIM_UP): {CONF_EVENT: 2003},
|
||||
(CONF_SHORT_RELEASE, CONF_DIM_DOWN): {CONF_EVENT: 3002},
|
||||
(CONF_LONG_RELEASE, CONF_DIM_DOWN): {CONF_EVENT: 3003},
|
||||
(CONF_SHORT_RELEASE, CONF_TURN_OFF): {CONF_EVENT: 4002},
|
||||
(CONF_LONG_RELEASE, CONF_TURN_OFF): {CONF_EVENT: 4003},
|
||||
}
|
||||
|
||||
HUE_TAP_REMOTE_MODEL = "Hue tap switch" # ZGPSWITCH
|
||||
HUE_TAP_REMOTE = {
|
||||
(CONF_SHORT_PRESS, CONF_BUTTON_1): {CONF_EVENT: 34},
|
||||
(CONF_SHORT_PRESS, CONF_BUTTON_2): {CONF_EVENT: 16},
|
||||
(CONF_SHORT_PRESS, CONF_BUTTON_3): {CONF_EVENT: 17},
|
||||
(CONF_SHORT_PRESS, CONF_BUTTON_4): {CONF_EVENT: 18},
|
||||
}
|
||||
|
||||
REMOTES = {
|
||||
HUE_DIMMER_REMOTE_MODEL: HUE_DIMMER_REMOTE,
|
||||
HUE_TAP_REMOTE_MODEL: HUE_TAP_REMOTE,
|
||||
}
|
||||
|
||||
TRIGGER_SCHEMA = TRIGGER_BASE_SCHEMA.extend(
|
||||
{vol.Required(CONF_TYPE): str, vol.Required(CONF_SUBTYPE): str}
|
||||
)
|
||||
|
||||
|
||||
def _get_hue_event_from_device_id(hass, device_id):
|
||||
"""Resolve hue event from device id."""
|
||||
for bridge in hass.data.get(DOMAIN, {}).values():
|
||||
for hue_event in bridge.sensor_manager.current_events.values():
|
||||
if device_id == hue_event.device_registry_id:
|
||||
return hue_event
|
||||
|
||||
return None
|
||||
|
||||
|
||||
async def async_validate_trigger_config(hass, config):
|
||||
"""Validate config."""
|
||||
config = TRIGGER_SCHEMA(config)
|
||||
|
||||
device_registry = await hass.helpers.device_registry.async_get_registry()
|
||||
device = device_registry.async_get(config[CONF_DEVICE_ID])
|
||||
|
||||
trigger = (config[CONF_TYPE], config[CONF_SUBTYPE])
|
||||
|
||||
if (
|
||||
not device
|
||||
or device.model not in REMOTES
|
||||
or trigger not in REMOTES[device.model]
|
||||
):
|
||||
raise InvalidDeviceAutomationConfig
|
||||
|
||||
return config
|
||||
|
||||
|
||||
async def async_attach_trigger(hass, config, action, automation_info):
|
||||
"""Listen for state changes based on configuration."""
|
||||
device_registry = await hass.helpers.device_registry.async_get_registry()
|
||||
device = device_registry.async_get(config[CONF_DEVICE_ID])
|
||||
|
||||
hue_event = _get_hue_event_from_device_id(hass, device.id)
|
||||
if hue_event is None:
|
||||
raise InvalidDeviceAutomationConfig
|
||||
|
||||
trigger = (config[CONF_TYPE], config[CONF_SUBTYPE])
|
||||
|
||||
trigger = REMOTES[device.model][trigger]
|
||||
|
||||
event_config = {
|
||||
event.CONF_PLATFORM: "event",
|
||||
event.CONF_EVENT_TYPE: CONF_HUE_EVENT,
|
||||
event.CONF_EVENT_DATA: {CONF_UNIQUE_ID: hue_event.unique_id, **trigger},
|
||||
}
|
||||
|
||||
event_config = event.TRIGGER_SCHEMA(event_config)
|
||||
return await event.async_attach_trigger(
|
||||
hass, event_config, action, automation_info, platform_type="device"
|
||||
)
|
||||
|
||||
|
||||
async def async_get_triggers(hass, device_id):
|
||||
"""List device triggers.
|
||||
|
||||
Make sure device is a supported remote model.
|
||||
Retrieve the hue event object matching device entry.
|
||||
Generate device trigger list.
|
||||
"""
|
||||
device_registry = await hass.helpers.device_registry.async_get_registry()
|
||||
device = device_registry.async_get(device_id)
|
||||
|
||||
if device.model not in REMOTES:
|
||||
return
|
||||
|
||||
triggers = []
|
||||
for trigger, subtype in REMOTES[device.model].keys():
|
||||
triggers.append(
|
||||
{
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_PLATFORM: "device",
|
||||
CONF_TYPE: trigger,
|
||||
CONF_SUBTYPE: subtype,
|
||||
}
|
||||
)
|
||||
|
||||
return triggers
|
||||
@@ -28,6 +28,7 @@ class HueEvent(GenericHueDevice):
|
||||
def __init__(self, sensor, name, bridge, primary_sensor=None):
|
||||
"""Register callback that will be used for signals."""
|
||||
super().__init__(sensor, name, bridge, primary_sensor)
|
||||
self.device_registry_id = None
|
||||
|
||||
self.event_id = slugify(self.sensor.name)
|
||||
# Use the 'lastupdated' string to detect new remote presses
|
||||
@@ -79,9 +80,10 @@ class HueEvent(GenericHueDevice):
|
||||
entry = device_registry.async_get_or_create(
|
||||
config_entry_id=self.bridge.config_entry.entry_id, **self.device_info
|
||||
)
|
||||
self.device_registry_id = entry.id
|
||||
_LOGGER.debug(
|
||||
"Event registry with entry_id: %s and device_id: %s",
|
||||
entry.id,
|
||||
self.device_registry_id,
|
||||
self.device_id,
|
||||
)
|
||||
|
||||
|
||||
@@ -27,5 +27,22 @@
|
||||
"already_in_progress": "Config flow for bridge is already in progress.",
|
||||
"not_hue_bridge": "Not a Hue bridge"
|
||||
}
|
||||
},
|
||||
"device_automation": {
|
||||
"trigger_subtype": {
|
||||
"button_1": "First button",
|
||||
"button_2": "Second button",
|
||||
"button_3": "Third button",
|
||||
"button_4": "Fourth button",
|
||||
"dim_down": "Dim down",
|
||||
"dim_up": "Dim up",
|
||||
"turn_off": "Turn off",
|
||||
"turn_on": "Turn on"
|
||||
},
|
||||
"trigger_type": {
|
||||
"remote_button_long_release": "\"{subtype}\" button released after long press",
|
||||
"remote_button_short_press": "\"{subtype}\" button pressed",
|
||||
"remote_button_short_release": "\"{subtype}\" button released"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user