picframe-overlay

Cross-platform PictureFrame overlay with JavaScript, HTML, and CSS

Prerequisites

Electron

picframe-overlay uses electron.

Installation

# if not already installed, install nodejs and npm
$ sudo apt install nodejs
$ sudo apt install npm

# Clone the Quick Start repository
$ git clone https://github.com/helgeerbe/picframe-overlay

# Go into the repository
$ cd picframe-overlay

# create .env file
HOME={"home": "Our castle", "lat": 47.55776221979791, "lon": 10.750175907276837}
IMAGE={"file": "/dev/shm/overlay.png", "width": 1920, "height": 1200}
WEATHER={"city": "My City", "lat": 47.55776221979791, "lon": 10.7501759072768371, "key": "myOpenWeatherMapKey", "lang": "de", "units": "metric"}
MQTT={"host": "mymqttserver", "port": "1883", "clientId": "picframe_overlay", "username": "name", "password": "mypasswd"}

# when logged in via ssh
$ export DISPLAY=:0

# Install the dependencies and run
$ npm install && npm start

How to use

Publish on topic "picframe/overlay" message:

• 0 empty overlay
• 1 digital clock
• 2 weather
• 3 image meta

What's next

Impressions