Library for irobot roomba cloud api
This library implements some parts of the irobot cloud api (to control the different robots of the company).
Supported devices:
It has only been tested with a roomba i7 and a braava M6
Quickstart
$ pip3 install irbt
$ export IRBT_LOGIN="your@email.com"
$ export IRBT_PASSWORD="password"
$ irbt-cli.py -l # list rooms
$ irbt-cli.py -c start -r 'roomid' # start cleaning the room corresponding to the id
Features
- login using gigya/irbt api
- associated robot list
- history
- maps api (as json)
- missions api
- mqtt start, pause, stop, dock, find
- cli
usage: cli.py [-h] [-m] [-M] [-e] [-t] [-d] [-c [CMD]] [-l] [-r [ROOM_IDS]]
[-p] [-R] [-i [ROBOT_ID]] [-I] [-j] [-w]
optional arguments:
-h, --help show this help message and exit
-m, --map output current map
-M, --missions Missions history
-e, --evachistory Evac history
-t, --timeline Timeline
-d, --debug-mqtt debug-mqtt
-c [CMD], --cmd [CMD]
cmd for the robot (start, stop, dock, pause)
-l, --list-rooms List rooms
-r [ROOM_IDS], --room-ids [ROOM_IDS]
room ids to clean
-p, --robot-password Show robot password
-R, --robots List robots
-i [ROBOT_ID], --robot-id [ROBOT_ID]
Specify robot id
-I, --robot-infos Show robot infos
-j, --output-json Output as Json if possible
-w, --raw Output Raw Json (from server api) if possible
Install the dependencies
pip3 install -r requirements
Run
set your irobot credentials in the following var :
export IRBT_LOGIN="your.email@provider.com"
export IRBT_PASSWORD="yourpassword"
Then launch the cli (-h for the options)
./cli.py -h
You can also build the container using:
docker build . -t irbt_cli
Then run it with the credentials environment variable sets
docker run -e IRBT_LOGIN -e IRBT_PASSWORD -ti irbt_cli:latest python3 ./cli.py -h
for wireshark debugging
import sslkeylog
sslkeylog.set_keylog("sslkeylog.txt")
1 maintainer
Metadata
1 maintainer
Release files for irbt 0.15.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| irbt-0.15.1.tar.gz | 22.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| irbt-0.15.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 45.9 kB
Release files / irbt-0.15.1.tar.gz
| Download URL | irbt-0.15.1.tar.gz |
|---|---|
| Size | 22.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f89f38a0db2ef975b846cfee88cf5d74409f311ead1182987cff59f73f20ba1f
|
|
BLAKE2b-256 checksum How to use checksums |
42c47cf608a8396c7a02db4c65cd12647bb6d7137f5677578110aed83f180515
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 23, 2026.
Transparency logRelease files / irbt-0.15.1-py3-none-any.whl
| Download URL | irbt-0.15.1-py3-none-any.whl |
|---|---|
| Size | 23.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7e15dc7ba2f21d6ae1515b383d5cdfc41b8bf0b5387184e0fa4c2987e0025762
|
|
BLAKE2b-256 checksum How to use checksums |
5bc45f7ee58e46ab56f0947ebc1cb8fa5569b9a2b9feff67190d98fe09cdd086
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 23, 2026.
Transparency log
