README.md

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

Notes

This library is only for firmware 2.x.x Check your robot version!

Only local connections are supported.

How to get your username/blid and password

To get password from Roomba type in console:

$ roomba-password <ip>

It will find your Roomba in local network, then follow the instructions in console to get password. If IP address not provided password will be request for auto discovered robot.

Also you can just ask Roomba for info:

$ roomba-discovery <optional ip address>

To test connection with iRobot:

$ roomba-connect <ip> <password>

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