Add device cleanup to Vodafone Station

[chemelli74]

Breaking change

Proposed change

Add Device cleanup button to remove state entities no more available in the router itself.

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:

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

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

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

[home-assistant]

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

Code owner commands

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

[bouwew]

Interesting approach!

But, are you aware of this? https://developers.home-assistant.io/docs/device_registry_index/#removing-devices

I'm thinking about doing something similar for the Plugwise integration and did some research.
I came to the conclusion that it doesn't make sense to clean the entity-registry, this is done automatically is my impression.
Cleaning the device-registry is a good thing, looks like there are two options:

• clean during init, after a restart
• let the User delete a removed device manually, via the async_remove_config_entry_device() function, resulting in a Delete-button showing up in HA after the device has been removed.

If anyone else cares to share their thoughts/ideas/feedback (HA devs!) on this topic, that would be appreciated :)

[chemelli74]

Hi, I implemented the same approach I used in fritz.

Device trackers are entities, and if they don't attach to a device, then also the device is created.
This code take care of cleanup both things.

[mib1185]

entity entries will not be deleted automatically, more over the user can manually delete them as soon as they are not provided by integration anymore.
this "entity registry cleanup" could also be done by the integration itself, either by an own service/button (like @chemelli74 is doing here and has done in fritz integration) or automatically by the integration based on a detection mechanism of no more existing real devices (as lately done in #114573 and #114601) - finally this cleanup has to remove the config entry from the device eq. device_reg.async_update_device(device.id, remove_config_entry_id=config_entry.entry_id)

[bouwew]

@mib1185 Thanks for your feedback, and for providing examples :)

I'm also thinking of implementing the opposite: when a new device is added, how would I go about adding this device?
Is it possible to do this without an integration-reload?

Sorry @chemelli74 for hijacking your PR!

[mib1185]

• @bouwew checkout Discover new added device at runtime in AVM Fritz!Smarthome #103859 😉

[mib1185]

Hi @chemelli74
sorry delayed response - there are just some small comments from my side

[home-assistant]

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.

[mib1185]

LGTM, thx @chemelli74 👍

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

stale

[bdraco]

Merged in dev since this PR is a bit behind to make sure merging it won't cause any lint issues