Skip to main content

CircuitPython module for interacting with the VL53L1X distance sensor.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.8.tar.gz
Algorithm Hash digest
SHA256 5a3aa8aaa4c5bb926c3623f6628a4f4b76f7fd3ace15238077f367524e76fb96
MD5 14e87cd1fcfe180afef0414a65887da1
BLAKE2b-256 e1621dab8ceb712c5b3f9b24c2c2bdd55aa710f6d59fb50b7ac7343fe55893e6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8fc40db5e3fba635173c5148154de550a553288d4e435ed49a4613c8b2308a67
MD5 b12743d98be834ea42921e168a792da8
BLAKE2b-256 cbefe1da00ab56fbad2927b07baebb4f119c0b4f0fe7f451857d2e2e32af4c28

See more details on using hashes here.

Supported by

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