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.

Building locally

Zip release files

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

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

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

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vcnl4040 --library_location .

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

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This 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.

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

Uploaded Source

File details

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

File metadata

  • Download URL: adafruit-circuitpython-vcnl4040-1.1.0.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.6.7

File hashes

Hashes for adafruit-circuitpython-vcnl4040-1.1.0.tar.gz
Algorithm Hash digest
SHA256 15d7fd7bb5d520769a3f67dc8a87ec31ba48ac47be926ebc494d318572f7ba24
MD5 0258b91e195a8b645f891f1e40d00b58
BLAKE2b-256 3d4c6aed3c58e39525eeed19bf12daa82ac414b769fbd0765c383219932d11c3

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