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-28 03:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new async_update_progress flow method (#2643)

Browse Source
This commit is contained in:
Petar Petrov 2025-04-14 16:30:43 +03:00 committed by GitHub
parent cf81429226
commit 7c85921b92
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/data_entry_flow_index.md
View File

@ -474,6 +474,7 @@ The flow works as follows:
* If the task is finished, the flow must call the `async_show_progress_done`, indicating the next step
5. The frontend will update each time we call show progress or show progress done.
6. The config flow will automatically advance to the next step when the progress was marked as done. The user is prompted with the next step.
7. The task can optionally call `async_update_progress(progress)` where progress is a float between 0 and 1, indicating how much of the task is done.
Example configuration flow that includes two show sequential progress tasks.
@ -499,6 +500,7 @@ class TestFlow(config_entries.ConfigFlow, domain=DOMAIN):
uncompleted_task = self.task_one
if not uncompleted_task:
if not self.task_two:
self.async_update_progress(0.5) # tell frontend we are 50% done
coro = asyncio.sleep(10)
self.task_two = self.hass.async_create_task(coro)
if not self.task_two.done():