Document zwave_js.set_lock_configuration service (#29768)

* Document zwave_js.set_lock_configuration service

* Remove handle params
This commit is contained in:
Raman Gupta 2023-11-15 11:57:58 -05:00 committed by GitHub
parent 5d54313dcb
commit f0801e44ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -413,6 +413,20 @@ This service will reset the meters on a device that supports the Meter Command C
| `meter_type` | no | If supported by the device, indicates the type of meter to reset. Not all devices support this option. |
| `value` | no | If supported by the device, indicates the value to reset the meter to. Not all devices support this option. |
### Service `zwave_js.set_lock_configuration`
This service will set the configuration of a lock.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | no | Lock entity or list of entities to set the usercode. |
| `operation_type` | yes | Lock operation type, one of `timed` or `constant`. |
| `lock_timeout` | no | Seconds until lock mode times out. Should only be used if operation type is `timed`. |
| `auto_relock_time` | no | Duration in seconds until lock returns to secure state. Only enforced when operation type is `constant`. |
| `hold_and_release_time` | no | Duration in seconds the latch stays retracted. |
| `twist_assist` | no | Enable Twist Assist. |
| `block_to_block` | no | Enable block-to-block functionality. |
### Service `zwave_js.set_lock_usercode`
This service will set the usercode of a lock to X at code slot Y.