Simple test

Ensure your device works with this simple test.

examples/opt4048_simpletest.py

# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
A basic demo for using the OPT4048 tristimulus XYZ color sensor

This example reads the sensor values from all four channels (X, Y, Z, W),
demonstrates setting and getting threshold values, and displays the results.
"""

import time
from time import sleep

import board

from adafruit_opt4048 import OPT4048, ConversionTime, Mode, Range

i2c = board.I2C()  # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
sensor = OPT4048(i2c)

sensor.range = Range.AUTO
sensor.conversion_time = ConversionTime.TIME_100MS
sensor.mode = Mode.CONTINUOUS
while True:
    try:
        x, y, lux = sensor.cie
        print(f"CIE x:{x}, y:{y}, lux: {lux}", end=" ")
        print(f"K: {sensor.calculate_color_temperature(x, y)}")
        time.sleep(1)
    except RuntimeError:
        # CRC check failed while reading data
        pass

Webserial example

Output color data over serial for use with webserial page

examples/opt4048_webserial.py

# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
This example reads color data from the OPT4048 sensor and outputs it
in a format suitable for displaying on a web page using Web Serial API.

It continuously measures CIE x,y coordinates, lux, and color temperature.

This example works with the web interface in the /webserial directory of the
gh-pages branch of the Arduino driver repo: https://github.com/adafruit/Adafruit_OPT4048/tree/gh-pages,
which can be accessed at: https://adafruit.github.io/Adafruit_OPT4048/webserial/
"""

import time
from time import sleep

import board

from adafruit_opt4048 import OPT4048, ConversionTime, Mode, Range

READ_INTERVAL = 0.1  # seconds

i2c = board.I2C()  # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
sensor = OPT4048(i2c)

sensor.range = Range.AUTO
sensor.conversion_time = ConversionTime.TIME_100MS
sensor.mode = Mode.CONTINUOUS

last_read_time = 0
while True:
    if time.monotonic() > last_read_time + READ_INTERVAL:
        try:
            last_read_time = time.monotonic()
            x, y, lux = sensor.cie
            print("---CIE Data---")
            print(f"CIE x: {x}")
            print(f"CIE y: {y}")
            print(f"Lux: {lux}")
            print(f"Color Temperature: {sensor.calculate_color_temperature(x, y)} K")
            print("-------------")
        except RuntimeError:
            # CRC check failed while reading data
            pass

Interrupt Pin example

Wait for the interrupt pin to be triggered, then read data.

examples/opt4048_interruptpin.py

# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
A basic interrupt pin demo for using the OPT4048 tristimulus XYZ color sensor

This example waits for the interrupt pin to be triggered,
then reads and displays the sensor values.
"""

import time

import board
import countio
from digitalio import Pull

from adafruit_opt4048 import (
    OPT4048,
    ConversionTime,
    Mode,
    Range,
)

i2c = board.I2C()  # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
sensor = OPT4048(i2c)

sensor.range = Range.AUTO
sensor.conversion_time = ConversionTime.TIME_100MS
sensor.mode = Mode.CONTINUOUS

# counter that will track the pulses on the interrupt pin
pin_counter = countio.Counter(board.D5, edge=countio.Edge.RISE, pull=Pull.UP)

last_read_time = 0
while True:
    try:
        if pin_counter.count > 0:
            pin_counter.reset()
            x, y, lux = sensor.cie
            print(f"CIE x:{x}, y:{y}, lux: {lux}", end=" ")
            print(f"K: {sensor.calculate_color_temperature(x, y)}", end=" ")
            print(f"Read Delay: {time.monotonic() - last_read_time} sec")
            last_read_time = time.monotonic()

    except RuntimeError:
        # error reading data
        pass

Full test

Comprehensive test of features

examples/opt4048_fulltest.py

# SPDX-FileCopyrightText: Copyright (c) 2025 Tim C for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
A comprehensive demo for using the OPT4048 tristimulus XYZ color sensor,
showing all capabilities.

This example reads the sensor values from all four channels (X, Y, Z, W),
demonstrates setting and getting threshold values, and displays the results.
"""

import time

import board

from adafruit_opt4048 import (
    OPT4048,
    OPT4048_FLAG_CONVERSION_READY,
    OPT4048_FLAG_H,
    OPT4048_FLAG_L,
    OPT4048_FLAG_OVERLOAD,
    ConversionTime,
    FaultCount,
    IntConfig,
    Mode,
    Range,
)

READ_INTERVAL = 0.1  # seconds

print("Adafruit OPT4048 Tristimulus XYZ Color Sensor Test")

# Initialize the sensor
i2c = board.I2C()  # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
sensor = OPT4048(i2c)
print("OPT4048 sensor found!")

# Set low and high thresholds for interrupts
low_threshold_val = 1000
print(f"Setting low threshold to: {low_threshold_val}")
sensor.threshold_low = low_threshold_val

high_threshold_val = 10000
print(f"Setting high threshold to: {high_threshold_val}")
sensor.threshold_high = high_threshold_val

# Read back the thresholds to verify
print(f"Read back low threshold: {sensor.threshold_low}")
print(f"Read back high threshold: {sensor.threshold_high}")

# Enable Quick Wake feature
print("\nEnabling Quick Wake feature...")
sensor.qick_wake = True

# Read back Quick Wake status
print(f"Quick Wake status: {sensor.quick_wake}")

# Set range to auto
print("\nSetting range to Auto...")
sensor.range = Range.AUTO
time.sleep(0.1)
# Read back range setting
print(f"Current range setting value: {sensor.range} name: {Range.get_name(sensor.range)}")

# Set conversion time to 100ms
print("\nSetting conversion time to 100ms...")
sensor.conversion_time = ConversionTime.TIME_100MS

# Read back conversion time setting
print(
    f"Current conversion time setting value: {sensor.conversion_time} "
    + f"name: {ConversionTime.get_name(sensor.conversion_time)}"
)

# Set operating mode to continuous
print(f"\nSetting operating mode to Continuous...")
sensor.mode = Mode.CONTINUOUS
print(f"Current operating mode value: {sensor.mode} name: {Mode.get_name(sensor.mode)}")

# Configure interrupt settings
print("\nConfiguring interrupt settings...")
sensor.interrupt_latch = True
sensor.interrupt_polarity = True

# Read back interrupt settings
print(f"Interrupt latch mode: {'Latched' if sensor.interrupt_latch else 'Transparent'}")
print(f"Interrupt polarity: {'Active-high' if sensor.interrupt_polarity else 'Active-low'}")

# Configure fault count
print("\nSetting fault count to 4 consecutive faults...")
sensor.fault_count = FaultCount.COUNT_4
# Read back fault count setting
print(
    f"Fault count setting value: {sensor.fault_count} "
    + f"name: {FaultCount.get_name(sensor.fault_count)}"
)

# Configure threshold channel
print("\nSetting threshold channel to Channel 1 (Y)...")
sensor.threshold_channel = 1
channels = {
    0: "(X)",
    1: "(Y)",
    2: "(Z)",
    3: "(W)",
}
# Read back threshold channel setting
print(f"Threshold channel setting: Channel {channels[sensor.threshold_channel]}")

# Configure interrupt configuration
print("\nSetting interrupt configuration to data ready for all channels...")
sensor.interrupt_config = IntConfig.DATA_READY_ALL

# Read back interrupt configuration setting
print(
    f"Interrupt configuration value: {sensor.interrupt_config} "
    + f"name: {IntConfig.get_name(sensor.interrupt_config)}"
)

while True:
    try:
        # Read all four channels from the sensor (raw ADC values)
        x, y, z, w = sensor.all_channels

        print("Channel readings (raw values):")
        print(f"X (CH0): {x}")
        print(f"Y (CH1): {y}")
        print(f"Z (CH2): {z}")
        print(f"W (CH3): {w}")

        # Calculate and display CIE chromaticity coordinates and lux
        CIEx, CIEy, lux = sensor.cie
        print("\nCIE Coordinates:")
        print(f"CIE x: {CIEx}")
        print(f"CIE y: {CIEy}")
        print(f"Lux: {lux}")

        # Calculate and display color temperature
        color_temp = sensor.calculate_color_temperature(CIEx, CIEy)
        print(f"Color Temperature: {color_temp} K")

        # Read and print status flags
        flags = sensor.flags
        print("\nStatus Flags:")
        if flags & OPT4048_FLAG_L:
            print("- Measurement below low threshold")
        if flags & OPT4048_FLAG_H:
            print("- Measurement above high threshold")
        if flags & OPT4048_FLAG_CONVERSION_READY:
            print("- Conversion complete")
        if flags & OPT4048_FLAG_OVERLOAD:
            print("- Overflow condition detected")
        if flags == 0:
            print("- No flags set")

    except RuntimeError:
        print("Error reading sensor data")

    time.sleep(1)  # read once per second