Skip to content

Fix UniFi wired client speed sensor respecting track_clients option#169678

Open
RaHehl wants to merge 2 commits intohome-assistant:devfrom
RaHehl:fix/unifi-wired-client-speed-sensor-track-clients
Open

Fix UniFi wired client speed sensor respecting track_clients option#169678
RaHehl wants to merge 2 commits intohome-assistant:devfrom
RaHehl:fix/unifi-wired-client-speed-sensor-track-clients

Conversation

@RaHehl
Copy link
Copy Markdown
Contributor

@RaHehl RaHehl commented May 3, 2026

Breaking change

Proposed change

The UniFi integration creates a "wired client link speed" diagnostic sensor for every wired network device (non-Ubiquiti clients), even when the user has disabled client tracking via the track_clients option. This causes unwanted (disabled) entities to appear in Home Assistant for all wired network clients.

This PR fixes async_wired_client_allowed_fn in sensor.py to respect option_track_clients, consistent with how async_bandwidth_sensor_allowed_fn and async_uptime_sensor_allowed_fn already handle this option. Clients explicitly listed in option_supported_clients (Entity Sources) are still allowed regardless.

Additionally, the incorrect type annotations for option_track_clients and option_track_wired_clients in hub/config.py are corrected from list[str] to bool — they were always stored and used as booleans.

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 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:

@RaHehl RaHehl requested a review from Kane610 as a code owner May 3, 2026 08:15
Copilot AI review requested due to automatic review settings May 3, 2026 08:15
@home-assistant home-assistant Bot added bugfix cla-signed has-tests integration: unifi small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage labels May 3, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented May 3, 2026

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

Code owner commands

Code owners of unifi 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 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.

Copy link
Copy Markdown
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 updates the UniFi integration so the wired client link-speed diagnostic sensor follows the client-tracking options more closely, and corrects the corresponding config type annotations. It fits into the integration’s entity-creation logic by aligning this wired-client sensor with the existing option-driven behavior used elsewhere in UniFi.

Changes:

  • Added a track_clients gate to async_wired_client_allowed_fn, while still allowing explicitly selected clients from client_source.
  • Corrected UnifiConfig type annotations for option_track_clients and option_track_wired_clients from list[str] to bool.
  • Added sensor tests covering the new track_clients=False behavior and the client_source bypass case.

Reviewed changes

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

File Description
homeassistant/components/unifi/sensor.py Adjusts wired client link-speed sensor eligibility logic.
homeassistant/components/unifi/hub/config.py Fixes config option type annotations to match actual stored values.
tests/components/unifi/test_sensor.py Adds regression tests for wired link-speed sensor creation rules.

Comment thread homeassistant/components/unifi/sensor.py Outdated
Comment thread tests/components/unifi/test_sensor.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix cla-signed has-tests integration: unifi Quality Scale: silver small-pr PRs with less than 30 lines. 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.

3 participants