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

Update dev-tools.markdown (#17628)

Browse Source 
Developer Tools/Events documentation is incomplete. This adds documents for event subscription.
This commit is contained in:
Ron Schaeffer 2021-04-28 12:05:01 +01:00 committed by GitHub
parent 47029bd9d2
commit 500c62fb67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_docs/tools/dev-tools.markdown
View File

@ -54,9 +54,12 @@ For example, changing the `light.bedroom` state from `off` to `on` does not turn
## Events
This Events section is as basic as it can get. It does only one thing – fires events on the event bus.
In the Events section, you can either fire an event on the event bus or subscribe to an event type in order to view the event data JSON.
### Fire an event
To fire an event, simply type the name of the event, and pass the event data in JSON format.
For ex: To fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as
For example, to fire a custom event, enter the `event_type` as `event_light_state_changed` and the event data JSON as
```yaml
state: on
@ -75,6 +78,32 @@ If there is an automation that handles that event, it will be automatically trig
message: "Light is turned {{ trigger.event.data.state }}"
```
### Subscribe to an event
To subscribe to an event, enter the event event type under "Listen to events" and click "Start listening". Some events types are listed in the Events section under "Available events". You can usually find information about event types for a particular integration in its documentation. You can then examine the event data JSON to find the correct parameters for your automations.
For example, subscribing to the event type `shelly.click` of the Shelly integration, returns event data JSON similar to the following on a button press.
```json
Event 0 fired 9:53 AM:
{
"event_type": "shelly.click",
"data": {
"device_id": "e09c64a22553484d804353ef97f6fcd6",
"device": "shellybutton1-A4C12A45174",
"channel": 1,
"click_type": "single"
},
"origin": "LOCAL",
"time_fired": "2021-04-28T08:53:12.755729+00:00",
"context": {
"id": "e0f379706563aaa0c2c1fda5174b5a0e",
"parent_id": null,
"user_id": null
}
}
```
## Template Editor
The Template Editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.