https://github.com/wbyoung/yalexs-ble-activity
Yale Access Bluetooth Activity
https://github.com/wbyoung/yalexs-ble-activity
august home-assistant smart-lock yale
Last synced: about 1 month ago
JSON representation
Yale Access Bluetooth Activity
- Host: GitHub
- URL: https://github.com/wbyoung/yalexs-ble-activity
- Owner: wbyoung
- License: apache-2.0
- Created: 2025-09-04T23:18:14.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-12-11T01:40:03.000Z (6 months ago)
- Last Synced: 2025-12-11T16:33:59.635Z (6 months ago)
- Topics: august, home-assistant, smart-lock, yale
- Language: Python
- Homepage:
- Size: 43 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Yale Access Bluetooth Activity for Home Assistant
[][hacs-repo]
[][hacs-repo]
[][releases]
[][gh-sponsors]
Activity history sensor for Yale Access Bluetooth.
Disclaimers:
- Enabling this integration for a lock will consume activity from the lock. This means that the activity **will not be available** to the Yale mobile app.
- This installs a [custom patched version](https://github.com/wbyoung/yalexs-ble/branches) of [`yalexs-ble`](https://github.com/Yale-Libs/yalexs-ble).
- This is an implementation of work done to [integrate activity into Home Assistant Core](https://github.com/home-assistant/core/pull/151436#issuecomment-3243330215).
- The ideas were rejected from HA Core because there is not yet a standard architecture for [recording historic state changes](https://github.com/home-assistant/architecture/discussions/580).
## Installation
### HACS
Installation through [HACS][hacs] is the preferred installation method.
1. Go to the HACS dashboard.
1. Click the ellipsis menu (three dots) in the top right → choose _Custom repositories_.
1. Enter the URL of this GitHub repository,
`https://github.com/wbyoung/yalexs-ble-activity`, in the _Repository_ field.
1. Select _Integration_ as the category.
1. Click _Add_.
1. Search for "Yale Access Bluetooth Activity" → select it → press _DOWNLOAD_.
1. Press _DOWNLOAD_.
1. Select the version (it will auto select the latest) → press _DOWNLOAD_.
1. Restart Home Assistant then continue to [the setup section](#setup).
### Manual Download
1. Go to the [release page][releases] and download the `yalexs_ble_activity.zip` attached
to the latest release.
1. Unpack the zip file and move `custom_components/yalexs_ble_activity` to the following
directory of your Home Assistant configuration: `/config/custom_components/`.
1. Restart Home Assistant then continue to [the setup section](#setup).
## Setup
Open your Home Assistant instance and start setting up by following these steps:
1. Navigate to "Settings" → "Devices & Services"
1. Click "+ Add Integration"
1. Search for and select → "Yale Access Bluetooth Activity"
Or you can use the My Home Assistant Button below.
[][config-flow-start]
Follow the instructions to configure the integration.
## Entities
One _sensor_ entity is created for each selected lock:
### `sensor._operation`
The last operation of the door or lock. One of:
- `door_unknown`
- `door_closed`
- `door_ajar`
- `door_opened`
- `lock_unknown`
- `lock_unlocking`
- `lock_unlocked`
- `lock_locking`
- `lock_locked`
The sensor value will only change to the most recent value obtained and will skip over activity to avoid rapid state changes. To create automations that trigger on any activity, use the [`yalexs_ble_activity` event](#yalexs_ble_activity)
#### Attributes
- `timestamp`: The time of the activity.
- `source`: The source of a lock operation. Possible values: `remote`, `manual`, `auto_lock`, `pin` or `unknown`. Not present for door related activity.
- `remote_type`: The type of remote operation performed. Not present for door related activity.
- `slot`: This is a unique integer representing the code used. Only present for unlock activity with `source=pin`.
## Events
### `yalexs_ble_activity`
An event emitted immediately when new activity is received.
This will be triggered for all activity that is received from the lock regardless of how old it is. Even for the most recent activity, however, the state of the [`sensor._operation`](#sensorlock_name_operation) sensor entity will not yet be updated at the time this event is fired. (State updates are deferred for a short period to ensure all activity has been read from the lock.)
#### Event Data
- `entity_id`: The entity ID of the [`sensor._operation`](#sensorlock_name_operation) with the activity.
- `state`: The state of the activity which mirrors that of [`sensor._operation`](#sensorlock_name_operation).
- `attributes`: The attributes for the activity which mirrors that of the [`sensor._operation`](#sensorlock_name_operation) attributes.
[config-flow-start]: https://my.home-assistant.io/redirect/config_flow_start/?domain=yalexs_ble_activity
[hacs]: https://hacs.xyz/
[hacs-repo]: https://github.com/hacs/integration
[hacs-badge]: https://my.home-assistant.io/badges/hacs_repository.svg
[hacs-open]: https://my.home-assistant.io/redirect/hacs_repository/?owner=wbyoung&repository=yalexs-ble-activity&category=integration
[releases]: https://github.com/wbyoung/yalexs-ble-activity/releases
[gh-sponsors]: https://github.com/sponsors/wbyoung