{ "info": { "author": "Stian Askeland", "author_email": "stianaske@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# pybotvac\n\nThis is an unofficial API for controlling Neato Botvac Connected vacuum robots.\nThe code is based on https://github.com/kangguru/botvac and credit for reverse engineering the API goes to\n[Lars Brillert @kangguru](https://github.com/kangguru)\n\n## Disclaimer\nThis API is experimental. Use at your own risk. Feel free to contribute if things are not working.\n\n## Installation\nInstall using pip\n\n pip install pybotvac\n\nAlternatively, clone the repository and run\n\n python setup.py install\n\n## Usage\n### Robot\nIf the serial and secret for your robot is known, simply run\n\n >>> from pybotvac import Robot\n >>> robot = Robot('OPS01234-0123456789AB', '0123456789ABCDEF0123456789ABCDEF', 'my_robot_name')\n >>> print(robot)\n Name: sample_robot, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF\n\nThe format of the serial should be 'OPSxxxxx-xxxxxxxxxxxx', and the secret should be a string of hex characters 32 characters long.\nThese can be found by using the Account class.\n\nTo start cleaning\n\n robot.start_cleaning()\n\nIf no exception occurred, your robot should now get to work.\n\nCurrently the following methods are available in the Robot class:\n\n* get_robot_state()\n* start_cleaning()\n* start_spot_cleaning()\n* pause_cleaning()\n* stop_cleaning()\n* send_to_base()\n* enable_schedule()\n* disable_schedule()\n* get_schedule()\n\nFor convenience, properties exist for state and schedule\n\n # Get state\n state = robot.state\n\n # Check if schedule is enabled\n robot.schedule_enabled\n\n # Disable schedule\n robot.schedule_enabled = False\n\n### Account\nIf the serial and secret is unknown, they can be retrieved using the Account class.\n\n >>> from pybotvac import Account\n >>> # List all robots associated with account\n >>> for robot in Account('sample@email.com', 'sample_password').robots:\n print(robot)\n\n Name: my_robot_name, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF, Traits: ['maps']\n\nInformation about maps and download of maps can be done from the Account class:\n\n >>> from pybotvac import Account\n >>> # List all maps associated with a specific robot\n >>> for map_info in Account('sample@email.com', 'sample_password').maps:\n print(map_info)\n\nA cleaning map can be downloaded with the account class. Returns the raw image response. Example shows latest map.\n You need the url from the map output to do that:\n\n >>> from pybotvac import Account\n >>> # List all maps associated with a specific robot\n >>> map = Account('sample@email.com', 'sample_password').maps\n >>> download_link = map['robot_serial']['maps'][0]['url']\n Account('sample@email.com', 'sample_password').get_map_image('download_link')\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/stianaske/pybotvac", "keywords": "", "license": "Licensed under the MIT license. See LICENSE file for details", "maintainer": "", "maintainer_email": "", "name": "pybotvac", "package_url": "https://pypi.org/project/pybotvac/", "platform": "", "project_url": "https://pypi.org/project/pybotvac/", "project_urls": { "Homepage": "https://github.com/stianaske/pybotvac" }, "release_url": "https://pypi.org/project/pybotvac/0.0.17/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "Python package for controlling Neato pybotvac Connected vacuum robot", "version": "0.0.17" }, "last_serial": 5999319, "releases": { "0.0.10": [ { "comment_text": "", "digests": { "md5": "4452de89470b42cf8df3795c9eea14c9", "sha256": "d9d20e2d614d3538c5d447933e5e890f7b9f8e3a667b541bc96eacd6f8ca0c4c" }, "downloads": -1, "filename": "pybotvac-0.0.10-py3-none-any.whl", "has_sig": false, "md5_digest": "4452de89470b42cf8df3795c9eea14c9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13313, "upload_time": "2018-09-17T15:10:32", "url": "https://files.pythonhosted.org/packages/5b/3c/73bfbc85dead3ebb517e4619858962f74db71a1d4bcee6dc6c2085a4f384/pybotvac-0.0.10-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "06dad496864fd5e21a439310f1a26472", "sha256": "b02deb9f93c5c0bba5a3bc09ceccbd569c6be799026167190ac2983361e95281" }, "downloads": -1, "filename": "pybotvac-0.0.10.tar.gz", "has_sig": false, "md5_digest": "06dad496864fd5e21a439310f1a26472", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8617, "upload_time": "2018-09-17T15:10:58", "url": "https://files.pythonhosted.org/packages/2c/69/2c33e5abadad7571ccf21c702cc36cb21defb90314efcf20bd79d5572b34/pybotvac-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "313e884e7ad196fe6ab15348992c9fba", "sha256": "dc034aa4aee0fa35a45d1c0470786d4637e7d5e6dbb5f9ce018d143efa13fd72" }, "downloads": -1, "filename": "pybotvac-0.0.11-py3-none-any.whl", "has_sig": false, "md5_digest": "313e884e7ad196fe6ab15348992c9fba", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13780, "upload_time": "2018-12-02T18:57:44", "url": "https://files.pythonhosted.org/packages/6d/3d/ba476c6d29af2d5533f39030843148364df9c3d432675d9533f2f3b5f833/pybotvac-0.0.11-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "957ff5aa63c1e705c3ef371868e0ba30", "sha256": "86fd51e92e3f9ed8641adfb7097aabcd451701d9b98f7b1d807935e4899d1384" }, "downloads": -1, "filename": "pybotvac-0.0.11.tar.gz", "has_sig": false, "md5_digest": "957ff5aa63c1e705c3ef371868e0ba30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8655, "upload_time": "2018-12-02T18:57:45", "url": "https://files.pythonhosted.org/packages/02/19/ed544f13c3cb2c2aeb4bc2a29a0b5e7599adcf21b5183366a21dfe8558bc/pybotvac-0.0.11.tar.gz" } ], "0.0.12": [ { "comment_text": "", "digests": { "md5": "e9dee2486360e807762f30ee57d5b04a", "sha256": "69ebb8eede319cb95591c778c42ddbc868d3e0096f9ba5a1e55c876eb65c355c" }, "downloads": -1, "filename": "pybotvac-0.0.12-py3-none-any.whl", "has_sig": false, "md5_digest": "e9dee2486360e807762f30ee57d5b04a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15927, "upload_time": "2018-12-17T18:28:24", "url": "https://files.pythonhosted.org/packages/c1/69/1f643c4ca236c6da1c0eff9a862dd3ba66dbadb158a60013d00684d5ebf1/pybotvac-0.0.12-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d6f5d81492b70de07add9a67e8b7e82", "sha256": "50fe6eecf9b5865f098472becc24ce71bc31022d9069e31c7766d9811027158b" }, "downloads": -1, "filename": "pybotvac-0.0.12.tar.gz", "has_sig": false, "md5_digest": "3d6f5d81492b70de07add9a67e8b7e82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8924, "upload_time": "2018-12-17T18:28:25", "url": "https://files.pythonhosted.org/packages/ff/7d/94faebfbc8ac337c51d1917cd4925180545d0b694ebad2001a7421b664c4/pybotvac-0.0.12.tar.gz" } ], "0.0.13": [ { "comment_text": "", "digests": { "md5": "c65d53969fa13e90b96fcbf11b624b5a", "sha256": "00f682407e1bcd33977a00595737864c0e8ae38e361adc7888dc28e809e84ec4" }, "downloads": -1, "filename": "pybotvac-0.0.13-py3-none-any.whl", "has_sig": false, "md5_digest": "c65d53969fa13e90b96fcbf11b624b5a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16684, "upload_time": "2019-01-06T18:26:57", "url": "https://files.pythonhosted.org/packages/82/69/a8fee0104ec87d9778cc2ca85aa292d5607d5290362b584d5e9111015f6c/pybotvac-0.0.13-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "590f8b8a56e719aaefab36f780797534", "sha256": "f6f147694ee5cbab1dea494454c11bd254e1c214d96d057cba27894a87210f1b" }, "downloads": -1, "filename": "pybotvac-0.0.13.tar.gz", "has_sig": false, "md5_digest": "590f8b8a56e719aaefab36f780797534", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7754, "upload_time": "2019-01-06T18:26:59", "url": "https://files.pythonhosted.org/packages/ff/31/73c975bb24d3a2e0510b79c2f020c70ca425a7fb217dafd193c8ab390a66/pybotvac-0.0.13.tar.gz" } ], "0.0.14": [ { "comment_text": "", "digests": { "md5": "4d94672a0b43d7feef1eada57eab899c", "sha256": "b1bb68a4cb21ca62870a95bb948579a65f8f77387fe671519b0bfcaa2c8c8e28" }, "downloads": -1, "filename": "pybotvac-0.0.14-py3-none-any.whl", "has_sig": false, "md5_digest": "4d94672a0b43d7feef1eada57eab899c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13713, "upload_time": "2019-07-13T19:02:34", "url": "https://files.pythonhosted.org/packages/33/a1/fadede86e21dfe86dd095d51b2a23b5c703fae7104209ff2101895400a34/pybotvac-0.0.14-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76e36c87d047412aaedbd505cfecc8fe", "sha256": "fd18401446e32991ac4f95ff75e45fcf03bc33bd66b1a94332cf9b1e6f4e8146" }, "downloads": -1, "filename": "pybotvac-0.0.14.tar.gz", "has_sig": false, "md5_digest": "76e36c87d047412aaedbd505cfecc8fe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8985, "upload_time": "2019-07-13T19:02:36", "url": "https://files.pythonhosted.org/packages/7d/49/df22c2a0e3e5d171102659d279ea6067f81eefe8cfd418d55750e5404e08/pybotvac-0.0.14.tar.gz" } ], "0.0.15": [ { "comment_text": "", "digests": { "md5": "e295d40f6ccb9ca6fd0b82cacedc1b4a", "sha256": "7055a578acb5a75660227b72f0f166849a4632afb24705325adccee1dbaa684a" }, "downloads": -1, "filename": "pybotvac-0.0.15-py3-none-any.whl", "has_sig": false, "md5_digest": "e295d40f6ccb9ca6fd0b82cacedc1b4a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13713, "upload_time": "2019-07-13T20:04:42", "url": "https://files.pythonhosted.org/packages/26/d9/338c4a2afc3c284fb205ac93c55a6af3e36a2f6c557481202f29a5067282/pybotvac-0.0.15-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "66c7338dbba21660c73f80cfbe0a2a1e", "sha256": "38519812df81868c387e71c890a2d41e8d32dbe1e1666063f48a06d6fd658b2a" }, "downloads": -1, "filename": "pybotvac-0.0.15.tar.gz", "has_sig": false, "md5_digest": "66c7338dbba21660c73f80cfbe0a2a1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8997, "upload_time": "2019-07-13T20:04:43", "url": "https://files.pythonhosted.org/packages/ce/52/62ed3681490e3ef73c51e85b61abf806c9b554a3f23674414c51658a53d8/pybotvac-0.0.15.tar.gz" } ], "0.0.16": [ { "comment_text": "", "digests": { "md5": "224a3b065f94eb399794b14366f5d75b", "sha256": "faaed64f0d3c7834d7479254770ba8fc23c1292b4f9a5fc5da8c47ae08bfb096" }, "downloads": -1, "filename": "pybotvac-0.0.16-py3-none-any.whl", "has_sig": false, "md5_digest": "224a3b065f94eb399794b14366f5d75b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14328, "upload_time": "2019-10-04T18:05:45", "url": "https://files.pythonhosted.org/packages/1b/7b/75678712154c915092c38eeb96a8d4141250143cd28dbd265ec303c062d2/pybotvac-0.0.16-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "aaf7c3811fef593317d56dff116eb063", "sha256": "f75240520c918793510766d8b1f5ebc1feb0286f86eab971550f6580b0ea68f5" }, "downloads": -1, "filename": "pybotvac-0.0.16.tar.gz", "has_sig": false, "md5_digest": "aaf7c3811fef593317d56dff116eb063", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9660, "upload_time": "2019-10-04T18:05:46", "url": "https://files.pythonhosted.org/packages/24/da/456bc09440029fbcab50fb83651be26165dd96e2884e207943830dd59ced/pybotvac-0.0.16.tar.gz" } ], "0.0.17": [ { "comment_text": "", "digests": { "md5": "b68920b54eb90114d34bf572f1c45032", "sha256": "a0dc5a26500ce3f1ee825318faadc74f3881908b494468d9533907882aaa09e6" }, "downloads": -1, "filename": "pybotvac-0.0.17-py3-none-any.whl", "has_sig": false, "md5_digest": "b68920b54eb90114d34bf572f1c45032", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14376, "upload_time": "2019-10-19T09:34:30", "url": "https://files.pythonhosted.org/packages/d9/1a/62b403d479a74d3bc00c50e211efd0c795033df0267e55716c4ea91d9293/pybotvac-0.0.17-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a0d66a818fd2809ca53cdc8c477e13e", "sha256": "f212f0df8a946c0fa25f0c20c3c9decd9ddc4dbd9b48592a3283e7481112923e" }, "downloads": -1, "filename": "pybotvac-0.0.17.tar.gz", "has_sig": false, "md5_digest": "7a0d66a818fd2809ca53cdc8c477e13e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8888, "upload_time": "2019-10-19T09:34:32", "url": "https://files.pythonhosted.org/packages/e9/f6/d7c3ce29c15f0501f2d87b765e7b7803ef2677242ed0479739960440be49/pybotvac-0.0.17.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "10f2b13a440f4c74bfea46b416952cd3", "sha256": "cad760fc6c2fc6449111ebdb7f31f488d96b01dfb17bcc162ebeb552819af6a0" }, "downloads": -1, "filename": "pybotvac-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "10f2b13a440f4c74bfea46b416952cd3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10426, "upload_time": "2018-06-23T18:27:02", "url": "https://files.pythonhosted.org/packages/01/9f/e7734aa8ca8c017c66918a1f8dadc3153f42f23e6b0482c64d6e4cdaab04/pybotvac-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d79f53f5f22b2f8b1970eff382dcb5ba", "sha256": "f81e131c868f20c311489c1322b7d7c3ccc4f0b1a249ae3de23272d63b838781" }, "downloads": -1, "filename": "pybotvac-0.0.7.tar.gz", "has_sig": false, "md5_digest": "d79f53f5f22b2f8b1970eff382dcb5ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6953, "upload_time": "2018-06-23T18:27:03", "url": "https://files.pythonhosted.org/packages/db/cf/9d89bc7f18090641ca8684998f65fd66f4b30fcbfe6a57016569abeda647/pybotvac-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "2cd5fdea3d49ac1f14be547643816d78", "sha256": "ce302b8de70e694e068964837f45026d57cd002fb0225c792d460d396eecaa1a" }, "downloads": -1, "filename": "pybotvac-0.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "2cd5fdea3d49ac1f14be547643816d78", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14500, "upload_time": "2018-07-14T16:21:14", "url": "https://files.pythonhosted.org/packages/66/f2/30a2a885ce4242a295d3bd95b0fff5b1312b69f3ad999c7e5c249d702a54/pybotvac-0.0.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4e21bda4a840508cf04cf7540a0febce", "sha256": "c009c8d6090af6e5d5f466c2d0442223b5d411560ac265d5706a84a8d6a17926" }, "downloads": -1, "filename": "pybotvac-0.0.8.tar.gz", "has_sig": false, "md5_digest": "4e21bda4a840508cf04cf7540a0febce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7240, "upload_time": "2018-07-14T16:21:16", "url": "https://files.pythonhosted.org/packages/ba/80/4fd24e4f27d766656c9d3b9e603ee135576525825115f27f571bcb5e027e/pybotvac-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "146fce07b3af0f2da4c20c7a11d103b1", "sha256": "94e9a4d2aadd6174236ac3c33a48c57b9c0176fad45d7de8117628a7f85a5098" }, "downloads": -1, "filename": "pybotvac-0.0.9-py3-none-any.whl", "has_sig": false, "md5_digest": "146fce07b3af0f2da4c20c7a11d103b1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9332, "upload_time": "2018-07-22T16:59:45", "url": "https://files.pythonhosted.org/packages/64/36/5b3511777932073d9c91663be2858ecbc8ef34859cf5a7dd4c8bed837e32/pybotvac-0.0.9-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4a41e887ef287249881ad630de26b14d", "sha256": "6edf199643e4fb3ff27d7232b388c1eb486eb5837b121b0df54c27ffae130b05" }, "downloads": -1, "filename": "pybotvac-0.0.9.tar.gz", "has_sig": false, "md5_digest": "4a41e887ef287249881ad630de26b14d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7158, "upload_time": "2018-07-22T16:59:46", "url": "https://files.pythonhosted.org/packages/59/8d/bc0b7fb7f26ee694972a66667d90a9e9ab2f06ea2d2c67e6580a36661bf4/pybotvac-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b68920b54eb90114d34bf572f1c45032", "sha256": "a0dc5a26500ce3f1ee825318faadc74f3881908b494468d9533907882aaa09e6" }, "downloads": -1, "filename": "pybotvac-0.0.17-py3-none-any.whl", "has_sig": false, "md5_digest": "b68920b54eb90114d34bf572f1c45032", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14376, "upload_time": "2019-10-19T09:34:30", "url": "https://files.pythonhosted.org/packages/d9/1a/62b403d479a74d3bc00c50e211efd0c795033df0267e55716c4ea91d9293/pybotvac-0.0.17-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a0d66a818fd2809ca53cdc8c477e13e", "sha256": "f212f0df8a946c0fa25f0c20c3c9decd9ddc4dbd9b48592a3283e7481112923e" }, "downloads": -1, "filename": "pybotvac-0.0.17.tar.gz", "has_sig": false, "md5_digest": "7a0d66a818fd2809ca53cdc8c477e13e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8888, "upload_time": "2019-10-19T09:34:32", "url": "https://files.pythonhosted.org/packages/e9/f6/d7c3ce29c15f0501f2d87b765e7b7803ef2677242ed0479739960440be49/pybotvac-0.0.17.tar.gz" } ] }