https://github.com/jposada202020/MicroPython_TCS3430

MicroPython driver for the AMS TCS3430 Color and ALS sensor
https://github.com/jposada202020/MicroPython_TCS3430

als ams color driver light micropython sensor tcs3420

Last synced: 3 months ago
JSON representation

MicroPython driver for the AMS TCS3430 Color and ALS sensor

• Host: GitHub
• URL: https://github.com/jposada202020/MicroPython_TCS3430
• Owner: jposada202020
• License: mit
• Created: 2023-06-29T14:55:43.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-28T22:44:29.000Z (about 1 year ago)
• Last Synced: 2024-06-28T20:09:05.487Z (4 months ago)
• Topics: als, ams, color, driver, light, micropython, sensor, tcs3420
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-micropython - MicroPython_TCS3430 - MicroPython driver for the AMS TCS3430 Color and ALS sensor. (Libraries / Sensors)

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/micropython-tcs3430/badge/?version=latest

    :target: https://micropython-tcs3430.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-tcs3430.svg

    :alt: latest version on PyPI

    :target: https://pypi.python.org/pypi/micropython-tcs3430

.. image:: https://static.pepy.tech/personalized-badge/micropython-tcs3430?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-tcs3430

.. 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 AMS TCS3430 Color and ALS sensor

Installing with mip

====================

To install using mpremote

.. code-block:: shell

    mpremote mip install github:jposada202020/MicroPython_TCS3430

To install directly using a WIFI capable board

.. code-block:: shell

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

Installing Library Examples

============================

If you want to install library examples:

.. code-block:: shell

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

To install directly using a WIFI capable board

.. code-block:: shell

    mip.install("github:jposada202020/MicroPython_TCS3430/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:

.. code-block:: shell

    pip3 install micropython-tcs3430

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

.. code-block:: shell

    sudo pip3 install micropython-tcs3430

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

Usage Example

=============

Take a look at the examples directory

Documentation

=============

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