# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Overview
If you want a sensor that's a 3-in-1, the **Adafruit APDS-9999 Proximity, Lux Light, and Color Sensor** has RGB color, lux light level as well as infrared proximity all built into one device. When connected to your microcontroller (running our library code), it can detect the amount of red, blue, green, and clear light, as well as how close an object is to the front of the sensor. This device uses an I2C interface, so it's easy to wire up and use.
**Note** that this chip is considered by Broadcom to be the 'successor' [to the APDS-9960](https://www.adafruit.com/product/3595) which has technically been discontinued, but it does _not_ have gesture sensing! It does have true Lux sensing though, not just light counts.
The proximity sensing bounces IR light, it isn't a time-of-flight sensor, so it doesn't give you exact distances, just how much light has reflected. It's best for short distances, 2 inches / 50mm or less, but can detect objects up to 150mm away. The APDS9999 also has a configurable interrupt pin that can trigger when a specified proximity threshold is crossed or when a color sensor threshold is exceeded.
For your convenience, we've pick-and-placed the sensor on a PCB with a 3.3V regulator and some level shifting so it can be easily used with your favorite 3.3V _or_ 5V microcontroller. We've included [SparkFun qwiic](https://www.sparkfun.com/qwiic) compatible** [STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt)** connectors for the I2C bus, so **you don't even need to solder!** [Just wire up to your favorite microcontroller or computer with a plug-and-play QT cable](https://www.adafruit.com/category/619) to light/color/proximity data ASAP. [**QT Cable is not included** , but we have a variety in the shop](https://www.adafruit.com/?q=stemma+qt+cable&sort=BestMatch).
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Pinouts
The fixed I2C address is **0x52**.
## Power Pins
- **Vin** - this is the power pin. Since the sensor chip uses 3VDC, we have included a voltage regulator on board that will take 3-5VDC and safely convert it to 3VDC. To power the board, give it the same power as the logic level of your microcontroller - e.g. for a 5V micro like Arduino, use 5V.
- **3Vo** - this is the 3.3V output from the voltage regulator, you can grab up to 100mA from this if you like
- **GND** - common ground for power and logic
## I2C Data Pins
- **SCL ** - the I2C clock pin, connect to your microcontroller's I2C clock line.
- **SDA** - the I2C data pin, connect to your microcontroller's I2C data line.
- **[STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt) -** These connectors allow you to connectors to dev boards with **STEMMA QT** connectors or to other things with [various associated accessories](https://www.adafruit.com/?q=JST%20SH%204)
## Interrupt Pin
**INT** - the interrupt pin. It is an open-drain interrupt. To use, connect the pin to a GPIO pin on your microcontroller.
## LED Jumper
Above the left STEMMA QT connector there is a small green **ON** power indicator LED. When the breakout is powered this LED will turn on.
On the back of the APDS9999 breakout there is a jumper with a small trace between two pads that can be cut to disable the **ON** power indicator LED on the board.
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## CircuitPython & Python
It's easy to use the **APDS9999** with Python or CircuitPython, and the [Adafruit\_CircuitPython\_APDS9999](https://github.com/adafruit/Adafruit_CircuitPython_APDS9999) module. This module allows you to easily write Python code to read data from the sensor.
You can use this driver with any CircuitPython microcontroller board or with a computer that has GPIO and Python [thanks to Adafruit\_Blinka, our CircuitPython-for-Python compatibility library](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
## CircuitPython Microcontroller Wiring
First wire up a APDS9999 to your board exactly as shown below. Here's an example of wiring a Feather RP2040 to the sensor with I2C using one of the handy [**STEMMA QT**](https://learn.adafruit.com/introducing-adafruit-stemma-qt) connectors:
- **Board STEMMA 3V** to **sensor** **VIN (red wire)**
- **Board STEMMA GND** to **sensor** **GND (black wire)**
- **Board STEMMA SCL** to **sensor** **SCL (yellow wire)**
- **Board STEMMA SDA** to **sensor** **SDA (blue wire)**
The following is the APDS9999 wired to a Feather RP2040 using a solderless breadboard:
- **Board 3V** to **sensor** **VIN (red wire)**
- **Board GND** to **sensor** **GND (black wire)**
- **Board SCL** to **sensor** **SCL (yellow wire)**
- **Board SDA** to **sensor** **SDA (blue wire)**
## Python Computer Wiring
Since there are _dozens_ of Linux computers/boards you can use, we will show wiring for Raspberry Pi. For other platforms, [please visit the guide for CircuitPython on Linux to see whether your platform is supported](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
Here's the Raspberry Pi wired with I2C using the STEMMA connector:
- **Pi 3V** to **sensor VIN (red wire)**
- **Pi GND** to **sensor** **GND (black wire)**
- **Pi SCL** to **sensor** **SCL (yellow wire)**
- **Pi SDA** to **sensor** **SDA (blue wire)**
Here's the Raspberry Pi wired with I2C using a solderless breadboard:
- **Pi 3V** to **sensor VIN (red wire)**
- **Pi GND** to **sensor** **GND (black wire)**
- **Pi SCL** to **sensor** **SCL (yellow wire)**
- **Pi SDA** to **sensor** **SDA (blue wire)**
## Python Installation of APDS9999 Library
You'll need to install the **Adafruit\_Blinka** library that provides the CircuitPython support in Python. This may also require enabling I2C on your platform and verifying you are running Python 3. [Since each platform is a little different, and Linux changes often, please visit the CircuitPython on Linux guide to get your computer ready](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux)!
Once that's done, from your command line run the following command:
- `pip3 install adafruit-circuitpython-apds9999`
If your default Python is version 3 you may need to run 'pip' instead. Just make sure you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
## CircuitPython Usage
To use with CircuitPython, you need to first install the **Adafruit\_CircuitPython\_APDS9999** library, and its dependencies, into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY/lib** folder should contain the following folders and files:
- **adafruit\_bus\_device/**
- **adafruit\_register/**
- **adafruit\_apds9999.mpy**
- **adafruit\_simplemath.mpy**
## Python Usage
Once you have the library `pip3` installed on your computer, copy or download the following example to your computer, and run the following, replacing **code.py** with whatever you named the file:
`python3 code.py`
## Example Code
**If running CircuitPython:** Once everything is saved to the **CIRCUITPY** drive, [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the data printed out!
**If running Python:** The console output will appear wherever you are running Python.
https://github.com/adafruit/Adafruit_CircuitPython_APDS9999/blob/main/examples/apds9999_simpletest.py
First, the sensor gets initialized over I2C, then configured to enable both light and proximity sensing. In the main loop the RGB/IR and proximity data are read from the sensor and printed to the serial console once per second.
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Python Docs
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Arduino
Using the APDS9999 breakout with Arduino involves wiring up the breakout to your Arduino-compatible microcontroller, installing the [Adafruit\_APDS9999](https://github.com/adafruit/Adafruit_APDS9999) library, and running the provided example code.
## Wiring
Wire as shown for a **5V** board like an Uno. If you are using a **3V** board, like an Adafruit Feather, wire the board's 3V pin to the sensor **VIN**.
Here is an Adafruit Metro wired up to the sensor using the STEMMA QT connector:
- **Board 5V** to **breakout** **VIN (red wire)**
- **Board GND** to **breakout** **GND (black wire)**
- **Board SCL** to **breakout** **SCL (yellow wire)**
- **Board SDA** to **breakout** **SDA (blue wire)**
Here is an Adafruit Metro wired up using a solderless breadboard:
- **Board 5V** to **breakout** **VIN (red wire)**
- **Board GND** to **breakout** **GND (black wire)**
- **Board SCL** to **breakout** **SCL (yellow wire)**
- **Board SDA** to **breakout** **SDA (blue wire)**
## Library Installation
You can install the **Adafruit\_APDS9999** library for Arduino using the Library Manager in the Arduino IDE.
Click the **Manage Libraries ...** menu item, search for **Adafruit\_APDS9999** , and select the **Adafruit\_APDS9999** library:
If asked about dependencies, click "Install all".
If the "Dependencies" window does not come up, then you already have the dependencies installed.
Warning: If the dependencies are already installed, you must make sure you update them through the Arduino Library Manager before loading the example!
## Example Code
https://github.com/adafruit/Adafruit_APDS9999/blob/main/examples/color_sensor/color_sensor.ino
Upload the sketch to your board and open up the Serial Monitor ( **Tools -\> Serial Monitor** ) at 115200 baud. You'll see the APDS9999 recognized over I2C. Then, the RGB, IR, and calculated lux values will be printed out to the Serial Monitor.
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Arduino Docs
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## WipperSnapper
Info: WipperSnapper version 1 doesn't allow the reporting of RGB (Red/Green/Blue) colour information. This means **no RGB data will be recorded from this sensor in v1**, but it will still report light levels and proximity data.
Version 2 is in progress and we hope to have R/G/B data supported later this year.
## What is WipperSnapper
WipperSnapper is a firmware designed to turn any WiFi-capable board into an Internet-of-Things device without programming a single line of code. WipperSnapper connects to [Adafruit IO](https://io.adafruit.com/), a web platform designed ([by Adafruit!](https://www.adafruit.com/about)) to _display_, _respond_, and _interact_ with your project's data.
Simply load the WipperSnapper firmware onto your board, add credentials, and plug it into power. Your board will automatically register itself with your Adafruit IO account.
From there, you can add _components_ to your board such as buttons, switches, potentiometers, sensors, and more! Components are _dynamically _added to hardware, so you can immediately start interacting, logging, and streaming the data your projects produce without writing code.
If you've never used WipperSnapper, click below to read through the quick start guide before continuing.
[Quickstart: Adafruit IO WipperSnapper](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper)
## Wiring
Wire up the APDS-9999 exactly as follows. Here it's shown connected via our convenient StemmaQT cable, or alternatively wired up on a prototyping breadboard:
- **Board 3V** to **sensor **** VIN (red wire)**
- **Board GND** to **sensor** **GND (black wire)**
- **Board SCL** to **sensor** **SCL (yellow wire)**
- **Board SDA** to **sensor** **SDA (blue wire)**
## Usage
Connect your board to Adafruit IO Wippersnapper and **[navigate to the WipperSnapper board list](https://io.adafruit.com/wippersnapper).**
On this page, **select the WipperSnapper board you're using** to be brought to the board's interface page.
If you do not see your board listed here - you need [to connect your board to Adafruit IO](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) first.
On the device page, quickly **check that you're running the latest version of the WipperSnapper firmware**.
The device tile on the left indicates the version number of the firmware running on the connected board.
- **If the firmware version is green with a checkmark -** continue with this guide.
- **If the firmware version is red with an exclamation mark "!" -** [update to the latest WipperSnapper firmware](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) on your board before continuing.
Next, make sure the sensor is plugged into your board and click the ** I2C Scan ** button.
You should see the APDS-9999's default I2C address of `0x52` pop-up in the I2C scan list.
### I don't see the sensor's I2C address listed!
First, double-check the connection and/or wiring between the sensor and the board.
Then, reset the board and let it re-connect to Adafruit IO WipperSnapper.
With the sensor detected in an I2C scan, you're ready to add the sensor to your board.
**Click the New Component button or the + button** to bring up the component picker.
Adafruit IO supports a large amount of components. To quickly find your sensor, type `APDS-9999` into the search bar, then select the **APDS-9999** component.
On the component configuration page, the APDS-9999's sensor address should be listed along with the sensor's settings.
The **Send Every** option is specific to each sensor's measurements. This option will tell the Feather how often it should read from the APDS-9999 sensor and send the data to Adafruit IO. Measurements can range from every second to every 24 hours.
For this example, set the **Send Every ** interval to every 30 seconds.
Your device interface should now show the sensor components you created. After the interval you configured elapses, WipperSnapper will automatically read values from the sensor(s) and send them to Adafruit IO.
To view the data that has been logged from the sensor, click on the graph next to the sensor name.
Here you can see the feed history and edit things about the feed such as the name, privacy, webhooks associated with the feed and more. If you want to learn more about how feeds work, [check out this page](https://learn.adafruit.com/all-the-internet-of-things-episode-four-adafruit-io/advanced-feeds).
# Adafruit APDS9999 Proximity, Lux Light & Color Sensor
## Downloads
## Files
- [APDS9999 Datasheet](https://cdn-learn.adafruit.com/assets/assets/000/142/830/original/APDS-9999-DS102.pdf?1772721160)
- [EagleCAD PCB files on GitHub](https://github.com/adafruit/Adafruit-APDS9999-Proximity-Light-and-Color-Sensor-PCB)
- [Fritzing object in the Adafruit Fritzing Library](https://github.com/adafruit/Fritzing-Library/blob/master/parts/Adafruit%20APDS9999%20Proximity%20Light%20Color%20Sensor.fzpz)
## Schematic and Fab Print
## Primary Products
### Adafruit APDS9999 Proximity, Lux Light & Color Sensor
[Adafruit APDS9999 Proximity, Lux Light & Color Sensor](https://www.adafruit.com/product/6461)
If you want a sensor that's a 3-in-1, the **Adafruit APDS9999 Proximity, Lux Light, and Color Sensor** has RGB color, lux light level as well as infrared proximity all built into one device. When connected to your microcontroller (running our library code), it...
Out of Stock
[Buy Now](https://www.adafruit.com/product/6461)
[Related Guides to the Product](https://learn.adafruit.com/products/6461/guides)
## Featured Products
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
Out of Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long
[STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long](https://www.adafruit.com/product/4210)
This 4-wire cable is a little over 100mm / 4" long and fitted with JST-SH female 4-pin connectors on both ends. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
Out of Stock
[Buy Now](https://www.adafruit.com/product/4210)
[Related Guides to the Product](https://learn.adafruit.com/products/4210/guides)
### STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable
[STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable](https://www.adafruit.com/product/4209)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium Dupont male headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4209)
[Related Guides to the Product](https://learn.adafruit.com/products/4209/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets
[STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets](https://www.adafruit.com/product/4397)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium female headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4397)
[Related Guides to the Product](https://learn.adafruit.com/products/4397/guides)
## Related Guides
- [Raspberry Pi Care and Troubleshooting](https://learn.adafruit.com/raspberry-pi-care-and-troubleshooting.md)
- [CircuitPython Hardware: PCA9685 PWM & Servo Driver](https://learn.adafruit.com/micropython-hardware-pca9685-pwm-and-servo-driver.md)
- [Adafruit HDC302x Precision Temperature & Humidity Sensor](https://learn.adafruit.com/adafruit-hdc3021-precision-temperature-humidity-sensor.md)
- [Sending an SMS with Temboo](https://learn.adafruit.com/sending-an-sms-with-temboo.md)
- [Nunchuck Controlled Laser Cat Toy](https://learn.adafruit.com/nunchuck-controlled-laser-cat-toy.md)
- [Adafruit Qualia High Res Displayport Desktop Monitor](https://learn.adafruit.com/qualia-high-res-displayport-desktop-monitor.md)
- [Standalone AVR Chip Programmer](https://learn.adafruit.com/standalone-avr-chip-programmer.md)
- [Asteroid Tracker](https://learn.adafruit.com/asteroid-tracker.md)
- [Adafruit Trinket M0](https://learn.adafruit.com/adafruit-trinket-m0-circuitpython-arduino.md)
- [Adafruit VCNL4020 Proximity and Light Sensor](https://learn.adafruit.com/adafruit-vcnl4020-proximity-and-light-sensor.md)
- [The Foul Fowl -- Keystroke Injection Attack Tool with Gemma M0](https://learn.adafruit.com/the-foul-fowl-keyboard-injection-payload-gemma-m0.md)
- [CLUE Rock, Paper, Scissors Game using Bluetooth](https://learn.adafruit.com/rock-paper-scissors-circuitpython.md)
- [Adafruit KB2040](https://learn.adafruit.com/adafruit-kb2040.md)
- [Adafruit DS2482S-800 8 Channel I2C to 1-Wire Bus Adapter](https://learn.adafruit.com/adafruit-ds2482s-800-8-channel-i2c-to-1-wire-bus-adapter.md)
- [NeoPixel Novelty Cufflinks with Scrolling Text](https://learn.adafruit.com/neopixel-novelty-cufflinks-with-scrolling-text.md)