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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for restoring HomeKit IIDs #79913

Merged
merged 28 commits into from Oct 14, 2022
Merged

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Oct 8, 2022

Needs ikalchev/HAP-python#423

Breaking change

HomeKit instance ID assignments are now stable between restarts to comply with the HomeKit specifications. This prevents accessories from loosing track of services between restarts, and improves stability with using Siri especially with apple watches.

This change may dramatically improve the stability and re-sync times of media_player entities (all), camera entities (all), fan entities (presets), remote entities (activity ones), switch entities (power strips), triggers (all) between restarts which was especially apparent when the home has many accessories.

As with #35691, because the assignments were previously unstable, it may be necessary to do a one time adjustment of accessory room assignments, favorites, or re-pair camera accessories after upgrading.

Proposed change

Currently we rely on creation order to keep iids the same but this is not reliable since services and chars can change.

Fixes #78092
Fixes #77514

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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@bdraco
Copy link
Member Author

bdraco commented Oct 12, 2022

Probably need some unit tests for the iid manager like we do for the aid manager as it would be good to test that implementation directly

@bdraco bdraco marked this pull request as ready for review October 14, 2022 08:53
@bdraco
Copy link
Member Author

bdraco commented Oct 14, 2022

Thanks

@bdraco bdraco merged commit 3b33e0d into home-assistant:dev Oct 14, 2022
@bdraco bdraco deleted the hk_stable_iids branch October 14, 2022 19:58
@github-actions github-actions bot locked and limited conversation to collaborators Oct 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants