Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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 .venv
source .venv/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

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-slideshow-1.7.8.tar.gz
Algorithm Hash digest
SHA256 d3f45fed01af8154c06c25be7262d4c001d32a47f1c2e75e439224b6e4968b1b
MD5 484672bd191b2e48f52c511b848d007b
BLAKE2b-256 e8699680b9de08f06d7558903f39695e6718d723942cada2cdc19493743863ef

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_slideshow-1.7.8-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_slideshow-1.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d5e238936e67fafd90d16f63f4c09a54a773c35bcfd419aa781f2bad82c22aad
MD5 be9a80fe2fa5e9d84cde3acee758bc43
BLAKE2b-256 09913751cecc2a77e1abba908df05af9d1ee87f80c1e56ed06ad12a11e4e5f6a

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