jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-15 13:26:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document async_has_matching_flow (#2340)

Browse Source 
* Document async_has_matching_flow

* Update docs/config_entries_config_flow_handler.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Accept suggestion from the bot

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Erik Montnemery 2024-10-03 13:01:14 +02:00 committed by GitHub
parent 8757dcb948
commit a20c3d26c6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/config_entries_config_flow_handler.md
View File

@ -92,7 +92,7 @@ If a unique ID isn't available, alternatively, the `bluetooth`, `dhcp`, `zerocon
the integration manifest. In that case, the `user` step will be called when the item is discovered.
Alternatively, if an integration can't get a unique ID all the time (e.g., multiple devices, some have one, some don't), a helper is available
that still allows for discovery, as long as there aren't any instances of the integrations configured yet.
that still allows for discovery, as long as there aren't any instances of the integration configured yet.
Here's an example of how to handle discovery where a unique ID is not always available:
@ -170,6 +170,11 @@ The Unique ID can be used to update the config entry data when device access det
When an integration is discovered, their respective discovery step is invoked (ie `async_step_dhcp` or `async_step_zeroconf`) with the discovery information. The step will have to check the following things:
- Make sure there are no other instances of this config flow in progress of setting up the discovered device. This can happen if there are multiple ways of discovering that a device is on the network.
- In most cases, it's enough to set the unique ID on the flow and check if there's already a config entry with the same unique ID as explained in the section about [managing unique IDs in config flows](#managing-unique-ids-in-config-flows)
- In some cases, a unique ID can't be determined, or the unique ID is ambiguous because different discovery sources may have different ways to calculate it. In such cases:
1. Implement the method `def is_matching(self, other_flow: Self) -> bool` on the flow.
2. Call `hass.config_entries.flow.async_has_matching_flow(self)`.
3. Your flow's `is_matching` method will then be called once for each other ongoing flow.
- Make sure that the device is not already set up.
- Invoking a discovery step should never result in a finished flow and a config entry. Always confirm with the user.