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

Add config_flow to bluesound integration #115207

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

LouisChrist
Copy link

@LouisChrist LouisChrist commented Apr 8, 2024

Proposed change

  • Adds user config_flow for bluesound integration and removes configurations via yaml.

The documentation for using the configuration.yaml is removed and replaced by documentation for using the config_flow(see matching PR for docs)

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

  • 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

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

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 home-assistant bot added cla-needed code-quality config-flow This integration migrates to the UI by adding a config flow has-tests integration: bluesound labels Apr 8, 2024
@home-assistant
Copy link

home-assistant bot commented Apr 8, 2024

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

Code owner commands

Code owners of bluesound 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 bluesound 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
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Before this integration can be migrated to a config flow, it should adhere to ADR-0010, which states that all code used to connect to a device or service should be encapsulated in a python library published on pypi.

@home-assistant home-assistant bot marked this pull request as draft April 8, 2024 18:21
@home-assistant
Copy link

home-assistant bot commented Apr 8, 2024

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.

@LouisChrist
Copy link
Author

LouisChrist commented Apr 8, 2024

My Bad. My intent was to do it the other way around as this seemed to be the smaller task.

I'm working on a library in parallel: pyblu. Should I do all that in one PR or should I split it into a separate PR?

@LouisChrist
Copy link
Author

LouisChrist commented Apr 27, 2024

I created and integrated a separate library for interacting with the devices: pyblu.

The parts regarding join/unjoin of devices are not tested with real devices as i have only one. They are tested to the degree that they do not return any 'Bad Request'. And there are unit tests in the library, which are based on the documentation.

I tried to change as little as possible in the integration itself.

@LouisChrist LouisChrist marked this pull request as ready for review April 27, 2024 15:37
@home-assistant home-assistant bot requested a review from joostlek April 27, 2024 15:37
@joostlek
Copy link
Member

Can we first do a prelimary PR to make the integration use the library?

@LouisChrist
Copy link
Author

I created a separate PR: Integrate pypi library: pyblu

@fredrike
Copy link
Contributor

Wow great work in getting Bluesound up to standards with a real config-flow.

I didn't look before I created my own config-flow (with zeroconf discovery). Perhaps you find something useful from my code (or once we get this merged I can create a new PR with the zeroconf code).

dev...fredrike:home-assistant:bluesound-updates

@LouisChrist
Copy link
Author

LouisChrist commented May 29, 2024

Wow great work in getting Bluesound up to standards with a real config-flow.

I didn't look before I created my own config-flow (with zeroconf discovery). Perhaps you find something useful from my code (or once we get this merged I can create a new PR with the zeroconf code).

dev...fredrike:home-assistant:bluesound-updates

Thank you.

I can integrate your zeroconf code into this PR, if you are ok with that. It seems to be a rather small addition. Or you can do it as a separate PR(doing zeroconf a separate PR was my initial plan). That is your decision, since it's your code i would be copying.

@fredrike
Copy link
Contributor

Feel free to use "my" code in any way you want. I didn't think there were anyone actively developing for Bluesound and was quite annoyed that the integration didn't support config registry.

@LouisChrist
Copy link
Author

LouisChrist commented May 29, 2024

Then i will integrate zeroconf into this PR, but it might take a while. I am currently working on Use pyblu library in bluesound, which has to be merged first.

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.

None yet

3 participants