Deebot client library in python 3
Project description
Client Library for Deebot devices (Vacuums)
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 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_[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!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
deebot_client-8.2.0.tar.gz
(116.3 kB
view details)
Built Distribution
deebot_client-8.2.0-py3-none-any.whl
(139.8 kB
view details)
File details
Details for the file deebot_client-8.2.0.tar.gz.
File metadata
- Download URL: deebot_client-8.2.0.tar.gz
- Upload date:
- Size: 116.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8a2a0a2673855eda81965a955c41bbdbc83b5eda1cdd40080dff66fa70a4372e |
|
| MD5 | 4b97b1287a80e8391e3062ecd5359ac7 |
|
| BLAKE2b-256 | ac8487a8e0a129c6ac01e10bef7b3b5ad50a91fe30cb7bbcb715e1d52e30f5c3 |
File details
Details for the file deebot_client-8.2.0-py3-none-any.whl.
File metadata
- Download URL: deebot_client-8.2.0-py3-none-any.whl
- Upload date:
- Size: 139.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 76d4dce4b782635a3ea749024c6e94d4add43c8860a845c8b2c9795e39b5ed89 |
|
| MD5 | fc13c14a40369490973aa3090a07d34c |
|
| BLAKE2b-256 | c2b7bb8f920ab9aef56818c57727956c124ff2ad05abbed0856f25543ed4038b |
