A Library to interact with irbt appliances
Project description
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")
Project details
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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file irbt-0.15.1.tar.gz.
File metadata
- Download URL: irbt-0.15.1.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f89f38a0db2ef975b846cfee88cf5d74409f311ead1182987cff59f73f20ba1f
|
|
| MD5 |
715a5a641edd46a125c53887a626a3b9
|
|
| BLAKE2b-256 |
42c47cf608a8396c7a02db4c65cd12647bb6d7137f5677578110aed83f180515
|
Provenance
The following attestation bundles were made for irbt-0.15.1.tar.gz:
Publisher:
pythonpublish.yml on tidalf/irbt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
irbt-0.15.1.tar.gz -
Subject digest:
f89f38a0db2ef975b846cfee88cf5d74409f311ead1182987cff59f73f20ba1f - Sigstore transparency entry: 1164810611
- Sigstore integration time:
-
Permalink:
tidalf/irbt@eaa0a14151420dcc0746137154630e62401c6b39 -
Branch / Tag:
refs/tags/0.15.1 - Owner: https://github.com/tidalf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pythonpublish.yml@eaa0a14151420dcc0746137154630e62401c6b39 -
Trigger Event:
release
-
Statement type:
File details
Details for the file irbt-0.15.1-py3-none-any.whl.
File metadata
- Download URL: irbt-0.15.1-py3-none-any.whl
- Upload date:
- Size: 23.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e15dc7ba2f21d6ae1515b383d5cdfc41b8bf0b5387184e0fa4c2987e0025762
|
|
| MD5 |
0e50e1d987be042bf2932fb6514e28e8
|
|
| BLAKE2b-256 |
5bc45f7ee58e46ab56f0947ebc1cb8fa5569b9a2b9feff67190d98fe09cdd086
|
Provenance
The following attestation bundles were made for irbt-0.15.1-py3-none-any.whl:
Publisher:
pythonpublish.yml on tidalf/irbt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
irbt-0.15.1-py3-none-any.whl -
Subject digest:
7e15dc7ba2f21d6ae1515b383d5cdfc41b8bf0b5387184e0fa4c2987e0025762 - Sigstore transparency entry: 1164810869
- Sigstore integration time:
-
Permalink:
tidalf/irbt@eaa0a14151420dcc0746137154630e62401c6b39 -
Branch / Tag:
refs/tags/0.15.1 - Owner: https://github.com/tidalf
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pythonpublish.yml@eaa0a14151420dcc0746137154630e62401c6b39 -
Trigger Event:
release
-
Statement type: