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

Include all enphase_envoy devices in async_remove_config_entry_device #124533

Merged
merged 2 commits into from
Sep 8, 2024

Conversation

catsmanac
Copy link
Contributor

Proposed change

Currently Enphase_envoy only checks for the Envoy itself or any solar inverters in __init__.py::async_remove_config_entry_device. Enpower and Encharge devices are not checked.

This PR extends async_remove_config_entry_device to also check for Encharge and Enpower devices and if matched return false.

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:

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

Comment on lines 67 to 73
if envoy_data and envoy_data.encharge_inventory:
for encharge in envoy_data.encharge_inventory:
if str(encharge) in dev_ids:
return False
if envoy_data and envoy_data.enpower:
if str(envoy_data.enpower.serial_number) in dev_ids:
return False
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we maybe look into automatic deletion at some point?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was added (without the encharge and enpower that are now added) in #74012, a year before the overhaul of the integration. So I assume this one was needed then, as confirmation a device could be manually removed or not. I think it's only used to prevent the user to remove a device manually if there's still an envoy, inverters, encharge and enpower present. An actual delete will occur when removing the integration entry.

So something automatically can be done in a future PR but I think till now we only allow disable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this code allows to delete manually. But if we can know from the API for sure that a device is gone, we can do that automatically

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll add it to my to-do list for an upcoming PR. Adding the encharge and enpower test is to prevent an accidental manual delete for now.

@catsmanac catsmanac requested a review from joostlek September 7, 2024 08:22
@joostlek joostlek merged commit 2ef1c96 into home-assistant:dev Sep 8, 2024
27 of 28 checks passed
@catsmanac catsmanac deleted the EnphaseRemoveDevices branch September 8, 2024 13:08
@github-actions github-actions bot locked and limited conversation to collaborators Sep 9, 2024
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.

4 participants