dglaude / adafruit_circuitpython_apds9960 Goto Github PK

The APDS9960 is a specialize chip that detects hand gestures, proximity detection and ambient light color over I2C. Its available on Adafruit as a breakout.

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Connect Vin to 3.3 V or 5 V power source, GND to ground, SCL and SDA to the appropriate pins.

Of course, you must import i2c bus device, board pins, and the library:

from board import SCL, SDA, A1
import adafruit_apds9960 as apds9960
import busio

To set-up the device to gather data, initialize the I2CDevice using SCL and SDA pins. Then initialize the libary. Optionally provide an interrupt pin for proximity detection.

int_pin = digitalio.DigitalInOutput(A1)
i2c = busio.I2C(SCL, SDA)
apds = apds9960.APDS9960(i2c, interrupt_pin=int_pin)

To get a gesture, see if a gesture is available first, then get the gesture Code

gesture = apds.gesture()
if gesture == apds.UP:
  print("up")
if gesture == apds.DOWN:
  print("down")
if gesture == apds.RIGHT:
  print("right")
if gesture == apds.LEFT:
  print("left")

To get a color measure, enable color measures, wait for color data, then get the color data.

apds.enable_color = True

while not apds.color_data_ready:
    time.sleep(0.005)

r, g, b, c = apds.color_data
print("r: {}, g: {}, b: {}, c: {}".format(r, g, b, c))

To check for a object in proximity, see if a gesture is available first, then get the gesture Code

apds.enable_proximity = True

# set the interrupt threshold to fire when proximity reading goes above 175
apds.proximity_interrupt_threshold = (0, 175)

# enable the proximity interrupt
apds.enable_proximity_interrupt = True

while not interrupt_pin.value:
  print(apds.proximity())

  # clear the interrupt
  apds.clear_interrupt()

.. toctree::
   :maxdepth: 2

   api

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

To build this library locally you'll need to install the circuitpython-travis-build-tools package.

Once installed, make sure you are in the virtual environment:

Then run the build: