Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4020/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vcnl4020/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_VCNL4020/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4020/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
Driver for the VCNL4020 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>`_
* `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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5810>`_
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-vcnl4020/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vcnl4020
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vcnl4020
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-vcnl4020
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_vcnl4020
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import adafruit_vcnl4020
i2c = board.I2C()
# Initialize VCNL4020
sensor = adafruit_vcnl4020.Adafruit_VCNL4020(i2c)
while True:
print(f"Proximity is: {sensor.proximity}")
print(f"Ambient is: {sensor.lux}")
time.sleep(0.1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4020/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_VCNL4020/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-vcnl4020",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,vcnl4020,proximity,,light,,lux",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/60/28/45450c39428094b69f3b2cfffcd2f23ca76223470ab2b7c9c11e38d64254/adafruit-circuitpython-vcnl4020-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4020/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vcnl4020/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4020/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4020/actions\n :alt: Build Status\n\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\nDriver for the VCNL4020 proximity and 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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5810>`_\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-vcnl4020/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vcnl4020\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vcnl4020\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 .env/bin/activate\n pip3 install adafruit-circuitpython-vcnl4020\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_vcnl4020\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n import adafruit_vcnl4020\n\n i2c = board.I2C()\n\n # Initialize VCNL4020\n sensor = adafruit_vcnl4020.Adafruit_VCNL4020(i2c)\n\n while True:\n print(f\"Proximity is: {sensor.proximity}\")\n print(f\"Ambient is: {sensor.lux}\")\n time.sleep(0.1)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vcnl4020/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_VCNL4020/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Driver for the VCNL4020 proximity and light sensor",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4020"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"vcnl4020",
"proximity",
"",
"light",
"",
"lux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43cc721ec60e5a55975373fdbc466f8760e90e6f39e50d819a73cf9943ba54be",
"md5": "b7d54c897cc777f831fc3d458123443b",
"sha256": "eaf61b4a3778e3c9d6148ec9b36088feaae702f25b895ad1aed087bbd9d637cd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4020-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7d54c897cc777f831fc3d458123443b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6317,
"upload_time": "2023-11-01T16:50:47",
"upload_time_iso_8601": "2023-11-01T16:50:47.364461Z",
"url": "https://files.pythonhosted.org/packages/43/cc/721ec60e5a55975373fdbc466f8760e90e6f39e50d819a73cf9943ba54be/adafruit_circuitpython_vcnl4020-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "602845450c39428094b69f3b2cfffcd2f23ca76223470ab2b7c9c11e38d64254",
"md5": "6531d7859660fed7bcf68cf706298c35",
"sha256": "43d09edc914b8f8319bc95797064ef6c40d8e0201d1897f00740832afe11c087"
},
"downloads": -1,
"filename": "adafruit-circuitpython-vcnl4020-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6531d7859660fed7bcf68cf706298c35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27556,
"upload_time": "2023-11-01T16:50:49",
"upload_time_iso_8601": "2023-11-01T16:50:49.019250Z",
"url": "https://files.pythonhosted.org/packages/60/28/45450c39428094b69f3b2cfffcd2f23ca76223470ab2b7c9c11e38d64254/adafruit-circuitpython-vcnl4020-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 16:50:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VCNL4020",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-vcnl4020"
}
JSON
