Skip to content

Conversation

@balloob
Copy link
Member

@balloob balloob commented Oct 6, 2025

Breaking change

Proposed change

In #153522 we switched to always set the Home ID. However, there are 2 cases where this is not the case: when a PoE adapter running ESPHome is not connected to ZWA-2 and when a Z-Wave antenna has never been used. With this PR, those 2 cases will now no longer cause duplicate discoveries once configured.

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@balloob balloob added this to the 2025.10.2 milestone Oct 6, 2025
Copilot AI review requested due to automatic review settings October 6, 2025 01:59
@balloob balloob requested a review from a team as a code owner October 6, 2025 01:59
@home-assistant
Copy link

home-assistant bot commented Oct 6, 2025

Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of zwave_js can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign zwave_js Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes a bug in the Z-Wave JS integration's ESPHome discovery flow where devices without a Home ID would cause issues. The change adds validation to abort the configuration flow when the Home ID is missing, which can occur with ESPHome running on PoE adapters.

  • Adds a check to abort ESPHome discovery when zwave_home_id is None
  • Provides a descriptive error message for the abort scenario
  • Includes comprehensive test coverage for the new validation

Reviewed Changes

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

File Description
homeassistant/components/zwave_js/config_flow.py Adds validation to check for missing Home ID and abort discovery flow
homeassistant/components/zwave_js/strings.json Adds user-facing error message for the missing Home ID scenario
tests/components/zwave_js/test_config_flow.py Adds test case to verify proper handling of ESPHome discoveries without Home ID

@bdraco bdraco marked this pull request as draft October 6, 2025 02:10
@balloob balloob changed the title Filter out ESPHome discoveries without Home ID Handle ESPHome discoveries with uninitialized Z-Wave antennas Oct 6, 2025
Comment on lines +1505 to +1532
if (
(
current_config_entries := self._async_current_entries(
include_ignore=False
)
)
)
and (home_id := str(discovery_info.zwave_home_id))
and (
existing_entry := next(
(
entry
for entry in current_config_entries
if entry.unique_id == home_id
),
None,
and (home_id := str(discovery_info.zwave_home_id))
and (
existing_entry := next(
(
entry
for entry in current_config_entries
if entry.unique_id == home_id
),
None,
)
)
# Only update existing entries that are configured via sockets
and existing_entry.data.get(CONF_SOCKET_PATH)
# And use the add-on
and existing_entry.data.get(CONF_USE_ADDON)
):
await self._async_set_addon_config(
{CONF_ADDON_SOCKET: discovery_info.socket_path}
)
# Reloading will sync add-on options to config entry data
self.hass.config_entries.async_schedule_reload(existing_entry.entry_id)
return self.async_abort(reason="already_configured")
Copy link
Member Author

Choose a reason for hiding this comment

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

This diff is big because I split out if discovery_info.zwave_home_id and so it got indented.

@balloob balloob marked this pull request as ready for review October 6, 2025 03:05
@balloob balloob merged commit 50a7af4 into dev Oct 6, 2025
34 checks passed
@balloob balloob deleted the zjs-filter-no-home-id branch October 6, 2025 03:06
@github-actions github-actions bot locked and limited conversation to collaborators Oct 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants