https://github.com/cedargrovestudios/circuitpython_palettefader

A CircuitPython color palette and list brightness setter and normalizer tool.
https://github.com/cedargrovestudios/circuitpython_palettefader

circuitpython circuitpython-community-bundle palette-brightness

Last synced: about 2 months ago
JSON representation

A CircuitPython color palette and list brightness setter and normalizer tool.

• Host: GitHub
• URL: https://github.com/cedargrovestudios/circuitpython_palettefader
• Owner: CedarGroveStudios
• License: mit
• Created: 2022-09-06T23:07:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-02T03:19:09.000Z (about 1 year ago)
• Last Synced: 2023-11-02T04:23:33.952Z (about 1 year ago)
• Topics: circuitpython, circuitpython-community-bundle, palette-brightness
• Language: Python
• Homepage:
• Size: 2.04 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

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

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/CedarGroveStudios/CircuitPython_PaletteFader/workflows/Build%20CI/badge.svg

    :target: https://github.com/CedarGroveStudios/CircuitPython_PaletteFader/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

*A CircuitPython color palette and list brightness setter and normalizer tool.*

PaletteFader is a CircuitPython class for brightness-adjusting color lists and displayio palettes. Normalization (scaling all palette values relative to the brightest palette color) is optionally applied to the palette prior to brightness and gamma adjustments. Transparency index values are preserved and associated with the adjusted palette. Creates an adjusted displayio color palette object (``displayio.Palette``) property that can also be read as a color list.

Two versions of PaletteFader are contained in the ``cedargrove_palettefader`` package folder, ``palettefader`` and ``palettefader_ulab``. The faster of the two is ``palettefader_ulab``, requiring CircuitPython with ``ulab`` as a built-in module. Certain CircuitPython distributions and versions may not support ``ulab``; check your specific implementation. For example, ``ulab`` is not included in MatrixPortal distributions after CircuitPython version 7.3.2. A list of built-in modules are listed for each distribution on the https://circuitpython.org/downloads page.

Dependencies

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

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

Installing to a Connected CircuitPython Device with Circup

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

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install cedargrove_palettefader

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

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

.. code-block:: py

    # For CircuitPython distributions without ulab (such as the MatrixPortal)

    from cedargrove_palettefader.palettefader import PaletteFader

    # Instantiate PaletteFader

    faded_object = PaletteFader(source_palette=object_palette, brightness=0.5)

.. code-block:: py

    # For CircuitPython distributions with ulab

    from cedargrove_palettefader.palettefader_ulab import PaletteFader

    # Instantiate PaletteFader

    faded_object = PaletteFader(source_palette=object_palette, brightness=0.5)

``palettefader_simpletest.py`` and other examples can be found in the ``examples`` folder.

Documentation

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

`PaletteFader API Class Description `_

.. image:: https://github.com/CedarGroveStudios/CircuitPython_PaletteFader/blob/main/media/PaletteFader_Class_description.jpeg

.. image:: https://github.com/CedarGroveStudios/CircuitPython_PaletteFader/blob/main/media/PaletteFader_Class_internals.jpeg

Contributing

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

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming to everyone.