Skip to content

Add Deadlock (SecureMode) support to the Yale Access Bluetooth integration #144107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: dev
Choose a base branch
from

Conversation

michaelp1742
Copy link

@michaelp1742 michaelp1742 commented May 2, 2025

Proposed change

Yale locks such as the YUR/DEL/1/SIL have a deadlock mode as well as the external locked state.

These Yale locks have three valid end-states, Unlocked, Locked, and Deadlocked (SecureMode). The lock can be Deadlocked directly while Locked or Unlocked but a Deadlocked lock can only be unlocked.

This PR adds support for both the SecureMode command and status reporting.

Lock status reporting simply treats SecureMode as equivalent to a Locked state.
The SecureMode command is implemented as a second lock which deadlocks the lock when switched on and unlocks it when switched off. The lock is disabled by default as the majority of Yale locks do not implement SecureMode and the lock should be enabled for testing by the end user.

Type of change

  • [x ] Bugfix (non-breaking change which fixes an issue)
  • [x ] New feature (which adds functionality to an existing integration)

Additional information

  • This PR requires an updated yalexs-ble library

Checklist

  • [x ] The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • [x ] There is no commented out code in this PR.
  • [x ] I have followed the development checklist
  • I have followed the perfect PR recommendations
  • [x ] The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • [ x] The [manifest file has been updated to refer to the updated yalexs-ble library

@michaelp1742 michaelp1742 requested a review from bdraco as a code owner May 2, 2025 15:22
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @michaelp1742,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <[email protected]>"
      
      (substituting "Author Name" and "[email protected]" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@home-assistant
Copy link

home-assistant bot commented May 2, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant
Copy link

home-assistant bot commented May 2, 2025

Hey there @bdraco, mind taking a look at this pull request as it has been labeled with an integration (yalexs_ble) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of yalexs_ble can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign yalexs_ble Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @michaelp1742

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@bdraco
Copy link
Member

bdraco commented May 7, 2025

@michaelp1742 Hey, just checking in—were you planning to continue with this PR? If not, that’s totally fine. I’d like to keep working on the integration, but the current breaking changes are blocking further progress. If you don’t plan to continue, I’ll need to revert the changes to yalexs-ble so I can move forward with a new release and some other improvements. Thanks for understanding!

@bdraco
Copy link
Member

bdraco commented May 7, 2025

I’m not sure it’s a good idea to implement this as a switch, since that would bypass standard voice assistant safeguards for unlocking. For security reasons, it would be better to expose this as a separate lock entity—perhaps something like secure_mode_lock. That way, we retain the existing lock behavior while giving users an explicit and guarded way to enable secure mode.

@bdraco
Copy link
Member

bdraco commented May 7, 2025

This approach works fine. The secure mode lock will still engage even if the device doesn't support secure mode, but it won't indicate that it's in secure mode in that case.

I think we can merge this after the docs are updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants