Skip to content
This repository has been archived by the owner on Dec 15, 2024. It is now read-only.

⛔️ DEPRECATED MicroPython Driver for the Vishay VCNL4010 Proximity and Ambient Light Sensor

License

Notifications You must be signed in to change notification settings

jposada202020/MicroPython_VCNL4010

Repository files navigation

⛔️ DEPRECATED

This repository is no longer supported, please consider using alternatives.

No Maintenance Intended

MicroPython Driver for the Vishay VCNL4010 Proximity and Ambient Light Sensor

Installing with mip

To install using mpremote

mpremote mip install github:jposada202020/MicroPython_VCNL4010

To install directly using a WIFI capable board

mip.install("github:jposada202020/MicroPython_VCNL4010")

Installing Library Examples

If you want to install library examples:

mpremote mip install github:jposada202020/MicroPython_VCNL4010/examples.json

To install directly using a WIFI capable board

mip.install("github:jposada202020/MicroPython_VCNL4010/examples.json")

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 micropython-vcnl4010

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

sudo pip3 install micropython-vcnl4010

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 micropython-vcnl4010

Usage Example

Take a look at the examples directory

Documentation

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