Add device automation support to ZHA (#26821)
* beginning ZHA device automations * add cube * load triggers from zigpy devices * cleanup * add face_any for aqara cube * add endpoint id to events * add cluster id to events * cleanup * add device tilt * add test * fix copy paste error * add event trigger test * add test for no triggers for device * add exception test * better exception tests
This commit is contained in:
1 parent
161c8aada6
commit
18873d202d
6 files changed
+524
-32
No files matched your search
@@ -1,20 +1,63 @@
|
||||
{
|
||||
"config": {
|
||||
"abort": {
|
||||
"single_instance_allowed": "Only a single configuration of ZHA is allowed."
|
||||
},
|
||||
"error": {
|
||||
"cannot_connect": "Unable to connect to ZHA device."
|
||||
},
|
||||
"step": {
|
||||
"user": {
|
||||
"data": {
|
||||
"radio_type": "Radio Type",
|
||||
"usb_path": "USB Device Path"
|
||||
},
|
||||
"title": "ZHA"
|
||||
}
|
||||
"config": {
|
||||
"abort": {
|
||||
"single_instance_allowed": "Only a single configuration of ZHA is allowed."
|
||||
},
|
||||
"error": {
|
||||
"cannot_connect": "Unable to connect to ZHA device."
|
||||
},
|
||||
"step": {
|
||||
"user": {
|
||||
"data": {
|
||||
"radio_type": "Radio Type",
|
||||
"usb_path": "USB Device Path"
|
||||
},
|
||||
"title": "ZHA"
|
||||
}
|
||||
},
|
||||
"title": "ZHA"
|
||||
},
|
||||
"device_automation": {
|
||||
"trigger_type": {
|
||||
"remote_button_short_press": "\"{subtype}\" button pressed",
|
||||
"remote_button_short_release": "\"{subtype}\" button released",
|
||||
"remote_button_long_press": "\"{subtype}\" button continuously pressed",
|
||||
"remote_button_long_release": "\"{subtype}\" button released after long press",
|
||||
"remote_button_double_press": "\"{subtype}\" button double clicked",
|
||||
"remote_button_triple_press": "\"{subtype}\" button triple clicked",
|
||||
"remote_button_quadruple_press": "\"{subtype}\" button quadruple clicked",
|
||||
"remote_button_quintuple_press": "\"{subtype}\" button quintuple clicked",
|
||||
"device_rotated": "Device rotated \"{subtype}\"",
|
||||
"device_shaken": "Device shaken",
|
||||
"device_slid": "Device slid \"{subtype}\"",
|
||||
"device_tilted": "Device tilted",
|
||||
"device_knocked": "Device knocked \"{subtype}\"",
|
||||
"device_dropped": "Device dropped",
|
||||
"device_flipped": "Device flipped \"{subtype}\""
|
||||
},
|
||||
"trigger_subtype": {
|
||||
"turn_on": "Turn on",
|
||||
"turn_off": "Turn off",
|
||||
"dim_up": "Dim up",
|
||||
"dim_down": "Dim down",
|
||||
"left": "Left",
|
||||
"right": "Right",
|
||||
"open": "Open",
|
||||
"close": "Close",
|
||||
"both_buttons": "Both buttons",
|
||||
"button_1": "First button",
|
||||
"button_2": "Second button",
|
||||
"button_3": "Third button",
|
||||
"button_4": "Fourth button",
|
||||
"button_5": "Fifth button",
|
||||
"button_6": "Sixth button",
|
||||
"face_any": "With any/specified face(s) activated",
|
||||
"face_1": "With face 1 activated",
|
||||
"face_2": "With face 2 activated",
|
||||
"face_3": "With face 3 activated",
|
||||
"face_4": "With face 4 activated",
|
||||
"face_5": "With face 5 activated",
|
||||
"face_6": "With face 6 activated"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -240,6 +240,8 @@ class ZigbeeChannel(LogMixin):
|
||||
{
|
||||
"unique_id": self._unique_id,
|
||||
"device_ieee": str(self._zha_device.ieee),
|
||||
"endpoint_id": cluster.endpoint.endpoint_id,
|
||||
"cluster_id": cluster.cluster_id,
|
||||
"command": command,
|
||||
"args": args,
|
||||
},
|
||||
|
||||
@@ -187,6 +187,13 @@ class ZHADevice(LogMixin):
|
||||
"""Return cluster channels and relay channels for device."""
|
||||
return self._all_channels
|
||||
|
||||
@property
|
||||
def device_automation_triggers(self):
|
||||
"""Return the device automation triggers for this device."""
|
||||
if hasattr(self._zigpy_device, "device_automation_triggers"):
|
||||
return self._zigpy_device.device_automation_triggers
|
||||
return None
|
||||
|
||||
@property
|
||||
def available_signal(self):
|
||||
"""Signal to use to subscribe to device availability changes."""
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
"""Provides device automations for ZHA devices that emit events."""
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.components.automation.event as event
|
||||
from homeassistant.components.device_automation.exceptions import (
|
||||
InvalidDeviceAutomationConfig,
|
||||
)
|
||||
from homeassistant.const import CONF_DEVICE_ID, CONF_DOMAIN, CONF_PLATFORM, CONF_TYPE
|
||||
|
||||
from . import DOMAIN
|
||||
from .core.const import DATA_ZHA, DATA_ZHA_GATEWAY
|
||||
from .core.helpers import convert_ieee
|
||||
|
||||
CONF_SUBTYPE = "subtype"
|
||||
DEVICE = "device"
|
||||
DEVICE_IEEE = "device_ieee"
|
||||
ZHA_EVENT = "zha_event"
|
||||
|
||||
TRIGGER_SCHEMA = vol.All(
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Required(CONF_DEVICE_ID): str,
|
||||
vol.Required(CONF_DOMAIN): DOMAIN,
|
||||
vol.Required(CONF_PLATFORM): DEVICE,
|
||||
vol.Required(CONF_TYPE): str,
|
||||
vol.Required(CONF_SUBTYPE): str,
|
||||
}
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
async def async_trigger(hass, config, action, automation_info):
|
||||
"""Listen for state changes based on configuration."""
|
||||
config = TRIGGER_SCHEMA(config)
|
||||
trigger = (config[CONF_TYPE], config[CONF_SUBTYPE])
|
||||
zha_device = await _async_get_zha_device(hass, config[CONF_DEVICE_ID])
|
||||
|
||||
if (
|
||||
zha_device.device_automation_triggers is None
|
||||
or trigger not in zha_device.device_automation_triggers
|
||||
):
|
||||
raise InvalidDeviceAutomationConfig
|
||||
|
||||
trigger = zha_device.device_automation_triggers[trigger]
|
||||
|
||||
state_config = {
|
||||
event.CONF_EVENT_TYPE: ZHA_EVENT,
|
||||
event.CONF_EVENT_DATA: {DEVICE_IEEE: str(zha_device.ieee), **trigger},
|
||||
}
|
||||
|
||||
return await event.async_trigger(hass, state_config, action, automation_info)
|
||||
|
||||
|
||||
async def async_get_triggers(hass, device_id):
|
||||
"""List device triggers.
|
||||
|
||||
Make sure the device supports device automations and
|
||||
if it does return the trigger list.
|
||||
"""
|
||||
zha_device = await _async_get_zha_device(hass, device_id)
|
||||
|
||||
if not zha_device.device_automation_triggers:
|
||||
return
|
||||
|
||||
triggers = []
|
||||
for trigger, subtype in zha_device.device_automation_triggers.keys():
|
||||
triggers.append(
|
||||
{
|
||||
CONF_DEVICE_ID: device_id,
|
||||
CONF_DOMAIN: DOMAIN,
|
||||
CONF_PLATFORM: DEVICE,
|
||||
CONF_TYPE: trigger,
|
||||
CONF_SUBTYPE: subtype,
|
||||
}
|
||||
)
|
||||
|
||||
return triggers
|
||||
|
||||
|
||||
async def _async_get_zha_device(hass, device_id):
|
||||
device_registry = await hass.helpers.device_registry.async_get_registry()
|
||||
registry_device = device_registry.async_get(device_id)
|
||||
zha_gateway = hass.data[DATA_ZHA][DATA_ZHA_GATEWAY]
|
||||
ieee_address = list(list(registry_device.identifiers)[0])[1]
|
||||
ieee = convert_ieee(ieee_address)
|
||||
zha_device = zha_gateway.devices[ieee]
|
||||
if not zha_device:
|
||||
raise InvalidDeviceAutomationConfig
|
||||
return zha_device
|
||||
@@ -1,20 +1,63 @@
|
||||
{
|
||||
"config": {
|
||||
"config": {
|
||||
"title": "ZHA",
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "ZHA",
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "ZHA",
|
||||
"data": {
|
||||
"radio_type": "Radio Type",
|
||||
"usb_path": "USB Device Path"
|
||||
}
|
||||
}
|
||||
},
|
||||
"error": {
|
||||
"cannot_connect": "Unable to connect to ZHA device."
|
||||
},
|
||||
"abort": {
|
||||
"single_instance_allowed": "Only a single configuration of ZHA is allowed."
|
||||
"data": {
|
||||
"radio_type": "Radio Type",
|
||||
"usb_path": "USB Device Path"
|
||||
}
|
||||
}
|
||||
},
|
||||
"error": {
|
||||
"cannot_connect": "Unable to connect to ZHA device."
|
||||
},
|
||||
"abort": {
|
||||
"single_instance_allowed": "Only a single configuration of ZHA is allowed."
|
||||
}
|
||||
}
|
||||
},
|
||||
"device_automation": {
|
||||
"trigger_type": {
|
||||
"remote_button_short_press": "\"{subtype}\" button pressed",
|
||||
"remote_button_short_release": "\"{subtype}\" button released",
|
||||
"remote_button_long_press": "\"{subtype}\" button continuously pressed",
|
||||
"remote_button_long_release": "\"{subtype}\" button released after long press",
|
||||
"remote_button_double_press": "\"{subtype}\" button double clicked",
|
||||
"remote_button_triple_press": "\"{subtype}\" button triple clicked",
|
||||
"remote_button_quadruple_press": "\"{subtype}\" button quadruple clicked",
|
||||
"remote_button_quintuple_press": "\"{subtype}\" button quintuple clicked",
|
||||
"device_rotated": "Device rotated \"{subtype}\"",
|
||||
"device_shaken": "Device shaken",
|
||||
"device_slid": "Device slid \"{subtype}\"",
|
||||
"device_tilted": "Device tilted",
|
||||
"device_knocked": "Device knocked \"{subtype}\"",
|
||||
"device_dropped": "Device dropped",
|
||||
"device_flipped": "Device flipped \"{subtype}\""
|
||||
},
|
||||
"trigger_subtype": {
|
||||
"turn_on": "Turn on",
|
||||
"turn_off": "Turn off",
|
||||
"dim_up": "Dim up",
|
||||
"dim_down": "Dim down",
|
||||
"left": "Left",
|
||||
"right": "Right",
|
||||
"open": "Open",
|
||||
"close": "Close",
|
||||
"both_buttons": "Both buttons",
|
||||
"button_1": "First button",
|
||||
"button_2": "Second button",
|
||||
"button_3": "Third button",
|
||||
"button_4": "Fourth button",
|
||||
"button_5": "Fifth button",
|
||||
"button_6": "Sixth button",
|
||||
"face_any": "With any/specified face(s) activated",
|
||||
"face_1": "with face 1 activated",
|
||||
"face_2": "with face 2 activated",
|
||||
"face_3": "with face 3 activated",
|
||||
"face_4": "with face 4 activated",
|
||||
"face_5": "with face 5 activated",
|
||||
"face_6": "with face 6 activated"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user