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:

importasynciofromroborock.web_apiimportRoborockApiClientfromroborock.devices.device_managerimportcreate_device_manager, UserParamsasyncdefmain():
email_address="youremailhere@example.com"web_api=RoborockApiClient(username=email_address)
# Send a login code to the above email addressawaitweb_api.request_code()
# Prompt the user to enter the codecode=input("What is the code?")
user_data=awaitweb_api.code_login(code)
# Create a device manager that can discover devices.user_params=UserParams(username=email_address, user_data=user_data)
device_manager=awaitcreate_device_manager(user_params)
devices=awaitdevice_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.fordeviceindevices:
ifnotdevice.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.statusawaitstatus_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

• Thanks to @rovo89 for Login APIs gist.
• Thanks to @PiotrMachowski for Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor.