Python program and library to control Wi-Fi enabled iRobot Roombas
Project description
roombapy
Unofficial iRobot Roomba python library (SDK).
Fork of NickWaterton/Roomba980-Python
This library was created for the Home Assistant Roomba integration.
Installation
pip install roombapy[cli]
Notes
This library is only for firmware 2.x.x Check your robot version!
Only local connections are supported.
How to discover your robots and obtain credentials
roombapy discover <optional ip address>
This will find your Roomba in local network, and obtain credentials automagically whether possible.
Event stream
To get event stream from iRobot, use:
roombapy connect <ip> -p <password>
Output is suitable for piping into tools like jq.
Development
To improve your development experience, you can install pre-commit hooks via the following command. With every commit it will run a set of checks, making sure it meets the quality standards.
pre-commit install
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.
