Skip to content

A websocket API demo to show the OpenSong presentation image on a networked device with a monitor, e.g. a Raspberry Pi.

License

Notifications You must be signed in to change notification settings

vwout/os-pimonitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

os-pimonitor

os-pimonitor is a display solution to show the OpenSong presentation image on a monitor using a Raspberry Pi - or as a matter of fact, any hardware platform that runs Python and offers a framebuffer interface. It shows the slide that is currently presented full-screen on the monitor. It can be used to easily setup an preview monitor or a presentation screen at location where installing a VGA or HDMI cable is not viable. The os-pimonitor uses the internal WebSocket server of OpenSong and only requires bandwidth when a slide change occurs. This makes this solution work very well over WiFi.

The OpenSong PI Monitor is a readonly client for the OpenSong API. It can not be used as a remote control for OpenSong.

The features are:

  • display of the current slide as image on the attached monitor

What is OpenSong?

OpenSong is a free, open-source software application created to manage lyrics, chords, lead sheets, overheads, computer projection, and more.

OpenSong releases are available for Microsoft Windows, Mac OSX, and Linux operating systems.

Download the full application for free and give it a try!

Requirements

  • An installation of OpenSong running on a PC, with enabled automation API in OpenSong (to enable, goto the generic settings, on the system tab)
  • The files in the repository, running on e.g. a Raspberry PI, with:
    • Python 2 and the packages as listed in requirements.txt. Install them easily via pip:
    $ pip install -r requirements.txt
    

Usage

The opensong_monitor script takes the following command line arguments:

usage: opensong_monitor.py [-h] [--host HOST] [--port PORT]
                           [--fullscreen [FULLSCREEN]]

OpenSong networked monitor.

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           Address of the OpenSong application (default:
                        localhost)
  --port PORT           Port of the OpenSong API server (default: 8082)
  --fullscreen [FULLSCREEN]
                        Run in fullscreen mode (default: True)

To configure the Opensong networked monitor, specify the hostname of the computer that runs Opensong optionally the port via the command line. Alternatively, the hostname and port can also be specified by means of environment variables:

export OPENSONG_HOST=<ip-of-opensong-pc>
export OPENSONG_PORT=<port-of-opensong-api>

Run the script, e.g. using

python opensong_monitor.py

License

GNU General Public License v2.0 (GPL-2.0)

About

A websocket API demo to show the OpenSong presentation image on a networked device with a monitor, e.g. a Raspberry Pi.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages