forked from github.com/eufy_robovac
Fix logic errors in previous commits, update version readme and changelog, add features, improve things, etc.
This commit is contained in:
29
README.md
29
README.md
@@ -8,6 +8,7 @@
|
||||
- [Command-line](#command-line)
|
||||
- [Config file](#config-file)
|
||||
- [Usage](#usage)
|
||||
- [Examples](#examples-1)
|
||||
- [Obtaining device credentials](#obtaining-device-credentials)
|
||||
- [tl;dr](#tldr)
|
||||
- [Instructions:](#instructions-1)
|
||||
@@ -77,7 +78,7 @@ local_code=LOCAL_CODE
|
||||
# Usage
|
||||
|
||||
```
|
||||
usage: vac [-h] [-c CONFIG] [--device_id DEVICE_ID] [--ip IP] [--local_code LOCAL_CODE] [--time TIME] [--pause] [--home] [--debug] [--verbose] [--quiet]
|
||||
usage: vac.py [-h] [-c CONFIG] [--device_id DEVICE_ID] [--ip IP] [--local_code LOCAL_CODE] [--time TIME] [--home] [--pause] [--mode MODE] [--verbose] [--quiet] [--status] [--return]
|
||||
|
||||
Control a Robovac device.
|
||||
|
||||
@@ -91,11 +92,33 @@ options:
|
||||
--local_code LOCAL_CODE
|
||||
Secret key obtained from eufy
|
||||
--time TIME, -t TIME Cleaning time in minutes
|
||||
--pause, -p Pause vacuum
|
||||
--home, -b Go home
|
||||
--debug, -d Enter debugging mode (won't send commands to vacuum)
|
||||
--pause, -p Pause vacuum
|
||||
--mode MODE, -m MODE Options: default, max, edge, spot, quiet
|
||||
--verbose, -v Enable verbose logs
|
||||
--quiet, -q Quiet logs
|
||||
--status, -s Print status
|
||||
--return, -r Return to base upon completion (requires -t)
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
__Clean for 5 minutes, then go home__
|
||||
|
||||
```
|
||||
robovac -t 5 -r
|
||||
```
|
||||
|
||||
__Clean the edge of the room until the battery runs out, then go home__
|
||||
|
||||
```
|
||||
robovac -m edge
|
||||
```
|
||||
|
||||
__Clean for 20 minutes then go home. Quiet all logs and run process in the background__
|
||||
|
||||
```
|
||||
robovac -t 20 -r -q > /dev/null 2>&1 &
|
||||
```
|
||||
|
||||
# Obtaining device credentials
|
||||
|
||||
Reference in New Issue
Block a user