From cf0836da3b1324c501ff62c6698ec9464d7ca215 Mon Sep 17 00:00:00 2001 From: Maurizio Porrato Date: Mon, 18 Feb 2019 07:09:07 +0000 Subject: [PATCH] Add README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce4ae3d --- /dev/null +++ b/README.md @@ -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.