pybotvac

What it is and what it does

pybotvac is an unofficial reverse-engineered API for controlling Neato Botvac Connected vacuum robots from Python code. It wraps the Neato cloud API, allowing you to start cleaning, pause, stop, send the robot to its base, manage schedules, and retrieve robot state and map information. The package handles authentication through three session types—password-based, OAuth2, and passwordless (for MyKobold app users)—and uses requests, requests-oauthlib, and voluptuous to manage HTTP communication and configuration validation.

The typical workflow involves creating a session with your Neato credentials, instantiating an Account object to fetch your robot's serial and secret, then creating a Robot instance to issue commands. You can also retrieve cleaning maps and associated metadata through the Account class. The package is experimental and community-maintained, so reliability may vary depending on Neato's API stability and firmware changes.

Use it for:

• Automate vacuum cleaning schedules or trigger cleaning on-demand from a home automation system
• Build a dashboard or mobile app to monitor and control multiple Neato robots remotely
• Integrate vacuum state and map data into smart home routines or logging systems
• Retrieve and archive cleaning maps for analysis or visualization

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

pybotvac provides an unofficial Python API to control Neato Botvac Connected vacuum robots remotely, supporting commands like start, pause, stop, and schedule management.

Yes, if you own a Neato Botvac Connected robot and want programmatic control. The package has low install friction, permissive licensing, no known vulnerabilities, and active maintenance. However, treat it as experimental—the API is unofficial and reverse-engineered, so compatibility with firmware updates is not guaranteed. Verify that your robot model and Neato account type are supported before committing to it in production automation.

Install

pybotvac on PyPI

pip install pybotvac

uv add pybotvac

poetry add pybotvac

Installing pybotvac

Before you install

Low install friction with three straightforward dependencies (requests, requests-oauthlib, voluptuous). The package is actively maintained with recent commits and has been stable since its initial release.

License in practice

Licensed under the MIT license, which is permissive and allows commercial and private use with minimal restrictions.

Quickstart

pip install pybotvac

from pybotvac import Robot
robot = Robot('OPS01234-0123456789AB', '0123456789ABCDEF0123456789ABCDEF', 'my_robot')
robot.start_cleaning()

You must obtain your robot's serial number and secret key; these can be retrieved via the Account class using valid Neato credentials.

Verify before relying

• Whether the API remains compatible with current Neato Botvac firmware versions
• Support status for newer Neato robot models beyond the Connected line
• Whether all documented methods work reliably or if some are known to be unstable

Package facts

Evidence: pybotvac-0.0.29-py3-none-any.whl

Tags

More Utilities packages