Add ESPHome device setup checklist - #53781
Draft
MindFreeze wants to merge 3 commits into
Draft
Conversation
Surface advertised proxy capabilities in a banner and dialog so users can continue Bluetooth, audio, Z-Wave, and serial setup after the device is added.
21 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an ESPHome device setup checklist with persistent reminders and guided configuration flows.
Changes:
- Adds capability detection and setup-status logic.
- Adds device-page banner, reminder, and checklist dialog.
- Adds localized copy and data-layer tests.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
test/data/esphome_setup.test.ts |
Tests capability and persistence helpers. |
src/translations/en.json |
Adds setup UI translations. |
src/panels/config/devices/ha-config-device-page.ts |
Integrates setup UI and persistence. |
src/panels/config/devices/device-detail/ha-esphome-setup-reminder.ts |
Adds compact reminder card. |
src/panels/config/devices/device-detail/ha-esphome-setup-banner.ts |
Adds setup banner. |
src/dialogs/esphome-device-setup/show-dialog-esphome-device-setup.ts |
Defines dialog launcher. |
src/dialogs/esphome-device-setup/dialog-esphome-device-setup.ts |
Implements checklist and setup flows. |
src/data/frontend.ts |
Defines deferred-setup user data. |
src/data/esphome.ts |
Adds capabilities API types and request. |
src/data/esphome_setup.ts |
Derives capabilities and completion status. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Show cached capabilities while offline, wait for user data before the banner, and expose setup status to assistive tech.
This file contains hidden or 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
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
Add a device-page setup checklist for ESPHome devices that advertise Bluetooth proxy, audio (
media_playerentities), Z-Wave proxy, and/or serial proxy capabilities.After the device is added, a banner on the device page opens a checklist dialog. Later collapses that to a compact reminder under Device info. Rows and copy follow the design prototype, with these overrides:
media_playerentities, not the capabilities API.Requires the core capabilities command: home-assistant/core#180135
Related: OpenHomeFoundation/roadmap#191, OpenHomeFoundation/ux-design#59
Screenshots
Full banner (capability pips, Set up / Later):
Compact reminder under Device info after Later:
Wizard:
Configured serial:
Type of change
Additional information
Checklist
If user exposed functionality or configuration variables are added/changed:
To help with the load of incoming pull requests: