Add config flow to Yamaha #131246
Add config flow to Yamaha #131246
Conversation
home-assistant
bot
added
bugfix
cla-signed
config-flow
|
As discussed in #130820 this is a first attempt to add a config flow to the Yamaha integration. As this was a first attempt at this and for people that are stumbling on this in the future, it's a mix of https://github.com/home-assistant/core/pull/51561/files and the current state of the I've removed references to I still have 2 unit tests marked as ignore in which I need your help to understand if they can be removed.
Hope this is more or less adequate for a first attempt :-) |
|
The CI is failing |
Yes sorry about that, it seems my dev environment is not running the git pre commit hooks, i'll fix this as soon as possible! |
|
FYI, you don't have to add the issue to the commit message. If you want to do so, feel free to do so, but you're not required to :) |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
* Realign code with yamaha_musiccast and store UPNP Description instead of model and name * Reuse rxv.ssdp.rxv_details for querying the rxv data instead of querying from HA code
…add discovery when configuration yaml has no host, add issues (taken from onkyo integration)
|
I hope this is moving in the right direction, so I've requested another review. |
…age for issue creation
…age for issue creation
…out SSDP and serials
| if entry.data.get(CONF_UPNP_DESC) is None: | ||
| hass.config_entries.async_update_entry( |
There was a problem hiding this comment.
How does this work?
Like I am known with the technique to do this in the config flow discovery step, so for example when someone setup the integration using the host and then we find either a zeroconf or DHCP flow that we can link to it (for example if the entry uses the same host and is loaded) and then we update the entry to have that unique identifier. Examples of this are fritzbox and reolink, both do this in the DHCP step I believe.
From my understanding this does the same, but I am wondering how the order of discovery works, because if the integration is setup and after that the SSDP picks up the advertisement, this code is not run anymore.
So I am not really sure what is best here, but I do want to share this info with you to at stir up the discussion.
| CONF_HOST: entry.data[CONF_HOST], | ||
| CONF_SERIAL: entry.data[CONF_SERIAL], |
There was a problem hiding this comment.
| CONF_HOST: entry.data[CONF_HOST], | |
| CONF_SERIAL: entry.data[CONF_SERIAL], | |
| **entry.data, |
| }, | ||
| ) | ||
|
|
||
| hass.data.setdefault(DOMAIN, {}) |
There was a problem hiding this comment.
You're storing nothing here so this line can be removed
| rxv_details = await YamahaConfigInfo.get_rxv_details( | ||
| entry.data[CONF_UPNP_DESC], hass | ||
| ) |
There was a problem hiding this comment.
So our code relies on having that info, but why do we then only set the upnp description during initialisation and why not during the config (or import) flow?
| return upnp_desc | ||
|
|
||
|
|
||
| async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: |
There was a problem hiding this comment.
Let's use a typed ConfigEntry here, see more at https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/runtime-data
|
|
||
| return await self.async_step_confirm() | ||
|
|
||
| async def async_step_confirm(self, user_input=None) -> ConfigFlowResult: |
| OPTION_INPUT_SOURCES_IGNORE: user_input.get( | ||
| OPTION_INPUT_SOURCES_IGNORE | ||
| ) | ||
| or [], |
There was a problem hiding this comment.
Let's wrap these multiline statements in parenthesis
| async def async_step_import(self, import_data: dict) -> ConfigFlowResult: | ||
| """Import data from configuration.yaml into the config flow.""" | ||
| return await self.async_step_user(import_data) |
There was a problem hiding this comment.
While for the user flow we want to raise errors, for the import flow we should abort when an error happens.
Also, typing is missing
…class to utils, reverted self._attr_unique_id change in media_player
Breaking change
Proposed change
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: