Skip to content
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

Fixed HomeKit security system's arming state mismatch #108863

Closed
wants to merge 2 commits into from
Closed

Fixed HomeKit security system's arming state mismatch #108863

wants to merge 2 commits into from

Conversation

dstanchfield
Copy link

Proposed change

This resolves an issue where HASS is passing an incorrect state for security systems in HomeKit. Currently, during a security system arming event initiated in either HomeKit or HASS, HASS maps this arming state to a 'armed away' state and then uses that for the targeted state in HomeKit (because HomeKit doesn't actually have an 'arming state' support). From a UI perspective, it causes the slider to move to the 'Away' selection during arming regardless of what type of 'arming to' state was chosen. This can be very confusing, and my initial encounter I thought I had chosen the wrong selection.

Type of change

  • Dependency upgrade
  • [ X] 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

  • [ X] The code change is tested and works locally.
  • [ X] 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
  • [ X] I have followed the perfect PR recommendations
  • [ X] The code has been formatted using Ruff (ruff format homeassistant tests)
  • [ X] 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

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

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 @dstanchfield

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!

@home-assistant
Copy link

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

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

Code owner commands

Code owners of homekit 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 homekit 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 @dstanchfield

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!

if (target_state := HASS_TO_HOMEKIT_TARGET.get(hass_state)) is not None:

if hass_state == STATE_ALARM_ARMING:
if (hass_next_state := new_state.attributes.get("next_state")) is not None:
Copy link
Member

Choose a reason for hiding this comment

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

next_state is only defined by manual.alarm_control_panel. We can only use attributes that are defined by the base entity class here as it won't work with any other integration

https://developers.home-assistant.io/docs/core/entity/alarm-control-panel/

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

@dstanchfield
Copy link
Author

Understood. I am going to close this while I search for a better solution. Thank you for your help!

@github-actions github-actions bot locked and limited conversation to collaborators Jan 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants