Skip to main content

A command line interface to help set up a raspberry pi as a video player.

Project description

NOTE: In progress!! Come back later!

PiPlayer

A relatively easy-to-use utility to set up one or more RaspberryPi's as a video player.

PiPlayer will install vlc on your Pi(s), transfer videos, and set them to play on startup.

Installation

You should have one or more Pi's on your local network. The Pi's should have:

  • the latest raspbian with console only install
  • auto-login enabled
  • passwordless authentication with ssh keys

On your computer, install PiPlayer with:

pip install piplayer

Usage

Basic usage

You can send one or more videos directly to individual Pi's like so:

piplayer --host HOSTNAME --video VIDEONAME.mp4

This will transfer the video file(s) to the Pi, and make them play on startup in a loop. The --video option can take multiple video files.

Project file

For more complex scenarios, you can also create project instructions as a YAML file. Here's an example project file:

players:
  - host: player1.local
    videos: vid1.mp4
  - host: player2.local
    videos: ["vid2.mp4", "vid3.mp4"]

To use:

piplayer --project PROJECTFILE.yaml

Required settings:

players is an array, containing at minimum a host and video entry.

host: the hostname or ip of the Pi on the local network

videos: the local path(s) to video files to be sent to the Pi
This can be a single video, an array, or a glob pattern (like myvids/*.mp4).

Optional settings:

The following settings are optional:

loop: should the playlist loop?
Can be true or false. Defaults to true.

random: play the videos in random order
Can be true or false. Defaults to false.

user: the username on the Pi
Defaults to pi.

gap: (TODO!) time in seconds to pause between each video (shows a black screen)
Defaults to 0.0.

start_at: (TODO!) start the playlist at a specific time.
Defaults to 0.0.

If you want to apply the same settings to all the Pi's, add a settings dictionary like so:

settings:
    user: cooluser 
    random: true
    gap: 2

These settings will be sent to all the Pi's listed in the players section (but individual player settings have precedence).

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

piplayer-0.1.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

piplayer-0.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file piplayer-0.1.1.tar.gz.

File metadata

  • Download URL: piplayer-0.1.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/22.5.0

File hashes

Hashes for piplayer-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ccabb57c5cd9644702e8dcdc955440091d090ade1127e4eb376cba121826570e
MD5 577c49febb3e5ef0cd4e671bf0f06201
BLAKE2b-256 03bca18aec64a83b519970e7cd93ac4febb1efe84b0c0d4e0df455d5d796acc4

See more details on using hashes here.

File details

Details for the file piplayer-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: piplayer-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/22.5.0

File hashes

Hashes for piplayer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1e4e4ec1968546b85468773e9f34ab21ce44b9bfea29d8667d07eecc478dc99c
MD5 b32855145c815a712d54d693babee4e5
BLAKE2b-256 8c3d8bd8beb39623073f88b28a3fa8060e4ae59d4d799721996179033f1ee44f

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