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.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.8.1.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

roombapy-1.8.1-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: roombapy-1.8.1.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.5.0-1016-azure

File hashes

Hashes for roombapy-1.8.1.tar.gz
Algorithm Hash digest
SHA256 a596aed941b3b4979dc076d8ff3d8f675d8f0aa655a9bc69da574eb1465bc015
MD5 8d7d6f5a2b5b78e4936d0039f633506b
BLAKE2b-256 20bf08873726de21a79b4e27963d1a189ed5c87eb9a0e27562434b421f2a76c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roombapy-1.8.1-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Linux/6.5.0-1016-azure

File hashes

Hashes for roombapy-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31d8c08f1e072c1f377ac397c99e0fa55752fba5703740f76f7051550dfedb4b
MD5 bb9eb91ed3743ced4dede54e78eb28fb
BLAKE2b-256 a2ed1601c745146a00a159033cf16e1bcfa9d4c2a86d1eb565b4a52d9eb79675

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