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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-vl53l1x-1.1.7.tar.gz
Algorithm Hash digest
SHA256 ca600b7c19f07e3b2d7c006bc513552b365e4de5b3794a2467527c535608421c
MD5 228f459f9a5673461c939475a6f8cf8a
BLAKE2b-256 c11d3811247431b4a367decff7a43d633a782a1735cb7181d153ad566e00f2f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f694f88cb892301342e3af91c52af683932b29c187754c09a4b0b3b82322ee82
MD5 10562a90a6a8e80442def95fb388e86a
BLAKE2b-256 114d412a212ae5a99f7fea93c8fb69a5189b84c2c67db7943953a58a2b4361a3

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