Skip to main content

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

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


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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: roombapy-1.9.1.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.3 Linux/6.11.0-1015-azure

File hashes

Hashes for roombapy-1.9.1.tar.gz
Algorithm Hash digest
SHA256 05ba180de52c675cadf3464b3fe2d5d6de1cf6e9d1d951bcf3162e3a14af3019
MD5 e4c5a1192c74abf3dfc22bbd2e485ca8
BLAKE2b-256 cc4c6c61bf000fd086b720417b93ac6772e47b52fd36f92dd29f95953d596299

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roombapy-1.9.1-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.3 Linux/6.11.0-1015-azure

File hashes

Hashes for roombapy-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5392f63ff5470c9082165f78016ebc6232c38f2ebcc6f7291e81627fd7ec76d8
MD5 d24b8787cfa284ceeac1240a1231f874
BLAKE2b-256 810ae690d9e68a7e562f15a2caab5f29bc9b7aed413f8a10d341f8466d0eb99a

See more details on using hashes here.

Supported by

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