Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bmartin5692/bumper
A standalone and self-hosted implementation of the central server used by Ecovacs vacuum robots.
https://github.com/bmartin5692/bumper
deebot ecovacs ozmo self-hosted vacuum
Last synced: 10 days ago
JSON representation
A standalone and self-hosted implementation of the central server used by Ecovacs vacuum robots.
- Host: GitHub
- URL: https://github.com/bmartin5692/bumper
- Owner: bmartin5692
- License: gpl-3.0
- Created: 2019-01-11T03:21:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:14:52.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T05:08:35.380Z (3 months ago)
- Topics: deebot, ecovacs, ozmo, self-hosted, vacuum
- Language: Python
- Homepage:
- Size: 24.6 MB
- Stars: 279
- Watchers: 18
- Forks: 49
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
![License GPLv3](https://img.shields.io/github/license/bmartin5692/bumper.svg?color=brightgreen)
# 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](./docs/images/BumperDiagram.png "Bumper Diagram")
**Note:** The current master branch is unstable, and in active development.
## Build Status
| Master Branch | Status |
| ------------------- | ---------------------------------------------------------------------- |
| AppVeyor (Win32) | [![AppVeyor branch](https://img.shields.io/appveyor/ci/bmartin5692/bumper/master?logo=appveyor)](https://ci.appveyor.com/project/bmartin5692/bumper/branch/master) |
| TravisCI (Linux) | [![Travis (.org) branch](https://img.shields.io/travis/bmartin5692/bumper/master?logo=travis)](https://travis-ci.com/bmartin5692/bumper/branch/master) |
| Docker Hub | [![Docker Build](https://img.shields.io/docker/cloud/build/bmartin5692/bumper?logo=docker)](https://hub.docker.com/r/bmartin5692/bumper/branch/master) |
| CodeCov Coverage | [![Codecov branch](https://img.shields.io/codecov/c/github/bmartin5692/bumper/master?logo=codecov)](https://codecov.io/gh/bmartin5692/bumper/branch/master) |**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](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/ecovacs-bumper/community)***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.
## CompatibilityAs 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](https://bumper.readthedocs.io)
---
### 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](https://github.com/wpietri/sucks), an open source client for Ecovacs robots. Thanks to @wpietri and contributors!