Skip to content

Latest commit

 

History

History
69 lines (60 loc) · 3.59 KB

README.md

File metadata and controls

69 lines (60 loc) · 3.59 KB
Raw

Module: MMM-iFrame-GSlides

The MMM-iFrame-GSlides module is for MagicMirror. It is a simple way to add an iFrame of published Google Slides Presentation content to your MagicMirror. It is specifically written to work with a google slide presentaton. However, you may be able to use this for other applications such as displaying a fullscreen webpage in an Iframe. This module will also allow for refreshing of the page at the user set intervals.

Using the Module for Google Slide Presentation

Create your google slide then publish it to the web by selecting File > Publish to the web. Select the Embed option along with your desired slide options. Select "Start slideshow as soon as the player loads" option and the "Restart the slideshow after the last slide" option. When you click on the "Publish" button you will be shown a long Iframe URL. You need to select starting with "https://docs.google.com/presentation/stringofletterstoyourpresentation/embed?start=true&loop=true&delayms=3000" and copy this into your MagicMirror config file as the MMM-iFrame-GSlides modules url option, as shown in the example config. DO NOT copy the "iframe src=" section or anything after the "delay=3000" section. These are all things that the MMM-iFrame-GSlides will take care of.

NOTES

If you use the default width and height settings of "full", this WILL cover any other modules on the screen UNLESS you set the MMM-iFrame-GSlides module position to fullscreen_below. If you want only your Google Slide Presentation to be shown and fullscreen, use "fullscreen" as the modules postion.

If you want to remove the slide navigation tool bar from the bottom of your Google Slide Presentation, add "&rm=minimal" to the end of your url before the closing quote.

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: "MMM-iFrame-GSlides",
		position: "bottom_bar",	// This can be any of the regions.
		config: {
			// See 'Configuration options' for more information.
				url: "https://magicmirror.builders/",  // enter the embed url to your Google Slides.
				RefreshInterval: 5 * 60 * 1000, // Refreshes Page every 5 minutes.
				width: "200px", // Optional. Default: "full". The "full" value will look at screen size and match for full screen."
				height: "100px" //Optional. Default: "full"  The "full" value will look at screen size and match for full screen."
			}
		}
	}
]

Configuration

The following properties can be configured:

Option Description
url the URL in the iFrame

Example:"http://example.com/"
Default value: "http://magicmirror.builders/"
RefreshInterval the Refresh Interval for the page shown in the Iframe.

Example for 2 minutes:2 * 60 * 1000
Default value: "5 * 60 * 1000"
width the width of the iFrame

Example:"200px" Using the "full" value here will look at screen size and match for full screen."
Default value: "full"
height the height of the iFrame

Example:"300px" Using the "full" value here will look at screen size and match for full screen."
Default value: "full"