Ecovacs


The ecovacs component is the main component to integrate all Ecovacs (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account.

Please see the Ecovacs Vacuum documentation for more information about using the vacuum entity.

Configuration

To add your Ecovacs devices into your Home Assistant installation, add the following to your configuration.yaml file:

ecovacs:
  username: YOUR_ECOVACS_USERNAME
  password: YOUR_ECOVACS_PASSWORD
  country: YOUR_TWO_LETTER_COUNTRY_CODE
  continent: YOUR_TWO_LETTER_CONTINENT_CODE

Configuration Variables

username

(string)(Required)Your username to login to your Ecovacs account.

password

(string)(Required)Your password to login to your Ecovacs account.

country

(string)(Required)Your two-letter country code (us, uk, etc).

continent

(string)(Required)Your two-letter continent code (na, eu, etc).

Note: For some countries, you will need to set continent to ww (meaning worldwide.) There is unfortunately no way to know the correct settings other than guessing and checking. See the sucks library protocol documentation for more information about what has been figured out about the Ecovacs servers.

Stability and Reporting Bugs

The library that talks to the Ecovacs servers is in a very early state and still under development. As such, it is likely that not all regions and devices will work at the current time.

Please see the sucks library documentation for some more information about what has been tested, and check out the GitHub issues to see if the issue you’re having is known or being worked on.

If you have an issue with the Ecovacs component, please file a GitHub Issue and include your Home Assistant logs in the report. To get full debug output from both the Ecovacs component and the underlying sucks library, place this in your configuration.yaml file:

logger:
  logs:
    homeassistant.components.ecovacs: debug
    homeassistant.components.vacuum.ecovacs: debug
    sucks: debug

Warning: doing this will cause your authentication token to visible in your log files. Be sure to remove any tokens and other authentication details from your log before posting them in an issue.