Integration to integrate with KevinBonnoron/the_keys.
This integration will set up the following platforms.
| Platform | Description |
|---|---|
lock |
Allow to change and see the lock status. |
sensor |
Show accurate battery percentage (calibrated from real data). |
button |
Buttons for calibrate and sync operations (visible in Controls dashboard). |
Buttons:
- Calibrate - Calibrate the lock mechanism
- Sync - Sync lock state with the cloud
Custom Services:
| Service | Description |
|---|---|
the_keys.calibrate |
Calibrate the lock mechanism (for automations/scripts) |
the_keys.sync |
Sync lock state with the cloud (for automations/scripts) |
Note: Both button entities (for manual use in UI) and services (for automations) are available for calibrate and sync operations.
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml). - If you do not have a
custom_componentsdirectory (folder) there, you need to create it. - In the
custom_componentsdirectory (folder) create a new folder calledthe_keys. - Download all the files from the
custom_components/the_keys/directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Restart Home Assistant
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "The Keys"
- Username: Your phone number in international format (e.g., +33...)
- Password: Your The Keys account password
- Gateway IP (optional): Manual gateway IP/hostname if auto-discovery fails
- Scan Interval: How often to poll for updates (minimum 10 seconds, default 60 seconds)
v1.2.0 (2026-01-30)
- ✓ Battery Accuracy Fix: Battery percentages now accurately reflect real values (±1% accuracy)
- Previous version overestimated by 5-9%
- Uses linear regression calibrated from real device data
- ✓ Gateway Rate Limiting: Prevents timeouts and gateway overload
- Heavy operations (open/close/calibrate/status): 8 second delay
- Light operations (status/list/sync): 2 second delay
- Per-gateway instance rate limiting
If you want to contribute to this please read the Contribution guidelines