CircuitPython driver for APSD9960 Gesture breakout board
Project description
Introduction
The APDS9960 is a specialized chip that detects hand gestures, proximity and ambient light color over I2C. Its available on Adafruit as a breakout.
Installation and Dependencies
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
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-apds9960To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-apds9960To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-apds9960Usage Example
import board
import digitalio
from adafruit_apds9960.apds9960 import APDS9960
i2c = board.I2C()
int_pin = digitalio.DigitalInOut(board.D5)
apds = APDS9960(i2c, interrupt_pin=int_pin)
apds.enable_proximity = True
apds.proximity_interrupt_threshold = (0, 175)
apds.enable_proximity_interrupt = True
while True:
print(apds.proximity)
apds.clear_interrupt()Hardware Set-up
Connect Vin to 3.3 V or 5 V power source, GND to ground, SCL and SDA to the appropriate pins.
Basics
Of course, you must import i2c bus device, board pins, and the library:
import board
from adafruit_apds9960.apds9960 import APDS9960
import digitalioTo set-up the device to gather data, initialize the I2CDevice using SCL and SDA pins. Then initialize the library. Optionally provide an interrupt pin for proximity detection.
int_pin = digitalio.DigitalInOut(board.A1)
i2c = board.I2C()
apds = APDS9960(i2c, interrupt_pin=int_pin)Gestures
To get a gesture, see if a gesture is available first, then get the gesture Code
gesture = apds.gesture()
if gesture == 1:
print("up")
if gesture == 2:
print("down")
if gesture == 3:
print("left")
if gesture == 4:
print("right")Color Measurement
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))Proximity Detection
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 True:
if not interrupt_pin.value:
print(apds.proximity)
# clear the interrupt
apds.clear_interrupt()Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Building locally
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:
Sphinx documentation
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-apds9960-2.2.7.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-apds9960-2.2.7.tar.gz
- Upload date:
- Size: 33.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d04ed0b336453d35b687e1c6dfd950615c60ef69e6b55b02efc13ad73e3c2f6c |
|
| MD5 | 0c3fe813b111bf4a94b90344216b7545 |
|
| BLAKE2b-256 | a53f4fd4b0421afaadde3e99a8afdae1dc95841c6afe4fc58dbb716a47c9e872 |
