Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework UniFi client configuration #99483

Merged

Conversation

Kane610
Copy link
Member

@Kane610 Kane610 commented Sep 1, 2023

Breaking change

Not a breaking change yet, but a deprecation, users should redo their configuration for clients.
Previously there were multiple options to configure different client entities, this is being replaced with a single select of clients which will create all relevant client entities. To be prepared go to the integration options and select what entities you want provided by the integration.

Proposed change

First step towards reworking how configuration of client entities work. As long as current configuration is untouched nothing should be affected.
This will help expand client based entities as it will be more explicit what client to create sensors from and will not be an all or nothing thing.
Using this option will override any previous configuration which will be removed according to typical deprecation time window (6 months, so with HA 2024.4).

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

  • 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 Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@Kane610 Kane610 force-pushed the unifi-simplify_client_configuration branch from cca1d0d to 62004d7 Compare September 14, 2023 18:16
@Kane610 Kane610 added the deprecation Indicates a breaking change to happen in the future label Sep 27, 2023
@bdraco
Copy link
Member

bdraco commented Oct 22, 2023

Old configurations related to setting options to expose network client entities will be replaced by this new singular way of selecting which network clients will be source of creating new entities.

Is it possible to migrate the old settings for them?

@Kane610
Copy link
Member Author

Kane610 commented Oct 22, 2023

Old configurations related to setting options to expose network client entities will be replaced by this new singular way of selecting which network clients will be source of creating new entities.

Is it possible to migrate the old settings for them?

Not in a coherent way as the main configuration are a "take all clients" approach, and other options might not be used

@bdraco
Copy link
Member

bdraco commented Oct 22, 2023

I'm not 100% sure what users should do from reading the breaking change section. Can you retarget the audience to be the user who has to adjustments?

@Kane610
Copy link
Member Author

Kane610 commented Oct 22, 2023

I'm not 100% sure what users should do from reading the breaking change section. Can you retarget the audience to be the user who has to adjustments?

Will do, thanks

@Kane610
Copy link
Member Author

Kane610 commented Oct 22, 2023

@bdraco better?

@bdraco
Copy link
Member

bdraco commented Oct 22, 2023

@bdraco better?

Much. Thanks!

@frenck frenck merged commit 721c45b into home-assistant:dev Oct 22, 2023
20 checks passed
@Kane610 Kane610 deleted the unifi-simplify_client_configuration branch October 23, 2023 05:59
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2023
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.

Unifi integration works incorrectly with filters
3 participants