/Adafruit_CircuitPython_VL6180X

CircuitPython module for the VL6180X distance sensor.

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython module for the VL6180X distance sensor. See examples/vl6180x_simpletest.py for a demo of the usage.

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.

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-vl6180x

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-vl6180x

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-vl6180x

Usage Example

See examples/vl6180x_simpletest.py for a demo of the usage.

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.