circuitpython-laser-at


Namecircuitpython-laser-at JSON
Version 0.9.0 PyPI version JSON
download
home_page
SummaryDriver for an inexpensive laser rangefinder module, made by AT, available on aliexpress.
upload_time2022-12-28 15:44:41
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython laser_at rangefinder laser distance disto
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://github.com/furbrain/CircuitPython_laser_at/workflows/Build%20CI/badge.svg
    :target: https://github.com/furbrain/CircuitPython_laser_at/actions
    :alt: Build Status


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

Driver for an inexpensive laser rangefinder module, made by Hi-AT, available on `aliexpress
<https://www.aliexpress.com/item/32792768667.html>`_


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-laser-at/>`_.
To install for current user:

.. code-block:: shell

    pip3 install circuitpython-laser-at

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install circuitpython-laser-at

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install circuitpython-laser-at

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install laser_at

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python3

    from board import UART
    from laser_at import Laser
    uart = UART()
    uart.baudrate = 19200
    laser = Laser(uart)
    print(f"Distance is {laser.distance}")

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-laser-at.readthedocs.io/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/furbrain/CircuitPython_laser_at/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "circuitpython-laser-at",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,laser_at,rangefinder,laser,distance,disto",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/32/28/d812f39f2841c63c92d4fc196f2f03248554e32499af1a3e8102ac5aa893/circuitpython-laser-at-0.9.0.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://github.com/furbrain/CircuitPython_laser_at/workflows/Build%20CI/badge.svg\n    :target: https://github.com/furbrain/CircuitPython_laser_at/actions\n    :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nDriver for an inexpensive laser rangefinder module, made by Hi-AT, available on `aliexpress\n<https://www.aliexpress.com/item/32792768667.html>`_\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/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 <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-laser-at/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install circuitpython-laser-at\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install circuitpython-laser-at\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 .venv\n    source .env/bin/activate\n    pip3 install circuitpython-laser-at\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install laser_at\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    from board import UART\n    from laser_at import Laser\n    uart = UART()\n    uart.baudrate = 19200\n    laser = Laser(uart)\n    print(f\"Distance is {laser.distance}\")\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-laser-at.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/furbrain/CircuitPython_laser_at/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Driver for an inexpensive laser rangefinder module, made by AT, available on aliexpress.",
    "version": "0.9.0",
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "laser_at",
        "rangefinder",
        "laser",
        "distance",
        "disto"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e80dc578b5070b010334fe163d773969",
                "sha256": "82c077047d23135cd83ea7aa2d3e8c59790e9d65040617ffc87245c495d940f2"
            },
            "downloads": -1,
            "filename": "circuitpython_laser_at-0.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e80dc578b5070b010334fe163d773969",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4970,
            "upload_time": "2022-12-28T15:44:39",
            "upload_time_iso_8601": "2022-12-28T15:44:39.759001Z",
            "url": "https://files.pythonhosted.org/packages/32/a0/d0747ba44c066e4a47511ef9e0b604aea78c35da857262f2e6d004a36634/circuitpython_laser_at-0.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "1ee0da36186c9cf528f9dd17e47900c0",
                "sha256": "29a3699775dd4cd02cb29b00192edc1d7366ac3dca9473dca361171515aa2a62"
            },
            "downloads": -1,
            "filename": "circuitpython-laser-at-0.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1ee0da36186c9cf528f9dd17e47900c0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26207,
            "upload_time": "2022-12-28T15:44:41",
            "upload_time_iso_8601": "2022-12-28T15:44:41.485710Z",
            "url": "https://files.pythonhosted.org/packages/32/28/d812f39f2841c63c92d4fc196f2f03248554e32499af1a3e8102ac5aa893/circuitpython-laser-at-0.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-28 15:44:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "circuitpython-laser-at"
}
        
Elapsed time: 0.07660s