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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for freekode from gravatar.com freekode Avatar for pschmitt from gravatar.com pschmitt

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Philipp Schmitt
  • Requires: Python <4.0, >=3.10
Classifiers

Project description

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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for freekode from gravatar.com freekode Avatar for pschmitt from gravatar.com pschmitt

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Philipp Schmitt
  • Requires: Python <4.0, >=3.10
Classifiers

Release history Release notifications | RSS feed

This version

1.9.0

1.8.2

1.8.1

1.8.0

1.7.0

1.6.13

1.6.12

1.6.11

1.6.10

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2.post1

1.6.2

1.6.1

1.6.0

1.5.3

1.5.2

1.5.1

1.5.0

1.4.3

1.4.2

1.4.1

1.3.1.post1

1.3.1

1.3.0

Download files

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

Source Distribution

roombapy-1.9.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

roombapy-1.9.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file roombapy-1.9.0.tar.gz.

File metadata

  • Download URL: roombapy-1.9.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.1 Linux/6.8.0-1020-azure

File hashes

Hashes for roombapy-1.9.0.tar.gz
Algorithm Hash digest
SHA256 74562873535ba0b33a853ed8e05fc348ba2c3d28e2b77519499aecfe378c1781
MD5 197351b2232cdcc6c392cac8960e2354
BLAKE2b-256 efb9d405ad8cf3422b21619f57bc905a7bbbd3a13894df90d1674d87e6d91566

See more details on using hashes here.

File details

Details for the file roombapy-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: roombapy-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.1 Linux/6.8.0-1020-azure

File hashes

Hashes for roombapy-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c9d6b4d1098725d19b1679fab1130078b0c92c4d1ea44fb46bfcdac3547891c
MD5 8fa45fdd14fadbd3a34dc71d9ae674fb
BLAKE2b-256 a255a985ec7206bfc91a4e52bc55a75213f2a66e79760b1474f73dac9cdaf6aa

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page