mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 02:28:56 +00:00
e8733459d2
* * Updated wait_template to include 'trigger.entity_id' and 'variables' support * * Deleted notes and whitespaces * Small grammar correction
133 lines
4.1 KiB
Markdown
133 lines
4.1 KiB
Markdown
---
|
|
layout: page
|
|
title: "Script Syntax"
|
|
description: "Documention for the Home Assistant Script Syntax."
|
|
date: 2016-04-24 08:30 +0100
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
redirect_from: /getting-started/scripts/
|
|
---
|
|
|
|
Scripts are a sequence of actions that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in [automations] and [Alexa/Amazon Echo] configurations.
|
|
|
|
The script syntax basic structure is a list of key/value maps that contain actions. If a script contains only 1 action, the wrapping list can be omitted.
|
|
|
|
```yaml
|
|
# Example script component containing script syntax
|
|
script:
|
|
example_script:
|
|
sequence:
|
|
# This is written using the Script Syntax
|
|
- service: light.turn_on
|
|
entity_id: light.ceiling
|
|
- service: notify.notify
|
|
data:
|
|
message: 'Turned on the ceiling light!'
|
|
```
|
|
|
|
### {% linkable_title Call a Service %}
|
|
|
|
The most important one is the action to call a service. This can be done in various ways. For all the different possibilities, have a look at the [service calls page].
|
|
|
|
```yaml
|
|
alias: Bedroom lights on
|
|
service: light.turn_on
|
|
data:
|
|
entity_id: group.bedroom
|
|
brightness: 100
|
|
```
|
|
|
|
### {% linkable_title Test a Condition %}
|
|
|
|
While executing a script you can add a condition to stop further execution. When a condition does not return `true`, the script will finish. There are many different conditions which are documented at the [conditions page].
|
|
|
|
```yaml
|
|
condition: state
|
|
entity_id: device_tracker.paulus
|
|
state: 'home'
|
|
```
|
|
|
|
### {% linkable_title Delay %}
|
|
|
|
Delays are useful for temporarily suspending your script and start it at a later moment. We support different syntaxes for a delay as shown below.
|
|
|
|
```yaml
|
|
# Waits 1 hour
|
|
delay: 01:00
|
|
```
|
|
|
|
```yaml
|
|
# Waits 1 minute, 30 seconds
|
|
delay: 00:01:30
|
|
```
|
|
|
|
```yaml
|
|
# Waits 1 minute
|
|
delay:
|
|
# supports milliseconds, seconds, minutes, hours, days
|
|
minutes: 1
|
|
```
|
|
|
|
```yaml
|
|
# Waits however many minutes input_number.minute_delay is set to
|
|
# Valid formats include HH:MM and HH:MM:SS
|
|
delay: {% raw %}'00:{{ states.input_number.minute_delay.state | int }}:00'{% endraw %}
|
|
```
|
|
### {% linkable_title Wait %}
|
|
|
|
Wait until some things are complete. We support at the moment `wait_template` for waiting until a condition is `true`, see also on [Template-Trigger](/docs/automation/trigger/#template-trigger). It is possible to set a timeout after which the script will abort its execution if the condition is not satisfied. Timeout has the same syntax as `delay`.
|
|
|
|
```yaml
|
|
# wait until media player have stop the playing
|
|
wait_template: {% raw %}"{{ states.media_player.floor.state == 'stop' }}"{% endraw %}
|
|
```
|
|
|
|
```yaml
|
|
# wait until a valve is < 10 or abort after 1 minutes.
|
|
wait_template: {% raw %}"{{ states.climate.kitchen.attributes.valve < 10 }}"{% endraw %}
|
|
timeout: 00:01:00
|
|
```
|
|
|
|
When using `wait_template` within an automation `trigger.entity_id` is supported for `state`, `numeric_state` and `template` triggers, see also [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).
|
|
|
|
{% raw %}
|
|
```yaml
|
|
wait_template: "{{ is_state(trigger.entity_id, 'on') }}"
|
|
```
|
|
{% endraw %}
|
|
|
|
It is also possible to use dummy variables, e.g., in scripts, when using `wait_template`.
|
|
|
|
{% raw %}
|
|
```yaml
|
|
# Service call, e.g. from an automation.
|
|
service: script.do_something
|
|
data_template:
|
|
dummy: "{{ input_boolean.switch }}"
|
|
|
|
# Inside the script
|
|
wait_template: "{{ is_state(dummy, 'off') }}"
|
|
```
|
|
{% endraw %}
|
|
|
|
### {% linkable_title Fire an Event %}
|
|
|
|
This action allows you to fire an event. Events can be used for many things. It could trigger an automation or indicate to another component that something is happening. For instance, in the below example it is used to create an entry in the logbook.
|
|
|
|
```yaml
|
|
event: LOGBOOK_ENTRY
|
|
event_data:
|
|
name: Paulus
|
|
message: is waking up
|
|
entity_id: device_tracker.paulus
|
|
domain: light
|
|
```
|
|
|
|
[Script component]: /components/script/
|
|
[automations]: /getting-started/automation-action/
|
|
[Alexa/Amazon Echo]: /components/alexa/
|
|
[service calls page]: /getting-started/scripts-service-calls/
|
|
[conditions page]: /getting-started/scripts-conditions/
|