Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 5.27 KB

README.md

File metadata and controls

87 lines (66 loc) · 5.27 KB
Raw

@Guillaume042 : I've made some really DIRTY change to make it work please take care of what you're doing with this code Tested with bumper but not tested with Cloud access

Latest version is 1.7.0 that includes updates that SHOULD at least let the component work with newer HASS versions. This version includes async updates so the comoponent won't crap out on setup if it's unable to reach the vacuum. I am unable to tset these changes since I don't have HASS currently setup and I don't have my old Ecovacs vacuum anymore (handed down to younger sis).

If 1.7.0 doesn't work, use version 1.6.0. I just made the bare minimum changes to the component that again SHOULD work, but I'm unable to test it. HASS ditched the VacuumEntity import for the vacuum component at some point and change it to StateVacuumEntity. That's all that's included in this update. Thanks @guillaume042 for making it easy for me by pointing me straight to a an issue with another component using VacuumEntity (though theirs was just leftover code that wasn't actually being used).

Home Assistant Ecovacs Custom Component with Bumper Support

Based off the regular home assistant ecovacs components and bmartin's fork of sucks, https://github.com/bmartin5692/sucks. Replaces built in ecovacs component, with some upgrades and fixes. Allows SSL verification to be set to false to work with a self-hosted bumper server, https://github.com/bmartin5692/bumper, a replacement for Ecovacs servers to truly get local control.

Works with bumper with my N79 and should work with other XMPP based ecovacs. Catches some XMPP messages now that the default HASS one misses (at least with my Ecovacs), including some initial queries and also life span for filters and brushes. Includes MQTT robot support from bmartin's fork that's basically unchanged in this since I don't have one of those robots.

Should work as regular without bumper if verify_ssl is true or omitted in config but haven't tested yet, goal was to get it all local. Maybe mess around and test it in future.

Bumper Setup

Check out bmartin's docs to setup a bumper server, https://bumper.readthedocs.io/.

Home Assistant Install & Config

HACS Install

You can add this repository to your HACS: https://github.com/bittles/ha_ecovacs_bumper

Then download with HACS, HACS -> Integrations -> Explore & Download Repositories -> EcovacsBumper

Restart HASS.

Manually Install

Drop the ecovacs folder into your custom_components folder.

Restart HASS.

Config

Example in configuration.yaml:

ecovacs:
  username: bumper
  password: bumper
  country: us
  continent: na
  verify_ssl: false

If you're not using bumper this SHOULD technically work no different than the Home Assistant ecovacs integration but I haven't tested it.

Paremeter Description Required/Optional
username Ecovacs username, can be anything if using bumper required
password Ecovacs password, can be anything if using bumper required
country Ecovacs country, can be anything if using bumper required
continent Ecovacs continent, can be anything if using bumper required
verify_ssl true/false, defaults to true. Use false if using bumper optional

Country/Continent Values and Pairs

From the HASS ecovacs integration page:

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 py-sucks library protocol documentation for more information about what has been figured out about the Ecovacs servers.

Additional note: There are some issues during the password encoding. 
Using some special characters (e.g., -) in your password does not work.

From the sucks documentation:

country code matching continent code
CH ww or as
TW, MY, JP, SG, TH, HK, IN, KR as
US na
FR, ES, UK, NO, MX, DE, PT, CH, AU, IT, NL, SE, BE, DK eu
Any other country code ww

Logging

If your debug logs are throwing errors and the errno is '' then my small fork of bumper may help https://github.com/bittles/bumper-fork, which also includes ability to disable the XMPP or MQTT servers seperately if you don't own a robot that uses that protocol.

logger:
  logs:
    sleekxmpss: debug
    custom_components.ecovacs.sucksbumper: debug  # or whatever level you want

To-Do:

Make component async, use config_flow, create device and clean up some of the hass integration stuff. Not in that order.

Misc Info From Making This

Commit history is a bit of a mess. master branch shows changes from bmartins fork of sucks to v1.3.0 of this custom component. dev branch shows commits from my attempts at testing and getting this to work.

Added additional catches to sucks because my N79 sends some weird payloads, but attributes all pull in now for brush life spans. Couple initial queries it also sends weird that I'm in process of catching atm. As of version 1.3.0 (in the manifest.json) these initial queries and all attributes are working. Was using an implementation completely mine but saw in the MQTT class there were already catches for child payloads without the main payload having the expected td in its payload. Kept comments in giving credit and adapted them to work with xmpp.