Fix UniFi wired client speed sensor respecting track_clients option#169678
Open
RaHehl wants to merge 2 commits intohome-assistant:devfrom
Open
Fix UniFi wired client speed sensor respecting track_clients option#169678RaHehl wants to merge 2 commits intohome-assistant:devfrom
RaHehl wants to merge 2 commits intohome-assistant:devfrom
Conversation
Contributor
|
Hey there @Kane610, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
Contributor
There was a problem hiding this comment.
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_clientsgate toasync_wired_client_allowed_fn, while still allowing explicitly selected clients fromclient_source. - Corrected
UnifiConfigtype annotations foroption_track_clientsandoption_track_wired_clientsfromlist[str]tobool. - Added sensor tests covering the new
track_clients=Falsebehavior and theclient_sourcebypass 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. |
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.
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_clientsoption. This causes unwanted (disabled) entities to appear in Home Assistant for all wired network clients.This PR fixes
async_wired_client_allowed_fninsensor.pyto respectoption_track_clients, consistent with howasync_bandwidth_sensor_allowed_fnandasync_uptime_sensor_allowed_fnalready handle this option. Clients explicitly listed inoption_supported_clients(Entity Sources) are still allowed regardless.Additionally, the incorrect type annotations for
option_track_clientsandoption_track_wired_clientsinhub/config.pyare corrected fromlist[str]tobool— they were always stored and used as booleans.Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: