Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l4cd/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vl53l4cd/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_VL53L4CD/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L4CD/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 helper library for the VL53L4CD time of flight 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 VL53L4CD Time of Flight Distance Sensor - ~1 to 1300mm - STEMMA QT / Qwiic
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5396>`_
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-vl53l4cd/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vl53l4cd
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vl53l4cd
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-vl53l4cd
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_vl53l4cd
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See examples/vl53l4cd_simpletest.py for basic usage example.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l4cd/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_VL53L4CD/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vl53l4cd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, vl53l4cd, distance",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/ce/2243d3d0984c53d2513cf87e71543be0d6524140bc39633aa5b49465298e/adafruit-circuitpython-vl53l4cd-1.2.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl53l4cd/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vl53l4cd/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_VL53L4CD/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VL53L4CD/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 helper library for the VL53L4CD time of flight 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 VL53L4CD Time of Flight Distance Sensor - ~1 to 1300mm - STEMMA QT / Qwiic\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5396>`_\n\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-vl53l4cd/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vl53l4cd\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vl53l4cd\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-vl53l4cd\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_vl53l4cd\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/vl53l4cd_simpletest.py for basic usage example.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl53l4cd/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_VL53L4CD/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for the VL53L4CD time of flight distance sensor.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VL53L4CD.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" vl53l4cd",
" distance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "027152eb5f8e891c6de1a34511365dd7243b4becf2c14d6505bef4d89e960610",
"md5": "9422e0547a63b197d13a3fdb1e0e5167",
"sha256": "d73ed9c256e31a34f246244058da4b7e1ef31384edccedcc106151abe332d416"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl53l4cd-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9422e0547a63b197d13a3fdb1e0e5167",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8089,
"upload_time": "2024-03-21T16:22:50",
"upload_time_iso_8601": "2024-03-21T16:22:50.405496Z",
"url": "https://files.pythonhosted.org/packages/02/71/52eb5f8e891c6de1a34511365dd7243b4becf2c14d6505bef4d89e960610/adafruit_circuitpython_vl53l4cd-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8ce2243d3d0984c53d2513cf87e71543be0d6524140bc39633aa5b49465298e",
"md5": "f31c3f46cd4a173a9dd64b548ec1a264",
"sha256": "5fa1ca39c1e11d8e6d30a2baee3c1431b85ecbd876415708e57e919948078810"
},
"downloads": -1,
"filename": "adafruit-circuitpython-vl53l4cd-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f31c3f46cd4a173a9dd64b548ec1a264",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30553,
"upload_time": "2024-03-21T16:22:53",
"upload_time_iso_8601": "2024-03-21T16:22:53.752602Z",
"url": "https://files.pythonhosted.org/packages/d8/ce/2243d3d0984c53d2513cf87e71543be0d6524140bc39633aa5b49465298e/adafruit-circuitpython-vl53l4cd-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 16:22:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VL53L4CD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vl53l4cd"
}
JSON
