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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-vl53l1x-1.1.10.tar.gz
Algorithm Hash digest
SHA256 32c06f42cdbc020c8d55a7bcf871f0589029d30e67479c64818fc1e0aed03646
MD5 2f903b0968b1eb68a1ea2691b40132d7
BLAKE2b-256 297b76f88e673e8277fb43582aba93ed0eec650e0d511e215d65312bb0d390b8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 bbfd17a3f1d8ed45ec21079945544713481eaae8bccda1d8c70022973847c40a
MD5 d40f7fb5f9c785dda08a90b241a91708
BLAKE2b-256 b79c2ecb41e973b0bd0031d0c31b23e3d5a6323a32faf5f8c4d0f16836670445

See more details on using hashes here.

Provenance

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