Skip to content

wbyoung/yalexs-ble-activity

Repository files navigation

Yale Access Bluetooth Activity for Home Assistant

HACS HACS installs Version Downloads Build Github Sponsors

Activity history sensor for Yale Access Bluetooth.

Disclaimers:

Installation

HACS

Installation through HACS is the preferred installation method.

  1. Go to the HACS dashboard.
  2. Click the ellipsis menu (three dots) in the top right → choose Custom repositories.
  3. Enter the URL of this GitHub repository, https://github.com/wbyoung/yalexs-ble-activity, in the Repository field.
  4. Select Integration as the category.
  5. Click Add.
  6. Search for "Yale Access Bluetooth Activity" → select it → press DOWNLOAD.
  7. Press DOWNLOAD.
  8. Select the version (it will auto select the latest) → press DOWNLOAD.
  9. Restart Home Assistant then continue to the setup section.

Manual Download

  1. Go to the release page and download the yalexs_ble_activity.zip attached to the latest release.
  2. Unpack the zip file and move custom_components/yalexs_ble_activity to the following directory of your Home Assistant configuration: /config/custom_components/.
  3. Restart Home Assistant then continue to the setup section.

Setup

Open your Home Assistant instance and start setting up by following these steps:

  1. Navigate to "Settings" → "Devices & Services"
  2. Click "+ Add Integration"
  3. Search for and select → "Yale Access Bluetooth Activity"

Or you can use the My Home Assistant Button below.

Add Integration

Follow the instructions to configure the integration.

Entities

One sensor entity is created for each selected lock:

sensor.<lock_name>_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

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.<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.)

Event Data

About

Yale Access Bluetooth Activity

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published