Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4040/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vcnl4040/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_VCNL4040/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040/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
A CircuitPython library for the VCNL4040 proximity and ambient light sensor.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
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-vcnl4040/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vcnl4040
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vcnl4040
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-vcnl4040
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_vcnl4040
i2c = board.I2C()
sensor = adafruit_vcnl4040.VCNL4040(i2c)
while True:
print("Proximity:", sensor.proximity)
print("Light:", sensor.light)
print("White:", sensor.white)
time.sleep(0.3)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4040/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_VCNL4040/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vcnl4040",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, vcnl4040, ambient, light, proximity, ir, sensor, hardware",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d6/d8/a9854edd60088d711e4c5120f52746bc7c1ed2b2cd2efad44e5f9fe93a02/adafruit_circuitpython_vcnl4040-1.2.18.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4040/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vcnl4040/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_VCNL4040/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040/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\nA CircuitPython library for the VCNL4040 proximity and ambient light sensor.\n\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* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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-vcnl4040/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vcnl4040\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vcnl4040\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-vcnl4040\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_vcnl4040\n\n i2c = board.I2C()\n sensor = adafruit_vcnl4040.VCNL4040(i2c)\n\n while True:\n print(\"Proximity:\", sensor.proximity)\n print(\"Light:\", sensor.light)\n print(\"White:\", sensor.white)\n time.sleep(0.3)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4040/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_VCNL4040/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CircuitPython library for the VCNL4040 proximity and ambient light sensor.",
"version": "1.2.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" vcnl4040",
" ambient",
" light",
" proximity",
" ir",
" sensor",
" hardware"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "456b03657d2f7128d9d1e219be66cf57b9aa5eb48efb57c9279e70f20dc428e6",
"md5": "df6b147c7e6b7ebad21ff9ac1ece8b19",
"sha256": "7046813b7a2906fba6444a3d0352e6133d92f1a9f7d9a609013d7d26b50a5b39"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4040-1.2.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df6b147c7e6b7ebad21ff9ac1ece8b19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6626,
"upload_time": "2024-10-07T15:33:13",
"upload_time_iso_8601": "2024-10-07T15:33:13.608025Z",
"url": "https://files.pythonhosted.org/packages/45/6b/03657d2f7128d9d1e219be66cf57b9aa5eb48efb57c9279e70f20dc428e6/adafruit_circuitpython_vcnl4040-1.2.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d6d8a9854edd60088d711e4c5120f52746bc7c1ed2b2cd2efad44e5f9fe93a02",
"md5": "3b762514475f809b60f238353b5f0fa9",
"sha256": "d942ad643008173db4e93cfdf88b23e47285aa48518e20286050e12614fb3fab"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4040-1.2.18.tar.gz",
"has_sig": false,
"md5_digest": "3b762514475f809b60f238353b5f0fa9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28096,
"upload_time": "2024-10-07T15:33:14",
"upload_time_iso_8601": "2024-10-07T15:33:14.666215Z",
"url": "https://files.pythonhosted.org/packages/d6/d8/a9854edd60088d711e4c5120f52746bc7c1ed2b2cd2efad44e5f9fe93a02/adafruit_circuitpython_vcnl4040-1.2.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 15:33:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VCNL4040",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vcnl4040"
}
JSON
