hass-ttlock

Home Assistant integration for TTLock based locks.

Overview

This integration uses the TTLock Cloud to communicate with your lock. It supports the following features:

• Locking and unlocking
• Discovery of locks on startup
• Real-time updates via a webhook (no periodic polling which wastes battery)
• Additional sensors for battery, last operator + reason
• Add new pass codes
• Delete expired pass codes

Known working locks

If this integration is working for you, please leave a comment here

• Catchface Smart Lock
• Cielsa Dawn Fingerprint Digital Doorknob
• E-Lok 9 series
• Raykube locks
• Simpled locks
• TOTOWISER locks
• YRHAND locks

Usage

Requirements

1. A TTLock based smart lock
2. A Gateway (if your lock doesn't have integrated wifi)
   • These can be purchased from the vendor of your lock or direct from Aliexpress

Creating an OAuth APP

1. Go to https://open.ttlock.com/manager and create an account
2. Register an application (this will take a few days to get approved)
3. Install the extension via HACS and restart Home Assistant
4. Setup the integration via Home Assistant UI
5. Once the integration is working you should receive a system notification with the webhook url
   • This will go away when the webhook receives data
6. Go back to the url from the first step and set the 'Callback URL' for your application

Reporting issues

When reporting issues, please attach the diagnostic information and consider enabling debug logging to provide extra information.

Say thanks

If you found this helpful and you'd like to say thanks you can do so via buy me a coffee. Thanks!