Metadata-Version: 2.4
Name: adafruit-circuitpython-apds9999
Version: 1.0.0
Summary: CircuitPython driver for Broadcom APDS-9999 Light + RGB + Proximity
Author-email: Adafruit Industries <circuitpython@adafruit.com>
License: MIT
Project-URL: Homepage, https://github.com/adafruit/Adafruit_CircuitPython_APDS9999
Keywords: adafruit,blinka,circuitpython,micropython,apds9999,rgb,ir,light,sensor,proximity
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Adafruit-Blinka
Requires-Dist: adafruit-circuitpython-busdevice
Requires-Dist: adafruit-circuitpython-register
Requires-Dist: adafruit-circuitpython-simplemath
Provides-Extra: optional
Dynamic: license-file

Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-apds9999/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/apds9999/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_APDS9999/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_APDS9999/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 Broadcom APDS-9999 Light + RGB + Proximity


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>`_.



Adafruit APDS9999 breakout

`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6461>`_

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-apds9999/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-apds9999

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-apds9999

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-apds9999

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_apds9999

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import time

    import board

    from adafruit_apds9999 import APDS9999

    apds_sensor = APDS9999(board.I2C())

    apds_sensor.light_sensor_enabled = True
    apds_sensor.proximity_sensor_enabled = True
    apds_sensor.rgb_mode = True

    while True:
        time.sleep(1)
        print(apds_sensor.main_status)
        r, g, b, ir = apds_sensor.rgb_ir

        print(
            f"r: {r}, g: {g}, b: {b}, ir: {ir} "
            f"lux: {apds_sensor.calculate_lux(g)} proximity: {apds_sensor.proximity}"
        )


Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/apds9999/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_APDS9999/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
