Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l1x/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vl53l1x/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_VL53L1X/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X/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 module for interacting with the VL53L1X 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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Adafruit VL53L1X Time of Flight Distance Sensor - ~30 to 4000mm - STEMMA QT / Qwiic
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/3967>`_
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-vl53l1x/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vl53l1x
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vl53l1x
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-vl53l1x
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 adafruit_vl53l1x
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See examples/vl53l1x_simpletest.py for basic usage example.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l1x/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_VL53L1X/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vl53l1x",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, vl53l1x, distance, ToF",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/29/ea/c56d5ec7a6ad28c4502e8de613a63b884f5ea1d87d3be7bb7fbcd225abb1/adafruit_circuitpython_vl53l1x-1.2.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l1x/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vl53l1x/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X/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\nCircuitPython module for interacting with the VL53L1X distance sensor.\n\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nAdafruit VL53L1X Time of Flight Distance Sensor - ~30 to 4000mm - STEMMA QT / Qwiic\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/3967>`_\n\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-vl53l1x/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vl53l1x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vl53l1x\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-vl53l1x\n\n\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 adafruit_vl53l1x\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee examples/vl53l1x_simpletest.py for basic usage example.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l1x/en/latest/>`_.\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/adafruit/Adafruit_CircuitPython_VL53L1X/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython module for interacting with the VL53L1X distance sensor.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" vl53l1x",
" distance",
" tof"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fffa2d91e76f2e7f1db1b0c739865831da2e079b60a1f8216d46a68e8690fbc8",
"md5": "5b792e547d505cdc9c0317db586d24da",
"sha256": "91b36d44bfa1ca66768f1a7c41267a1b78a2a66bea073f80fb4253fc9f55ef01"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl53l1x-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b792e547d505cdc9c0317db586d24da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7538,
"upload_time": "2025-01-22T20:34:26",
"upload_time_iso_8601": "2025-01-22T20:34:26.106882Z",
"url": "https://files.pythonhosted.org/packages/ff/fa/2d91e76f2e7f1db1b0c739865831da2e079b60a1f8216d46a68e8690fbc8/adafruit_circuitpython_vl53l1x-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "29eac56d5ec7a6ad28c4502e8de613a63b884f5ea1d87d3be7bb7fbcd225abb1",
"md5": "e4644c5535b5842469fc89a478a26be7",
"sha256": "5bcb234b916b472c0b7b06c8af6dccaceef944125d2d4544f30a8e999a7cbcc8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl53l1x-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "e4644c5535b5842469fc89a478a26be7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31162,
"upload_time": "2025-01-22T20:34:28",
"upload_time_iso_8601": "2025-01-22T20:34:28.044659Z",
"url": "https://files.pythonhosted.org/packages/29/ea/c56d5ec7a6ad28c4502e8de613a63b884f5ea1d87d3be7bb7fbcd225abb1/adafruit_circuitpython_vl53l1x-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 20:34:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VL53L1X",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vl53l1x"
}
JSON
