Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4010/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vcnl4010/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_VCNL4010/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010/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 VCNL4010 proximity and light sensor.
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-vcnl4010/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vcnl4010
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vcnl4010
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-vcnl4010
Usage Example
=============
See examples/vcnl4010_simpletest.py for an example of the usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4010/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_VCNL4010/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vcnl4010",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, vcnl4010, proximity, light, sensor, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/86/0de51de13aa358acd0de5933c8f6ec62f2007d91bb521885eeb68337c962/adafruit_circuitpython_vcnl4010-0.11.12.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4010/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vcnl4010/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_VCNL4010/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010/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 VCNL4010 proximity and light sensor.\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-vcnl4010/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vcnl4010\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vcnl4010\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-vcnl4010\n\nUsage Example\n=============\n\nSee examples/vcnl4010_simpletest.py for an example of the usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4010/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_VCNL4010/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for VCNL4010 proximity and light sensor.",
"version": "0.11.12",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010"
},
"split_keywords": [
"adafruit",
" vcnl4010",
" proximity",
" light",
" sensor",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "34c1fcc7f0b9d60f17791ff6d748aaf26f0fd14cdcd96713d04cb793a6288d5f",
"md5": "2ca58c2f481b7e4574ebe73629451b1a",
"sha256": "2bbac13475bba823667ccdb3ccf4f66e96106d9b3dfd3fced7fe93ed3f25f511"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4010-0.11.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ca58c2f481b7e4574ebe73629451b1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6829,
"upload_time": "2024-12-09T14:26:48",
"upload_time_iso_8601": "2024-12-09T14:26:48.803207Z",
"url": "https://files.pythonhosted.org/packages/34/c1/fcc7f0b9d60f17791ff6d748aaf26f0fd14cdcd96713d04cb793a6288d5f/adafruit_circuitpython_vcnl4010-0.11.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb860de51de13aa358acd0de5933c8f6ec62f2007d91bb521885eeb68337c962",
"md5": "f192703a661ae06887c0ae6f2c196ec5",
"sha256": "4c0b7420182dabae499bc1bc716ae78f062b3f249fb54c9c6673090f60c4f235"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4010-0.11.12.tar.gz",
"has_sig": false,
"md5_digest": "f192703a661ae06887c0ae6f2c196ec5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28528,
"upload_time": "2024-12-09T14:26:51",
"upload_time_iso_8601": "2024-12-09T14:26:51.933860Z",
"url": "https://files.pythonhosted.org/packages/fb/86/0de51de13aa358acd0de5933c8f6ec62f2007d91bb521885eeb68337c962/adafruit_circuitpython_vcnl4010-0.11.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 14:26:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VCNL4010",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vcnl4010"
}
JSON
