Schlage
The Schlage integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides connectivity with Schlage WiFi smart locks through Schlage’s cloud API.
Known working devices
- Schlage Encode Smart WiFi Deadbolt
- Schlage Encode Smart WiFi Lever
- Schlage Encode Plus Smart WiFi Deadbolt
Other devices not listed above have not been tested and may not function as expected.
There is currently support for the following device types within Home Assistant:
- Binary sensor
- Lock
- Sensor
- Switch
Configuration
To add the Schlage hub to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Schlage.
-
Follow the instructions on screen to complete the setup.
Data updates
The Schlage integration fetches updated lock state data every 30 seconds.
Binary sensor
Once you have enabled the Schlage integration, you should see the following binary sensor:
- Keypad disabled - Indicates that the keypad has been disabled, typically due to too many incorrect lock codes being attempted.
Select
Once you have enabled the Schlage integration, you should see the following selects:
-
Auto Lock Time - Configure the time until the deadbolt automatically locks, or disable the auto-lock feature entirely. For example,
0: auto-lock is disabled,15: auto-lock after 15 seconds,300: auto-lock after 5 minutes.
Sensor
Once you have enabled the Schlage integration, you should see the following sensors:
- Lock Battery
Switch
Once you have enabled the Schlage integration, you should see the following switches:
- 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.
Get codes action details
| Data attribute | Optional | Description | Example |
|---|---|---|---|
entity_id |
no | Lock entity to use (one or more) | lock.front_door |
# Example action
action: schlage.get_codes
data:
entity_id:
- lock.front_door
The returned codes will be in the following format:
lock.front_door:
93ab517c-0000-0000-0000-000000000000:
name: Example Person
code: "3333"
82958b77-0000-0000-0000-000000000000:
name: Example person 2
code: "2222"
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.
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 |
# Example action
action: schlage.add_code
data:
entity_id:
- lock.front_door
name: Example Person
code: "3333"
Action: Delete Code
You can use the schlage.delete_code action to delete a code from your lock.
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 |
# Example action
action: schlage.delete_code
data:
entity_id:
- lock.front_door
name: Example Person
Removing the integration
This integration follows standard integration removal. No extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three dots
menu. Then, select Delete.