Skip to main content

CircuitPython module for interacting with the VL53L1X distance sensor.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython module for interacting with the VL53L1X 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 VL53L1X Time of Flight Distance Sensor - ~30 to 4000mm - 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-vl53l1x

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

sudo pip3 install adafruit-circuitpython-vl53l1x

To install in a virtual environment in your current project:

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:

pip3 install circup

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

circup install adafruit_vl53l1x

Or the following command to update an existing version:

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.

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_vl53l1x-1.1.16.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_vl53l1x-1.1.16.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.16.tar.gz
Algorithm Hash digest
SHA256 4a7715507caf09d3ae3abab610a4c0575a3cec0bd216b49fa29ab1fa1ae1fe99
MD5 91b4ce4ea6a8867f4f904d3919777ebf
BLAKE2b-256 6ed09d0bb5fadb01413cc7a38d076db93d1b84747e0c926478850d05aad58965

See more details on using hashes here.

Provenance

File details

Details for the file adafruit_circuitpython_vl53l1x-1.1.16-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a0ccc20b4dba3dca6a89b2eadbfbc14ca6e2eaeaf1ac04f6c0df5357a22d2e75
MD5 9d5f04f04e1bfd556de3f54c5bf85961
BLAKE2b-256 8fc5e454bccdbfbc44f702639dd9868143aa2d48c468f63940f6dcda0f059eaa

See more details on using hashes here.

Provenance

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