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: Ruff

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

adafruit_circuitpython_slideshow-1.8.7.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_slideshow-1.8.7.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_slideshow-1.8.7.tar.gz
Algorithm Hash digest
SHA256 c6989c308ced56d6638e5afe9875b9d048651c2b7a722394e063f57478c9e604
MD5 635e1bb20f81589673b83d8325264b1f
BLAKE2b-256 182584102430a01eb7424effb9164f7b564f33d7efb8eec635cdc2d09196c11f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_slideshow-1.8.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c222a36b3006d908b4bcaaa2bd450a5f5142ca3cef5c2e6754be73faf06360ae
MD5 7181cb6fc630c8436919d155bcb21b93
BLAKE2b-256 f35af417a3d4703ca8d56c243322fa42ca83cc3c21d1092c3fe89c8825486746

See more details on using hashes here.

Supported by

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