@@ -13,7 +13,7 @@ Does it work for your model as well? Join the discussion on the
13
13
[ sucks-users mailing
14
14
list] ( https://groups.google.com/forum/#!forum/sucks-users ) .
15
15
16
- If you're curious about the protocol, I have [ a rough doc] ( protocol.md )
16
+ If you're curious about the protocol, I have [ a rough doc] ( http://github.com/wpietri/sucks/blob/master/ protocol.md)
17
17
started. I'll happily accept pull requests for it.
18
18
19
19
Why the project name? Well, a) it's ridiculous that I needed to MITM
@@ -23,15 +23,14 @@ it's a vacuum.
23
23
24
24
## Installation
25
25
26
- Check out this code, possibly create a virtualenv, and do
27
- ` pip install pipenv; pip install -e . ` . If that doesn't work for
28
- you, please [ open an issue ] ( https://github.com/wpietri/sucks/issues ) .
26
+ If you have a recent version of python, you should be able to
27
+ do ` pip install sucks ` to get the most recently released version of
28
+ this .
29
29
30
30
## Usage
31
31
32
32
To get started, you'll need to have already set up an EcoVacs account
33
- using your smartphone. I've only tested this with Android, but I expect
34
- it will work with iPhone-created accounts as well.
33
+ using your smartphone.
35
34
36
35
Step one is to log in:
37
36
```
@@ -44,7 +43,8 @@ Step one is to log in:
44
43
```
45
44
46
45
That creates a config file in ~ /.config.sucks.conf. The password is
47
- hashed before saving, so it's reasonably safe.
46
+ hashed before saving, so it's reasonably safe. (If it doesn't appear
47
+ to work for your continent, try "ww", their world-wide catchall.)
48
48
49
49
With that set up, you could have it clean in auto mode for 10 minutes
50
50
and return to its charger:
@@ -83,7 +83,7 @@ so it also has a mode where it randomly decides to run or not based on
83
83
a frequency you give it. My crontab entry looks like this:
84
84
85
85
```
86
- 0 10 * * * /home/william/projects/sucks/sucks clean -f 4/7 15 edge -f 1/14 10
86
+ 0 10 * * * /home/william/projects/sucks/sucks.sh clean -f 4/7 15 edge -f 1/14 10
87
87
```
88
88
89
89
This means that every day at 10 am, it might do something. 4 days out
@@ -118,9 +118,9 @@ vacbot.run(Charge()) # return to the charger
118
118
## Developing
119
119
120
120
If you'd like to join in on developing, I recommend checking out the code,
121
- doing ` pipenv install ` to set up a virtual environment, and then ` pipenv shell `
122
- to start using it. You can run the existing tests using ` nosetests ` . Current
123
- test are not yet comprehensive, as the integrated nature of this makes it difficult.
121
+ setting up a virtual environment, and doing ` pip install -e . ` . You can
122
+ run the existing tests using ` nosetests ` . Current test are not yet
123
+ comprehensive, as the integrated nature of this makes it difficult.
124
124
But I aim to reduce that problem over time, so please add tests as you go.
125
125
126
126
@@ -142,12 +142,4 @@ very helpful in figuring out what the Android app was up to,
142
142
experiments] ( https://community.smartthings.com/t/ecovacs-deebot-n79/93410/33 )
143
143
with his device, and
144
144
* All the users who have given useful feedback and reported on how it is
145
- working for them.
146
-
147
-
148
-
149
-
150
-
151
- ## To Do
152
-
153
- * add a status commmand
145
+ working for them, and even contributed code.
0 commit comments