Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl6180x/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vl6180x/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: 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:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-vl6180x/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vl6180x
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vl6180x
To install in a virtual environment in your current project:
.. code-block:: shell
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 <https://docs.circuitpython.org/projects/vl6180x/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vl6180x",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, vl6180x, time, flight, distance, sensorbreakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ec/a4/6ee63fbdb605a35caa6b04b43cccf41fd5ceaf7ca1742dcd4ccd57fdc06c/adafruit_circuitpython_vl6180x-1.4.14.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl6180x/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vl6180x/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython module for the VL6180X distance sensor. See\nexamples/vl6180x_simpletest.py for a demo of the usage.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-vl6180x/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vl6180x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vl6180x\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-vl6180x\n\nUsage Example\n=============\n\nSee examples/vl6180x_simpletest.py for a demo of the usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vl6180x/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for VL6180X time of flight distance sensor.",
"version": "1.4.14",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X"
},
"split_keywords": [
"adafruit",
" vl6180x",
" time",
" flight",
" distance",
" sensorbreakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49ab2db12a5b16ff6a4338ffc1cdd1e0106742d4563f69d40b6ccc2e0b364152",
"md5": "005fa81038a54ce0dc5c67f2dfc661c7",
"sha256": "de14c28f7c3bc01950b9f8a8f21abf6a08a82ef96a2f7987b1c70abe00ae258b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl6180x-1.4.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "005fa81038a54ce0dc5c67f2dfc661c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7477,
"upload_time": "2024-12-16T14:45:16",
"upload_time_iso_8601": "2024-12-16T14:45:16.961636Z",
"url": "https://files.pythonhosted.org/packages/49/ab/2db12a5b16ff6a4338ffc1cdd1e0106742d4563f69d40b6ccc2e0b364152/adafruit_circuitpython_vl6180x-1.4.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eca46ee63fbdb605a35caa6b04b43cccf41fd5ceaf7ca1742dcd4ccd57fdc06c",
"md5": "fb4287f4c09b119aa1842f34b34afbe1",
"sha256": "706841e689ab836c754c2f5c79b4c704dc2e152ea981f5b471a34f2db70c5f4d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vl6180x-1.4.14.tar.gz",
"has_sig": false,
"md5_digest": "fb4287f4c09b119aa1842f34b34afbe1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30523,
"upload_time": "2024-12-16T14:45:20",
"upload_time_iso_8601": "2024-12-16T14:45:20.115998Z",
"url": "https://files.pythonhosted.org/packages/ec/a4/6ee63fbdb605a35caa6b04b43cccf41fd5ceaf7ca1742dcd4ccd57fdc06c/adafruit_circuitpython_vl6180x-1.4.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 14:45:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VL6180X",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vl6180x"
}
JSON
