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-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update zwave_js docs to reflect changes in Z-Wave JS 7.0.0 (#17053)

Browse Source 
* Update docs to reflect changes in Z-Wave JS 7.0.0 and to add the new notification event type

* grammar

* grammar

* fix event names

* grammar

* remove type from value notification event

* 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 2021-03-30 16:51:07 -04:00 committed by GitHub
parent 3b38e3ae83
commit 17072f3ee4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/_integrations/zwave_js.markdown
View File

@ -214,33 +214,58 @@ Valid code slots are between 1-254.
## Events ## Events
Events are fired when you press a button on a remote (aka Central Scene support) or when a stateless value is being signalled by a device. You can test what events come in using the event {% my developer_events title="developer tools in Home Assistant" %} and subscribe to `zwave_js_event`. Once you know what the event data looks like, you can use this to create automations. There are two types of events that are fired, notification events and value notification events. You can test what events come in using the event {% my developer_events title="developer tools in Home Assistant" %} and subscribing to the `zwave_js_notification` or `zwave_js_value_notification` events respectively. Once you know what the event data looks like, you can use this to create automations.
### Node events (Notification) ### Node events (Notification)
These are events fired by the device using the notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event. Check the [Z-Wave JS notification event documentation](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotnotificationquot) for an explanation of the notification event data. These events fire with the `zwave_js_notification` event type.
#### Notification Command Class
These are notification events fired by devices using the Notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.
```json ```json
{ {
"type": "notification",
"domain": "zwave_js", "domain": "zwave_js",
"node_id": 1, "node_id": 1,
"home_id": "974823419", "home_id": "974823419",
"device_id": "ad8098fe80980974", "device_id": "ad8098fe80980974",
"label": "Keypad lock operation", "command_class": 113,
"command_class_name": "Notification",
"type": 6,
"event": 5,
"label": "Access Control",
"event_label": "Keypad lock operation",
"parameters": {"userId": 1} "parameters": {"userId": 1}
} }
``` ```
#### Entry Control Command Class
These are notification events fired by devices using the Entry Control command class.
```json
{
"domain": "zwave_js",
"node_id": 1,
"home_id": "974823419",
"device_id": "ad8098fe80980974",
"command_class": 111,
"command_class_name": "Entry Control",
"event_type": 6,
"data_type": 5,
"event_data": "555"
}
```
## Scene events (Value Notification) ## Scene events (Value Notification)
Value Notifications are used for stateless values, like `Central Scenes` and `Scene Activation`. Value Notifications are used for stateless values, like `Central Scenes` and `Scene Activation`. These events fire with the `zwave_js_value_notification` event type.
Value Notification example: Value Notification example:
```json ```json
{ {
"type": "value_notification",
"domain": "zwave_js", "domain": "zwave_js",
"node_id": 1, "node_id": 1,
"home_id": "974823419", "home_id": "974823419",