Add ecovacs component #15520

OverloadUT · 2018-07-17T22:03:38Z

Description:

Adds support for Ecovacs vacuums (DEEBOT vacuums) via an ecovacs component that creates vacuum entities for each vacuum in the user's account.

Supports pretty much the full vacuum feature-set, and the vacuums respond instantly to Hass service calls due to the always-open XMPP connection, which is pretty cool! It also supports showing the lifespan of the various replaceable components as attributes on the vacuum state.

Support for the reverse-engineered API is very early, and as such it's likely that not all vacuums and not all regions will work correctly on this first release. The Hass documentation will link to the sucks project for users to find more information about what vacuums and regions have been tested.

This PR has been tested with two DEEBOT M80 Pros on the same account.

Related issue (if applicable): n/a

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5922

Example entry for `configuration.yaml` (if applicable):

ecovacs:
  username: !secret ecovacs_username
  password: !secret ecovacs_password
  country: us
  continent: na

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

Getting fan speed and locating the vac are still unsupported until sucks adds support

This support does not exist in sucks yet; this commit serves as a sort of TDD approach of what such support COULD look like.

Never worked before, as it should have been looking for a key, not an attribute

balloob · 2018-07-18T09:39:24Z

homeassistant/components/ecovacs.py

+from homeassistant.const import CONF_USERNAME, CONF_PASSWORD, \
+    EVENT_HOMEASSISTANT_STOP
+
+REQUIREMENTS = ['sucks==0.9.0']


balloob · 2018-07-18T09:39:55Z

homeassistant/components/ecovacs.py

+
+def setup(hass, config):
+    """Set up the Ecovacs component."""
+    _LOGGER.info("Creating new Ecovacs component")


balloob · 2018-07-18T09:40:13Z

homeassistant/components/ecovacs.py

+    """Set up the Ecovacs component."""
+    _LOGGER.info("Creating new Ecovacs component")
+
+    if ECOVACS_DEVICES not in hass.data:


Components are only setup once, no need for this if-statement.

balloob · 2018-07-18T09:41:03Z

homeassistant/components/ecovacs.py

+
+    if hass.data[ECOVACS_DEVICES]:
+        _LOGGER.debug("Starting vacuum components")
+        # discovery.load_platform(hass, "sensor", DOMAIN, {}, config)


balloob · 2018-07-18T09:41:31Z

homeassistant/components/ecovacs.py

+CONF_COUNTRY = "country"
+CONF_CONTINENT = "continent"
+
+CONFIG_SCHEMA = vol.Schema({


Any reason you went for configuration via configuration.yaml and not using our shiny new config entry?

You know what, I created the bulk of this component 9 months ago and when I came back to it I didn't think to convert it. I'll read up on the config entry docs and see about converting it

Hit me up on Discord, would love to help you with this. Hue is a good (although maybe a bit complicated) example.

balloob · 2018-07-18T09:42:24Z

homeassistant/components/vacuum/ecovacs.py

+
+ECOVACS_FAN_SPEED_LIST = ['normal', 'high']
+
+# These consts represent bot statuses that can come from the `sucks` library


Would we be able to get them from the sucks lib directly instead of defining them? sucks.STATUS_AUTO etc?

In doing this, I actually decided to move the is_cleaning and is_charging logic in to the sucks lib which removed the need to define or import these at all!

balloob · 2018-07-18T09:43:40Z

homeassistant/components/vacuum/ecovacs.py

+STATUS_ERROR = 'error'
+
+# Any status that represents active cleaning
+STATUSES_CLEANING = [STATUS_AUTO, STATUS_EDGE, STATUS_SPOT, STATUS_SINGLE_ROOM]


Make it a set for faster lookups 👍

balloob · 2018-07-18T09:44:11Z

homeassistant/components/vacuum/ecovacs.py

+        _LOGGER.debug("Vacuum initialized: %s", self.name)
+
+    async def async_added_to_hass(self) -> None:
+        """d."""


balloob · 2018-07-18T09:44:34Z

homeassistant/components/vacuum/ecovacs.py

+    async def async_added_to_hass(self) -> None:
+        """d."""
+        # Fire off some queries to get initial state
+        self.device.statusEvents.subscribe(self.on_status)


Since all you do is call schedule_update_ha_state, why not use lambdas?

self.device.statusEvents.subscribe(lambda _: self.schedule_update_ha_state())

Yep, that's better. Each of those event handlers used to do more, but I moved the logic to the sucks library since their creation. I'll make this change.

balloob · 2018-07-18T09:46:29Z

homeassistant/components/vacuum/ecovacs.py

+        self.device.run(Charge())
+
+    @property
+    def battery_icon(self):


This seems a flaw in the vacuum ABC if you need to implement this yourself. Your implementation seems like how it should be?

It definitely is an issue with the ABC having no formal support for determining if the bot is charging. The reason I chose not to fix the ABC here is because the proper fix is the rearchitecture discussed here: home-assistant/architecture#29

I plan on updating this component after/alongside @cnrd makes the foundational changes

MartinHjelmare · 2018-07-18T11:12:42Z

homeassistant/components/ecovacs.py

+    # Convenient hack for debugging to pipe sucks logging to the Hass logger
+    if _LOGGER.getEffectiveLevel() <= logging.DEBUG:
+        import sucks
+        sucks.logging = _LOGGER


It would be good if the sucks library could be updated to use a logger per module, as is recommended.

https://docs.python.org/3/library/logging.html#logger-objects

Yep, you're right. Done.

MartinHjelmare · 2018-07-18T11:13:50Z

homeassistant/components/ecovacs.py

+    ecovacs_api = EcoVacsAPI(ECOVACS_API_DEVICEID,
+                             config[DOMAIN].get(CONF_USERNAME),
+                             EcoVacsAPI.md5(config[DOMAIN].get(CONF_PASSWORD)),
+                             config[DOMAIN].get(CONF_COUNTRY).lower(),


Move the lowercase modification to the config schema and use vol.Lower().

homeassistant/components/ecovacs.py

+    DOMAIN: vol.Schema({
+        vol.Required(CONF_USERNAME): cv.string,
+        vol.Required(CONF_PASSWORD): cv.string,
+        vol.Required(CONF_COUNTRY): vol.All(vol.Lower, cv.string),


frenck · 2018-07-21T12:11:49Z

I was unable to spot a related documentation PR, hence, I've added the docs-missing label.

balloob · 2018-07-23T09:59:13Z

homeassistant/components/vacuum/ecovacs.py

+
+        data[ATTR_ERROR] = self._error
+
+        for key, val in self.device.components.items():


It's not clear to me what values are added to the state machine. Meaning it can't be documented nor can it be judged if they are appropriate to be stored as state attributes to begin with.

Ah, these are attributes representing the lifespan of replaceable components on the vacuum. Today, they are hard coded in the lib to be main_brush, side_brush, and filter. (In Hass the attributes will be component_main_brush, etc.) The value is a 0-100 integer representing the percentage of lifespan remaining. I made it dynamic here because those three components may not be present on all vacuum models, so as we get feedback and make sucks more comprehensive for all vacuum models, this should appropriately populate based on what the vacuum actually has.

(I plan on documenting all of this in the docs once I implement the config entries)

balloob · 2018-07-24T08:11:21Z

Looks good to me. Can be merged when the docs are done.

OverloadUT · 2018-07-30T01:03:46Z

Docs added, but now we're waiting on an upstream version bump due to a bug I found writing the docs :)

cnrd · 2018-08-01T21:32:54Z

@OverloadUT The STATE support has been merged here: 2ff5b4c but I'm hoping that I can also get the split of start / pause merged soon: #15751 not sure if you want to base your PR on those changes?

Sucks is being slow to release currently, so doing this so we can get a version out the door.

OverloadUT · 2018-08-18T05:52:36Z

Okay, I just pushed up a very tiny change that fixes a bug in sucks 0.9.1 and bumps the requirement back down to that version.

I was originally waiting for 0.9.2 to be released, but the lib owner seems to currently be unavailable.

As soon as the documentation PR is reviewed, we should be good here: home-assistant/home-assistant.io#5922

( @cnrd in the interest of getting a version out so that we can start getting feedback on stability, I'm going to request this version be merged, but I'll work on a refactor to use your new system, if that's agreeable to everyone)

MartinHjelmare · 2018-08-18T06:18:28Z

homeassistant/components/vacuum/ecovacs.py

+        self.device.run(VacBotCommand(command, params))
+
+    @property
+    def state_attributes(self):


This should be device_state_attributes. These will be merged with state attributes.

Thanks; I hadn't realized about that method!

MartinHjelmare · 2018-08-18T06:18:59Z

homeassistant/components/vacuum/ecovacs.py

+    @property
+    def state_attributes(self):
+        """Return the state attributes of the vacuum cleaner."""
+        data = super().state_attributes


This isn't needed.

leofuscaldi · 2018-08-23T16:02:41Z

After this, whats is the next step to have it working with HA?

trisk · 2018-08-23T16:28:42Z

@leofuscaldi Install HA from the dev branch or wait for the next release (0.77).

OverloadUT added 13 commits July 12, 2018 13:37

Ecovacs Deebot vacuums WIP

71597c6

More WIP

da08c60

All core features implemented

51e15d2

Getting fan speed and locating the vac are still unsupported until sucks adds support

Move init queries to the added_to_hass method

3f9de5f

Adding support for subscribing to events from the sucks library

5158f67

This support does not exist in sucks yet; this commit serves as a sort of TDD approach of what such support COULD look like.

Add OverloadUT as ecovacs code owner

17e7f43

Full support for Ecovacs vacuums (Deebot)

0085f12

Add requirements

8762825

Linting fixes

bf1d433

Make API Device ID random on each boot

ef4bae1

Fix unique ID

16de5c6

Never worked before, as it should have been looking for a key, not an attribute

Fix random string generation to work in Python 3.5 (thanks, Travis!)

6c821f7

Add new files to .coveragerc

c6684ad

homeassistant added cla-signed new-platform integration: ecovacs platform: vacuum.ecovacs labels Jul 17, 2018

ghost assigned OverloadUT Jul 17, 2018

ghost added the in progress label Jul 17, 2018

balloob reviewed Jul 18, 2018

View reviewed changes

MartinHjelmare reviewed Jul 18, 2018

View reviewed changes

MartinHjelmare reviewed Jul 20, 2018

View reviewed changes

frenck added the docs-missing label Jul 21, 2018

Bump sucks to 0.9.1 now that it has released

1e33d77

homeassistant added the cla-signed label Jul 21, 2018

Update requirements_all.txt as well

854ca6e

balloob reviewed Jul 23, 2018

View reviewed changes

balloob approved these changes Jul 24, 2018

View reviewed changes

Bump sucks version to fix lifespan value errors

b95e137

OverloadUT added the waiting-for-upstream We're waiting for a change upstream label Jul 29, 2018

OverloadUT mentioned this pull request Jul 29, 2018

Add documentation for the new Ecovacs (Deebot) component and vacuum home-assistant/home-assistant.io#5922

Merged

2 tasks

OverloadUT removed the docs-missing label Jul 29, 2018

Revert to sucks 0.9.1 and include a fix for a bug in that release

fc38f57

Sucks is being slow to release currently, so doing this so we can get a version out the door.

homeassistant added the cla-signed label Aug 18, 2018

OverloadUT removed the waiting-for-upstream We're waiting for a change upstream label Aug 18, 2018

MartinHjelmare reviewed Aug 18, 2018

View reviewed changes

Switch state_attributes to device_state_attributes

c9a0e20

homeassistant added the cla-signed label Aug 18, 2018

balloob approved these changes Aug 20, 2018

View reviewed changes

balloob merged commit df6239e into home-assistant:dev Aug 20, 2018

ghost removed the in progress label Aug 20, 2018

home-assistant locked as resolved and limited conversation to collaborators Aug 23, 2018

ghost removed the platform: vacuum.ecovacs label Mar 21, 2019

OverloadUT deleted the add-ecovacs-component branch May 2, 2019 20:19


		ECOVACS_FAN_SPEED_LIST = ['normal', 'high']

		# These consts represent bot statuses that can come from the `sucks` library


		data[ATTR_ERROR] = self._error

		for key, val in self.device.components.items():

Add ecovacs component #15520

Add ecovacs component #15520

Conversation

OverloadUT commented Jul 17, 2018 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

frenck commented Jul 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Jul 24, 2018

OverloadUT commented Jul 30, 2018

cnrd commented Aug 1, 2018

OverloadUT commented Aug 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leofuscaldi commented Aug 23, 2018

trisk commented Aug 23, 2018

OverloadUT commented Jul 17, 2018 •

edited

Example entry for `configuration.yaml` (if applicable):