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 of
yalexs-ble
. - This is an implementation of work done to integrate activity into Home Assistant Core.
- The ideas were rejected from HA Core because there is not yet a standard architecture for recording historic state changes.
Installation through HACS is the preferred installation method.
- Go to the HACS dashboard.
- Click the ellipsis menu (three dots) in the top right → choose Custom repositories.
- Enter the URL of this GitHub repository,
https://github.com/wbyoung/yalexs-ble-activity
, in the Repository field. - Select Integration as the category.
- Click Add.
- Search for "Yale Access Bluetooth Activity" → select it → press DOWNLOAD.
- Press DOWNLOAD.
- Select the version (it will auto select the latest) → press DOWNLOAD.
- Restart Home Assistant then continue to the setup section.
- Go to the release page and download the
yalexs_ble_activity.zip
attached to the latest release. - Unpack the zip file and move
custom_components/yalexs_ble_activity
to the following directory of your Home Assistant configuration:/config/custom_components/
. - Restart Home Assistant then continue to the setup section.
Open your Home Assistant instance and start setting up by following these steps:
- Navigate to "Settings" → "Devices & Services"
- Click "+ Add Integration"
- Search for and select → "Yale Access Bluetooth Activity"
Or you can use the My Home Assistant Button below.
Follow the instructions to configure the integration.
One sensor entity is created for each selected lock:
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
timestamp
: The time of the activity.source
: The source of a lock operation. Possible values:remote
,manual
,auto_lock
,pin
orunknown
. 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 withsource=pin
.
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.<lock_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.)
entity_id
: The entity ID of thesensor.<lock_name>_operation
with the activity.state
: The state of the activity which mirrors that ofsensor.<lock_name>_operation
.attributes
: The attributes for the activity which mirrors that of thesensor.<lock_name>_operation
attributes.