Skip to content

Conversation

@lboue
Copy link
Contributor

@lboue lboue commented Dec 9, 2025

Proposed change

Problem: The Door Lock Operating Mode selector was including all 5 operating modes unconditionally, but the Matter specification uses a bitmap attribute (SupportedOperatingModes) to indicate which modes a device actually supports.

Solution: Created a specialized MatterDoorLockOperatingModeSelectEntity class that:

  1. Reads the bitmap: Retrieves the SupportedOperatingModes bitmap from the device
  2. Extracts enabled bits: Converts the bitmap to bit positions (0-4, representing the 5 operating modes)
  3. Filters options dynamically: Only includes modes that the device supports
  4. Maintains translation support: Uses the full DOOR_LOCK_OPERATING_MODE_MAP for all possible translations

Key Features:

  • ✅ Respects Matter bitmap specification
  • ✅ Dynamically updates available modes based on device capabilities
  • ✅ Full translation support for all 5 operating modes (Normal, Vacation, Privacy, NoRemoteLockUnlock, Passage)
  • ✅ Handles enum to string conversion for user selection
  • ✅ Writes correct enum values when options are selected

SupportedOperatingModes Attribute

  • This attribute SHALL contain a bitmap with all operating bits of the OperatingMode attribute supported by the lock.
  • A bit position set to zero SHALL indicate that the mode is supported. A bit position set to one SHALL indicate that the mode is not supported.
  • Any bit that is not yet defined in OperatingModesBitmap SHALL be set to 1.

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

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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:

@home-assistant
Copy link

home-assistant bot commented Dec 9, 2025

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.

@lboue lboue changed the title Door_lock_operating_mode Matter Door Lock Operating Mode Bitmap Support Dec 9, 2025
@lboue lboue self-assigned this Dec 9, 2025
@lboue lboue added the bugfix label Dec 9, 2025
@lboue lboue marked this pull request as ready for review December 9, 2025 16:00
@lboue lboue requested a review from a team as a code owner December 9, 2025 16:00
Copilot AI review requested due to automatic review settings December 9, 2025 16:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a bug where the Matter Door Lock Operating Mode selector was showing all 5 operating modes regardless of device capabilities. The solution implements bitmap-based filtering using the Matter specification's SupportedOperatingModes attribute, where bit=0 indicates a supported mode and bit=1 indicates unsupported.

Key changes:

  • Created specialized MatterDoorLockOperatingModeSelectEntity class that reads and interprets the SupportedOperatingModes bitmap
  • Changed discovery schema to use MatterMapSelectEntityDescription with bitmap attribute support
  • Updated tests to verify bitmap-based filtering and only test with supported operating modes

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
homeassistant/components/matter/select.py Implements new MatterDoorLockOperatingModeSelectEntity class with bitmap interpretation logic and updates discovery schema to require SupportedOperatingModes attribute
tests/components/matter/test_select.py Updates test to verify bitmap-based filtering works correctly with fixture that has bits 0, 2, and 3 cleared (Normal, Privacy, NoRemoteLockUnlock supported)
tests/components/matter/snapshots/test_select.ambr Updates snapshots to reflect filtered options based on each fixture's bitmap values instead of showing all 5 modes

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@lboue lboue added this to the 2025.12.3 milestone Dec 9, 2025
@lboue lboue changed the title Matter Door Lock Operating Mode Bitmap Support Fixt Matter Door Lock Operating Mode select entity Dec 9, 2025
@lboue lboue changed the title Fixt Matter Door Lock Operating Mode select entity Fix Matter Door Lock Operating Mode select entity Dec 9, 2025
@lboue lboue requested a review from Apollon77 December 9, 2025 17:47
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.

Door Lock Operating Mode unsupported modes are displayed in the list.

2 participants