diff --git a/source/_integrations/schlage.markdown b/source/_integrations/schlage.markdown index 2ec524011608..53bf3ecafdd1 100644 --- a/source/_integrations/schlage.markdown +++ b/source/_integrations/schlage.markdown @@ -69,6 +69,98 @@ Once you have enabled the Schlage integration, you should see the following swit - **1-Touch Locking** - When enabled, locks the lock with a press of the Schlage button. - **Keypress Beep** - Controls whether the lock will emit beeping tones on use. +## Actions + +### Action: Get Codes + +You can use the `schlage.get_codes` action to retrieve the codes stored on your lock. This action returns all codes related to the Entity ID. + +{% details "Get codes action details" %} + +| Data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------- | --------| +| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` | + +{% raw %} + +```yaml +# Example action +action: schlage.get_codes +data: + entity_id: + - lock.front_door +``` + +The returned codes will be in the following format: + +```yaml +lock.front_door: + 93ab517c-0000-0000-0000-000000000000: + name: Example Person + code: "3333" + 82958b77-0000-0000-0000-000000000000: + name: Example person 2 + code: "2222" +``` + +{% endraw %} + +{% enddetails %} + +### Action: Add Code + +You can use the `schlage.add_code` action to add a new code to your lock. The code must be between 4 and 8 digits long. + +{% details "Add code action details" %} + +| Data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------- | --------| +| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` | +| `name` | no | Name for the code | `Example Person` | +| `code` | no | Code to add (4-8 digits) | `3333` | + +{% raw %} + +```yaml +# Example action +action: schlage.add_code +data: + entity_id: + - lock.front_door + name: Example Person + code: "3333" +``` + +{% endraw %} + +{% enddetails %} + +### Action: Delete Code + +You can use the `schlage.delete_code` action to delete a code from your lock. + +{% details "Delete code action details" %} + +| Data attribute | Optional | Description | Example | +| ---------------------- | -------- | ----------- | --------| +| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` | +| `name` | no | Name for the code to delete. The name evaluation for deletion is case insensitive | `Example Person` | + +{% raw %} + +```yaml +# Example action +action: schlage.delete_code +data: + entity_id: + - lock.front_door + name: Example Person +``` + +{% endraw %} + +{% enddetails %} + ## Removing the integration This integration follows standard integration removal. No extra steps are required.