Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 1.57 KB

README.md

File metadata and controls

57 lines (46 loc) · 1.57 KB
Raw

MMM-piwigo-photo-wheel

This is a module for the MagicMirror, which displays images downloaded from a Piwigo photo library instance. Every 10 seconds the display changes to the next photo.

Preview

preview

Getting Started

Prerequisites

You need to have access to a Piwigo instance that hosts your images. Setup an album and a user that has access rights to the album.

Install the module

  1. Navigate to your modules folder
  2. Clone this repository 
    git clone https://github.com/nsieg/MMM-piwigo-photo-wheel.git
  3. Install dependencies 
    npm install

Configure the module

Add MMM-piwigo-photo-wheel to the modules array in config.js. Adjust URL, username and password to your instance. Make sure that the URL points to the Piwigo API.

modules: [
  ...,
  {
    module: 'MMM-piwigo-photo-wheel',
    position: 'bottom_left',
    config: {
        piwigoBaseUrl: "https://mypiwigo.com/ws.php",
        piwigoUsername: "user",
        piwigoPassword: "secret",
    },
  },
  ...
]

Configuration

In addition to the parameters shown above, the following settings can be changed. The values shown here are the defaults.

config: {
    updateInterval: 60 * 60 * 1000, // check new images every 1 hour
    switchInterval: 10 * 1000, // switch image every 10 seconds
    maxWidth: "250px",
    maxHeight: "333px",
    piwigoSize: "large", // piwigo size derivative used for download
    loadingText: "Loading...",
},