Add websock command to query device for triggers #24044

emontnemery · 2019-05-22T19:48:03Z

Description:

Add websock command to query device for triggers.

Triggers can be provided by the integration that provided the device or the entity integrations that the device has entities with.

As an example of the latter, this PR also adds turn_on and turn_off triggers to light entities.
TODO: Add an example of the former.

This PR is intended as initial step towards home-assistant/architecture#178

To test, add to configuration.yaml:

device_automation:

Example websock exchange:

# Ask for triggers for device:
{"id": 1, "type": "automation/device_automation/list_triggers", "device_id": "46d461813d264be185bad875ea907166"}
# Two triggers returned:
{"id": 1, "type": "result", "success": true, "result": {"triggers": [{"platform": "device", "domain": "light", "type": "turn_on", "entity_id": "light.brown_light"}, {"platform": "device", "domain": "light", "type": "turn_off", "entity_id": "light.brown_light"}]}}

The returned trigger can be used in an automation:

trigger:
 - platform: 'device'
   domain: 'light'
   type: turn_off
   entity_id: light.disco_room
action:
   service: homeassistant.turn_on
   entity_id: light.sonoff

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist

If the code does not interact with devices:

Tests have been added to verify that the new code works. - TODO

homeassistant/components/automation/device_automation.py

homeassistant/components/light/device_automation.py

homeassistant/components/automation/__init__.py

homeassistant/components/automation/device_automation.py

balloob · 2019-05-23T22:04:02Z

homeassistant/components/light/device_automation.py

+}))
+
+
+async def async_trigger(hass, config, action, automation_info):


Name it async_attach_trigger. What is config vs automation_info ? Shouldn't we just have hass, trigger_config, action ?

Ok, but I leave it for now so the new trigger can be tested without any changes to the existing automation framework.

balloob · 2019-06-03T21:20:26Z

homeassistant/components/automation/device.py

+def _domain_validator(config):
+    """Validate it is a valid  domain or platform."""
+    try:
+        platform = importlib.import_module(


This is really ugly, and it won't work with custom integrations either. We should use the async_get_integration method instead. However, that's async. Maybe just drop this validator ?

Yeah, the problem was that async_get_integration is async. I removed the validator for now.

balloob · 2019-06-03T21:30:34Z

homeassistant/components/device_automation/__init__.py

+        try:
+            integration = await async_get_integration(hass, domain)
+        except IntegrationNotFound:
+            _LOGGER.exception('Integration %s not found', domain)


We should never use exception unless it's an unexpected exception. This one we know why it happens (but shouldn't). I suggest we log a warning

balloob · 2019-06-03T21:31:43Z

homeassistant/components/device_automation/__init__.py

+
+async def async_get_device_automation_triggers(hass, device_id):
+    """List device triggers."""
+    device_registry = await hass.helpers.device_registry.async_get_registry()


Run both at the same time: dev_reg, ent_reg = await asyncio.gather(…)

balloob · 2019-06-03T21:32:09Z

homeassistant/components/device_automation/__init__.py

+    for entity in entities:
+        domains.add(split_entity_id(entity.entity_id)[0])
+
+    for domain in domains:


Let's run all of these tasks at the same time using asyncio.gather

balloob · 2019-06-03T21:33:05Z

homeassistant/components/light/device_automation.py

+        # Trigger when light is turned on
+        CONF_PLATFORM: 'device',
+        CONF_DOMAIN: DOMAIN,
+        CONF_TYPE: 'turn_on',


let's create constants for turn_on and turn_off

balloob · 2019-06-03T21:33:27Z

homeassistant/components/light/device_automation.py

+    vol.Required(CONF_PLATFORM): 'device',
+    vol.Optional(CONF_DEVICE_ID): str,
+    vol.Required(CONF_DOMAIN): DOMAIN,
+    vol.Required(CONF_ENTITY_ID): cv.entity_ids,


This should be single?

balloob · 2019-06-03T21:34:14Z

homeassistant/components/light/device_automation.py

+    state_config = {
+        state.CONF_ENTITY_ID: config[CONF_ENTITY_ID],
+        state.CONF_TO: to_state
+    }


Include a FROM or else a color update will trigger it too.

balloob · 2019-06-03T21:42:42Z

I think that overall this looks great.

For translations, would we do something like device_automation.<domain>.<type> ?

emontnemery · 2019-06-09T13:10:04Z

@balloob thanks for reviewing! All fixed now + tests added.

* Add websock command to query device for triggers * Lint * Refactor * Add support for domain automations * Make device automation an automation platform * lint * Support device_id in light trigger * Review comments * Add tests * Add tests * lint

Add websock command to query device for triggers

e137572

emontnemery requested a review from a team as a code owner May 22, 2019 19:48

homeassistant added the cla-signed label May 22, 2019

emontnemery commented May 22, 2019

View reviewed changes

homeassistant/components/automation/device_automation.py Outdated Show resolved Hide resolved

homeassistant/components/automation/device_automation.py Outdated Show resolved Hide resolved

homeassistant/components/light/device_automation.py Outdated Show resolved Hide resolved

homeassistant added core integration: automation integration: light labels May 22, 2019

Lint

c22ba80

balloob reviewed May 23, 2019

View reviewed changes

homeassistant/components/automation/__init__.py Outdated Show resolved Hide resolved

balloob reviewed May 23, 2019

View reviewed changes

homeassistant/components/automation/device_automation.py Outdated Show resolved Hide resolved

balloob reviewed May 23, 2019

View reviewed changes

homeassistant/components/automation/device_automation.py Outdated Show resolved Hide resolved

balloob reviewed May 23, 2019

View reviewed changes

emontnemery added 5 commits May 25, 2019 16:16

Refactor

a445235

Add support for domain automations

60ffcfa

Make device automation an automation platform

3e076df

lint

d948bc7

Support device_id in light trigger

6307d04

balloob reviewed Jun 3, 2019

View reviewed changes

balloob mentioned this pull request Jun 3, 2019

Device automations home-assistant/architecture#178

Closed

emontnemery added 3 commits June 9, 2019 13:07

Review comments

0b5ad46

Add tests

deb08a6

Add tests

0ac5eb2

lint

e1a1d6d

balloob approved these changes Jun 10, 2019

View reviewed changes

balloob changed the title ~~WIP: Add websock command to query device for triggers~~ Add websock command to query device for triggers Jun 10, 2019

balloob merged commit 935240f into home-assistant:dev Jun 10, 2019

balloob mentioned this pull request Jun 26, 2019

0.95.0 #24776

Merged

emontnemery mentioned this pull request Aug 22, 2019

WIP - Mqtt device triggers #26000

Closed

6 tasks

emontnemery deleted the device_automations branch September 6, 2019 10:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add websock command to query device for triggers #24044

Add websock command to query device for triggers #24044

emontnemery commented May 22, 2019 •

edited

balloob May 23, 2019

emontnemery May 25, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019 •

edited

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob Jun 3, 2019

emontnemery Jun 9, 2019

balloob commented Jun 3, 2019

emontnemery commented Jun 9, 2019

		}))


		async def async_trigger(hass, config, action, automation_info):

Add websock command to query device for triggers #24044

Add websock command to query device for triggers #24044

Conversation

emontnemery commented May 22, 2019 • edited

Description:

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emontnemery Jun 9, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Jun 3, 2019

emontnemery commented Jun 9, 2019

emontnemery commented May 22, 2019 •

edited

emontnemery Jun 9, 2019 •

edited