Introduction
============
.. image:: https://readthedocs.org/projects/micropython-vcnl4010/badge/?version=latest
:target: https://micropython-vcnl4010.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg
:target: https://micropython.org
:alt: micropython
.. image:: https://img.shields.io/pypi/v/micropython-vcnl4010.svg
:alt: latest version on PyPI
:target: https://pypi.python.org/pypi/micropython-vcnl4010
.. image:: https://static.pepy.tech/personalized-badge/micropython-vcnl4010?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads
:alt: Total PyPI downloads
:target: https://pepy.tech/project/micropython-vcnl4010
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
MicroPython Driver for the Vishay VCNL4010 Proximity and Ambient Light Sensor
Installing with mip
====================
To install using mpremote
.. code-block:: shell
mpremote mip install github:jposada202020/MicroPython_VCNL4010
To install directly using a WIFI capable board
.. code-block:: shell
mip install github:jposada202020/MicroPython_VCNL4010
Installing Library Examples
============================
If you want to install library examples:
.. code-block:: shell
mpremote mip install github:jposada202020/MicroPython_VCNL4010/examples.json
To install directly using a WIFI capable board
.. code-block:: shell
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 <https://pypi.org/project/micropython-vcnl4010/>`_.
To install for current user:
.. code-block:: shell
pip3 install micropython-vcnl4010
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install micropython-vcnl4010
To install in a virtual environment in your current project:
.. code-block:: shell
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 <https://micropython-vcnl4010.readthedocs.io/en/latest/>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "micropython-vcnl4010",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sensor,micropython,vcnl4010,light,micropython,vishay,vcnl4010,proximity,driver,sensor",
"author": "",
"author_email": "JDM <xxyx@mailmeto.mozmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1f/8a/60a29878df14642d25fa6a2cefdd82c834cd78766899c6ed8dd9357a49dc/micropython-vcnl4010-0.1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/micropython-vcnl4010/badge/?version=latest\n :target: https://micropython-vcnl4010.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/badge/micropython-Ok-purple.svg\n :target: https://micropython.org\n :alt: micropython\n\n.. image:: https://img.shields.io/pypi/v/micropython-vcnl4010.svg\n :alt: latest version on PyPI\n :target: https://pypi.python.org/pypi/micropython-vcnl4010\n\n.. image:: https://static.pepy.tech/personalized-badge/micropython-vcnl4010?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Pypi%20Downloads\n :alt: Total PyPI downloads\n :target: https://pepy.tech/project/micropython-vcnl4010\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nMicroPython Driver for the Vishay VCNL4010 Proximity and Ambient Light Sensor\n\n\nInstalling with mip\n====================\nTo install using mpremote\n\n.. code-block:: shell\n\n mpremote mip install github:jposada202020/MicroPython_VCNL4010\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip install github:jposada202020/MicroPython_VCNL4010\n\n\nInstalling Library Examples\n============================\n\nIf you want to install library examples:\n\n.. code-block:: shell\n\n mpremote mip install github:jposada202020/MicroPython_VCNL4010/examples.json\n\nTo install directly using a WIFI capable board\n\n.. code-block:: shell\n\n mip install github:jposada202020/MicroPython_VCNL4010/examples.json\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/micropython-vcnl4010/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install micropython-vcnl4010\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install micropython-vcnl4010\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install micropython-vcnl4010\n\n\nUsage Example\n=============\n\nTake a look at the examples directory\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://micropython-vcnl4010.readthedocs.io/en/latest/>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MicroPython Driver for the Vishay VCNL4010 Proximity and Ambient Light Sensor",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/jposada202020/MicroPython_VCNL4010"
},
"split_keywords": [
"sensor",
"micropython",
"vcnl4010",
"light",
"micropython",
"vishay",
"vcnl4010",
"proximity",
"driver",
"sensor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbf75146fd242f38f3baf0d70cd372e546fd9efc41ba99f8264045d1512da2f4",
"md5": "1a2498aae4bfcf82af2a4e67f61f5191",
"sha256": "81b70373aaeaf1a9d2a6cbae58336fa87350f4f02509ae1f8cbbcf4115f8f8bf"
},
"downloads": -1,
"filename": "micropython_vcnl4010-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a2498aae4bfcf82af2a4e67f61f5191",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7193,
"upload_time": "2023-06-26T21:52:28",
"upload_time_iso_8601": "2023-06-26T21:52:28.227467Z",
"url": "https://files.pythonhosted.org/packages/fb/f7/5146fd242f38f3baf0d70cd372e546fd9efc41ba99f8264045d1512da2f4/micropython_vcnl4010-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f8a60a29878df14642d25fa6a2cefdd82c834cd78766899c6ed8dd9357a49dc",
"md5": "7327fe5f1478b57087277a0af8f13489",
"sha256": "fddee8a8db8e80e0f06ecbddae92eee88978c7e5722c790fa96c524d6e966fcf"
},
"downloads": -1,
"filename": "micropython-vcnl4010-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7327fe5f1478b57087277a0af8f13489",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18881,
"upload_time": "2023-06-26T21:52:29",
"upload_time_iso_8601": "2023-06-26T21:52:29.818765Z",
"url": "https://files.pythonhosted.org/packages/1f/8a/60a29878df14642d25fa6a2cefdd82c834cd78766899c6ed8dd9357a49dc/micropython-vcnl4010-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-26 21:52:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jposada202020",
"github_project": "MicroPython_VCNL4010",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "micropython-vcnl4010"
}
JSON
