mia/bumper

A standalone and self-hosted implementation of the central server used by Ecovacs vacuum robots.

Find a file

Robert Resch f050213113 improve docker images creation as requirements are change less often		2021-04-19 20:49:39 +02:00
.github/ISSUE_TEMPLATE	Update issue templates	2019-03-11 21:10:27 -04:00
bumper	- use only one level subdomain urls on service list	2021-04-19 14:03:45 +02:00
certs	update gitignore add readme to empties	2019-06-07 08:05:09 -04:00
create_certs	add new used subdomains (for europe)	2021-04-19 20:46:39 +02:00
data	move data web under bumper	2020-01-06 09:31:22 -05:00
docs	add new used subdomains (for europe)	2021-04-19 20:46:39 +02: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	add oauth	2021-04-11 16:26:15 +02:00
.dockerignore	add new used subdomains (for europe)	2021-04-19 20:46:39 +02: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	improve docker images creation as requirements are change less often	2021-04-19 20:49:39 +02:00
LICENSE.txt	License	2017-12-18 12:57:28 -08:00
mkdocs.yml	Add sniffing and developing notes	2020-01-01 17:00:39 -05:00
Pipfile	add jinja2	2020-01-02 01:16:43 -05:00
Pipfile.lock	add jinja2	2020-01-02 01:16:43 -05:00
README.md	Update README.md	2020-01-02 10:08:56 -05:00
requirements.txt	fix build and add style	2020-01-02 08:46:11 -05:00

README.md

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.

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

Build Status

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

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

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:

Convenience: It works without an internet connection or if Ecovacs servers are down
Performance: No need for messages to travel to Ecovacs server and back.
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!