Introduction

CircuitPython driver for the Adafruit TCS3448 14-Channel Light / Color Sensor Breakout - STEMMA QT / Qwiic

Dependencies

This driver depends on:

• Adafruit CircuitPython

• Bus Device

• Register

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Purchase one from the Adafruit shop

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-tcs3448

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

sudo pip3 install adafruit-circuitpython-tcs3448

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-tcs3448

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_tcs3448

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
from adafruit_tcs3448 import TCS3448

i2c = board.I2C()
sensor = TCS3448(i2c)

CHANNEL_LABELS = [
    "FZ (450nm blue)",
    "FY (560nm yellow-green)",
    "FXL (596nm orange)",
    "NIR (855nm near-IR)",
    "VIS_TL_0 (clear top-left, cycle 1)",
    "VIS_BR_0 (clear btm-right, cycle 1)",
    "F2 (424nm violet-blue)",
    "F3 (473nm blue-cyan)",
    "F4 (516nm green)",
    "F6 (636nm red)",
    "VIS_TL_1 (clear top-left, cycle 2)",
    "VIS_BR_1 (clear btm-right, cycle 2)",
    "F1 (407nm violet)",
    "F7 (687nm deep red)",
    "F8 (748nm near-IR edge)",
    "F5 (546nm green-yellow)",
    "VIS_TL_2 (clear top-left, cycle 3)",
    "VIS_BR_2 (clear btm-right, cycle 3)",
]

while True:
    readings = sensor.all_channels
    print("--- TCS3448 Channel Readings ---")
    for label, value in zip(CHANNEL_LABELS, readings):
        print(f"  {label}: {value}")
    print()
    time.sleep(1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.