Unofficial Home Assistant integration for Homely alarm systems with real-time WebSocket updates and periodic API synchronization.
The integration is read-only. It monitors alarm, lock, sensor, battery, and connection states but cannot arm, disarm, lock, or unlock devices.
See documentation.md for runtime behavior, entity details, API limitations, Repairs, reauthentication, and troubleshooting.
- Live alarm and device-state updates through WebSocket events
- Device discovery and periodic reconciliation through the Homely
/homeAPI - Alarm control panel and state-only lock entities
- Automatic sensors based on the features Homely exposes for each device
- Multiple Homely homes, including an Add all homes setup option
- Cached state during restarts and temporary API outages
- Diagnostic entities, System Health information, downloadable diagnostics, and Repairs for confirmed stale devices
Make sure HACS is installed.
Open the repository in HACS, select Download, and restart Home Assistant.
- Download the latest release.
- Copy
custom_components/homelyto/config/custom_components/homely. - Restart Home Assistant.
- Go to Settings > Devices & services.
- Select Add integration and search for Homely.
- Enter the email address and password for your Homely account.
- If the account has multiple homes, select one home or Add all homes.
Each home is created as a separate config entry. Homes that are already configured are skipped.
Start by checking:
- The Homely email address and password are correct.
- The expected home was selected during setup if you have multiple homes.
- The integration is updated to the latest available version.
- Live update connection status and Last cloud API poll on the Homely home device.
- Settings > System > Logs for Homely errors.
To enable debug logging from YAML:
logger:
default: info
logs:
custom_components.homely: debug
homely: debugYou can also select Enable debug logging from the integration menu. Download diagnostics from the affected Homely config entry when reporting missing devices or entities. Review diagnostic files before sharing them.
Use the matching issue form:
Entities are created from the features present in the Homely API payload. Common Frient sensors, HAN meters, Yale Doorman, and similar locks are supported when Homely exposes the required data.
A device visible in the Homely app may still be absent or incomplete in the API. The integration cannot add data that Homely does not expose. See the detailed device and entity coverage before reporting a missing device.
Contributions are welcome. Before opening a pull request, run:
python -m ruff check custom_components testspytestpython -m mypy --config-file mypy.ini -p custom_components.homely
- Created by: Ludvik
- Inspired by: Homely MQTT Add-on
- License: MIT
This project is not affiliated with Homely. It relies on Homely cloud services and APIs, which may change.