guru
/
eupy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add README.md

This commit is contained in:
Maurizio Porrato 2019-02-18 07:09:07 +00:00
parent 7bbbe52a52
commit cf0836da3b
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
eupy
====
This repository contains the information I gathered reverse engineering
the protocol by the infrared remote to control the Eufy RoboVac 11s robot
vacuum cleaner.
Apart from the
[protocol documentation](https://git.worn.eu/guru/eupy/src/branch/master/protocol.md)
itself, it also provides a "reference implementation" of the protocol in
python. At the moment the code contains only two IR beamer drivers, both
targeted at Android (4.4+): one uses the termux-infrared-transmit script from
[termux-api](https://wiki.termux.com/wiki/Termux:API) and one uses Kivi's
`plyer` module. Only the Termux-based driver has been tested so far.
The python tool takes simple instructions from the command line or from an
interactive console and beams the corresponding IR signal to the robot.
It can also read the instruction from a script file.
Based on the information contained here I started writing a native Android
application called [AndroVac](https://git.worn.eu/guru/AndroVac) meant to
replace the original remote.