Super Best Frame

This is a picture frame slideshow for running on linux systems that is connected to a display/monitor. These linux systems may include Raspian, Ubuntu, Mint, or even WSL (Windows Subsystem for Linux). The image slideshow is displayed on a connected display, monitor, or projector in either horizontal (landscape) or vertical (portrait) orientation.

You can then control the picture frame slideshow's behavior using a simple browser based web interface of the local network at port 5555. That is, you can access this web interface with http://<IP Address of Picture Frame Host>:55555

Very Basically ...

1. You run this on a computer that is connected to a monitor, display, or projector.
2. You will then be able to control the shown images on the monitor using a website that you can access with a computer, phone, or tablet.
3. You can access this website as long as you are on your local or home network.

👓 Overview

• 👓 Overview
• 👍 Compatibility
  • Minimum System Requirements
  • Verified Platforms
• 🚀 Installing and Setup
• 💥 Usage
  • Image Formats You Can Use
  • Adding Images
    • Using The Web Interface
    • Via Physical Flash/USB Drive
    • Remotely Via scp Command
    • Remotely Via ftp Command
• 👤 Author
• Licence

👍 Compatibility

Minimum System Requirements

The following are the minimum system requirments where this application will work smooth and as intendent.

• CPU: 1.2 GHz
• CPUs/Cores: 4
• RAM: 1GB
• Disk Storage: 400 MB + Images

🚀 Installing and Setup

1. [If on remote computer] Enter remote linux device using ssh:
   • MAC/Linux Terminal, Windows Powershell: ssh <username/login>@<IP address of picture frame computer>
   • May need to enable SSH on remote linux host computer: sudo apt install -y openssh-server
2. Navigate into user documents directory:
   • $ cd ~/Documents
3. Install git:
   • $ sudo apt -y install git-all
4. Configure git:
   • $ git config --global user.name "Your Name Here"
   • $ git config --global user.email "your.email@here.com"
5. Clone this public git repo form github:
   • $ git clone git@github.com:ismet55555/Super-Best-Frame.git
6. Change directory into cloned directory:
   • $ cd Super-Best-Frame
7. Install OpenCV system dependencies:
   • $ sudo apt -y install python3-opencv
8. Run the start script
   • $ ./start

NOTE: Check out the start script to see what exactly it executes.

💥 Usage

TODO - Maybe some gifs

Image Formats You Can Use

• .png, .jpg, .jpeg, .bmp, .dib, .jpe, .jp2, .pgm, .tiff, .tif, .ppm

Adding Images

All images that are displayed in the picture frame must be stored in the Images directory of this project. Note that subdirectories in the "Images" directory will not be considered.

Using The Web Interface

• TODO

Via Physical Flash/USB Drive

• TODO

Remotely Via scp Command

• TODO

Remotely Via ftp Command

• TODO

👤 Author

Ismet Handžić - Github: @ismet55555

Licence

This project is licensed under the MIT License - see the LICENSE.md file for details