Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4200/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vcnl4200/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_VCNL4200/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4200/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for the Adafruit VCNL4200 Long Distance IR 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/6064>`_
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-vcnl4200/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vcnl4200
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vcnl4200
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-vcnl4200
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_vcnl4200
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_vcnl4200
i2c = board.I2C()
# Initialize VCNL4200
sensor = adafruit_vcnl4020.Adafruit_VCNL4200(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/vcnl4200/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_VCNL4200/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-vcnl4200",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, vcnl4200, ir, , proximity, , light, , stemma, qt",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f1/fc/fa2b57327676c74454bcbba4be109ee9db4af2dbb53cc5c002d93527ff6d/adafruit_circuitpython_vcnl4200-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4200/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vcnl4200/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_VCNL4200/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4200/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython driver for the Adafruit VCNL4200 Long Distance IR 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/6064>`_\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-vcnl4200/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vcnl4200\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vcnl4200\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-vcnl4200\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_vcnl4200\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_vcnl4200\n\n i2c = board.I2C()\n\n # Initialize VCNL4200\n sensor = adafruit_vcnl4020.Adafruit_VCNL4200(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/vcnl4200/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_VCNL4200/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the Adafruit VCNL4200 Long Distance IR Proximity and Light Sensor",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4200"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" vcnl4200",
" ir",
" ",
" proximity",
" ",
" light",
" ",
" stemma",
" qt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3bfc4dfc63405a69e2e51f48a72e9d1a41976bf6c2979db7b3e92fa9b5a5122",
"md5": "53de3a6885ae4fa5831806bede06264c",
"sha256": "e7245541beddb2eb061fe651491fe236a54e1826eddefb5c8834271d8e859d6d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4200-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53de3a6885ae4fa5831806bede06264c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8950,
"upload_time": "2024-10-30T20:02:22",
"upload_time_iso_8601": "2024-10-30T20:02:22.607795Z",
"url": "https://files.pythonhosted.org/packages/d3/bf/c4dfc63405a69e2e51f48a72e9d1a41976bf6c2979db7b3e92fa9b5a5122/adafruit_circuitpython_vcnl4200-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1fcfa2b57327676c74454bcbba4be109ee9db4af2dbb53cc5c002d93527ff6d",
"md5": "94e4f9ded85af5ae29bf1e97b3797c0e",
"sha256": "91b3ed8a8bac9de93790b3b7c0d8e5333ebbed8f4bd413969389b26e9c126d4a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vcnl4200-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "94e4f9ded85af5ae29bf1e97b3797c0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28124,
"upload_time": "2024-10-30T20:02:24",
"upload_time_iso_8601": "2024-10-30T20:02:24.493500Z",
"url": "https://files.pythonhosted.org/packages/f1/fc/fa2b57327676c74454bcbba4be109ee9db4af2dbb53cc5c002d93527ff6d/adafruit_circuitpython_vcnl4200-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 20:02:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VCNL4200",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "adafruit-circuitpython-vcnl4200"
}
JSON
