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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add stop/error script/automation action (#22338)

Browse Source
This commit is contained in:
Franck Nijhof 2022-04-12 12:19:39 +02:00 committed by GitHub
parent 91f28433ab
commit 88dd32b169
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
source/_docs/scripts.markdown
View File

@ -710,6 +710,29 @@ automation:
{% endraw %}
## Stopping a script sequence
It is possible to halt a script sequence at any point. Using the `stop` or
`error` action.
Both actions take a text as input explaining the reason for halting the
sequence. This text will be logged and shows up in the automations and
script traces.
`stop` can be useful to halt a script halfway through a sequence when,
for example, a condition is not met.
```yaml
- stop: "Stop running the rest of the sequence"
```
The `error` action stops a script as well, but marks the automation
or script as failed to run.
```yaml
- error: "Well, that was unexpected!"
```
[Script component]: /integrations/script/
[automations]: /getting-started/automation-action/
[Alexa/Amazon Echo]: /integrations/alexa/