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.7.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.7.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.7.tar.gz
Algorithm Hash digest
SHA256 6f9531f369ac99eead799a59d2e894bb37c90e910a8cf9651be1d659fd533496
MD5 590dffb4893c97a1cb32340d7e229c40
BLAKE2b-256 82e202e75dfeec38982240e179aa02681cba1331172a1ca7fee644b97afa6013

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 3ff0865344ca9b6adc512ae78d26de91aa805168e5cb2f80d7d711ba05b451f5
MD5 4c5d5077ecde5a83f3ddfd5fe2a34bd6
BLAKE2b-256 16988467185dbd2d3531f3ae4453aeb049a0974d2fa09004b65a27772d596028

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