Metadata-Version: 2.1
Name: adafruit-circuitpython-vcnl4040
Version: 1.2.0
Summary: A CircuitPython library for the VCNL4040 proximity and ambient light sensor.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-vcnl4040/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/vcnl4040/en/latest/
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :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
        
        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 .env
            source .env/bin/activate
            pip3 install adafruit-circuitpython-vcnl4040
        
        Usage Example
        =============
        
        .. code-block:: python
        
            import time
            import board
            import busio
            import adafruit_vcnl4040
        
            i2c = busio.I2C(board.SCL, board.SDA)
            sensor = adafruit_vcnl4040.VCNL4040(i2c)
        
            while True:
                print("Proximity:", sensor.proximity)
                print("Light:", sensor.light)
                print("White:", sensor.white)
                time.sleep(0.3)
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_VCNL4040/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        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>`_.
        
Keywords: adafruit blinka circuitpython micropython vcnl4040 ambient light proximity ir sensor hardware
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
