{ "info": { "author": "Alexander Hagerman", "author_email": "alexander@unexpectedeof.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Libraries", "Topic :: System :: Hardware" ], "description": ".. role:: bash(code)\n :language: bash\n\nIntroduction\n============\n\n.. image:: https://codecov.io/gl/AlexanderHagerman/circuitroomba/branch/master/graph/badge.svg\n :target: https://codecov.io/gl/AlexanderHagerman/circuitroomba\n :alt: Coverage Report\n\n.. image:: https://readthedocs.org/projects/circuitroomba/badge/?version=latest\n :target: https://circuitroomba.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://gitlab.com/AlexanderHagerman/circuitroomba/badges/master/pipeline.svg\n :target: https://gitlab.com/AlexanderHagerman/circuitroomba/commits/master\n :alt: Build Status\n\nCircuitRoomba is a CircuitPython library for interfacing with Roomba Open Interface devices.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython `_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle `_.\n\nInstalling from PyPI for blinka boards\n--------------------------------------\n\n.. code-block:: shell\n\n pip install circuitroomba\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .env\n source .env/bin/activate\n pip install circuitroomba\n\nFor CircuitPython boards that don't support :bash:`blinka` copy :bash:`/circuitroomba` from :bash:`/src` to\n:bash:`/lib` on the CircuitPython board. :bash:`make install` has been setup as a helper, but you may need\nto update the :bash:`/Volume` path for your system and board name.\n\n.. code-block:: shell\n\n make install\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import digitalio\n import time\n from circuitroomba.series6 import roomba\n\n __repo__ = \"https://github.com/AlexanderHagerman/circuitroomba.git\"\n\n # initialize roomba\n bot = roomba.Commands(board.TX, board.RX, digitalio.DigitalInOut(board.A1))\n\n # wake roomba from sleep mode\n bot.wake_up()\n\n # CircuitPython loop\n while True:\n # send commands\n bot.start()\n bot.safe()\n bot.clean()\n\n time.sleep(2)\n\n bot.power()\n bot.stop()\n\n break\n\nMore examples are available in :bash:`/examples`.\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n`_\nbefore contributing to help this project stay welcoming.\n\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to :bash:`docs/_build/html`. Open the ``index.html`` in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.\n\nImages\n======\n\n.. image:: https://drive.google.com/open?id=1KtG_M6wwwOtODZrK1ZTnyX92WZUBcyOU\n :target: https://drive.google.com/open?id=1KtG_M6wwwOtODZrK1ZTnyX92WZUBcyOU\n :alt: circuit roomba high level\n\n.. image:: https://drive.google.com/open?id=1GCv2tUK9gy0zGXF1X7UAJXt-FR0cVhlm\n :target: https://drive.google.com/open?id=1GCv2tUK9gy0zGXF1X7UAJXt-FR0cVhlm\n :alt: circuit roomba running video\n\n.. image:: https://drive.google.com/open?id=1Um1UUVvmV5FkCiyP8SBmEOifm1huh9Bm\n :target: https://drive.google.com/open?id=1Um1UUVvmV5FkCiyP8SBmEOifm1huh9Bm\n :alt: roomba open interface connections\n\n.. image:: https://drive.google.com/open?id=1goaZUGYlUYxY0_c_kZM8E3LHNcuu2lPR\n :target: https://drive.google.com/open?id=1goaZUGYlUYxY0_c_kZM8E3LHNcuu2lPR\n :alt: circuit playground connections\n\n.. image:: https://drive.google.com/open?id=1YYps3UBBO7gMA1RfhlnACCx4bNVq-io_\n :target: https://drive.google.com/open?id=1YYps3UBBO7gMA1RfhlnACCx4bNVq-io_\n :alt: circuit playground connected to roomba", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/AlexanderHagerman/circuitroomba", "keywords": "adafruit blinka circuitpython micropythoncircuitroomba circuitroomba robot automation roomba interface", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "circuitroomba", "package_url": "https://pypi.org/project/circuitroomba/", "platform": "", "project_url": "https://pypi.org/project/circuitroomba/", "project_urls": { "Homepage": "https://gitlab.com/AlexanderHagerman/circuitroomba" }, "release_url": "https://pypi.org/project/circuitroomba/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "CircuitPython helper library for interfacing with Roomba Open Interface devices.", "version": "0.1.0" }, "last_serial": 5391265, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "059e05c276855908cf588c13c06caa6c", "sha256": "bd347a75730934ed5ad371c6836e6ef2786fce3707fd47af81f6941ea046e078" }, "downloads": -1, "filename": "circuitroomba-0.1.0.tar.gz", "has_sig": false, "md5_digest": "059e05c276855908cf588c13c06caa6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2263433, "upload_time": "2019-06-12T13:33:45", "url": "https://files.pythonhosted.org/packages/62/3d/0313d7e9f7e30d2b8b66f138caad2c37f80e1f7b3cf31f9261608f062997/circuitroomba-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "059e05c276855908cf588c13c06caa6c", "sha256": "bd347a75730934ed5ad371c6836e6ef2786fce3707fd47af81f6941ea046e078" }, "downloads": -1, "filename": "circuitroomba-0.1.0.tar.gz", "has_sig": false, "md5_digest": "059e05c276855908cf588c13c06caa6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2263433, "upload_time": "2019-06-12T13:33:45", "url": "https://files.pythonhosted.org/packages/62/3d/0313d7e9f7e30d2b8b66f138caad2c37f80e1f7b3cf31f9261608f062997/circuitroomba-0.1.0.tar.gz" } ] }