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-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document zwave_js.event automation trigger (#20877)

Browse Source 
* Add documentation for zwave_js.event automation trigger

* fix rebase

* fix rebase

* Add links to docs and add note about opening a GitHub issue

* Remove link from example

* fix lint

* Update source/_integrations/zwave_js.markdown

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Raman Gupta 2022-02-21 17:47:42 -05:00 committed by GitHub
parent e45e8eb52e
commit 26421219ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
source/_integrations/zwave_js.markdown
View File

@ -476,6 +476,46 @@ In addition to the [standard automation trigger data](/docs/automation/templatin
| `trigger.current_value` | The current value for this Z-Wave value (translated to a state name when possible). |
| `trigger.current_value_raw` | The raw current value for this Z-Wave value (the key of the state when a state is named). |
### `zwave_js.event`
This trigger platform can be used to trigger automations on any Z-Wave JS controller, driver, or node event, including events that may not be handled by Home Assistant automatically. Refer to the linked [Z-Wave JS documentation](https://zwave-js.github.io/node-zwave-js/#/) to learn more about the available events and the data that is sent along with it.
There is strict validation in place based on all known event types, so if you come across an event type that isn't supported, please open a GitHub issue in the `home-assistant/core` repository.
#### Example automation trigger configuration
```yaml
# Fires whenever the `interview failed` event is fired on the three devices (devices will be derived from device and entity IDs).
trigger:
platform: zwave_js.event
# At least one `device_id` or `entity_id` must be provided for `node` events. For any other events, a `config_entry_id` needs to be provided.
device_id: 45d7d3230dbb7441473ec883dab294d4 # Garage Door Lock device ID
entity_id:
- lock.front_lock
- lock.back_door
config_entry_id:
# `event_source` and `event` are required
event_source: node # options are node, controller, and driver
event: "interview failed" # event names can be retrieved from the Z-Wave JS docs (see links above)
# `event_data` and `partial_dict_match` are optional. If `event_data` isn't included, all events of a given type for the given context will trigger the automation. When the `interview failed` event is fired, all argument live in a dictionary within the `event_data` dictionary under the `args` key. The default behavior is to require a full match of the event_data dictionary below and the dictionary that is passed to the event. By setting `partial_dict_match` to true, Home Assistant will check if the isFinal argument is true and ignore any other values in the dictionary. If this setting was false, this trigger would never fire because the dictionary always contains more keys than `isFinal` so the comparsion check would never evaluate to true.
event_data:
args:
isFinal: true
partial_dict_match: true # defaults to false
```
#### Available Trigger Data
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.event` trigger platform has additional trigger data available for use.
| Template variable | Data |
|------------------------------|--------------------------------------------------------------------------------------------|
| `trigger.device_id` | Device ID for the device in the device registry (only included for node events). |
| `trigger.node_id` | Z-Wave node ID (only included for node events). |
| `trigger.event_source` | Source of event (node, controller, or driver). |
| `trigger.event` | Name of event. |
| `trigger.event_data` | Any data included in the event. |
## Migrating from previous Z-Wave implementations
If you are switching from the `zwave` or `ozw` integrations to the new Z-Wave JS integration, you will not need to recreate your entire network, as the network is **stored on your stick**. A few things, such as how you receive [central scene events](#events) will work differently than they did before.