{ "info": { "author": "Adafruit Industries", "author_email": "circuitpython@adafruit.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries", "Topic :: System :: Hardware" ], "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4040/badge/?version=latest\n :target: https://circuitpython.readthedocs.io/projects/vcnl4040/en/latest/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://discord.gg/nBQh6qu\n :alt: Discord\n\n.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_VCNL4040.svg?branch=master\n :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_VCNL4040\n :alt: Build Status\n\nA CircuitPython library for the VCNL4040 proximity and ambient light sensor.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython `_\n* `Bus Device `_\n* `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 `_.\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI `_. 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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-vcnl4040\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n import busio\n import adafruit_vcnl4040\n\n i2c = busio.I2C(board.SCL, board.SDA)\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\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nZip release files\n-----------------\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools `_ package.\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .env/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vcnl4040 --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040", "keywords": "adafruit blinka circuitpython micropython vcnl4040 ambient light proximity ir sensor hardware", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "adafruit-circuitpython-vcnl4040", "package_url": "https://pypi.org/project/adafruit-circuitpython-vcnl4040/", "platform": "", "project_url": "https://pypi.org/project/adafruit-circuitpython-vcnl4040/", "project_urls": { "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040" }, "release_url": "https://pypi.org/project/adafruit-circuitpython-vcnl4040/1.1.0/", "requires_dist": null, "requires_python": "", "summary": "A CircuitPython library for the VCNL4040 proximity and ambient light sensor.", "version": "1.1.0" }, "last_serial": 5669412, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "6173b671d9ec64ba0721e23808bbe52c", "sha256": "0c219928b4d657c8d074413b15f371aab708578df8a44e0b03461b40e87d7b4c" }, "downloads": -1, "filename": "adafruit-circuitpython-vcnl4040-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6173b671d9ec64ba0721e23808bbe52c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22240, "upload_time": "2019-06-25T22:49:53", "url": "https://files.pythonhosted.org/packages/6e/20/5827ccaa6c60433416742d04c4761f5ae4dac7dfcbb7fbe81b4ba2de7c8f/adafruit-circuitpython-vcnl4040-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "0258b91e195a8b645f891f1e40d00b58", "sha256": "15d7fd7bb5d520769a3f67dc8a87ec31ba48ac47be926ebc494d318572f7ba24" }, "downloads": -1, "filename": "adafruit-circuitpython-vcnl4040-1.1.0.tar.gz", "has_sig": false, "md5_digest": "0258b91e195a8b645f891f1e40d00b58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22548, "upload_time": "2019-08-13T00:49:46", "url": "https://files.pythonhosted.org/packages/3d/4c/6aed3c58e39525eeed19bf12daa82ac414b769fbd0765c383219932d11c3/adafruit-circuitpython-vcnl4040-1.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0258b91e195a8b645f891f1e40d00b58", "sha256": "15d7fd7bb5d520769a3f67dc8a87ec31ba48ac47be926ebc494d318572f7ba24" }, "downloads": -1, "filename": "adafruit-circuitpython-vcnl4040-1.1.0.tar.gz", "has_sig": false, "md5_digest": "0258b91e195a8b645f891f1e40d00b58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22548, "upload_time": "2019-08-13T00:49:46", "url": "https://files.pythonhosted.org/packages/3d/4c/6aed3c58e39525eeed19bf12daa82ac414b769fbd0765c383219932d11c3/adafruit-circuitpython-vcnl4040-1.1.0.tar.gz" } ] }