Docs and diagram #52

Merged
bmartin5692 merged 2 commits from diagram into master 2019-09-28 15:41:45 +02:00
5 changed files with 17 additions and 3 deletions

View file

@ -4,6 +4,8 @@
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.
| Master Branch | Status |

View file

@ -1,5 +1,7 @@
# How does Bumper work?
![Bumper Diagram](./images/BumperDiagram.png "Bumper Diagram")
Bumper runs multiple services to re-create what the central EcoVacs servers provide the bots and users. At this point two different protocols have been seen, **XMPP** and **MQTT**.
**Services**

View file

@ -1,4 +1,13 @@
# Using Bumper with Sucks
Instructions (verified to work with Sucks 0.8.3)
- Download and install [Sucks](https://github.com/wpietri/sucks)
- See the [example script](examples/sucks.py) for how to connect
At this time you'll need to use the bmartin5692 fork of sucks. Especially if you have a newer bot like an Ozmo.
- Download and install [Sucks](https://github.com/bmartin5692/sucks)
- You can use Sucks CLI to control the bots
**Note:** When performing the login command you'll either want to set `verify_ssl` to `False` or provide the full path to your Bumper certificate.
OR
- You can use Sucks as a library from your own script, see the [example script](../examples/sucks.py)

View file

@ -0,0 +1 @@
<mxfile host="www.draw.io" modified="2019-09-28T13:08:38.526Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:69.0) Gecko/20100101 Firefox/69.0" etag="p24nTdrdDcPJghOp5Mda" version="12.0.0" type="device" pages="1"><diagram id="tBTloOmGqy_bjKOA6F6G" name="Page-1">7VvbUuM4EP0aHuOyfM8jENidndkqapi9zBMlbMXx4FgeWSHJfP22bDmxLIcYiAMsQFUStzq6nNPdal1yYp/PV78xnM/+pBFJTywzWp3YkxPLCpALr0KwlgJnXAlilkSVyNwKrpNfpBKiWrpIIlJIWSXilKY8yVVhSLOMhFyRYcboUlWb0jRSBDmOidINIbgOcUo0tX+SiM/kKNyG9u8kiWd1y8iUJXNcK0tBMcMRXTZE9sWJfc4o5dWn+eqcpAI7FZfLHaWbjjGS8T5fCP74yj//tfxu//h1d/r5ji3JJzayJT33OF3IEcve8nUNAaOLLCKiFnRiny1nCSfXOQ5F6RI4B9mMz1NZXHBG78g5TSkrv22b5R+UTJM0bcin5R/IZQcI42S1c2hoAxgYGqFzwtkaVOovONU3pI2N/KB6Xm4Zs005sFmDLduWilhaSbypegskfJBYPgJXqweuMQCbPwUYaev4Nm2bbm/Axr7hKpghD2mYBUiHzLfrLx4cM9QDs5wmGSfs4h4GWtQmVzuWsLIIF7PSVs2H7DKjGdGRd03xD/IU35L0ihYJT2gGZSERjUKBICOB4PClpXBLOafzhsJpmsSigFPBMF3wNMmg9TpGiUawVNlUDuPIxTDnq1iEUoNOp0lIjIjcw1thhADhTT6Dnt/gLGI0iW5yRnPKRB9wKmos8qr6abISGPRzrQfsd6f91MwoDqYbizuYqQSaqVyE9G8cFiA8zXPNbgAArhoEI0XyS7qQoKO0rLKf7tmJOxFwLjgwXE5IqMFXSqZ8J9MFBMYki7+Jh8nIGYQD6bHuuPbEPS5bR8fDBzn/VQc5pxXhXF+Daxx0RDh/uAjn9AXsOag8wNXuCcHTsPE6HNqzBkJG9+djAVNxogPzUkj0mAShFkh/yf5k7IATQrAXJYhHDvK2f37HfNCtcnAMvTeFoazFNFzfG8M8Kl99JXpZhhl4rh04Hqpe9WDm+gaykYNMy/XEaxcB3SqHnxl6EJBFp2J9ts3GGqBX2iSq12YHtNKuNEXKGEkxT+7VNruwkS1ciZShkRQZG+7K10AlEBhUCVbrL+iChURW2VzGtVpxPaNpBq7zqFY4ZjHhWislyRvAns67/R55dw0naBKPFEaQa1gm0v360bzbxgPWta+VgXnvkde8voDrOIZjNVzWbiPqj5u86sm2a0AoDayNhtNhYt0qh88szf0M1Kk4oxzLdevIKtfMCQPEKwmYoxje8/LyJ5DhG2Pb2mneIwTFfsdyx1DmRNfWGfAMSDu2CsFQuX2PtdAgoQ+Z3bgeJ/Yhw1cnPU91IhPyDWc3+n2DH/CPVKLV7AiKx5bSkaOGv/EH9zr3YzVPaW+19p732tQqjUDS3HRux0NHJR6hNx52HYigSsKohl3LsGy3Wey85hCMXmrZgXZsRL0KP3wnMRi91NrjXZDvGGqUbW2tGn6ghPojU6/nXtvTgK/0lvJCM4U3eSCwYw9XsuDZHQcCXTvcwx0IHGUb91G7/iNHPwu27HEHKMFgqPRYHatn7JiF8iYEMnueXU7ci2AizCtmOEoAq5b6M6xu/+bKkQFFPfZ368PUZF5e8Gg6erej7j3aLQ+Fz3B4F5dkdR1mlY2d1vsXZtdmhuzPZMa5uMFyKpCwLsMoc4wEjH+agBkwI4QWrcsIcwxvQg4B7LIIWZJzCCYjnEWjnFGgej4XzynO4gXUK7RckQVdXq35jGY3KY0ppEWBkWfx4S1AVtPaOLF0h+s6Cxhs8x/1WI11HshP6dZrgFX4vxTN7vIo7abL5gtN15TKyrWEJ94i0C4MNGxa9L0OGVb9LMfbaYftywZ4WTgGTIFlPvApFP0RM2L1SdWa/+RcXD3gNKTpIKGlrkZd6yFTP/PoPJozhwrk+ibb2WKeAxf/i+xiDxmm2boy1HECZR0z2eix9n6H14Vg6pgvMqhUtFUYq3me3xSEiTtEQ5rHuG0dqPbePd7qDuWttq2Zg1jc1VFRckoZTJSxuED1hZZeJNj/QThfy3Aq3PIwC8V6Yqxi7EOKErlq2bR3qtM5edyaEpbEeN1QkKFp95LTHbfistMkS9MPHqluttTHLVOo+nvYc0tnIFsBi2Drf6ULlw/fxQP4inycrJqFk3Xz6YqwBEYmvL0Uvh7Dq/Z2jm54vhpigiNYRg3JRzY5UDYpFkLHySa9dhx66XSya8fSS3l5NHCvmJj3cyF+JlASMaqSRFg5mgjlq20hfIrle1orP7+WW9aWwGCrqjVx2W1V+jGSj5F01PItydaT54+nvelTBtH6dzpWK6VvxahpSpfhDDNuiH2WW7zzbkpHAB4uSLU2UzzUsaeLOvZ0rcGi1Fif7wbJmVHPJMU7VnL8vNWH+UZh27W9fiTY0CuDrT7p2o+b9aK4dWSlbwS3gewNHre/raxWA9sfqNoX/wE=</diagram></mxfile>

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB