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

PaletteFader is a CircuitPython helper class for brightness-adjusting color lists and displayio palettes. Normalization 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.

Installing PaletteFader 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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install cedargrove_palettefader

Or the following command to update an existing version:

circup update

Usage Examples

# 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)

# 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 documentation

PaletteFader GitHub Repository