Library for DeebotOzmo 960/950/920

A simple command-line python script to drive a robot vacuum. Currently known to work with the Ecovacs Deebot 960/950/920 from both North America and Europe.

Installation

If you have a recent version of Python 3, you should be able to do pip install deebotozmo to get the most recently released version of this.

Usage

To get started, you'll need to have already set up an EcoVacs account using your smartphone.

You are welcome to try using this as a python library for other efforts. A simple usage might go something like this:

import aiohttp
import asyncio
import logging
import random
import string

from deebotozmo.commands import *
from deebotozmo.commands.clean import CleanAction
from deebotozmo.ecovacs_api import EcovacsAPI
from deebotozmo.ecovacs_mqtt import EcovacsMqtt
from deebotozmo.events import BatteryEvent
from deebotozmo.util import md5
from deebotozmo.vacuum_bot import VacuumBot

device_id = "".join(random.choice(string.ascii_uppercase + string.digits) for _ in range(12))
email = "your email or phonenumber (cn)"
password_hash = md5("yourPassword")
continent = "eu"
country = "de"


async def main():
  async with aiohttp.ClientSession() as session:
    logging.basicConfig(level=logging.DEBUG)
    api = EcovacsAPI(session, device_id, email, password_hash, continent=continent, country=country,
                     verify_ssl=False)
    await api.login()

    devices_ = await api.get_devices()

    auth = await api.get_request_auth()
    bot = VacuumBot(session, auth, devices_[0], continent=continent, country=country, verify_ssl=False)

    mqtt = EcovacsMqtt(continent=continent, country=country)
    await mqtt.initialize(auth)
    await mqtt.subscribe(bot)

    async def on_battery(event: BatteryEvent):
      # Do stuff on battery event
      if event.value == 100:
        # Battery full
        pass

    # Subscribe for events (more events available)
    bot.events.battery.subscribe(on_battery)

    # Execute commands
    await bot.execute_command(Clean(CleanAction.START))
    await asyncio.sleep(900)  # Wait for...
    await bot.execute_command(Charge())


if __name__ == '__main__':
  loop = asyncio.get_event_loop()
  loop.create_task(main())
  loop.run_forever()

A more advanced example can be found here.

Thanks

My heartfelt thanks to:

sucks, After all, this is a sucks fork :)
xmpppeek, a great library for examining XMPP traffic flows ( yes, your vacuum speaks Jabbber!),
mitmproxy, a fantastic tool for analyzing HTTPS,
click, a wonderfully complete and thoughtful library for making Python command-line interfaces,
requests, a polished Python library for HTTP requests,
Decompilers online, which was very helpful in figuring out what the Android app was up to,
Albert Louw, who was kind enough to post code from his own experiments with his device, and
All the users who have given useful feedback and contributed code!

Metadata

Release files for deebotozmo 3.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deebotozmo 3.0.2
File	Size	Uploaded
deebotozmo-3.0.2.tar.gz	45.0 kB	Oct 8, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for deebotozmo 3.0.2
File	Interpreter	ABI	Platform	Reset
deebotozmo-3.0.2-py3-none-any.whl 55.0 kB Oct 8, 2021	Python 3	none	any	Details

Total release size: 100.0 kB

Release files / deebotozmo-3.0.2.tar.gz

Download URL	deebotozmo-3.0.2.tar.gz
Size	45.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`4aecbe235d7f086d25c6971d30f382aafd1730bf75daeca932703d3453e8e30c`
BLAKE2b-256 checksum How to use checksums	`e93b397d474b8f5745bcf7b4b055e0ae08ccd5c76013bfe28998f6212ff5a330`
Upload date	Oct 8, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7`

Release files / deebotozmo-3.0.2-py3-none-any.whl

Download URL	deebotozmo-3.0.2-py3-none-any.whl
Size	55.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f211fe5c3075d98fd1890d329ab70f0f8d8e3d6ef8115f0cf4e887a4caedc07f`
BLAKE2b-256 checksum How to use checksums	`a304fbf50b29f08cee164c9825e5150d4885a7d097a7cf209c49b698c9a29add`
Upload date	Oct 8, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7`