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": "",
"name": "adafruit-circuitpython-vcnl4010",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,vcnl4010,proximity,light,sensor,breakout,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/37/be/e1295d08b763c6b793fbef1f58c7e9bd18c60b1504a4bc6407674dbd909b/adafruit-circuitpython-vcnl4010-0.11.10.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.10",
"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": "6bf443c09a5b1c6f854e3545dc4e0700bf790ed52aa2b4c5c4f32113322c8afe",
"md5": "ef4a9dd6a8958cb6c023b12c4cd7a56c",
"sha256": "e02687b248f0641ae60d73d62adc4928b6918d97fc6c5aaa1ea2c26422765be6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4010-0.11.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef4a9dd6a8958cb6c023b12c4cd7a56c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6824,
"upload_time": "2023-12-09T17:36:33",
"upload_time_iso_8601": "2023-12-09T17:36:33.368682Z",
"url": "https://files.pythonhosted.org/packages/6b/f4/43c09a5b1c6f854e3545dc4e0700bf790ed52aa2b4c5c4f32113322c8afe/adafruit_circuitpython_vcnl4010-0.11.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37bee1295d08b763c6b793fbef1f58c7e9bd18c60b1504a4bc6407674dbd909b",
"md5": "65710e12984b359d7f2a2ff40a77cf79",
"sha256": "0a867d233dfbf81ff6e525cc309fdf970327e2d2f1c67bab9ca5e32fb89fcda0"
},
"downloads": -1,
"filename": "adafruit-circuitpython-vcnl4010-0.11.10.tar.gz",
"has_sig": false,
"md5_digest": "65710e12984b359d7f2a2ff40a77cf79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28005,
"upload_time": "2023-12-09T17:36:34",
"upload_time_iso_8601": "2023-12-09T17:36:34.651044Z",
"url": "https://files.pythonhosted.org/packages/37/be/e1295d08b763c6b793fbef1f58c7e9bd18c60b1504a4bc6407674dbd909b/adafruit-circuitpython-vcnl4010-0.11.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:36:34",
"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": [],
"lcname": "adafruit-circuitpython-vcnl4010"
}
JSON
