Add APDS9999 I2C driver for proximity, lux light, and color sensor

Co-authored-by: tyeth <6692083+tyeth@users.noreply.github.com>
Agent-Logs-Url: https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/sessions/80f4d06b-e0b8-4f72-ab45-5384676defbf

Author: Copilot

library.properties

@@ -7,4 +7,4 @@ paragraph=Arduino application for Adafruit.io WipperSnapper
 category=Communication
 url=https://github.com/adafruit/Adafruit_Wippersnapper_Arduino
 architectures=*
-depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPA06_003, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA260 Library, Adafruit INA237 and INA238 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit MLX90632 Library, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit AS5600 Library, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit BMP5xx Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Adafruit SGP41, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit VL53L1X, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit QMC5883P Library, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306, Adafruit EPD, Adafruit ST7735 and ST7789 Library
+depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPA06_003, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA260 Library, Adafruit INA237 and INA238 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit MLX90632 Library, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit APDS9999, Adafruit AS5600 Library, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit BMP5xx Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Adafruit SGP41, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit VL53L1X, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit QMC5883P Library, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306, Adafruit EPD, Adafruit ST7735 and ST7789 Library

platformio.ini

@@ -23,6 +23,7 @@ lib_deps =
     adafruit/ENS160 - Adafruit Fork
     adafruit/Adafruit SleepyDog Library
     adafruit/Adafruit AHTX0
+    adafruit/Adafruit APDS9999
     adafruit/Adafruit AS5600 Library
     adafruit/Adafruit BME280 Library
     adafruit/Adafruit BMP280 Library

src/components/i2c/WipperSnapper_I2C.cpp

@@ -239,6 +239,18 @@ bool WipperSnapper_Component_I2C::initI2CDevice(
     }
     _ahtx0->configureDriver(msgDeviceInitReq);
     drivers.push_back(_ahtx0);
+  } else if (strcmp("apds9999", msgDeviceInitReq->i2c_device_name) == 0) {
+    _apds9999 =
+        new WipperSnapper_I2C_Driver_APDS9999(this->_i2c, i2cAddress);
+    if (!_apds9999->begin()) {
+      WS_DEBUG_PRINTLN("ERROR: Failed to initialize APDS9999!");
+      _busStatusResponse =
+          wippersnapper_i2c_v1_BusResponse_BUS_RESPONSE_DEVICE_INIT_FAIL;
+      return false;
+    }
+    _apds9999->configureDriver(msgDeviceInitReq);
+    drivers.push_back(_apds9999);
+    WS_DEBUG_PRINTLN("APDS9999 Initialized Successfully!");
   } else if (strcmp("as5600", msgDeviceInitReq->i2c_device_name) == 0) {
     _as5600 = new WipperSnapper_I2C_Driver_AS5600(this->_i2c, i2cAddress);
     if (!_as5600->begin()) {

src/components/i2c/WipperSnapper_I2C.h

@@ -22,6 +22,7 @@
 #include "drivers/WipperSnapper_I2C_Driver.h"
 #include "drivers/WipperSnapper_I2C_Driver_ADT7410.h"
 #include "drivers/WipperSnapper_I2C_Driver_AHTX0.h"
+#include "drivers/WipperSnapper_I2C_Driver_APDS9999.h"
 #include "drivers/WipperSnapper_I2C_Driver_AS5600.h"
 #include "drivers/WipperSnapper_I2C_Driver_BH1750.h"
 #include "drivers/WipperSnapper_I2C_Driver_BME280.h"
@@ -164,6 +165,7 @@ class WipperSnapper_Component_I2C {
       _drivers_out; ///< List of i2c output drivers
   // Sensor driver objects
   WipperSnapper_I2C_Driver_AHTX0 *_ahtx0 = nullptr;
+  WipperSnapper_I2C_Driver_APDS9999 *_apds9999 = nullptr;
   WipperSnapper_I2C_Driver_AS5600 *_as5600 = nullptr;
   WipperSnapper_I2C_Driver_D6T1A *_d6t1a = nullptr;
   WipperSnapper_I2C_Driver_DPS310 *_dps310 = nullptr;

src/components/i2c/drivers/WipperSnapper_I2C_Driver_APDS9999.h

@@ -0,0 +1,147 @@
+/*!
+ * @file WipperSnapper_I2C_Driver_APDS9999.h
+ *
+ * Device driver for the APDS9999 proximity, lux light, and color sensor.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Adafruit Industries 2025.
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef WipperSnapper_I2C_Driver_APDS9999_H
+#define WipperSnapper_I2C_Driver_APDS9999_H
+
+#include "WipperSnapper_I2C_Driver.h"
+#include <Adafruit_APDS9999.h>
+
+/**************************************************************************/
+/*!
+    @brief  Class that provides a driver interface for an APDS9999 sensor.
+*/
+/**************************************************************************/
+class WipperSnapper_I2C_Driver_APDS9999 : public WipperSnapper_I2C_Driver {
+public:
+  /*******************************************************************************/
+  /*!
+      @brief    Constructor for an APDS9999 sensor.
+      @param    i2c
+                The I2C interface.
+      @param    sensorAddress
+                The 7-bit I2C address of the sensor.
+  */
+  /*******************************************************************************/
+  WipperSnapper_I2C_Driver_APDS9999(TwoWire *i2c, uint16_t sensorAddress)
+      : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
+    _i2c = i2c;
+    _sensorAddress = sensorAddress;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Destructor for an APDS9999 sensor.
+  */
+  /*******************************************************************************/
+  ~WipperSnapper_I2C_Driver_APDS9999() { delete _apds9999; }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Initializes the APDS9999 sensor and begins I2C.
+      @returns  True if initialized successfully, False otherwise.
+  */
+  /*******************************************************************************/
+  bool begin() {
+    _apds9999 = new Adafruit_APDS9999();
+    if (!_apds9999->begin((uint8_t)_sensorAddress, _i2c))
+      return false;
+
+    // Enable light sensor and proximity sensor
+    _apds9999->enableLightSensor(true);
+    _apds9999->enableProximitySensor(true);
+
+    // Enable RGB mode for color data
+    _apds9999->setRGBMode(true);
+
+    // Explicitly set light sensor defaults
+    _apds9999->setLightGain(APDS9999_LIGHT_GAIN_3X);
+    _apds9999->setLightResolution(APDS9999_LIGHT_RES_18BIT);
+    _apds9999->setLightMeasRate(APDS9999_LIGHT_RATE_100MS);
+
+    // Explicitly set proximity sensor defaults
+    _apds9999->setProxResolution(APDS9999_PROX_RES_11BIT);
+    _apds9999->setProxMeasRate(APDS9999_PROX_RATE_100MS);
+
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Reads the APDS9999 sensor data.
+      @returns  True if the sensor was read successfully, False otherwise.
+  */
+  /*******************************************************************************/
+  bool ReadSensorData() {
+    // Don't read sensor more than once per second
+    if (_lastRead != 0 && (millis() - _lastRead < 1000))
+      return true;
+
+    uint32_t r, g, b, ir;
+    if (!_apds9999->getRGBIRData(&r, &g, &b, &ir))
+      return false;
+
+    _cachedLight.light = _apds9999->calculateLux(g);
+
+    uint16_t prox;
+    if (!_apds9999->readProximity(&prox))
+      return false;
+
+    _cachedProximity.data[0] = (float)prox;
+    _lastRead = millis();
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the APDS9999's current light reading in lux.
+      @param    lightEvent
+                Pointer to an Adafruit_Sensor event.
+      @returns  True if the light reading was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventLight(sensors_event_t *lightEvent) {
+    if (!ReadSensorData())
+      return false;
+
+    *lightEvent = _cachedLight;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the APDS9999's current proximity reading.
+      @param    proximityEvent
+                Pointer to an Adafruit_Sensor event.
+      @returns  True if the proximity was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventProximity(sensors_event_t *proximityEvent) {
+    if (!ReadSensorData())
+      return false;
+
+    *proximityEvent = _cachedProximity;
+    return true;
+  }
+
+protected:
+  Adafruit_APDS9999 *_apds9999 = nullptr; ///< APDS9999 driver object
+  unsigned long _lastRead = 0;            ///< Last sensor read time
+  sensors_event_t _cachedLight = {0};     ///< Cached light reading
+  sensors_event_t _cachedProximity = {0}; ///< Cached proximity reading
+};
+
+#endif // WipperSnapper_I2C_Driver_APDS9999_H