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.15.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.15.tar.gz
Algorithm Hash digest
SHA256 c4a82fa01e7cda4f8686dc11fa5639eb2066e4044349264862eaba99478232d3
MD5 673f87cf4e1e424710c16fb83c74163f
BLAKE2b-256 6bde490fd7e86db939d682617cfcb6c0bbc0d04fab5ada8346ba6972a875e223

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 4de1028b4875eb87c9c739327114f104e7ac873e24773ba2b5cc0074d4a42257
MD5 81bdc6b10a8a08b2a45151b5873df9c6
BLAKE2b-256 0962e2827078cd679818558c3b2c48fecf2d7e65fff11305481be83e8ec5bff4

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