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

Implement Coordinator for HEOS (initial plumbing) #136205

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Conversation

andrewsayre
Copy link
Member

@andrewsayre andrewsayre commented Jan 21, 2025

Proposed change

Starts the implementation of the coordinator for HEOS. This first step establishes the coordinator plumbing and moves the connection setup logic into the coordinator. Subsequent parts will move the logic of the 3 managers (ControllerManager, SourceManager, and GroupManager) into the coordinator.

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 is an incremental step from this larger PR that was closed: #135736

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:

@andrewsayre andrewsayre force-pushed the heos_coordinator_part_one branch from 607dd25 to 4e14faa Compare January 22, 2025 13:02
homeassistant/components/heos/__init__.py Show resolved Hide resolved
homeassistant/components/heos/media_player.py Outdated Show resolved Hide resolved
tests/components/heos/test_init.py Outdated Show resolved Hide resolved
@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 home-assistant bot marked this pull request as draft January 22, 2025 13:44
@andrewsayre andrewsayre marked this pull request as ready for review January 22, 2025 14:11
@home-assistant home-assistant bot requested a review from joostlek January 22, 2025 14:11
try:
await self.heos.connect()
except HeosError as error:
raise ConfigEntryNotReady from error
Copy link
Member Author

Choose a reason for hiding this comment

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

In the future, this (and the next try/except block) will have a specific message informing the user why setup failed. I can add that to this PR if that helps justify the repeated try/except blocks (I was trying to keep this PR as small as possible initially.)

@joostlek joostlek merged commit 52f7762 into dev Jan 22, 2025
32 checks passed
@joostlek joostlek deleted the heos_coordinator_part_one branch January 22, 2025 21:12
@github-actions github-actions bot locked and limited conversation to collaborators Jan 23, 2025
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.

2 participants