Skip to main content

CircuitPython driver for the Adafruit VCNL4200 Long Distance IR Proximity and Light Sensor

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython driver for the Adafruit VCNL4200 Long Distance IR Proximity and 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 or individual libraries can be installed using circup.

Purchase one from the Adafruit shop

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

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

sudo pip3 install adafruit-circuitpython-vcnl4200

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-vcnl4200

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_vcnl4200

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import adafruit_vcnl4200

i2c = board.I2C()

# Initialize VCNL4200
sensor = adafruit_vcnl4020.Adafruit_VCNL4200(i2c)

while True:
    print(f"Proximity is: {sensor.proximity}")
    print(f"Ambient is: {sensor.lux}")
    time.sleep(0.1)

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_vcnl4200-1.0.0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_vcnl4200-1.0.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_vcnl4200-1.0.0.tar.gz
Algorithm Hash digest
SHA256 91b3ed8a8bac9de93790b3b7c0d8e5333ebbed8f4bd413969389b26e9c126d4a
MD5 94e4f9ded85af5ae29bf1e97b3797c0e
BLAKE2b-256 f1fcfa2b57327676c74454bcbba4be109ee9db4af2dbb53cc5c002d93527ff6d

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_vcnl4200-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_vcnl4200-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7245541beddb2eb061fe651491fe236a54e1826eddefb5c8834271d8e859d6d
MD5 53de3a6885ae4fa5831806bede06264c
BLAKE2b-256 d3bfc4dfc63405a69e2e51f48a72e9d1a41976bf6c2979db7b3e92fa9b5a5122

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