Initial draft device automations docs by balloob · Pull Request #321 · home-assistant/developers.home-assistant

balloob · 2019-09-24T21:35:40Z

Just a quick write up. Relies on home-assistant/core#26880

MartinHjelmare

It would be good to talk about when integrations need to define new device automations. The base components already provide some standard device automations, right?

MartinHjelmare · 2019-09-25T07:55:28Z

+sidebar_label: Actions
+---
+
+Device actions allow a user to have a device to something. Examples are to turn a light on or open the door.


to have a device do something.

MartinHjelmare · 2019-09-25T07:57:36Z

+
+Device conditions allow a user to check if a certain device condition is met. Examples are is a light on or is the floor wet.
+
+Device conditions are defined as dictionaries. These dictionaries are created by your integration and are passed to your integration to createa a function that checks the condition.


to create a function that checks

MartinHjelmare · 2019-09-25T07:58:33Z

+
+## `async async_condition_from_config(config, config_validation)`
+
+Create a condition function from a function. The condition functions should be an async-friendly callback that


Missing end of sentence.

MartinHjelmare · 2019-09-25T07:59:08Z

+sidebar_label: Introduction
+---
+
+Device Automations provides users with a device-centric layer on top of the core concepts of Home Assistant. When creating automations, users no longer have to deal with core concepts like states and events. Instead, they will be able to pick a device and then pick from a list of pre-defined triggers, conditions and actions.


Device Automations provide users

MartinHjelmare · 2019-09-25T07:59:53Z

+
+Device Automations provides users with a device-centric layer on top of the core concepts of Home Assistant. When creating automations, users no longer have to deal with core concepts like states and events. Instead, they will be able to pick a device and then pick from a list of pre-defined triggers, conditions and actions.
+
+Integrations can hook in this system by exposing functions to generate the pre-defined triggers, conditions, actions and having functions that can listen for the triggers, check the condition and execute the action.


Integrations can hook into this system

MartinHjelmare · 2019-09-25T08:00:56Z

+
+Integrations can hook in this system by exposing functions to generate the pre-defined triggers, conditions, actions and having functions that can listen for the triggers, check the condition and execute the action.
+
+Device automations are not exposing extra functionality but are a way for users to not have to learn new concepts. Device automatoins are using events, state and service helpers under the hood.


Device automations are using events, state and service helpers under the hood.

emontnemery · 2019-09-25T17:04:06Z

It would be good to talk about when integrations need to define new device automations. The base components already provide some standard device automations, right?

Yeah, @MartinHjelmare do you have any suggestion for wording?

I added a note like this:

Device triggers can be provided by the integration that provides the device (e.g. ZHA, deCONZ) or the entity integrations that the device has entities with (e.g. light, switch).
An example of the former is events not tied to an entity e.g. key press on a remote control or touch panel, while an example of the latter could be that a light has been turned on.

MartinHjelmare · 2019-09-25T17:12:51Z

I think it's good. But we're not consistent as a whole in the dev docs about how we name the entity integrations. In the architecture section we call these components. In the backend section we call them entity integrations.

balloob · 2019-09-25T17:25:45Z

Yeah I think that's an artifact from our component past. I think that we should go with entity integrations

Initial draft device automations docs

37521ca

homeassistant added the cla-signed label Sep 24, 2019

balloob added 2 commits September 24, 2019 14:54

Fix code block

73208dc

Add notes about scaffolding

f38474c

balloob mentioned this pull request Sep 24, 2019

Scaffold device automation home-assistant/core#26871

Merged

MartinHjelmare reviewed Sep 25, 2019

View reviewed changes

emontnemery added 5 commits September 25, 2019 18:52

Update device_automation_action.md

63c440a

Update device_automation_condition.md

ceeed86

Update device_automation_condition.md

c4e0730

Update device_automation_index.md

0973674

Update device_automation_trigger.md

95f4c14

MartinHjelmare approved these changes Sep 25, 2019

View reviewed changes

balloob merged commit c025ed1 into master Sep 25, 2019

delete-merged-branch Bot deleted the device-automations branch September 25, 2019 18:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Initial draft device automations docs#321

Initial draft device automations docs#321
balloob merged 8 commits into
masterfrom
device-automations

balloob commented Sep 24, 2019

Uh oh!

MartinHjelmare left a comment •

edited

Loading

Uh oh!

MartinHjelmare Sep 25, 2019

Uh oh!

MartinHjelmare Sep 25, 2019

Uh oh!

MartinHjelmare Sep 25, 2019

Uh oh!

MartinHjelmare Sep 25, 2019

Uh oh!

MartinHjelmare Sep 25, 2019

Uh oh!

MartinHjelmare Sep 25, 2019 •

edited

Loading

Uh oh!

emontnemery commented Sep 25, 2019

Uh oh!

MartinHjelmare commented Sep 25, 2019

Uh oh!

balloob commented Sep 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		Device conditions allow a user to check if a certain device condition is met. Examples are is a light on or is the floor wet.

		Device conditions are defined as dictionaries. These dictionaries are created by your integration and are passed to your integration to createa a function that checks the condition.


		## `async async_condition_from_config(config, config_validation)`

		Create a condition function from a function. The condition functions should be an async-friendly callback that


		Device Automations provides users with a device-centric layer on top of the core concepts of Home Assistant. When creating automations, users no longer have to deal with core concepts like states and events. Instead, they will be able to pick a device and then pick from a list of pre-defined triggers, conditions and actions.

		Integrations can hook in this system by exposing functions to generate the pre-defined triggers, conditions, actions and having functions that can listen for the triggers, check the condition and execute the action.


		Integrations can hook in this system by exposing functions to generate the pre-defined triggers, conditions, actions and having functions that can listen for the triggers, check the condition and execute the action.

		Device automations are not exposing extra functionality but are a way for users to not have to learn new concepts. Device automatoins are using events, state and service helpers under the hood.

Uh oh!

Conversation

balloob commented Sep 24, 2019

Uh oh!

MartinHjelmare left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Sep 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emontnemery commented Sep 25, 2019

Uh oh!

MartinHjelmare commented Sep 25, 2019

Uh oh!

balloob commented Sep 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MartinHjelmare left a comment •

edited

Loading

MartinHjelmare Sep 25, 2019 •

edited

Loading