aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.md b/README.md
index e4894da..2867887 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,39 @@ Hi everyone !
Neato Control is a GUI based interface for [pybotvac](https://github.com/stianaske/pybotvac)
-
+# INSTALLATION
```python
pip install neatocontrols
```
+# USAGE
+
+For the `aneatocli.py` script :
+
+```bash
+Usage:
+ aneatocli.py (--gc | --get-commands) <robotname>
+ aneatocli.py (--go | --start-cleaning ) <robotname>
+ aneatocli.py (--stp | --stop-cleaning ) <robotname>
+ aneatocli.py (--pse | --pause-cleaning ) <robotname>
+ aneatocli.py (--res | --resume-cleaning) <robotname>
+ aneatocli.py (--base | --send-to-base ) <robotname>
+ aneatocli.py (--gi |--get-infos ) <robotname>
+ aneatocli.py (--lgsc | --log-secrets) <mail>
+ aneatocli.py (--ltst | --log-tests)
+ aneatocli.py -h | --help
+ aneatocli.py -v | --version
+
+Options:
+ -h , --help Show this message.
+ -v , --version Show version.
+ --go , --start-cleaning Tell the robot to start cleaning.
+ --stp , --stop-cleaning Tell the robot to stop cleaning.
+ --pse , --pause-cleaning Tell the robot to pause cleaning.
+ --res , --resume-cleaning Tell the robot to resume cleaning.
+ --base ,--send-to-base Tell the robot to go back to its dock.
+ --gc , --get-commands Get the available commands and write them to file '<robotname>-robotcommands.json'
+ --gi, --get-infos Get various infos about the current robot and write them to file '<robotname>-robotinfos.json'
+ --lgsc , --log-secrets Log the credentials into the file '<robotname>.json'.
+```
+
+Screenshots to come for the GUI part.