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 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak "event" script action documentation (#16400)

Browse Source
This commit is contained in:
Erik Montnemery 2021-02-05 13:46:32 +01:00 committed by GitHub
parent 9267e660f7
commit 94aedbd415
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_docs/scripts.markdown
View File

@ -272,6 +272,8 @@ This action allows you to fire an event. Events can be used for many things. It
You can also use event_data to fire an event with custom data. This could be used to pass data to another script awaiting You can also use event_data to fire an event with custom data. This could be used to pass data to another script awaiting
an event trigger. an event trigger.
The `event_data` accepts templates.
{% raw %} {% raw %}
```yaml ```yaml
@ -285,7 +287,7 @@ an event trigger.
### Raise and Consume Custom Events ### Raise and Consume Custom Events
The following automation shows how to raise a custom event called `event_light_state_changed` with `entity_id` as the event data. The action part could be inside a script or an automation. The following automation example shows how to raise a custom event called `event_light_state_changed` with `entity_id` as the event data. The action part could be inside a script or an automation.
```yaml ```yaml
- alias: Fire Event - alias: Fire Event
@ -299,7 +301,7 @@ The following automation shows how to raise a custom event called `event_light_s
state: "on" state: "on"
``` ```
The following automation shows how to capture the custom event `event_light_state_changed`, and retrieve corresponding `entity_id` that was passed as the event data. The following automation example shows how to capture the custom event `event_light_state_changed` with an [Event Automation Trigger](/docs/automation/trigger#event-trigger), and retrieve corresponding `entity_id` that was passed as the event trigger data, see [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data) for more details.
{% raw %} {% raw %}