Skip to main content

CircuitPython helper library for the VL53L4CD time of flight distance sensor.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython helper library for the VL53L4CD time of flight distance sensor.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Adafruit VL53L4CD Time of Flight Distance Sensor - ~1 to 1300mm - STEMMA QT / Qwiic

Purchase one from the Adafruit shop

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-vl53l4cd

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

sudo pip3 install adafruit-circuitpython-vl53l4cd

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install vl53l4cd

Or the following command to update an existing version:

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-vl53l4cd-1.0.1.tar.gz (30.5 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-vl53l4cd-1.0.1.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-vl53l4cd-1.0.1.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for adafruit-circuitpython-vl53l4cd-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7062d4f70a61d19fc88e6437bcfbe956b52cb9144cd6d4f20cfee0663d82f871
MD5 ce9ab9b60d8bc7d0178d342efd814439
BLAKE2b-256 0246bb192a625dbd943d0c43ae323601737ab78541406926359764d164c2a112

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page