Skip to main content

Roborock

PyPI Version Supported Python versions License Code Coverage

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 like status, consumables, and maps. Use the command trait 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_properties using query_values() and set_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

Metadata

Release files for python-roborock 7.19.0

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

Source distribution (sdist)

Source distribution for python-roborock 7.19.0
File Size Uploaded Provenance Actions
python_roborock-7.19.0.tar.gz 241.4 kB With provenance Details for python_roborock-7.19.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-roborock 7.19.0
File Interpreter ABI Platform Actions
python_roborock-7.19.0-py3-none-any.whl Python 3 none any Details for python_roborock-7.19.0-py3-none-any.whl

Total release size: 553.8 kB

Release files / python_roborock-7.19.0.tar.gz

Download URL python_roborock-7.19.0.tar.gz
Size 241.4 kB
Tags Source
SHA-256 checksum
How to use checksums
bf02827698be0a1f2b87e9d28dbee54034918fe8b1c6fff9d3b703e38eae7fcf
BLAKE2b-256 checksum
How to use checksums
131eeb4c43233db456e6623b0f3e6a82cb454c27f868475931ee484dbddeb4dc
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 Nov 8, 2026.

Transparency log

Release files / python_roborock-7.19.0-py3-none-any.whl

Download URL python_roborock-7.19.0-py3-none-any.whl
Size 312.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e874991fc461fa2555515beba7540b82c520b9edc29dbaa87c2dab2daf650ef
BLAKE2b-256 checksum
How to use checksums
323058b6d9300170e2f1f72f8f20bfdf9218decad2b5a8690bafa914e949ad8a
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 Nov 8, 2026.

Transparency log

Security for python-roborock 7.19.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for python_roborock-7.19.0.tar.gz

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 Nov 8, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.19.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page