Client Library for Deebot devices (Vacuums)
IMPORTANT: Contribution only
This project is maintained in our spare time. Please be patient and respectful.
It's not related to Ecovacs or Deebot and we don't get any support from them.
As all is reverse engineered it might take some time to add new features and we can't guarantee that all features will be added.
Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. As result of this, we decided that this project is in a contribution only mode.
This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. Members will still review and help on pull requests.
Installation
If you have a recent version of Python 3, you should be able to
do pip install deebot-client 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 time
from deebot_client.api_client import ApiClient
from deebot_client.authentication import Authenticator, create_rest_config
from deebot_client.commands.json.clean import Clean, CleanAction
from deebot_client.events import BatteryEvent
from deebot_client.mqtt_client import MqttClient, create_mqtt_config
from deebot_client.util import md5
from deebot_client.device import Device
device_id = md5(str(time.time()))
account_id = "your email or phonenumber (cn)"
password_hash = md5("yourPassword")
country = "DE"
async def main():
async with aiohttp.ClientSession() as session:
logging.basicConfig(level=logging.DEBUG)
rest_config = create_rest_config(
session, device_id=device_id, alpha_2_country=country
)
authenticator = Authenticator(rest_config, account_id, password_hash)
api_client = ApiClient(authenticator)
devices_ = await api_client.get_devices()
bot = Device(devices_.mqtt[0], authenticator)
mqtt_config = create_mqtt_config(device_id=device_id, country=country)
mqtt = MqttClient(mqtt_config, authenticator)
await bot.initialize(mqtt)
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.subscribe(BatteryEvent, 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.
Note for Windows users
This library cannot be used out of the box with Windows due a limitation in the requirement aiomqtt.
More information and a workaround can be found here
Thanks
My heartfelt thanks to:
- deebotozmo, After all, this is a debotozmo fork :)
- sucks, deebotozmo was forked from it :)
- xmpppeek, a great library for examining XMPP traffic flows ( yes, your vacuum speaks Jabber!),
- 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!
1 maintainer
Release files for deebot-client 18.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| deebot_client-18.6.0.tar.gz | 278.9 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| deebot_client-18.6.0-cp314-cp314-win_amd64.whl | CPython 3.14 | CPython 3.14 | Windows x86-64 | Details |
| deebot_client-18.6.0-cp314-cp314-musllinux_1_2_x86_64.whl | CPython 3.14 | CPython 3.14 | Linux musl 1.2+ x86-64 | Details |
| deebot_client-18.6.0-cp314-cp314-musllinux_1_2_aarch64.whl | CPython 3.14 | CPython 3.14 | Linux musl 1.2+ ARM64 | Details |
| deebot_client-18.6.0-cp314-cp314-manylinux_2_34_x86_64.whl | CPython 3.14 | CPython 3.14 | Linux glibc 2.34+ x86-64 | Details |
| deebot_client-18.6.0-cp314-cp314-manylinux_2_34_aarch64.whl | CPython 3.14 | CPython 3.14 | Linux glibc 2.34+ ARM64 | Details |
| deebot_client-18.6.0-cp314-cp314-macosx_11_0_arm64.whl | CPython 3.14 | CPython 3.14 | macOS 11.0+ ARM64 | Details |
| deebot_client-18.6.0-cp314-cp314-macosx_10_12_x86_64.whl | CPython 3.14 | CPython 3.14 | macOS 10.12+ x86-64 | Details |
Total release size: 9.4 MB
Release files / deebot_client-18.6.0.tar.gz
| Download URL | deebot_client-18.6.0.tar.gz |
|---|---|
| Size | 278.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
17b6ecb5d0d20fa1112b70e0feaaee73f2aa140f16384f63170d7197a7280a19
|
|
BLAKE2b-256 checksum How to use checksums |
35f5a300a129e6f469a6e0dafa8a2791f7610846d4c1402bd5d948cf7ed11df2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-win_amd64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
cd7421fb6207fb492cbca48ef71ae8c475d47dfdf496e59746947fb17c7cd47e
|
|
BLAKE2b-256 checksum How to use checksums |
f81111a84d1c5284c65e78f99a20f8104787dffb725219313d8f96e91cd5aa16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-musllinux_1_2_x86_64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 1.5 MB |
| Tags | CPython 3.14 Linux musl 1.2+ x86-64 |
|
SHA-256 checksum How to use checksums |
23e95216163317b2ef29db7e9b1f91046f8ddaeb80ccdf56ccf8e69e57ea3c58
|
|
BLAKE2b-256 checksum How to use checksums |
10cc185f9174ea4a17c05136dbe5e8dd27a44cc746a5de6d7ac325b0061220bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-musllinux_1_2_aarch64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 1.4 MB |
| Tags | CPython 3.14 Linux musl 1.2+ ARM64 |
|
SHA-256 checksum How to use checksums |
5352af9f9f55f7796e1dd5631d281b619a96000d1614b72c7041df7e100d9ce3
|
|
BLAKE2b-256 checksum How to use checksums |
6c253dfb31c05874402c3c1bcd683a0f7c88d485b42ca6b764723fabdb2ab100
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-manylinux_2_34_x86_64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.14 Linux glibc 2.34+ x86-64 |
|
SHA-256 checksum How to use checksums |
bcb0fa21b19132e876eecc713a956ee0f438985095e9a326c410f98fa0f0b703
|
|
BLAKE2b-256 checksum How to use checksums |
0f824d661496a3a5ee19f93e4a31d8457a9ddd26915d4043d5c576e729b4b8f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-manylinux_2_34_aarch64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-manylinux_2_34_aarch64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.14 Linux glibc 2.34+ ARM64 |
|
SHA-256 checksum How to use checksums |
3855afedc819b8829097ddd9ffcbe1bc28f0ca2d47877252948ac766a045b88a
|
|
BLAKE2b-256 checksum How to use checksums |
04c631f523ea4b36a8454595babc490b1bce0cf416dee90594ea10b22d231bd5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-macosx_11_0_arm64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | CPython 3.14 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
8046780a1736d4cef42565f68e1082dd502c50bd5381989f0ef84f0f2dd61e27
|
|
BLAKE2b-256 checksum How to use checksums |
6cfe7797d61cf0d256077fb790be13e2c0618258fbb20184b5e20ea14c62b96b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / deebot_client-18.6.0-cp314-cp314-macosx_10_12_x86_64.whl
| Download URL | deebot_client-18.6.0-cp314-cp314-macosx_10_12_x86_64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | CPython 3.14 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
e18f622a9056d638f11475e276d54277f9d2836ecb3a298eb751ad09325a95e6
|
|
BLAKE2b-256 checksum How to use checksums |
a9ef1c7c1b19169c22d8271d18c3c9f38f3b36edede08dc15ad5990b1f6eb6b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency log
