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

Add support for MQTT based ecovacs vacuums #108167

Merged
merged 18 commits into from Jan 19, 2024
Merged

Add support for MQTT based ecovacs vacuums #108167

merged 18 commits into from Jan 19, 2024

Conversation

edenhaus
Copy link
Contributor

@edenhaus edenhaus commented Jan 16, 2024

Breaking change

Proposed change

Add support for MQTT based ecovacs vacuums by adding the library deebot_client
Login and getting all devices is handled by the new library.
If we get back a legacy device, we use the old library to communicate with it.
As Ecovacs calls them legacy devices, I have renamed the existing Vacuum entity to EcovacsLegacyVacuum
Removed continent from the config flow as it will be retrieved from the country.
Enabled strict typing

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

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @OverloadUT, @mib1185, 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.
  • @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.

@edenhaus edenhaus marked this pull request as ready for review January 16, 2024 19:08
homeassistant/components/ecovacs/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/controller.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/entity.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/entity.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/entity.py Show resolved Hide resolved
homeassistant/components/ecovacs/strings.json Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/vacuum.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/vacuum.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 18, 2024 10:10
@home-assistant
Copy link

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.

@edenhaus edenhaus marked this pull request as ready for review January 18, 2024 16:22
@@ -77,19 +95,25 @@ async def async_step_user(
type=selector.TextSelectorType.PASSWORD
)
),
vol.Required(CONF_COUNTRY): vol.All(vol.Lower, cv.string),
vol.Required(CONF_CONTINENT): vol.All(vol.Lower, cv.string),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing the continent requires no migration, as no stable release included the config flow of ecovacs

Copy link
Contributor

@mib1185 mib1185 left a comment

Choose a reason for hiding this comment

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

HI @edenhaus
i've tested this PR with my old Deebot slim 2 (xmpp based) and can confirm that it still works.

  • migration of yaml ✅
  • creating new entry ✅
  • controlling the vacuum ✅

homeassistant/components/ecovacs/controller.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/controller.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/controller.py Outdated Show resolved Hide resolved
homeassistant/components/ecovacs/strings.json Outdated Show resolved Hide resolved
tests/components/ecovacs/test_init.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft January 18, 2024 22:02
@edenhaus edenhaus marked this pull request as ready for review January 19, 2024 13:21
@home-assistant home-assistant bot marked this pull request as draft January 19, 2024 13:29
@edenhaus edenhaus marked this pull request as ready for review January 19, 2024 13:50
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@edenhaus
Copy link
Contributor Author

Test failures unrelated

@edenhaus edenhaus merged commit ed449a5 into dev Jan 19, 2024
47 of 49 checks passed
@edenhaus edenhaus deleted the edenhaus-ecovacs-mqtt branch January 19, 2024 15:52
@github-actions github-actions bot locked and limited conversation to collaborators Jan 20, 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.

Can't control my Deebot (Ping did not reach VacBot. Will retry)
5 participants