Introduction

CircuitPython driver for Broadcom APDS-9999 Light + RGB + Proximity

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.

Adafruit APDS9999 breakout

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

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

sudo pip3 install adafruit-circuitpython-apds9999

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

pip3 install circup

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

circup install adafruit_apds9999

Or the following command to update an existing version:

circup update

Usage Example

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.

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.