Initial commit

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2019 Richard Mitchell
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -0,0 +1,28 @@
+# Eufy Robovac control for Python
+
+Work in progress!
+
+## Installation
+Pre-requisites:
+* openssl (used for encryption)
+
+```
+git clone https://github.com/mitchellrj/eufy_robovac.git
+cd eufy_robovac
+python3 -m venv .
+bin/pip install -e .
+```
+
+## Demo usage
+```
+bin/demo DEVICE_ID LOCAL_KEY IP
+```
+
+The demo:
+* connects to your device,
+* prints its state out,
+* starts cleaning,
+* waits 30 seconds,
+* sends the device home,
+* waits 10 seconds,
+* disconnects & exits

eufy_robovac/__init__.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Richard Mitchell
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .robovac import Robovac

eufy_robovac/demo.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Richard Mitchell
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import asyncio
+import pprint
+import sys
+
+from eufy_robovac.robovac import Robovac
+
+
+async def connected_callback(message, device):
+    print("Connected. Current device state:")
+    pprint.pprint(device.state)
+
+
+async def cleaning_started_callback(message, device):
+    print("Cleaning started.")
+
+
+async def go_home_callback(message, device):
+    print("Device on its way home.")
+
+
+async def async_main(device_id, local_key, ip, *args, **kwargs):
+    r = Robovac(device_id, local_key, ip, *args, **kwargs)
+    await r.async_connect(connected_callback)
+    await asyncio.sleep(5)
+    print("Starting cleaning...")
+    await r.async_start_cleaning(cleaning_started_callback)
+    await asyncio.sleep(30)
+    print("Sending home...")
+    await r.async_go_home(go_home_callback)
+    await asyncio.sleep(10)
+    print("Disconnecting...")
+    await r.async_disconnect()
+
+
+def main(*args, **kwargs):
+    if not args:
+        args = sys.argv[1:]
+    asyncio.run(async_main(*args, **kwargs))
+
+
+if __name__ == '__main__':
+    main(*sys.argv[1:])

eufy_robovac/robovac.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Richard Mitchell
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+
+from .tuya import TuyaDevice
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class WorkMode:
+    AUTO = 'auto'
+    NO_SWEEP = 'Nosweep'
+    SMALL_ROOM = 'SmallRoom'
+    EDGE = 'Edge'
+    Spot = 'Spot'
+
+
+class Direction:
+    LEFT = 'left'
+    RIGHT = 'right'
+    FORWARD = 'forward'
+    BACKWARD = 'backward'
+
+
+class WorkStatus:
+    CHARGING = 'Charging'
+    STAND_BY = 'standby'
+    SLEEPING = 'Sleeping'
+    RECHARGING = 'Recharge'
+
+
+class CleanSpeed:
+    NO_SUCTION = 'No_suction'
+    STANDARD = 'Standard'
+    BOOST_IQ = 'Boost_IQ'
+    MAX = 'Max'
+
+
+class ErrorCode:
+    pass
+
+
+class Robovac(TuyaDevice):
+    """Represents a generic Eufy Robovac."""
+
+    PLAY_PAUSE = '2'
+    DIRECTION = '3'
+    WORK_MODE = '5'
+    WORK_STATUS = '15'
+    GO_HOME = '101'
+    CLEAN_SPEED = '102'
+    FIND_ROBOT = '103'
+    BATTERY_LEVEL = '104'
+    ERROR_CODE = '106'
+    KEY_NAMES = {
+        PLAY_PAUSE: 'play/pause',
+        DIRECTION: 'direction',
+        WORK_MODE: 'work mode',
+        WORK_STATUS: 'work status',
+        GO_HOME: 'go home',
+        CLEAN_SPEED: 'clean speed',
+        FIND_ROBOT: 'find robot',
+        BATTERY_LEVEL: 'battery level',
+        ERROR_CODE: 'error code'
+    }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    async def async_start_cleaning(self, callback=None):
+        await self.async_set({self.WORK_MODE: WorkMode.AUTO}, callback)
+
+    async def async_go_home(self, callback=None):
+        await self.async_set({self.GO_HOME: True}, callback)

eufy_robovac/tuya.py

@@ -0,0 +1,542 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Richard Mitchell
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Based on portions of https://github.com/codetheweb/tuyapi/
+#
+# MIT License
+#
+# Copyright (c) 2017 Max Isom
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import asyncio
+import base64
+import json
+from json.decoder import JSONDecodeError
+import logging
+import socket
+import struct
+import time
+
+from cryptography.hazmat.backends.openssl import backend as openssl_backend
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from cryptography.hazmat.primitives.hashes import Hash, MD5
+from cryptography.hazmat.primitives.padding import PKCS7
+
+
+_LOGGER = logging.getLogger(__name__)
+MESSAGE_PREFIX_FORMAT = '>IIII'
+MESSAGE_SUFFIX_FORMAT = '>II'
+MAGIC_PREFIX = 0x000055AA
+MAGIC_SUFFIX = 0x0000AA55
+MAGIC_SUFFIX_BYTES = struct.pack('>I', MAGIC_SUFFIX)
+CRC_32_TABLE = [
+    0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA,
+    0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3,
+    0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988,
+    0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91,
+    0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
+    0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7,
+    0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC,
+    0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5,
+    0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172,
+    0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
+    0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940,
+    0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59,
+    0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116,
+    0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
+    0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
+    0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
+    0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A,
+    0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433,
+    0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818,
+    0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
+    0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E,
+    0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457,
+    0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C,
+    0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65,
+    0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
+    0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB,
+    0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0,
+    0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
+    0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086,
+    0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
+    0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4,
+    0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
+    0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A,
+    0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683,
+    0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
+    0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1,
+    0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE,
+    0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7,
+    0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC,
+    0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
+    0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252,
+    0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
+    0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60,
+    0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79,
+    0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
+    0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F,
+    0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04,
+    0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
+    0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A,
+    0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
+    0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38,
+    0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21,
+    0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E,
+    0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777,
+    0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
+    0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
+    0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2,
+    0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB,
+    0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0,
+    0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
+    0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6,
+    0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF,
+    0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94,
+    0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D
+]
+
+
+class TuyaException(Exception):
+    """Base for Tuya exceptions."""
+
+
+class InvalidKey(TuyaException):
+    """The local key is invalid."""
+
+
+class InvalidMessage(TuyaException):
+    """The message received is invalid."""
+
+
+class MessageDecodeFailed(TuyaException):
+    """The message received cannot be decoded as JSON."""
+
+
+class ConnectionException(TuyaException):
+    """The socket connection failed."""
+
+
+class ConnectionTimeoutException(ConnectionException):
+    """The socket connection timed out."""
+
+
+class RequestResponseCommandMismatch(TuyaException):
+    """The command in the response didn't match the one from the request."""
+
+
+class TuyaCipher:
+    """The Tuya encryption cipher"""
+
+    def __init__(self, key, version):
+        """Initialize the cipher."""
+        self.version = version
+        self.key = key
+        self.cipher = Cipher(algorithms.AES(key.encode('ascii')), modes.ECB(),
+                             backend=openssl_backend)
+
+    def has_prefix(self, encrypted_data):
+        version = tuple(map(int, encrypted_data[:3].decode('utf8').split('.')))
+        if version != self.version:
+            return False
+        hash = encrypted_data[3:19].decode('ascii')
+        expected_hash = self.hash(encrypted_data[19:])
+        if hash != expected_hash:
+            return False
+
+        return True
+
+    def decrypt(self, data):
+        # Strip version and MD5 hash
+        if self.has_prefix(data):
+            data = data[19:]
+        decryptor = self.cipher.decryptor()
+        decrypted_data = decryptor.update(base64.b64decode(data))
+        decrypted_data += decryptor.finalize()
+        unpadder = PKCS7(128).unpadder()
+        unpadded_data = unpadder.update(decrypted_data)
+        unpadded_data += unpadder.finalize()
+
+        return unpadded_data
+
+    def encrypt(self, data):
+        padder = PKCS7(128).padder()
+        padded_data = padder.update(data)
+        padded_data += padder.finalize()
+        encryptor = self.cipher.encryptor()
+        encrypted_data = encryptor.update(padded_data)
+        encrypted_data += encryptor.finalize()
+
+        payload = base64.b64encode(encrypted_data)
+
+        hash = self.hash(payload)
+        result = "{}{}".format(
+            '.'.join(map(str, self.version)),
+            hash
+        ).encode('utf8') + payload
+
+        return result
+
+    def hash(self, data):
+        digest = Hash(MD5(), backend=openssl_backend)
+        to_hash = "data={}||lpv={}||{}".format(
+            data.decode('ascii'),
+            '.'.join(map(str, self.version)),
+            self.key
+        )
+        digest.update(to_hash.encode('utf8'))
+        intermediate = digest.finalize().hex()
+        return intermediate[8:24]
+
+def crc(data):
+    """Calculate the Tuya-flavored CRC of some data."""
+    c = 0xFFFFFFFF
+    for b in data:
+        c = (c >> 8) ^ CRC_32_TABLE[(c ^ b) & 255]
+
+    return c ^ 0xFFFFFFFF
+
+
+class Message:
+
+    PING_COMMAND = 0x09
+    GET_COMMAND = 0x0a
+    SET_COMMAND = 0x07
+    GRATUITOUS_UPDATE = 0x08
+
+    def __init__(self, command, payload=None, sequence=None, encrypt_for=None):
+        if payload is None:
+            payload = b''
+        self.payload = payload
+        self.command = command
+        if sequence is None:
+            # Use millisecond process time as the sequence number. Not ideal,
+            # but good for one month's continuous connection time though.
+            sequence = int(time.perf_counter() * 1000) & 0xFFFFFFFF
+        self.sequence = sequence
+        self.encrypt = False
+        self.device = None
+        if encrypt_for is not None:
+            self.device = encrypt_for
+            self.encrypt = True
+
+    def __repr__(self):
+        return "{}({}, {}, {})".format(
+            self.__class__.__name__,
+            hex(self.command),
+            repr(self.payload),
+            self.sequence)
+
+    def hex(self):
+        return self.bytes().hex()
+
+    def bytes(self):
+        payload_data = self.payload
+        if isinstance(payload_data, dict):
+            payload_data = json.dumps(
+                payload_data,
+                separators=(',',':')
+            )
+        if not isinstance(payload_data, bytes):
+            payload_data = payload_data.encode('utf8')
+
+        if self.encrypt:
+            payload_data = self.device.cipher.encrypt(payload_data)
+
+        payload_size = len(payload_data) + 8
+
+        header = struct.pack(
+            MESSAGE_PREFIX_FORMAT,
+            MAGIC_PREFIX,
+            self.sequence,
+            self.command,
+            payload_size,
+        )
+        footer = struct.pack(
+            MESSAGE_SUFFIX_FORMAT,
+            crc(payload_data),
+            MAGIC_SUFFIX
+        )
+        return (
+            header +
+            payload_data +
+            footer
+        )
+
+    class AsyncWrappedCallback:
+        def __init__(self, request, callback):
+            self.request = request
+            self.callback = callback
+            self.devices = []
+
+        def register(self, device):
+            self.devices.append(device)
+            device._handlers.setdefault(self.request.command, [])
+            device._handlers[self.request.command].append(self)
+
+        def unregister(self, device):
+            self.devices.remove(device)
+            device._handlers[self.request.command].remove(self)
+
+        def unregister_all(self):
+            while self.devices:
+                device = self.devices.pop()
+                device._handlers[self.request.command].remove(self)
+
+        async def __call__(self, response, device):
+            if response.sequence == self.request.sequence:
+                asyncio.ensure_future(self.callback(response, device))
+                self.unregister(device)
+
+    async def async_send(self, device, callback=None):
+        if callback is not None:
+            wrapped = self.AsyncWrappedCallback(self, callback)
+            wrapped.register(device)
+        await device._async_send(self)
+
+    @classmethod
+    def from_bytes(cls, data, cipher=None):
+        try:
+            prefix, sequence, command, payload_size = struct.unpack_from(
+                MESSAGE_PREFIX_FORMAT,
+                data
+            )
+        except struct.error as e:
+            raise InvalidMessage("Invalid message header format.") from e
+        if prefix != MAGIC_PREFIX:
+            raise InvalidMessage("Magic prefix missing from message.")
+
+        # check for an optional return code
+        header_size = struct.calcsize(MESSAGE_PREFIX_FORMAT)
+        try:
+            return_code, = struct.unpack_from('>I', data, header_size)
+        except struct.error as e:
+            raise InvalidMessage("Unable to unpack return code.") from e
+        if return_code >> 8:
+            payload_data = data[header_size:header_size + payload_size - 8]
+            return_code = None
+        else:
+            payload_data = data[header_size + 4:header_size + payload_size - 8]
+
+        try:
+            expected_crc, suffix = struct.unpack_from(
+                MESSAGE_SUFFIX_FORMAT,
+                data,
+                header_size + payload_size - 8
+            )
+        except struct.error as e:
+            raise InvalidMessage("Invalid message suffix format.") from e
+        if suffix != MAGIC_SUFFIX:
+            raise InvalidMessage("Magic suffix missing from message")
+
+        actual_crc = crc(data[:header_size + payload_size - 8])
+        if expected_crc != actual_crc:
+            raise InvalidMessage("CRC check failed")
+
+        payload = None
+        if payload_data:
+            try_decrypt = False
+            try:
+                payload_text = payload_data.decode('utf8')
+            except UnicodeDecodeError:
+                try_decrypt = True
+            else:
+                try:
+                    payload = json.loads(payload_text)
+                except json.decoder.JSONDecodeError:
+                    # data may be encrypted
+                    try_decrypt = True
+
+            if try_decrypt:
+                try:
+                    payload_data = cipher.decrypt(payload_data)
+                except ValueError as e:
+                    _LOGGER.debug(payload_data.hex())
+                    _LOGGER.error(e)
+                    raise MessageDecodeFailed() from e
+
+            try:
+                payload = payload_data.decode('utf8')
+                payload = json.loads(payload)
+            except (UnicodeDecodeError, json.decoder.JSONDecodeError):
+                # keep it as bytes
+                pass
+
+        return cls(command, payload, sequence)
+
+
+class TuyaDevice:
+    """Represents a generic Tuya device."""
+
+    PING_INTERVAL = 10
+
+    def __init__(self, device_id, local_key, host, port=6668, gateway_id=None,
+                 version=(3, 1), timeout=10):
+        """Initialize the device."""
+        self.device_id = device_id
+        self.host = host
+        self.port = port
+        if not gateway_id:
+            gateway_id = self.device_id
+        self.gateway_id = gateway_id
+        self.version = version
+        self.timeout = timeout
+        self.last_pong = 0
+
+        if len(local_key) != 16:
+            raise InvalidKey("Local key should be a 16-character string")
+
+        self.cipher = TuyaCipher(local_key, self.version)
+        self.writer = None
+        self._handlers = {
+            Message.GET_COMMAND: [self.async_update_state],
+            Message.GRATUITOUS_UPDATE: [self.async_update_state],
+            Message.PING_COMMAND: [self._async_pong_received],
+        }
+        self._dps = {}
+        self._disconnected = True
+
+    def __repr__(self):
+        return "{}({}, {}, {}, {})".format(
+            self.__class__.__name__,
+            self.device_id,
+            self.host,
+            self.port,
+            self.local_key
+        )
+
+    def __str__(self):
+        return "{} ({}:{})".format(self.device_id, self.host, self.port)
+
+    @property
+    def loop(self):
+        return asyncio.get_running_loop()
+
+    async def async_connect(self, callback=None):
+        sock = socket.socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
+        sock.settimeout(self.timeout)
+        _LOGGER.debug("Connecting to {}".format(self))
+        try:
+            sock.connect((self.host, self.port))
+        except socket.timeout as e:
+            raise ConnectionTimeoutException("Connection timed out") from e
+        self._disconnected = False
+        self.reader, self.writer = await asyncio.open_connection(sock=sock)
+
+        asyncio.ensure_future(self._async_handle_message())
+        asyncio.ensure_future(self._async_ping())
+        asyncio.ensure_future(self.async_get(callback))
+
+    async def async_disconnect(self):
+        _LOGGER.debug("Disconnected from {}".format(self))
+        self._disconnected = True
+        self.last_pong = 0
+        if self.writer is not None:
+            self.writer.close()
+
+    async def async_get(self, callback=None):
+        payload = {
+            'gwId': self.gateway_id,
+            'devId': self.device_id
+        }
+        message = Message(Message.GET_COMMAND, payload)
+        return await message.async_send(self, callback)
+
+    async def async_set(self, dps, callback=None):
+        t = int(time.time())
+        payload = {
+            'gwId': self.gateway_id,
+            'devId': self.device_id,
+            'uid': '',
+            't': t,
+            'dps': dps
+        }
+        message = Message(Message.SET_COMMAND, payload, encrypt_for=self)
+        return await message.async_send(self, callback)
+
+    async def _async_ping(self):
+        self.last_ping = time.time()
+        message = Message(Message.PING_COMMAND, sequence=0)
+        await self._async_send(message)
+        await asyncio.sleep(self.PING_INTERVAL)
+        if self.last_pong < self.last_ping:
+            await self.async_disconnect()
+        else:
+            asyncio.ensure_future(self._async_ping())
+
+    async def _async_pong_received(self, message, device):
+        self.last_pong = time.time()
+
+    async def async_update_state(self, state_message, _):
+        self._dps.update(state_message.payload["dps"])
+        _LOGGER.info("Received updated state {}: {}".format(self, self._dps))
+
+    @property
+    def state(self):
+        return dict(self._dps)
+
+    @state.setter
+    def state_setter(self, new_values):
+        asyncio.ensure_future(self.async_set(new_values))
+
+    async def _async_handle_message(self):
+        try:
+            response_data = await self.reader.readuntil(MAGIC_SUFFIX_BYTES)
+        except socket.error as e:
+            _LOGGER.error("Connection to {} failed".format(self))
+            asyncio.ensure_future(self.async_disconnect())
+            return
+
+        try:
+            message = Message.from_bytes(response_data, self.cipher)
+        except InvalidMessage as e:
+            _LOGGER.error("Invalid message from {}: {}".format(self, e))
+        except MessageDecodeFailed as e:
+            _LOGGER.error("Failed to decrypt message from {}".format(self))
+        else:
+            _LOGGER.debug("Received message from {}: {}".format(self, message))
+            for c in self._handlers.get(message.command, []):
+                asyncio.ensure_future(c(message, self))
+
+        asyncio.ensure_future(self._async_handle_message())
+
+    async def _async_send(self, message, retries=4):
+        _LOGGER.debug("Sending to {}: {}".format(self, message))
+        try:
+            self.writer.write(message.bytes())
+        except (socket.timeout, socket.error, OSError) as e:
+            if retries == 0:
+                raise ConnectionException("Failed to send data to {}".format(
+                    self)) from e
+            await self.async_connect()
+            await self_.async_send(message, retries=retries - 1)

setup.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Richard Mitchell
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import re
+from setuptools import setup, find_packages
+import sys
+import warnings
+
+dynamic_requires = []
+
+setup(
+    name='eufy_robovac',
+    version="0.0",
+    author='Richard Mitchell',
+    author_email='eufy-robovac@mitch.org.uk',
+    url='http://github.com/mitchellrj/eufy_robovac',
+    packages=find_packages(),
+    scripts=[],
+    description='Python API for controlling Eufy robotic vacuum cleaners',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+    ],
+    install_requires=[
+        'cryptography'
+    ],
+    entry_points = {
+        'console_scripts': ['demo=eufy_robovac.demo:main'],
+    }
+)