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-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document zwave_js.ping service (#18196)

Browse Source
This commit is contained in:
Raman Gupta 2021-06-14 16:39:43 -04:00 committed by GitHub
parent 3336b24534
commit b036d67d20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_integrations/zwave_js.markdown
View File

@ -220,6 +220,31 @@ This service will set a value on a Z-Wave device. It is for advanced use cases w
| `value` | yes | The new value that you want to set. | | `value` | yes | The new value that you want to set. |
| `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. | | `wait_for_result` | no | Boolean that indicates whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. |
### Service `zwave_js.ping`
Calling this service forces Z-Wave JS to try to reach a node. This can be used to update the status of the node in Z-Wave JS when you think it doesn't accurately reflect reality, e.g. reviving a failed/dead node or marking the node as asleep.
| Service Data Attribute | Required | Description |
|------------------------ |---------- |-------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Entity (or list of entities) to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided. |
| `device_id` | no | ID of device to set the configuration parameter on. At least one `entity_id` or `device_id` must be provided. |
This service can be used in tandem with the node status sensor (disabled by default) to track the node's status and fire the command when needed. Here's an example automation that would ping a node when the node status sensor state has changed to dead and remained dead for 30 minutes. Note that this may be useful for some devices but will definitely not be useful for all. In cases where it is not useful, all you will be doing is generating additional traffic on your Z-Wave network which could slow down communication.
```yaml
trigger:
platform: state
entity_id:
- sensor.z_wave_thermostat_node_status
- sensor.z_wave_lock_node_status
to: "dead"
for: "00:30:00"
action:
- service: zwave_js.ping
target:
entity_id: "{{ trigger.entity_id }}"
```
### Service `zwave_js.set_lock_usercode` ### Service `zwave_js.set_lock_usercode`
This service will set the usercode of a lock to X at code slot Y. This service will set the usercode of a lock to X at code slot Y.