Skip to content

Add esphome/get_device_capabilities websocket command - #180135

Draft
MindFreeze wants to merge 2 commits into
devfrom
esphome-get-device-capabilities
Draft

Add esphome/get_device_capabilities websocket command#180135
MindFreeze wants to merge 2 commits into
devfrom
esphome-get-device-capabilities

Conversation

@MindFreeze

@MindFreeze MindFreeze commented Aug 25, 2026

Copy link
Copy Markdown
Member

Proposed change

Add an admin websocket command that returns the cached ESPHome DeviceInfo flags the device page needs for a setup checklist: whether Bluetooth proxy and Z-Wave proxy are compiled in, the Z-Wave home ID, and advertised serial proxy ports.

Audio is not included. The frontend can tell that from media_player entities on the device.

Related: OpenHomeFoundation/roadmap#191, OpenHomeFoundation/ux-design#59

Frontend: home-assistant/frontend#53781

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running: python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Expose cached Bluetooth, Z-Wave, and serial proxy capabilities so the device page can show a setup checklist without extra native-API round trips.
Copilot AI balanced review requested due to automatic review settings August 25, 2026 12:48
@home-assistant home-assistant Bot added cla-signed has-tests integration: esphome new-feature Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage Top 50 Integration is ranked within the top 50 by usage labels Aug 25, 2026
@home-assistant

Copy link
Copy Markdown
Contributor

Hey there @jesserockz, @kbx81, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (esphome) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of esphome can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign esphome Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an admin ESPHome websocket command exposing cached device capabilities for the device setup checklist.

Changes:

  • Reports Bluetooth, Z-Wave, and serial proxy capabilities.
  • Handles unavailable, missing, and non-ESPHome devices.
  • Adds websocket API tests.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
homeassistant/components/esphome/websocket_api.py Implements the capability command.
tests/components/esphome/test_websocket_api.py Tests responses and error cases.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread homeassistant/components/esphome/websocket_api.py
Sub-devices share the config entry but should not surface the parent node's proxy flags, and serial port type may be unset.
Copilot AI review requested due to automatic review settings August 25, 2026 13:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed has-tests integration: esphome new-feature Quality Scale: platinum Top 50 Integration is ranked within the top 50 by usage Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants