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

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_vl53l1x-1.2.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0bbc26f2a68cf9ba785c3061f79c8d9102f7aa4fdab86a8d3e76054b8493eb83
MD5 fa454d4fa1add9d6a661681a87f65c7e
BLAKE2b-256 5fcbea0ecbdd3a969bf236dc95c2e381573d62d6119dec8b48a1505cb6d0e396

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61a1dff54db6418f2de2302f5e898d461e12463b6c1cdbda8f0077973a20327d
MD5 973898d97a3a62c8007e9389a41c57bd
BLAKE2b-256 612af1daee4bec434e3a5b786b7aa9a7fe32767409db0a4f572e349ad9df0c48

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