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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-vl53l1x-1.1.9.tar.gz
Algorithm Hash digest
SHA256 1c5a5b41031c982b503c08b555ee07be7e13d9bd844b9e24fa101c75a9b30ade
MD5 81796089d8b5975feddfd86c5bb0e7dc
BLAKE2b-256 b8aa669c9abce47ffcffadaf0c72e1ee0796c36ae7911ffe31bef75e2830ee68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_vl53l1x-1.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ba873fc777e2b25ab6c2ba0052ed502cf775541cf1d9acd546cf25ec514b245f
MD5 e5cc5cc5c0f759ad591f0b921fa206a9
BLAKE2b-256 4c4eaa406cab21e9740d76bb377490830e7c2d3321467a33825500e5961f85d9

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