Migrate unifi_direct from DeviceScanner to ScannerEntity and add ConfigFlow by PaulVanSchayck · Pull Request #171991 · home-assistant/core

PaulVanSchayck · 2026-05-23T19:31:59Z

Breaking change

This PR introduces ConfigFlow support for unifi_direct. It also has automatic migration from the existing yaml.

Proposed change

Migrate unifi_direct from DeviceScanner to ScannerEntity and add ConfigFlow.

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 Migrate unifi_direct from DeviceScanner to ScannerEntity #143042
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:

Documentation added/updated for www.home-assistant.io

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:

I have reviewed two other open pull requests in this repository.

home-assistant

Hi @PaulVanSchayck

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2026-05-23T19:32:06Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

home-assistant · 2026-05-23T19:32:08Z

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

Code owner commands

Code owners of unifi_direct 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 unifi_direct 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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR modernizes the unifi_direct integration by adding a config flow and refactoring device tracking to use a DataUpdateCoordinator, along with new tests and generated metadata updates.

Changes:

Added config flow support (including YAML import) and marked the integration as config_flow: true.
Reworked device tracker to be config-entry based and coordinator-driven.
Introduced test suite + fixtures for config flow and device tracker behavior.

Reviewed changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`homeassistant/components/unifi_direct/__init__.py`	Sets up/unloads the integration via config entries and forwards to platforms.
`homeassistant/components/unifi_direct/config_flow.py`	Implements UI + YAML import config flow for UniFi AP Direct.
`homeassistant/components/unifi_direct/coordinator.py`	Adds coordinator and connection validation helpers.
`homeassistant/components/unifi_direct/const.py`	Introduces integration constants.
`homeassistant/components/unifi_direct/device_tracker.py`	Migrates legacy YAML setup to import + adds coordinator-backed tracker entities.
`homeassistant/components/unifi_direct/manifest.json`	Declares `config_flow` and sets `integration_type` to `device`.
`homeassistant/components/unifi_direct/strings.json`	Adds issue translations for YAML import connection failures.
`homeassistant/generated/config_flows.py`	Registers `unifi_direct` as having a config flow (generated).
`homeassistant/generated/integrations.json`	Updates integration metadata for config flow and type (generated).
`tests/components/unifi_direct/conftest.py`	Adds fixtures for config entry and UniFiAP mocking.
`tests/components/unifi_direct/test_config_flow.py`	Adds config flow tests (success + cannot_connect + import).
`tests/components/unifi_direct/test_device_tracker.py`	Adds device tracker entity creation + legacy YAML import tests.
`tests/components/unifi_direct/__init__.py`	Adds test package marker/docstring.
`CODEOWNERS`	Adds code ownership for the new test directory.

Copilot

Pull request overview

Copilot reviewed 12 out of 14 changed files in this pull request and generated 4 comments.

Stale

Copilot

Pull request overview

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

Copilot

Pull request overview

Copilot reviewed 12 out of 14 changed files in this pull request and generated 5 comments.

PaulVanSchayck · 2026-06-08T19:59:59Z

+        """Initialize the coordinator using a config entry."""
+        self.config_entry = config_entry
+        self.host = config_entry.data[CONF_HOST]
+        self.username = config_entry.data[CONF_USERNAME]
+        self.password = config_entry.data[CONF_PASSWORD]
+        self.port = config_entry.data.get(CONF_PORT, DEFAULT_SSH_PORT)
+
+        self.ap = UniFiAP(


test_device_tracker_entities_created already tests the controller

Copilot

Pull request overview

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

Copilot

Pull request overview

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

joostlek · 2026-06-08T10:07:39Z

+        self.host = config_entry.data[CONF_HOST]
+        self.username = config_entry.data[CONF_USERNAME]
+        self.password = config_entry.data[CONF_PASSWORD]
+        self.port = config_entry.data.get(CONF_PORT, DEFAULT_SSH_PORT)
+
+        self.ap = UniFiAP(
+            target=self.host,
+            username=self.username,
+            password=self.password,
+            port=self.port,
+        )


you don't need the parameters after assignment right? might as well just pick them from the config entry directly

I've kept self.host

joostlek · 2026-06-08T10:17:32Z

+@pytest.fixture
+def mock_unifiap() -> Generator[MagicMock]:
+    """Mock UniFiAP to return known clients."""
+    with patch("homeassistant.components.unifi_direct.coordinator.UniFiAP") as mock:
+        ap_instance = MagicMock()
+        ap_instance.get_clients.return_value = MOCK_DEVICE_DATA
+        mock.return_value = ap_instance
+        yield mock
+
+
+@pytest.fixture
+def mock_unifiap_validate() -> Generator[MagicMock]:
+    """Mock UniFiAP for validate connection path."""
+    with patch("homeassistant.components.unifi_direct.coordinator.UniFiAP") as mock:
+        ap_instance = MagicMock()
+        ap_instance.get_clients.return_value = MOCK_DEVICE_DATA
+        mock.return_value = ap_instance
+        yield mock


This isn't fixed yet, you can combine these, cheak mealie for an example

PaulVanSchayck · 2026-06-08T20:17:11Z

I'm seeing the following in my log file, without having enabled any extra logging

2026-06-08 22:13:31.052 INFO (Thread-10) [paramiko.transport] Connected (version 2.0, client dropbear_2022.83)
2026-06-08 22:13:31.340 INFO (Thread-10) [paramiko.transport] Authentication (password) successful

I'm wondering if something is wrong with the log setup, and I should somehow mark paramiko.

Copilot

Pull request overview

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

PaulVanSchayck · 2026-06-08T20:27:19Z

+    def __init__(self, coordinator: UniFiDirectDataUpdateCoordinator, mac: str) -> None:
+        """Initialize the tracked device."""
+        super().__init__(coordinator)
+        self._mac = mac
+        device = coordinator.data.get(mac, {})
+        self._attr_name = device.get("hostname") or mac


I don't think that's needed. ScannerEntity already defines a unique_id(), and uses the mac address for that. This is a globally unique identifier.

+def validate_connection_data(data: dict[str, Any]) -> None:
+    """Validate connection using a config-style dict.
+
+    Kept for config flow compatibility.
+    """


PaulVanSchayck added 4 commits May 23, 2026 21:24

Initial work to migrate unifi_direct to ScannerEntity and ConfigFlow

807a52e

Explicitely pass config_entry

4b46f8e

Initial work to migrate from yaml to configflow

f9c29a6

Improve yaml migration

2ae3396

Copilot AI review requested due to automatic review settings May 23, 2026 19:32

home-assistant Bot added cla-needed config-flow This integration migrates to the UI by adding a config flow has-tests labels May 23, 2026

home-assistant Bot previously requested changes May 23, 2026

View reviewed changes

home-assistant Bot added integration: unifi_direct new-feature labels May 23, 2026

home-assistant Bot marked this pull request as draft May 23, 2026 19:32

home-assistant Bot added Quality Scale: legacy cla-recheck cla-signed and removed cla-recheck cla-needed labels May 23, 2026

Copilot AI reviewed May 23, 2026

View reviewed changes

PaulVanSchayck added 2 commits May 24, 2026 20:48

Address CoPilot comments

4d15cb8

Merge branch 'dev' into unifi_direct2

7f09298

Copilot AI review requested due to automatic review settings May 24, 2026 18:59

Copilot AI reviewed May 24, 2026

View reviewed changes

Comment thread tests/components/unifi_direct/test_config_flow.py

Comment thread homeassistant/components/unifi_direct/device_tracker.py Outdated

Comment thread homeassistant/components/unifi_direct/device_tracker.py

Comment thread homeassistant/components/unifi_direct/coordinator.py Outdated

Use config constants

ef5b310

PaulVanSchayck marked this pull request as ready for review May 24, 2026 19:12

Copilot AI review requested due to automatic review settings May 24, 2026 19:12

Copilot AI reviewed May 24, 2026

View reviewed changes

Comment thread homeassistant/components/unifi_direct/device_tracker.py Outdated

Comment thread homeassistant/components/unifi_direct/device_tracker.py

Comment thread homeassistant/components/unifi_direct/coordinator.py Outdated

Fix more constants

e644dde

PaulVanSchayck added 8 commits June 7, 2026 22:03

Fix config_entries imports

dc7562a

Create mock_setup_entry

78ee4f3

Small refactors to config flow tests

d11c1b9

Test if config flow can recover after failed connection

947b7b0

Test where an entry already exists and we try to set it up.

9167d60

Use mocked entity_registry

431f858

Improve mocking method for legacy imports

296f22a

Merge branch 'dev' into unifi_direct2

3e23640

Copilot AI review requested due to automatic review settings June 7, 2026 21:37

Copilot AI reviewed Jun 7, 2026

View reviewed changes

Address CoPilot comments

8ba7215

Copilot AI review requested due to automatic review settings June 7, 2026 21:54

Copilot AI reviewed Jun 7, 2026

View reviewed changes

Comment thread homeassistant/components/unifi_direct/device_tracker.py

Comment thread homeassistant/components/unifi_direct/device_tracker.py

Comment thread homeassistant/components/unifi_direct/coordinator.py

Stop yaml import when connection fails

b34413f

PaulVanSchayck marked this pull request as ready for review June 7, 2026 22:07

Copilot AI review requested due to automatic review settings June 7, 2026 22:07

home-assistant Bot requested a review from joostlek June 7, 2026 22:07

Copilot AI reviewed Jun 7, 2026

View reviewed changes

Comment thread homeassistant/components/unifi_direct/device_tracker.py

Comment thread tests/components/unifi_direct/test_device_tracker.py Outdated

Comment thread homeassistant/components/unifi_direct/coordinator.py Outdated

joostlek requested changes Jun 8, 2026

View reviewed changes

home-assistant Bot marked this pull request as draft June 8, 2026 10:10

joostlek requested changes Jun 8, 2026

View reviewed changes

PaulVanSchayck added 4 commits June 8, 2026 21:42

Misc fixes

7186962

Simplify to only use one UniFiAP mock

d02cb4a

Use config constants in tests

c797f75

Add tests for import flow where entry already exists

f6dca95

PaulVanSchayck marked this pull request as ready for review June 8, 2026 20:20

Copilot AI review requested due to automatic review settings June 8, 2026 20:20

home-assistant Bot requested a review from joostlek June 8, 2026 20:20

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Uh oh!

Conversation

PaulVanSchayck commented May 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant Bot left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant Bot commented May 23, 2026

Uh oh!

home-assistant Bot commented May 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PaulVanSchayck Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joostlek Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

PaulVanSchayck Jun 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

joostlek Jun 8, 2026

Choose a reason for hiding this comment

PaulVanSchayck commented May 23, 2026 •

edited

Loading