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