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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-vl53l1x-1.1.11.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-vl53l1x-1.1.11.tar.gz
Algorithm Hash digest
SHA256 2b46bb4b87edf4cb2339558090eaf270289577ad0df124bda86d583cc6e2983b
MD5 fc3bd12357eae4e50bc107ff757a7734
BLAKE2b-256 223aa872a085508e9afc99843b43b8f0b9e1a4b7a7a1a2c6a1577b3c8d60cb34

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 415922c60a2a158521be7a7a31b59dd7e5a4b161c814daf87f2b9b5b39a7f7c3
MD5 02213637270f3d6313650b9a7127acbf
BLAKE2b-256 9b9136b351af80f52377b1b7225dcb937f58e796f4a16f8bb255c44de103c6b1

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