adafruit-circuitpython-tcs3430

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


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tcs3430/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/tcs3430/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_TCS3430/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_TCS3430/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 library for AMS TCS3430 / TCS34303 XYZ tri-stimulus color 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/6479>`_

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-tcs3430

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-tcs3430

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

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_tcs3430

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_tcs3430 import TCS3430, ALSGain, InterruptPersistence

    i2c = board.I2C()
    tcs = TCS3430(i2c)

    print("TCS3430 Basic Test")
    print("TCS3430 found!")

    # --- Tweak these settings for your environment ---
    tcs.als_gain = ALSGain.GAIN_64X  # 1X, 4X, 16X, 64X, or 128X
    tcs.integration_time = 100.0  # 2.78ms to 711ms

    # Enable ALS interrupt so we can poll AINT for data ready
    tcs.als_interrupt_enabled = True
    tcs.interrupt_persistence = InterruptPersistence.EVERY
    tcs.clear_als_interrupt()

    while True:
        # Wait for new data
        if tcs.als_interrupt:
            x, y, z, ir1 = tcs.channels
            print(f"X: {x}  Y: {y}  Z: {z}  IR1: {ir1}")
            tcs.clear_als_interrupt()

        time.sleep(1.0)


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