Roborock
Roborock library for online and offline control of your vacuums.
Installation
Install this via pip (or your favourite package manager):
pip install python-roborock
To use the roborock command line tool, install the cli extra, which pulls in
its additional dependencies (click, pyyaml, pyshark):
pip install python-roborock[cli]
Example Usage
See examples/example.py for a more full featured example, or the API documentation for more details.
Here is a basic example:
import asyncio
from roborock.web_api import RoborockApiClient
from roborock.devices.device_manager import create_device_manager, UserParams
async def main():
email_address = "youremailhere@example.com"
web_api = RoborockApiClient(username=email_address)
# Send a login code to the above email address
await web_api.request_code()
# Prompt the user to enter the code
code = input("What is the code?")
user_data = await web_api.code_login(code)
# Create a device manager that can discover devices.
user_params = UserParams(username=email_address, user_data=user_data)
device_manager = await create_device_manager(user_params)
devices = await device_manager.get_devices()
# Get all vacuum devices. Each device generation has different capabilities
# and APIs available so to find vacuums we filter by the v1 PropertiesApi.
for device in devices:
if not device.v1_properties:
continue
# The PropertiesAPI has traits different device commands such as getting
# status, sending clean commands, etc. For this example we send a
# command to refresh the current device status.
status_trait = device.v1_properties.status
await status_trait.refresh()
print(status_trait)
asyncio.run(main())
Functionality
The library interacts with devices through specific API properties based on the device protocol:
- Standard Vacuums (V1 Protocol): Most robot vacuums use this. Interaction is done through
device.v1_properties, which contains traits likestatus,consumables, andmaps. Use thecommandtrait for actions like starting or stopping cleaning. - Wet/Dry Vacuums & Washing Machines (A01 Protocol): Devices like the Dyad and Zeo use this. Interaction is done through
device.a01_propertiesusingquery_values()andset_value().
You can find detailed documentation for Devices and Traits.
Supported devices
You can find what devices are supported here. Please note this may not immediately contain the latest devices.
Acknowledgements
- Thanks to @rovo89 for Login APIs gist.
- Thanks to @PiotrMachowski for Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python_roborock-5.28.0.tar.gz.
File metadata
- Download URL: python_roborock-5.28.0.tar.gz
- Upload date:
- Size: 183.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b6f7cc0a2b56af1dcd81df9350a196d71449a13c219d57fdd752ef1369e4d0f
|
|
| MD5 |
c0e35f5245776da3c1cfee10b0ca24ff
|
|
| BLAKE2b-256 |
7150c248deb7e32db6ae54d673300300d507d74ee8f534edba8e636732aed1d3
|
Provenance
The following attestation bundles were made for python_roborock-5.28.0.tar.gz:
Publisher:
ci.yml on Python-roborock/python-roborock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
python_roborock-5.28.0.tar.gz -
Subject digest:
7b6f7cc0a2b56af1dcd81df9350a196d71449a13c219d57fdd752ef1369e4d0f - Sigstore transparency entry: 2114125129
- Sigstore integration time:
-
Permalink:
Python-roborock/python-roborock@73ba2bf152d1c43b4d46d1e7f397043dd195d046 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Python-roborock
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@73ba2bf152d1c43b4d46d1e7f397043dd195d046 -
Trigger Event:
push
-
Statement type:
File details
Details for the file python_roborock-5.28.0-py3-none-any.whl.
File metadata
- Download URL: python_roborock-5.28.0-py3-none-any.whl
- Upload date:
- Size: 239.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
218b570bd49309dd900f859544a777f64a3d5929b9269d454f923d2a908e888c
|
|
| MD5 |
1ac6ce3f0a3d888bb22304f59d89b0ad
|
|
| BLAKE2b-256 |
2cdd0e2166f6e1f2be85c5a7eb4db6fc14cda80b62e80deeeffb914d8e2bd4c7
|
Provenance
The following attestation bundles were made for python_roborock-5.28.0-py3-none-any.whl:
Publisher:
ci.yml on Python-roborock/python-roborock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
python_roborock-5.28.0-py3-none-any.whl -
Subject digest:
218b570bd49309dd900f859544a777f64a3d5929b9269d454f923d2a908e888c - Sigstore transparency entry: 2114125197
- Sigstore integration time:
-
Permalink:
Python-roborock/python-roborock@73ba2bf152d1c43b4d46d1e7f397043dd195d046 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Python-roborock
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@73ba2bf152d1c43b4d46d1e7f397043dd195d046 -
Trigger Event:
push
-
Statement type:
