Skip to content

Python program and library to control Wi-Fi enabled iRobot Roombas

License

Notifications You must be signed in to change notification settings

pschmitt/roombapy

This branch is 450 commits ahead of, 80 commits behind NickWaterton/Roomba980-Python:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3566c73 · Mar 25, 2025
Feb 4, 2025
Dec 2, 2024
Nov 29, 2024
Mar 1, 2024
Feb 26, 2024
May 8, 2017
Sep 3, 2017
Feb 28, 2024
Mar 25, 2025
Mar 10, 2021
Mar 25, 2025

Repository files navigation

roombapy

CI PyPI PyPI - Downloads PyPI - License

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

About

Python program and library to control Wi-Fi enabled iRobot Roombas

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • Python 100.0%