mia/bumper
1
0
Fork 0
Code Issues 47 Pull requests 11 Projects Releases Packages Wiki Activity Actions
A standalone and self-hosted implementation of the central server used by Ecovacs vacuum robots.
241 commits 11 branches 0 tags 26 MiB
Find a file
Brian Martin eb72e003f5 Update __init__.py
2020-01-01 00:35:29 -05:00
.github/ISSUE_TEMPLATE Update issue templates 2019-03-11 21:10:27 -04:00
bumper Update __init__.py 2020-01-01 00:35:29 -05:00
certs update gitignore add readme to empties 2019-06-07 08:05:09 -04:00
create_certs create certs valid 2 years 2019-10-01 09:57:30 -04:00
data add image for bots in ecovacs home 2019-12-27 11:51:31 -05:00
docs merge sucks example 2019-12-31 00:59:02 -05:00
hooks builds 2019-12-31 16:05:46 -05:00
logs update gitignore add readme to empties 2019-06-07 08:05:09 -04:00
tests Merge branch 'master' into extend-confserver-logging 2019-12-30 16:01:06 -05:00
.dockerignore Update gitignore 2019-12-30 11:58:13 -05:00
.gitignore Update gitignore 2019-12-30 11:58:13 -05:00
.travis.yml fix tests 2019-06-07 02:00:42 -04:00
appveyor.yml Update appveyor.yml 2019-11-22 15:04:50 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-03-11 21:12:15 -04:00
conftest.py More MQTT Logging 2019-09-27 17:25:57 -04:00
Dockerfile Update Dockerfile 2019-12-31 15:26:55 -05:00
LICENSE.txt License 2017-12-18 12:57:28 -08:00
mkdocs.yml mkdocs 2019-12-31 00:37:23 -05:00
Pipfile update requirements and pipenv 2019-12-31 12:53:43 -05:00
Pipfile.lock update requirements and pipenv 2019-12-31 12:53:43 -05:00
README.md mkdocs 2019-12-31 00:37:23 -05:00
requirements.txt update requirements and pipenv 2019-12-31 12:53:43 -05:00

README.md

License GPLv3

Bumper

Bumper is a standalone and self-hosted implementation of the central server used by Ecovacs vacuum robots. Bumper allows you to have full control of your Ecovacs robots, without the robots or app talking to the Ecovacs servers and transmitting data outside of your home.

Bumper Diagram

Note: The current master branch is unstable, and in active development.

Build Status

Master Branch Status
AppVeyor (Win32) AppVeyor
TravisCI (Linux) Build Status
Docker Hub Docker Build
CodeCov Coverage Codecov

Community: A Gitter community has been created for Bumper so users can chat and dig into issues outside of Github, join us here: Gitter chat

Testing needed Bumper needs users to assist with testing in order to ensure compatability as bumper moves forward! If you've tested Bumper with your bot, please open an issue with details on success or issues.

Please note: this software is experimental and not ready for production use. Use at your own risk.

Why?

For fun, mostly :)

But seriously, there are a several reasons for eliminating the central server:

  1. Convenience: It works without an internet connection or if Ecovacs servers are down
  2. Performance: No need for messages to travel to Ecovacs server and back.
  3. Security: We can completely isolate the robot from the public Internet.

Compatibility

As work to reverse the protocols and provide a self-hosted central server is still in progress, Bumper has had limited testing. There are a number of EcoVacs models that it hasn't been tested against. Bumper should be compatible with most wifi-enabled robots that use either the Ecovacs Android/iOS app or the Ecovacs Home Android/iOS app, but has only been reported to work on the below:

Model Protocol Used Bumper Version Tested EcoVacs App Tested
Deebot 900/901 MQTT master Ecovacs/Ecovacs Home
Deebot 600 MQTT master Ecovacs Home
Deebot Ozmo 950 MQTT master Ecovacs Home
Deebot Ozmo 601 XMPP master Ecovacs
Deebot Ozmo 930 XMPP master Ecovacs
Deebot M81 Pro XMPP v0.1.0 Ecovacs

Documentation and Getting Started

See the documentation on Read the Docs

Thanks

A big thanks to the original project creator @torbjornaxelsson, without his work this project would have taken much longer to build.

Bumper wouldn't exist without Sucks, an open source client for Ecovacs robots. Thanks to @wpietri and contributors!