OZW usercode documentation (#13950)

This commit is contained in:
Chris 2020-07-08 16:42:22 -07:00 committed by GitHub
parent df7cfc0600
commit 4bb4d292d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,13 +3,13 @@ title: OpenZWave (beta)
description: Instructions on how to integrate OpenZWave with Home Assistant.
ha_category:
- Switch
ha_release: '0.110'
ha_release: "0.110"
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@cgarwood'
- '@marcelveldt'
- '@MartinHjelmare'
- "@cgarwood"
- "@marcelveldt"
- "@MartinHjelmare"
ha_domain: ozw
---
@ -65,3 +65,24 @@ this operation.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------- |
| `instance_id` | no | The OZW Instance/Controller to use, defaults to 1. |
### Service `ozw.set_usercode`
This service will set the usercode to X at code_slot Y.
Valid usercodes are at least 4 digits.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------- |
| `entity_id` | yes | Lock entity to set the usercode. |
| `code_slot` | yes | The code slot to set the usercode into. |
| `usercode` | yes | The code to set in the slot. |
### Service `ozw.clear_usercode`
This service will clear the usercode in code_slot X.
Valid code_slots are 1-254.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------------------------------------- |
| `entity_id` | yes | Lock entity to clear the usercode. |
| `code_slot` | yes | The code slot to clear the usercode from. |