homematicip_cloud: fix HmIP-FLC lock state polarity

[lackas]

Breaking change

Proposed change

The HmIP-FLC Locked binary sensor returns the inverted state. It uses BinarySensorDeviceClass.LOCK, where the HA convention is ON = unlocked / open and OFF = locked / closed. The sensor currently returns ON when the API reports LOCKED, so it displays the opposite of the lock's actual state.

Reported on hahn-th/homematicip-rest-api#606 by a user with an HmIP-FLC. After receiving their diagnostics, the polarity turns out to depend on the channel's binaryBehaviorType configuration:

• NORMALLY_OPEN (default): contact closure (e.g. magnetic door contact registering door closed) puts the input in the active state, which the firmware reports as lockState=LOCKED. To present "door closed = off" in HA the value must be inverted.
• NORMALLY_CLOSE: the same physical event puts the input in the idle state, reported as lockState=UNLOCKED. Here the value must be used as-is.

The fix reads binaryBehaviorType from the channel and inverts conditionally, so HA shows the right state regardless of how the user wired the contact in the HmIP app. Tests cover all four combinations of binaryBehaviorType × lockState.

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: Add HMIP-FLC Universal Motorschloss Controller hahn-th/homematicip-rest-api#606
• Link to documentation pull request:
• Link to developer documentation pull request:
• Link to frontend pull request:

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:

• Documentation added/updated for www.home-assistant.io

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

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

Code owner commands

Code owners of homematicip_cloud can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant mark-draft Mark the pull request as draft.
• @home-assistant ready-for-review Remove the draft status from the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign homematicip_cloud Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant update-branch Update the pull request branch with the base branch.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[frenck]

Thanks, @lackas 👍

../Frenck

                       

Blogging my personal ramblings at frenck.dev