Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Awesome Lists containing this project

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 `_.