adafruit-circuitpython-vl53l0x


Nameadafruit-circuitpython-vl53l0x JSON
Version 3.6.13 PyPI version JSON
download
home_pageNone
SummaryCircuitPython library for VL53L0X time of flight distance sensor.
upload_time2024-12-05 21:13:22
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit vl53l0x time flight distance sensorbreakout hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l0x/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/vl53l0x/en/latest/
    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X/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

CircuitPython driver for the VL53L0X distance sensor.

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

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

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

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

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-vl53l0x

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-vl53l0x

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install adafruit-circuitpython-vl53l0x

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

See usage in the examples/vl53l0x_simpletest.py file.

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l0x/en/latest/>`_.

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/adafruit/Adafruit_CircuitPython_vl53l0x/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-vl53l0x",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, vl53l0x, time, flight, distance, sensorbreakout, hardware, micropython, circuitpython",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/be/ae/e06222969cb2987f6e01d1b3cb8024e393e581f985559fef881a4edf93dc/adafruit_circuitpython_vl53l0x-3.6.13.tar.gz",
    "platform": null,
    "description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l0x/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/vl53l0x/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X/actions/\n    :alt: Build Status\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\nCircuitPython driver for the VL53L0X distance sensor.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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/adafruit-circuitpython-vl53l0x/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-vl53l0x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-vl53l0x\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 .venv/bin/activate\n    pip3 install adafruit-circuitpython-vl53l0x\n\nUsage Example\n=============\n\nSee usage in the examples/vl53l0x_simpletest.py file.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l0x/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_vl53l0x/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for VL53L0X time of flight distance sensor.",
    "version": "3.6.13",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X"
    },
    "split_keywords": [
        "adafruit",
        " vl53l0x",
        " time",
        " flight",
        " distance",
        " sensorbreakout",
        " hardware",
        " micropython",
        " circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4317235539b55ce08c31ba0450e5aeb6d114a4c95b15ec413f5199fb5b7568ae",
                "md5": "a5b7be1c75aadf170b7b3a8dd0a021e1",
                "sha256": "53db9859ebd3da6ca519fd4ff2dc43808fe6834b78b2a01ca346e76934b8b9a6"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_vl53l0x-3.6.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a5b7be1c75aadf170b7b3a8dd0a021e1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9817,
            "upload_time": "2024-12-05T21:13:21",
            "upload_time_iso_8601": "2024-12-05T21:13:21.358555Z",
            "url": "https://files.pythonhosted.org/packages/43/17/235539b55ce08c31ba0450e5aeb6d114a4c95b15ec413f5199fb5b7568ae/adafruit_circuitpython_vl53l0x-3.6.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "beaee06222969cb2987f6e01d1b3cb8024e393e581f985559fef881a4edf93dc",
                "md5": "04fce643a699ac70a9fe5240f5f793e7",
                "sha256": "e26b63137181af64e0579a259562da93c7d3ab8a855a2301df2d4bc7939d9f99"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_vl53l0x-3.6.13.tar.gz",
            "has_sig": false,
            "md5_digest": "04fce643a699ac70a9fe5240f5f793e7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 33731,
            "upload_time": "2024-12-05T21:13:22",
            "upload_time_iso_8601": "2024-12-05T21:13:22.730520Z",
            "url": "https://files.pythonhosted.org/packages/be/ae/e06222969cb2987f6e01d1b3cb8024e393e581f985559fef881a4edf93dc/adafruit_circuitpython_vl53l0x-3.6.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-05 21:13:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_VL53L0X",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-vl53l0x"
}
        
Elapsed time: 0.52002s