Skip to content

Commit ebf5852

Browse files
committed
Docs(schlage): Add door code management actions
Adds documentation for new actions to manage door codes on Schlage locks. Signed-off-by: Andrew Grimberg <[email protected]>
1 parent a6bf898 commit ebf5852

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

source/_integrations/schlage.markdown

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,98 @@ Once you have enabled the Schlage integration, you should see the following swit
6969
- **1-Touch Locking** - When enabled, locks the lock with a press of the Schlage button.
7070
- **Keypress Beep** - Controls whether the lock will emit beeping tones on use.
7171

72+
## Actions
73+
74+
### Action schlage.get_codes
75+
76+
You can use the `schlage.get_codes` action to retrieve the codes stored on your lock. The codes are returned as an object with all codes under the lock entity_id.
77+
78+
{% details "Get codes action details" %}
79+
80+
| Data attribute | Optional | Description | Example |
81+
| ---------------------- | -------- | ----------- | --------|
82+
| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` |
83+
84+
{% raw %}
85+
86+
```yaml
87+
# Example action
88+
action: schlage.get_codes
89+
data:
90+
entity_id:
91+
- lock.front_door
92+
```
93+
94+
The returned codes will be in the following format:
95+
96+
```yaml
97+
lock.front_door:
98+
93ab517c-0000-0000-0000-000000000000:
99+
name: Example Person
100+
code: "3333"
101+
82958b77-0000-0000-0000-000000000000:
102+
name: Example person 2
103+
code: "2222"
104+
```
105+
106+
{% endraw %}
107+
108+
{% enddetails %}
109+
110+
### Action schlage.add_code
111+
112+
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.
113+
114+
{% details "Add code action details" %}
115+
116+
| Data attribute | Optional | Description | Example |
117+
| ---------------------- | -------- | ----------- | --------|
118+
| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` |
119+
| `name` | no | Name for the code | `Example Person` |
120+
| `code` | no | Code to add (4-8 digits) | `3333` |
121+
122+
{% raw %}
123+
124+
```yaml
125+
# Example action
126+
action: schlage.add_code
127+
data:
128+
entity_id:
129+
- lock.front_door
130+
name: Example Person
131+
code: "3333"
132+
```
133+
134+
{% endraw %}
135+
136+
{% enddetails %}
137+
138+
### Action schlage.delete_code
139+
140+
You can use the `schlage.delete_code` action to delete a code from your lock.
141+
142+
{% details "Delete code action details" %}
143+
144+
| Data attribute | Optional | Description | Example |
145+
| ---------------------- | -------- | ----------- | --------|
146+
| `entity_id` | no | Lock entity to use (one or more) | `lock.front_door` |
147+
| `name` | no | Name for the code to delete. The name evaluation for deletion is case insensitive | `Example Person` |
148+
149+
{% raw %}
150+
151+
```yaml
152+
# Example action
153+
action: schlage.delete_code
154+
data:
155+
entity_id:
156+
- lock.front_door
157+
name: Example Person
158+
```
159+
160+
{% endraw %}
161+
162+
{% enddetails %}
163+
72164
## Removing the integration
73165

74166
This integration follows standard integration removal. No extra steps are required.

0 commit comments

Comments
 (0)