Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status

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

Dependencies

This driver depends on:

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.

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

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

File details

Details for the file adafruit-circuitpython-slideshow-1.7.6.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-slideshow-1.7.6.tar.gz
Algorithm Hash digest
SHA256 0af54b2add829096a33f40d778c5e375fe1bd28ae26f0645d045af1e109e2579
MD5 0d85d0615e7996c80a9fda275e281a90
BLAKE2b-256 abb63625534479bb402fd154c687b05a76aef7587a4a7479a983f92139f118b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page