roombapy

Name	roombapy JSON
Version	1.6.7 JSON
	download
home_page	https://github.com/pschmitt/roombapy
Summary	Python program and library to control Wi-Fi enabled iRobot Roombas
upload_time	2023-03-19 16:05:32
maintainer
docs_url	None
author	Philipp Schmitt
requires_python	>=3.7,<4.0
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # roombapy

[![CI](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml/badge.svg)](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml)
![PyPI](https://img.shields.io/pypi/v/roombapy)
![PyPI - Downloads](https://img.shields.io/pypi/dm/roombapy)
![PyPI - License](https://img.shields.io/pypi/l/roombapy)

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
```

# 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 get your username/blid and password

To get password from Roomba type in console:

```shell
$ roomba-password <ip>
```

It will find your Roomba in local network, then follow the instructions in console to get password.
If IP address not provided password will be request for auto discovered robot. 

Also you can just ask Roomba for info:

```shell
$ roomba-discovery <optional ip address>
```

To test connection with iRobot:

```shell
$ roomba-connect <ip> <password>
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pschmitt/roombapy",
    "name": "roombapy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Philipp Schmitt",
    "author_email": "philipp@schmitt.co",
    "download_url": "https://files.pythonhosted.org/packages/14/1a/a6d19abd18328143c580a8dd4fc43101aa8e67890adc14601ceb6f4eee80/roombapy-1.6.7.tar.gz",
    "platform": null,
    "description": "# roombapy\n\n[![CI](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml/badge.svg)](https://github.com/pschmitt/roombapy/actions/workflows/ci.yaml)\n![PyPI](https://img.shields.io/pypi/v/roombapy)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/roombapy)\n![PyPI - License](https://img.shields.io/pypi/l/roombapy)\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\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 get your username/blid and password\n\nTo get password from Roomba type in console:\n\n```shell\n$ roomba-password <ip>\n```\n\nIt will find your Roomba in local network, then follow the instructions in console to get password.\nIf IP address not provided password will be request for auto discovered robot. \n\nAlso you can just ask Roomba for info:\n\n```shell\n$ roomba-discovery <optional ip address>\n```\n\nTo test connection with iRobot:\n\n```shell\n$ roomba-connect <ip> <password>\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python program and library to control Wi-Fi enabled iRobot Roombas",
    "version": "1.6.7",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9eb5cdd2c7292cd972087e4fa83d9ddbb1549387b7a548405e8742a1a213b382",
                "md5": "e90f07a531acf021e4293582e1aa5eba",
                "sha256": "0878fb01d8d61502da17c3f9bb17226000222ce603f8ebd0f700b349405ca46d"
            },
            "downloads": -1,
            "filename": "roombapy-1.6.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e90f07a531acf021e4293582e1aa5eba",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 14648,
            "upload_time": "2023-03-19T16:05:30",
            "upload_time_iso_8601": "2023-03-19T16:05:30.902395Z",
            "url": "https://files.pythonhosted.org/packages/9e/b5/cdd2c7292cd972087e4fa83d9ddbb1549387b7a548405e8742a1a213b382/roombapy-1.6.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "141aa6d19abd18328143c580a8dd4fc43101aa8e67890adc14601ceb6f4eee80",
                "md5": "46b4c17d5039ca7052dc8161ae2fd212",
                "sha256": "cbcdb0a11b2039171ed5dac7d64779af6c9421c70fa5cacf678f51722e257f27"
            },
            "downloads": -1,
            "filename": "roombapy-1.6.7.tar.gz",
            "has_sig": false,
            "md5_digest": "46b4c17d5039ca7052dc8161ae2fd212",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 12167,
            "upload_time": "2023-03-19T16:05:32",
            "upload_time_iso_8601": "2023-03-19T16:05:32.090765Z",
            "url": "https://files.pythonhosted.org/packages/14/1a/a6d19abd18328143c580a8dd4fc43101aa8e67890adc14601ceb6f4eee80/roombapy-1.6.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-19 16:05:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "pschmitt",
    "github_project": "roombapy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "roombapy"
}