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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-vl53l1x-1.1.8.tar.gz
Algorithm Hash digest
SHA256 554e0a36d0894cf21685226022ff49210e4968c2c9a5319403f73600f1c9c862
MD5 955f7ce7f5ce0af6f26ffac07dd46726
BLAKE2b-256 684dbf39661b619859e750538fc665d8231b6e61cb2482a31019d38e02579650

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d59172926f5bc0dd799a26fd79921ed1a2c1712a779f10fc01159b983eb85b60
MD5 270d043b499abbcf92ed308ca0177568
BLAKE2b-256 1f02d574c519a69f313502c3b97c4d4840ae620c15fd22539fe4d050df61b608

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