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": "",
"name": "adafruit-circuitpython-vl53l0x",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,vl53l0x,time,flight,distance,sensorbreakout,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/ea/5999bdaf72945a40cc26e77963cfe0b1cf2e9cc63e961c09750388778933/adafruit-circuitpython-vl53l0x-3.6.11.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.11",
"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": "b06842ff0b8e50c1c50219690389c0b7e1fca4dd7fa27627facefdf5ad284ea8",
"md5": "85f05c36d83d571d2d1bf6053548b36b",
"sha256": "549ae436b3cbde3431f6326d7bc13fa9da43a9f497c98021398566eda32a049e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl53l0x-3.6.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85f05c36d83d571d2d1bf6053548b36b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9817,
"upload_time": "2023-12-09T17:36:43",
"upload_time_iso_8601": "2023-12-09T17:36:43.906859Z",
"url": "https://files.pythonhosted.org/packages/b0/68/42ff0b8e50c1c50219690389c0b7e1fca4dd7fa27627facefdf5ad284ea8/adafruit_circuitpython_vl53l0x-3.6.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6ea5999bdaf72945a40cc26e77963cfe0b1cf2e9cc63e961c09750388778933",
"md5": "11dd32f6f01d7704f707d9daed3392fd",
"sha256": "006af4f8c0aefaa79543f96f06e8a2ea2932cfa1fe57d81f40f99d0627057f22"
},
"downloads": -1,
"filename": "adafruit-circuitpython-vl53l0x-3.6.11.tar.gz",
"has_sig": false,
"md5_digest": "11dd32f6f01d7704f707d9daed3392fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33258,
"upload_time": "2023-12-09T17:36:46",
"upload_time_iso_8601": "2023-12-09T17:36:46.368021Z",
"url": "https://files.pythonhosted.org/packages/a6/ea/5999bdaf72945a40cc26e77963cfe0b1cf2e9cc63e961c09750388778933/adafruit-circuitpython-vl53l0x-3.6.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:36:46",
"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": [],
"lcname": "adafruit-circuitpython-vl53l0x"
}
JSON
