jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 08:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new automation configuration options (#13901)

Browse Source 
* Add new automation configuration options

* Update per review

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update source/_docs/automation.markdown

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

* Update source/_docs/automation.markdown

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Phil Bruckner 2020-07-06 04:33:45 -05:00 committed by GitHub
parent 04bd0946b3
commit 84695a3a29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
source/_docs/automation.markdown
View File

@ -47,7 +47,7 @@ When you create a new automation, it will be enabled unless you explicitly add `
Please note that if for some reason Home Assistant cannot restore the previous state, it will result in the automation being enabled. Please note that if for some reason Home Assistant cannot restore the previous state, it will result in the automation being enabled.
```text ```yaml
automation: automation:
- alias: Automation Name - alias: Automation Name
initial_state: false initial_state: false
@ -55,6 +55,39 @@ automation:
... ...
``` ```
### Automation Modes
The automation's `mode` configuration option controls what happens when the automation is triggered while the actions are still running from a previous trigger. The default mode is `legacy`.
Mode | Description
-|-
`legacy` | See [below](#legacy-mode).
`error` | Raise an error. Previous run continues normally.
`ignore` | Do not start a new run. Previous run continues normally.
`parallel` | Start a new, independent run in parallel with previous runs which continue normally.
`restart` | Start a new run after first stopping previous run.
`queue` | Start a new run after all previous runs complete. Runs are guaranteed to execute in the order they were queued. The maximum number of queued up runs is controlled by the `queue_size` configuration option, which defaults to 10.
#### Example Setting Automation Mode
```yaml
automation:
- mode: queue
queue_size: 5
trigger:
...
```
#### Legacy Mode
<div class='note'>
This mode is deprecated, and a warning to that effect will be issued at startup unless `mode: legacy` is specified.
</div>
This mode maintains the legacy script behavior. That is, the actions will run until a `delay` step, or a `wait_template` step (that actually waits) is executed, at which point the actions will suspend. If the automation is triggered while the actions are suspended, it will abort the delay/wait_template and continue immediately to the next step, or finish if there are no more steps.
### Deleting Automations ### Deleting Automations
When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI. When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI.