Add HEOS options flow for optional authentication #134105
Draft
+367
−23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zweckj
requested changes
Dec 27, 2024
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
zweckj
requested changes
Dec 28, 2024
Comment on lines
+140
to
+144
| authentication = CONF_USERNAME in user_input or CONF_PASSWORD in user_input | ||
| if authentication and CONF_USERNAME not in user_input: | ||
| errors[CONF_USERNAME] = "username_missing" | ||
| if authentication and CONF_PASSWORD not in user_input: | ||
| errors[CONF_PASSWORD] = "password_missing" |
There was a problem hiding this comment.
I think we can avoid doing this using vol.All in the schema, I'm just not sure if we have a prebuilt validator for this
| @@ -56,9 +69,22 @@ async def async_setup_entry(hass: HomeAssistant, entry: HeosConfigEntry) -> bool | |||
| hass.config_entries.async_update_entry(entry, unique_id=DOMAIN) | |||
|
|
|||
| host = entry.data[CONF_HOST] | |||
| credentials: Credentials | None = None | |||
| if CONF_USERNAME in entry.options and CONF_PASSWORD in entry.options: | |||
There was a problem hiding this comment.
Suggested change
| if CONF_USERNAME in entry.options and CONF_PASSWORD in entry.options: | |
| if entry.options: |
if one is in the other one is as well
| ) | ||
|
|
||
| try: | ||
| if authentication: |
There was a problem hiding this comment.
if this is false this means nothing was entered, so we don't get here, no?
| raise # Re-raise unexpected error | ||
| else: | ||
| # Log out | ||
| await heos.sign_out() |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Adds options flow for the user to enter their HEOS Account credentials used to access their favorites, playlists, and streaming services. The integration uses the stored credentials to ensure the HEOS System is logged in. When the credentials are cleared from the options flow, it will explicitly sign out of the HEOS Account. Previously, users were automating calls to the sign-in custom service action. This removes the need call the service actions directly.
Future enhancements:
sign_inandsign_outactions.Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: