Skip to content

Migrate from deprecated VacuumEntity to StateVacuumEntity in Ecovacs#95920

Merged
emontnemery merged 3 commits into
home-assistant:devfrom
mib1185:ecovacs/refactor-from-VacuumEntity-to-StateVacuumEntity
Jul 6, 2023
Merged

Migrate from deprecated VacuumEntity to StateVacuumEntity in Ecovacs#95920
emontnemery merged 3 commits into
home-assistant:devfrom
mib1185:ecovacs/refactor-from-VacuumEntity-to-StateVacuumEntity

Conversation

@mib1185
Copy link
Copy Markdown
Member

@mib1185 mib1185 commented Jul 5, 2023

Breaking change

The Ecovacs integration has been migrated to the new StateVacuumEntity under the hood.
The states of the vacuum entity now reports not only on or off, instead cleaning, paused, docked (implicit mean charging), returning (to base), idle and error. Further the actions turn_on (start cleaning) and turn_off (stop cleaning and return to base) were superseded by three single actions start, stop and return_to_base

Proposed change

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

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jul 5, 2023

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

Code owner commands

Code owners of ecovacs 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 ecovacs Removes the current integration label and assignees on the pull request, add the integration domain after the command.

def extra_state_attributes(self) -> dict[str, Any]:
"""Return the device-specific state attributes of this vacuum."""
data: dict[str, Any] = {}
data[ATTR_ERROR] = self.error
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

According to the documentation, this should not be needed, but it's missing in the base class.
We should fix that in a follow-up.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

the error property is initiated during __init__ with None and changed by on_error_() when needed.
but yes, it is not needed anymore on extra state attributes 👍

Copy link
Copy Markdown
Member Author

@mib1185 mib1185 Jul 5, 2023

Choose a reason for hiding this comment

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

there is no error property defined neither in the _BaseVacuum, nor in the StateVacuumEntity class (but mentioned in the docs) 🧐

now I get what you mean 🙈

Comment thread homeassistant/components/ecovacs/vacuum.py Outdated
Comment thread homeassistant/components/ecovacs/vacuum.py Outdated
@home-assistant home-assistant Bot marked this pull request as draft July 5, 2023 19:49
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jul 5, 2023

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 mib1185 force-pushed the ecovacs/refactor-from-VacuumEntity-to-StateVacuumEntity branch from 973460b to 0b9fba4 Compare July 5, 2023 20:34
@mib1185 mib1185 marked this pull request as ready for review July 5, 2023 20:53
@home-assistant home-assistant Bot requested a review from emontnemery July 5, 2023 20:53
Comment thread homeassistant/components/ecovacs/vacuum.py Outdated
Comment thread homeassistant/components/ecovacs/vacuum.py Outdated
Comment thread homeassistant/components/ecovacs/vacuum.py Outdated
@home-assistant home-assistant Bot marked this pull request as draft July 5, 2023 21:09
@mib1185 mib1185 marked this pull request as ready for review July 5, 2023 21:22
@home-assistant home-assistant Bot requested a review from emontnemery July 5, 2023 21:22
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Thanks a lot @mib1185 🚀

@emontnemery emontnemery merged commit af1cb7b into home-assistant:dev Jul 6, 2023
@mib1185 mib1185 deleted the ecovacs/refactor-from-VacuumEntity-to-StateVacuumEntity branch July 6, 2023 06:59
Comment thread homeassistant/components/ecovacs/vacuum.py
Comment thread homeassistant/components/ecovacs/vacuum.py
joostlek pushed a commit to joostlek/core that referenced this pull request Jul 6, 2023
…ome-assistant#95920)

* migrate to StateVacuumEntity

* harmoize supported features start and stop

* apply suggestions
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 7, 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.

4 participants