Skip to main content

A Library to interact with irbt appliances

Project description

Library for irbt cloud api

Maintainability Actions Status Actions Status Codacy Badge PyPI version

This library implements some parts of the irbt cloud api (to control the different robots of the company).

Supported devices:

It has only been tested with a roomba i7.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

irbt-0.8.0.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

irbt-0.8.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file irbt-0.8.0.tar.gz.

File metadata

  • Download URL: irbt-0.8.0.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for irbt-0.8.0.tar.gz
Algorithm Hash digest
SHA256 d69afd58ca92421364e4da7b230bc9eb365a275e57e4b6c802ec48c291031ee0
MD5 1628767a4746e2fd0cf454027a2d3c39
BLAKE2b-256 9f4f44a2b638fb3d357500bf738143c6588097e6b1651c04e6059d0602ec265b

See more details on using hashes here.

File details

Details for the file irbt-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: irbt-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6

File hashes

Hashes for irbt-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f608679e72b0a9dbba8bee6f04c0c749039653464086c59d5f5f3518e4ad557
MD5 63e48c4f38b2597a2414ef3583c45f31
BLAKE2b-256 adf1a21707f028aa8bdd1ab092943986641547d4b999b44369f443bcb8fb34b4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page