Download Raspberry Slideshow // how to use

About | Download and use | Donation | Faq | Changelog | References

Detailed write instructions are available here (long story short: you can write Raspberry Slideshow as any other operating system for the Pi). Some default images and videos (taken from the Web and YouTube) are included within the system for a quick functioning example: plug in the Ethernet cable (DHCP) for a full experience.

For web-based signaging, please have a look at Raspberry Digital Signage instead.

This “release” build of Raspberry Slideshow is limited is some functionality: please have a look at the donation page for the full access to the unrestricted versions of all of Binary Emotions’ operating systems.


 

SETUP: HOW TO USE (functioning modes)

1. Local media

Put image and/or video files into a USB stick with one only partition (or use its first partition), vFAT/NTFS or ext4 formatted.
Files must be put in the root folder (not inside directories).
Plug the USB stick into the Raspberry Pi running Raspberry Slideshow and boot.
That’s all – it’s that easy.

 

2. Retrieve media from remote URLs: remote-urls.txt

Put a text file named remote-urls.txt into a USB stick.
With this file you will specify LAN or Internet URLs of remote images and/or videos hosted by a Web or FTP server, one per line.
Plug the USB stick into the Raspberry Pi and boot. All remote media will be copied into the Pi’s internal card and slided (remember to connect Raspberry Slideshow to the network via a wired Ethernet cable, first).

Example: how to play two local images plus two remote ones:

a) Copy the image files into the USB key and save a text file named remote-urls.txt as well, in which you will specify the remote image locations (URLs), one per line:

rpfs-usb

b) Insert the key into the Raspberry and (re)boot. In this example, three images (not four) will be played, because two are identical.

 

3. Retrieve media from a local Windows (Samba) share: network-share.txt (donors’ build only)

Put a text file named network-share.txt into a USB stick.
With this file you will specify the local network folder share, username and password in the form:

share: //192.168.0.100/myShare
username: YOUR_USERNAME
password: YOUR_PASSWORD

All contained media will be copied into the Pi’s internal card and slided (remember to connect Raspberry Slideshow to the network via a wired Ethernet cable, first).
Plug the USB stick into the Raspberry Pi and boot. If you have issues, see the dedicated help FAQ.

Every time you want your Pi’s screen to change the playlist, just modify the files hosted by your network share (serverlist-refresh.txt must be set Pi-side, see below).

 

4. Point a remote list of images: serverlist.txt (donors’ build only)

Put a text file named serverlist.txt into a USB stick.
With this file you will specify the URL of a remote “inventory file” (a text list of images/videos’ links). This way, media list is managed server-side.
Plug the USB stick into the Raspberry Pi and boot (remember to connect Raspberry Slideshow to the network via a wired Ethernet cable, first).

Example: how to use serverlist.txt – server content based slideshow:

a) Save the URL of the remote “inventory file” into a text file named serverlist.txt then save serverlist.txt into the USB key (in the following screenshot, the “inventory file” is named images.txt).

rpfs-remotelist

b) Make your LAN or Internet server host the “inventory file” images.txt (here a LAN web server is used). File content is, again, just a simple list of URLs, for example:

rpfs-remotelist-server

c) Insert the USB key into the Raspberry Pi and (re)boot.

d) Every time you want your Pi’s screen to change the playlist, just modify the “inventory file” hosted by your web server (serverlist-refresh.txt must be set Pi-side, see later on) – this can be eventually automated by a server-side scripting logic, if needed.

 

5. Fetch media from your Dropbox account (donors’ build only)

For this feature to work you need an access token from Dropbox, first.
While logged-in in your Dropbox account, create an app here:

Choose an API -> Dropbox API
Choose the type of access you need -> App folder
Name your app -> Choose a unique name of your choice, say MyUniqueDropboxApp

Click on Create app, then, in the following page, click on the Generate button. The generated access token is a long string, something like 2Ti29hgj8jYAAAFFADONC6-6bKMms0ET3yg0Te97P4XNhjOOdgM11lKT8hpaaj_.

In the meanwhile, a new folder named Applications/MyUniqueDropboxApp will appear in your Dropbox account.

Copy and paste the access token into a file named dropbox.txt, then save it into the USB key.
Plug the USB stick into the Raspberry Pi and boot: every file within Applications/MyUniqueDropboxApp/ will be fetched and slided (remember to connect Raspberry Slideshow to the network via a wired Ethernet cable, first).

 

The refresh feature (use with 3., 4. and 5): serverlist-refresh.txt (donors’ build only)

Raspberry Slideshow can refresh the media list (remote list links, network share and Dropbox content) at given, fixed, intervals, in order to slide images and videos according to any server changement (addition or deletion of a media file).

You can accomplish this by saving a file named serverlist-refresh.txt (together with serverlist.txt, network-share.txt or dropbox.txt, of course) into the USB key, in which you’ll specify the refresh time value. System is smart enough to actually re-download all remote media only when it sees changements.

Refresh value is in seconds, just save in the file the number of seconds you need.
So, for an hour, just save 3600, nothing else.

 

Automatic photos rotation (donors’ build only)

An optional photos rotation based on their EXIF informations is available; enable in /etc/rs.conf via SSH as root (refer to the FAQ page). This will increase the boot time.

 

Using scp (donors’ build only)

All the above functioning modes have been presented together with the use of a USB key as the way to input media into the Raspberry Pi, which is the simplest possible use case for most users.

However, it’s also possible to load media files, or any other “command file” (remote-urls.txt, serverlist.txt, network-share.txt, dropbox.txt and serverlist-refresh.txt) via scp.

Just SSH in as root (refer to the FAQ page), put the media or “command” files in /usr/lib/rs/imgs and restart Systemd: systemctl restart rs.

So, to recap:
scp /path/to/my/files/* root@RASPBERRY_IP:/usr/lib/rs/imgs/
systemctl restart rs

 

Rules

  • All USB/scp’d files (media and text) are copied into the internal Raspberry’s SD-CARD:
          – if the USB key is inserted: at every reboot, SD-CARD files are updated and hence played according to the key’s content;
          – if the USB key is not inserted: at every reboot, media are played from the internal cache. So, after the first run, you can unplug the USB key.
  • Functioning modes can be combined: you can put all the command files into the USB key, or directly scp them.
  • Media will be displayed in a name-based order (donors’ build only), first remote-urls.txt-related content, then serverlist.txt-related media, network-share.txt, Dropbox and then USB contained media, followed by name-based order of remote-urls’/serverlist’s/network-share’s/Dropbox/USB key’s videos. So, images come first and then videos. This behaviour is by design and unmodifiable (please do not ask for).
  • Accepted image formats are jpeg (.jpeg or .jpg), png, gif.
  • Accepted video formats are the ones played by omxplayer, mostly mp4 files.

 

It does not work / I have issues/questions

Just have a look at FAQ page.
In case of problems, please do not contact me unless you have enabled the DEBUG mode and you have the output of /var/log/rs.log by hand.

 

Full version

This “release” build of Raspberry Slideshow is limited is some functionality: please have a look at the donation page for the full access to the unrestricted versions of all of Binary Emotions’ operating systems.