mia/bumper
1
0
Fork 0
Code Issues 47 Pull requests 11 Projects Releases Packages Wiki Activity Actions

Update docs

Browse source 
Update docs
This commit is contained in:
Brian Martin 2019-06-07 09:40:04 -04:00
parent 0157cac703
commit d99a37d6ba
5 changed files with 213 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -4,10 +4,10 @@ Bumper is a standalone and self-hosted implementation of the central server used
**Note:** The current master branch is unstable, and in active development.
| Master Build Status | Status |
|--|--|
|AppVeyor (Win32) | ![AppVeyor](https://img.shields.io/appveyor/ci/bmartin5692/bumper.svg)|
|TravisCI (Linux) | ![Travis (.org)](https://img.shields.io/travis/bmartin5692/bumper.svg)|
| Master Build Status | Status |
| ------------------- | ---------------------------------------------------------------------- |
| AppVeyor (Win32) | ![AppVeyor](https://img.shields.io/appveyor/ci/bmartin5692/bumper.svg) |
| TravisCI (Linux) | ![Travis (.org)](https://img.shields.io/travis/bmartin5692/bumper.svg) |
Code Test Coverage: ![Codecov](https://img.shields.io/codecov/c/github/bmartin5692/bumper.svg)
@ -20,13 +20,13 @@ Bumper needs users to assist with testing in order to ensure compatability as bu
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 601 | XMPP | master | Ecovacs |
| Deebot Ozmo 930 | XMPP | master | Ecovacs |
| Deebot M81 Pro | XMPP | v0.1.0 | Ecovacs |
| 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 601 | XMPP | master | Ecovacs |
| Deebot Ozmo 930 | XMPP | master | Ecovacs |
| Deebot M81 Pro | XMPP | v0.1.0 | Ecovacs |
For more information about the protocols and how Bumper works, see the [How does it work?](docs/How_It_Works.md) page in the docs. If you test against another model and it works, please open an issue to report it.
@ -55,6 +55,7 @@ But seriously, there are a several reasons for eliminating the central server:
## Quick Start Usage
- Download bumper then run `pipenv install` to install dependencies
- Generate certificates for Bumper - See the [Creating Certs](docs/Create_Certs.md) doc
- Configure your Ecovacs vacuum using the official mobile app (if you haven't done this already)
- Configure your DNS server as described in the [DNS Setup](docs/DNS_Setup.md) doc.
- Start bumper - see the [Starting Bumper](#starting-bumper) section.
@ -69,7 +70,6 @@ But seriously, there are a several reasons for eliminating the central server:
- Reboot your robot
- **Note:** Some models may require removing and re-inserting the battery pack.
- This doesn't seem to be required for models that don't have easily accessible batteries such as the 900/901.
- If your configuration is correct, the robot will connect to Bumper within about 30 seconds. Bumper will output information about the connection status.
## Thanks