gronod/ha_ecovacs_bumper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add new successful model; other minor changes

Browse Source
This commit is contained in:
William Pietri
2017-12-18 17:43:17 -08:00
committed by GitHub
parent 8e548cd79b
commit 7748bcd705
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -11
View File
@@ -6,8 +6,8 @@ sucks
===== =====
A simple command-line python script to drive a robot vacuum. Currently A simple command-line python script to drive a robot vacuum. Currently
known to work with the Ecovacs Deebot N79, M80 Pro, M81, and M88 known to work with the Ecovacs Deebot N79, M80 Pro, M81, M88
Pro from both North America and Europe. Pro, and R95 MKII from both North America and Europe.
Does it work for your model as well? Join the discussion on the Does it work for your model as well? Join the discussion on the
[sucks-users mailing [sucks-users mailing
@@ -17,8 +17,7 @@ If you're curious about the protocol, I have [a rough doc](http://github.com/wpi
started. I'll happily accept pull requests for it. started. I'll happily accept pull requests for it.
Why the project name? Well, a) it's ridiculous that I needed to MITM Why the project name? Well, a) it's ridiculous that I needed to MITM
my own vacuum. This is not the future I signed up for. There should my own vacuum. This is not the future I signed up for. And b),
be a nice, tidy RESTful API. That would be easy enough to make. And b),
it's a vacuum. it's a vacuum.
## Installation ## Installation
@@ -101,7 +100,7 @@ shaping the API.
A simple usage might go something like this: A simple usage might go something like this:
``` ```
include sucks import sucks
config = ... config = ...
@@ -111,7 +110,8 @@ my_vac = api.devices()[0]
vacbot = VacBot(api.uid, api.REALM, api.resource, api.user_access_token, my_vac, config['continent']) vacbot = VacBot(api.uid, api.REALM, api.resource, api.user_access_token, my_vac, config['continent'])
vacbot.connect_and_wait_until_ready() vacbot.connect_and_wait_until_ready()
vacbot.run(Clean(900)) # clean for 15 minutes vacbot.run(Clean()) # start cleaning
time.sleep(900) # clean for 15 minutes
vacbot.run(Charge()) # return to the charger vacbot.run(Charge()) # return to the charger
``` ```
@@ -119,9 +119,8 @@ vacbot.run(Charge()) # return to the charger
If you'd like to join in on developing, I recommend checking out the code, If you'd like to join in on developing, I recommend checking out the code,
setting up a virtual environment, and doing `pip install -e .`. You can setting up a virtual environment, and doing `pip install -e .`. You can
run the existing tests using `nosetests`. Current test are not yet run the existing tests using `nosetests`. Please add tests for any
comprehensive, as the integrated nature of this makes it difficult. new functionality.
But I aim to reduce that problem over time, so please add tests as you go.
For more information see [the development documentation](developing.md) For more information see [the development documentation](developing.md)
@@ -143,5 +142,4 @@ very helpful in figuring out what the Android app was up to,
* Albert Louw, who was kind enough to post code from [his own * Albert Louw, who was kind enough to post code from [his own
experiments](https://community.smartthings.com/t/ecovacs-deebot-n79/93410/33) experiments](https://community.smartthings.com/t/ecovacs-deebot-n79/93410/33)
with his device, and with his device, and
* All the users who have given useful feedback and reported on how it is * All the users who have given useful feedback and contributed code!
working for them, and even contributed code.