# roombapy
[](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml)
[](https://pypi.org/project/roombapy/)
[](https://pypi.org/project/roombapy/)
[](./LICENSE)
Unofficial iRobot Roomba python library (SDK).
Fork of [NickWaterton/Roomba980-Python](https://github.com/NickWaterton/Roomba980-Python)
This library was created for the [Home Assistant Roomba integration](https://www.home-assistant.io/integrations/roomba/).
## Installation
```shell
pip install roombapy[cli]
```
# Notes
This library is only for firmware 2.x.x [Check your robot version!](http://homesupport.irobot.com/app/answers/detail/a_id/529)
Only local connections are supported.
## How to discover your robots and obtain credentials
```shell
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:
```shell
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.
```shell
pre-commit install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pschmitt/roombapy",
"name": "roombapy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Philipp Schmitt",
"author_email": "philipp@schmitt.co",
"download_url": "https://files.pythonhosted.org/packages/e9/fd/6af4b01136f038a960b331bbed5183cbe44fda695dfd560eef98416b6110/roombapy-1.8.2.tar.gz",
"platform": null,
"description": "# roombapy\n\n[](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml)\n[](https://pypi.org/project/roombapy/)\n[](https://pypi.org/project/roombapy/)\n[](./LICENSE)\n\nUnofficial iRobot Roomba python library (SDK).\n\nFork of [NickWaterton/Roomba980-Python](https://github.com/NickWaterton/Roomba980-Python)\n\nThis library was created for the [Home Assistant Roomba integration](https://www.home-assistant.io/integrations/roomba/).\n\n## Installation\n\n```shell\npip install roombapy[cli]\n```\n\n# Notes\n\nThis library is only for firmware 2.x.x [Check your robot version!](http://homesupport.irobot.com/app/answers/detail/a_id/529)\n\nOnly local connections are supported.\n\n## How to discover your robots and obtain credentials\n\n```shell\nroombapy discover <optional ip address>\n```\nThis will find your Roomba in local network, and obtain credentials _automagically_ whether possible.\n\n## Event stream\n\nTo get event stream from iRobot, use:\n\n```shell\nroombapy connect <ip> -p <password>\n```\n\nOutput is suitable for piping into tools like `jq`.\n\n## Development\n\nTo improve your development experience, you can install pre-commit hooks via the following command.\nWith every commit it will run a set of checks, making sure it meets the quality standards.\n\n```shell\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python program and library to control Wi-Fi enabled iRobot Roombas",
"version": "1.8.2",
"project_urls": {
"Homepage": "https://github.com/pschmitt/roombapy",
"Repository": "https://github.com/pschmitt/roombapy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3e86c563cdcd157f3d11a3c66c04ef2e0464ff0837a255e29d5a4a07d1e8c92",
"md5": "c8e7877c60715e98460eb1d05cf1cb9e",
"sha256": "740e88cee6b90a347a4532a3f7802be83c62be22b2097747cf782d85f505adcd"
},
"downloads": -1,
"filename": "roombapy-1.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8e7877c60715e98460eb1d05cf1cb9e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 17581,
"upload_time": "2024-12-02T08:39:52",
"upload_time_iso_8601": "2024-12-02T08:39:52.497836Z",
"url": "https://files.pythonhosted.org/packages/d3/e8/6c563cdcd157f3d11a3c66c04ef2e0464ff0837a255e29d5a4a07d1e8c92/roombapy-1.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9fd6af4b01136f038a960b331bbed5183cbe44fda695dfd560eef98416b6110",
"md5": "53c84090885b0110f541226d283abde7",
"sha256": "dfffbafdccab60862833fbc15cd6783910da940a4b9fabfc15be51ef8be6124b"
},
"downloads": -1,
"filename": "roombapy-1.8.2.tar.gz",
"has_sig": false,
"md5_digest": "53c84090885b0110f541226d283abde7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 15151,
"upload_time": "2024-12-02T08:39:54",
"upload_time_iso_8601": "2024-12-02T08:39:54.198348Z",
"url": "https://files.pythonhosted.org/packages/e9/fd/6af4b01136f038a960b331bbed5183cbe44fda695dfd560eef98416b6110/roombapy-1.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 08:39:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pschmitt",
"github_project": "roombapy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "roombapy"
}
JSON
