Skip to main content

A Library to interact with irbt appliances

Project description

Library for irbt cloud api

Maintainability Actions Status Actions Status Known Vulnerabilities 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.3.7.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

irbt-0.3.7-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: irbt-0.3.7.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.0

File hashes

Hashes for irbt-0.3.7.tar.gz
Algorithm Hash digest
SHA256 d983fd061d23227dd76df962828bddfe9566ff27cdf5379e436e89006d9e3592
MD5 f75d196affdedff7cd43b6c34f0f9261
BLAKE2b-256 2dcfd06a90f57412c7f39d59756b0f8123c0def594db88cf8e00127b45d4585c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: irbt-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.0

File hashes

Hashes for irbt-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bd7913c6f247e4de24ff9941d31ddd19947fc7266deb055e3924382b066a1527
MD5 dfc897f089009d0673790160c7c11df3
BLAKE2b-256 8316421e048ad3740955dbc03d504827751b2a4cc07762f9e5aacd620686505a

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