Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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 .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-vcnl4040

Usage Example

import time
import board
import adafruit_vcnl4040

i2c = board.I2C()
sensor = adafruit_vcnl4040.VCNL4040(i2c)

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

Documentation

API documentation for this library can be found on Read the Docs.

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

Contributing

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

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.22.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_vcnl4040-1.2.22.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vcnl4040-1.2.22.tar.gz
Algorithm Hash digest
SHA256 3158e1f6ba6a90c14ae7b589af4297d7641bd74458850ffd6da96afd26101a4a
MD5 15ff981ff1d61a91d96c058a6ff27280
BLAKE2b-256 11c04bcdab3501c1f49bae2095207bfb1509e9a6c4b89842bcc928d1a30a3572

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_vcnl4040-1.2.22-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_vcnl4040-1.2.22-py3-none-any.whl
Algorithm Hash digest
SHA256 7040209d6dbdc3933c36278de898c714bada525a1367ceffc8030b4277932aa8
MD5 0321f3a371ee81d3a3600ff59efbc248
BLAKE2b-256 803d287a708dc566fb28731b0225831427afaf9f74a5d430bedede18c963c04b

See more details on using hashes here.

Supported by

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