Skip to content

edv/inky-photogallery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Inky Photogallery

Photogallery for Inky Impression color e-ink display connected to Raspberry Pi.

See my blog on building a DIY Color E-Ink Picture Frame for additional details.

How to install

Prerequisites

  • Connect the Inky Impression e-ink display to the Raspberry Pi (I am using a Raspberry Pi Zero W)
  • Install the Raspberry Pi operating system on the Pi
  • Enable I2C and SPI using sudo raspi-config for the Raspberry Pi to interact with the e-ink display

Install Dependencies

  1. Install system dependencies:
apt install python3 python3-pip libopenjp2-7
  1. Install Python dependencies using the requirements file:
pip3 install -r requirements.txt

Alternatively, install dependencies manually:

pip3 install inky[rpi,example-depends]
pip3 install pillow>=10.1.0
pip3 install requests>=2.31.0

Using photogallery.py (Local Images)

  • Copy the photogallery.py script and images folder to the Raspberry Pi (e.g. to /home/[username]/eink)
  • Remove the example images and place your own PNG files in the images folder
  • Automatically run the script when the Raspberry Pi is booted by running crontab -e and adding the following line (change the location of the script):
@reboot sleep 60 && cd /home/username/eink && python3 /home/username/eink/photogallery.py &

Using photogallery-immich.py (Immich Integration)

  • Copy the photogallery-immich.py script to the Raspberry Pi
  • Set the required environment variables (you can add these to your ~/.bashrc or create a startup script):
export IMMICH_URL='https://your-immich-instance.com'
export IMMICH_API_KEY='your-api-key-here'
export IMMICH_ALBUM_ID='your-album-id-here'
  • To get your Immich API key: Go to your Immich account settings and create a new API key
  • To get your album ID: Check the album URL in Immich or use the Immich API to list albums
  • Automatically run the script when the Raspberry Pi is booted by running crontab -e and adding:
@reboot sleep 60 && cd /home/username/eink && source ~/.bashrc && python3 /home/username/eink/photogallery-immich.py &

The script will automatically create an immich_cache directory to store downloaded thumbnails.

About

Photogallery for Inky Impression color e-ink display connected to Raspberry Pi

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages