Skip to main content

A CircuitPython library for the VCNL4040 proximity and ambient light sensor.

Project description

Introduction

Documentation Status Discord Build Status

A CircuitPython library for the VCNL4040 proximity and ambient light sensor.

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

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

sudo pip3 install adafruit-circuitpython-vcnl4040

To 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-vcnl4040

Usage Example

import time
import board
import busio
import adafruit_vcnl4040

i2c = busio.I2C(board.SCL, board.SDA)
sensor = adafruit_vcnl4040.VCNL4040(i2c)

while True:
    print("Proximity:", sensor.proximity)
    print("Light:", sensor.light)
    print("White:", sensor.white)
    time.sleep(0.3)

Contributing

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

Documentation

For information on building library documentation, please check out this guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-vcnl4040-1.2.2.tar.gz (21.2 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-vcnl4040-1.2.2.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-vcnl4040-1.2.2.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for adafruit-circuitpython-vcnl4040-1.2.2.tar.gz
Algorithm Hash digest
SHA256 c56d9bf4e55361f5c7c3cb35a2b695721a28701661d7d65b858f9df3925e5283
MD5 d53048828ea5252801312bb6b7ed129d
BLAKE2b-256 e51b6178ddd7721a3b64b02b1e9e4c3e11680823d4d2e842de3aa0721e662e74

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page