dhalbert/Adafruit_CircuitPython_Slideshow

CircuitPython helper library for displaying a slideshow of images on a board with a built-in display.

Introduction

CircuitPython helper library for displaying a slideshow of images on a display.

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.

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:

pip3 install adafruit-circuitpython-slideshow

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

sudo pip3 install adafruit-circuitpython-slideshow

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-slideshow

Usage Example

from adafruit_slideshow import PlayBackOrder, SlideShow
import board
import pwmio

# Create the slideshow object that plays through once alphabetically.
slideshow = SlideShow(board.DISPLAY, pwmio.PWMOut(board.TFT_BACKLIGHT), folder="/",
                      loop=False, order=PlayBackOrder.ALPHABETICAL)

while slideshow.update():
    pass

Documentation

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

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.