Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix state for Matter Locks (including optional door sensor)#121665

Merged
edenhaus merged 2 commits into
devfrom
matter-lock-state
Jul 10, 2024
Merged

Fix state for Matter Locks (including optional door sensor)#121665
edenhaus merged 2 commits into
devfrom
matter-lock-state

Conversation

@marcelveldt
Copy link
Copy Markdown
Member

@marcelveldt marcelveldt commented Jul 10, 2024

Proposed change

After some back-and-forth with Nuki (the smart lock manufacturer) we came to the conclusion that a few assumption of translating the door lock state were wrong. This PR corrects that:

  • Only signal state 'open' if the door lock state is 'unlatched'
  • Only signal state 'locked' if the lock state is literally locked
  • Only signal state 'unlocked' if the lock state is literally unlocked (or NotFullyLocked)
  • Signal door lock state of 'unknown' (None) in all other cases
  • Treat the optional door sensor as separate binary sensor
  • Do not connect the door sensor state to the lock state
  • Use a timer to reset optimistic state of unlocking/locking/opening in case the lock does not send a notification

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • 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:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@marcelveldt marcelveldt requested a review from a team as a code owner July 10, 2024 08:26
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jul 10, 2024

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

Code owner commands

Code owners of matter 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 matter 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.

@marcelveldt marcelveldt mentioned this pull request Jul 10, 2024
Closed
19 tasks
@marcelveldt marcelveldt added this to the 2024.7.2 milestone Jul 10, 2024
edenhaus
edenhaus approved these changes Jul 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @marcelveldt 👍

@edenhaus edenhaus merged commit 6702d23 into dev Jul 10, 2024
@edenhaus edenhaus deleted the matter-lock-state branch July 10, 2024 08:32
@marcelveldt
Copy link
Copy Markdown
Member Author

marcelveldt commented Jul 10, 2024

test is broken - I'll do a follow up

MartinHjelmare
MartinHjelmare reviewed Jul 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Why did we merge with failing tests?

Comment thread homeassistant/components/matter/lock.py
self.async_write_ha_state()
# the lock should acknowledge the command with an attribute update
# but bad things may happen, so guard against it with a timer.
self._optimistic_timer = self.hass.loop.call_later(
Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Jul 10, 2024

Choose a reason for hiding this comment

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

We have the event helper async_call_later.

Copy link
Copy Markdown
Member Author

@marcelveldt marcelveldt Jul 10, 2024

Choose a reason for hiding this comment

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

what's the benefit of that ?

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Jul 10, 2024

Choose a reason for hiding this comment

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

It's an abstraction over the low level event loop API. Generally we want to use our helpers when we can.

Copy link
Copy Markdown
Member Author

@marcelveldt marcelveldt Jul 10, 2024

Choose a reason for hiding this comment

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

I have a follow-up PR open, I can use the helper right away

Copy link
Copy Markdown
Member Author

@marcelveldt marcelveldt Jul 10, 2024

Choose a reason for hiding this comment

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

Tried implementing it with the async_call_later helper but didn't like it. I needed more (and ugly) code to use it with a regular callback instead of coroutine. I think there's something wrong with the typing of that helper as it does seem to accept a callback but the type hint simply doesn't allow it.

Anyways, me and @edenhaus decided to leave it as-is for now and look at async_call_later another day. Something flaky there

Copy link
Copy Markdown
Member Author

@marcelveldt marcelveldt Jul 10, 2024

Choose a reason for hiding this comment

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

image

image

image

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Jul 10, 2024

Choose a reason for hiding this comment

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

The callback should accept a single datetime parameter.

Copy link
Copy Markdown
Member Author

@marcelveldt marcelveldt Jul 10, 2024

Choose a reason for hiding this comment

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

I just want to mimic the behavior of loop.call_later --> call a callback method after X period of time.
It does work with that helper but mypy chokes

@marcelveldt
Copy link
Copy Markdown
Member Author

marcelveldt commented Jul 10, 2024

Why did we merge with failing tests?

Apparently it showed as green for @edenhaus
We'll do a quick follow-up with a fix for the test

@marcelveldt marcelveldt mentioned this pull request Jul 10, 2024
Merged
19 tasks
frenck pushed a commit that referenced this pull request Jul 10, 2024
@marcelveldt @frenck
Fix state for Matter Locks (including optional door sensor) (#121665)
2151086
@frenck frenck mentioned this pull request Jul 10, 2024
Merged
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@MartinHjelmare MartinHjelmare MartinHjelmare left review comments

@edenhaus edenhaus edenhaus approved these changes

Assignees

No one assigned

Labels

bugfix by-code-owner cherry-picked cla-signed integration: matter Quality Scale: No score

Projects

None yet

Milestone

2024.7.2

Development

Successfully merging this pull request may close these issues.

4 participants

@marcelveldt @MartinHjelmare @edenhaus @frenck