Skip to main content

CircuitPython library for VL53L0X time of flight distance sensor.

Project description

Introduction

Documentation Status Discord Build Status

CircuitPython driver for the VL53L0X 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.

Usage Example

See usage in the examples/vl53l0x_simpletest.py file.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vl53l0x --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

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

Uploaded Source

File details

Details for the file adafruit-circuitpython-vl53l0x-3.1.1.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-vl53l0x-3.1.1.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for adafruit-circuitpython-vl53l0x-3.1.1.tar.gz
Algorithm Hash digest
SHA256 b009bc6dd338f7b6c02888763957b79fe3cd011daf357f34144c2abe069dde66
MD5 784f786ef85cbb6b3ad0c0d39c2dad4c
BLAKE2b-256 dacd170f6d1daff2dd66d30e5ccf624ac34f76a915e1e6c3ad0d84b7299f7707

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