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.

Keywords

FAQs

What is adafruit-circuitpython-vl53l4cd?

Is adafruit-circuitpython-vl53l4cd well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install