MMM-DriveImages

Preview

MagicMirror module that displays images from a Google Drive folder using rclone.

No API keys. No Google developer setup. Simple browser-based authentication.

---

Features

• Displays images from a Google Drive folder
• Uses rclone with simple browser authentication (no API keys required)
• Automatic background syncing (no cron jobs)
• Local image playback for smooth performance
• Linear or random playback modes
• Tap or click to pause and resume slideshow
• Swipe left or right to navigate images
• Designed for non-technical users
• Configurable navigation arrows
• Configurable image layout (portrait or landscape)
• Adjustable image scaling (% based sizing)

---

Installation

Navigate to your MagicMirror modules folder:

cd ~/MagicMirror/modules

Clone the repository:

git clone https://github.com/Dresch360/MMM-DriveImages.git

Make the setup script executable:

chmod +x MMM-DriveImages/connect

---

Configuration

Add this to your config.js:

{
  module: "MMM-DriveImages",
  position: "fullscreen_above",
  config: {
    driveRemote: "drive:mirror-images", // Google Drive folder (via rclone)
    imagePath: "/home/pi/MagicMirror/modules/MMM-DriveImages/public/images", // Local image storage path
    syncInterval: 2 * 60 * 1000, // Time between Google Drive syncs (ms)
    syncOnStart: true,         // Sync immediately when MagicMirror starts
    syncTimeout: 120000,      // Max time allowed for each sync (ms)
    slideshowInterval: 10000,  // Time each image is displayed (ms)
    animationSpeed: 1000,     // Transition/update speed (ms)
    playMode: "linear",       //"linear" or "random"
    touchControls: true,      // enable tap + swipe controls
    showArrows: true,          // click left/right arrows for previous or next image
    arrowOpacity: 0.3,        // controls arrow visibility (0.0 to 1.0)
    arrowFontSize: 40,         // controls arrow size in pixels
    objectFit: "",            // Optional override: "cover" or "contain" (leave blank to use screenMode)
    screenMode: "portrait",   // "portrait" = full image (contain), "landscape" = fill screen (cover)
    imageScale: 100           // Image size as % (100 = full, 80 = smaller, 120 = zoom)
  }
},

Configuration Options

Option	Description	Default
driveRemote	Google Drive folder to sync from	"drive:mirror-images"
syncInterval	How often to sync with Google Drive (ms)	2 * 60 * 1000
slideshowInterval	Time between image changes (ms)	10000
syncOnStart	Run a sync immediately on startup	true
animationSpeed	Transition speed between images (ms)	1000
playMode	Playback order for images	"linear"
touchControls	Enable tap to pause and swipe navigation	true
screenMode	Screen orientation (controls image fit)	"portrait"
showArrows	Show or hide left/right navigation arrows	true
arrowOpacity	Controls arrow visibility (0.0 to 1.0)	0.3
arrowFontSize	Controls arrow size in pixels	40
imageScale	Image size as a percentage of available space	100

---

Playback Modes

• linear = plays images in order
• random = randomizes the next image

Setup (First Time)

1. Minimize MagicMirror Press: Ctrl + m

2. Open Terminal

3. Run:

~/MagicMirror/modules/MMM-DriveImages/connect

4. Follow prompts:

• Type y to authenticate
• A browser window will open. Sign into your Google account
• Return to Terminal
• Type n for Shared Drive

MagicMirror will restart automatically.

---

Adding Images

Smartphone (Recommended)

1. Open the Google Drive app
2. Open the folder: mirror-images or you can rename to an existing image folder in the config (see driveRemote option above)
3. Tap + → Upload
4. Press and hold one image, then select multiple
5. Tap Select → Upload

Images will appear automatically in ~2 minutes.

---

Computer (Best for large batches)

1. Go to https://drive.google.com
2. Open the folder: mirror-images
3. Drag and drop your images

---

Notes

• The Google Drive folder mirror-images is created automatically during setup
• Folder name must be exactly: mirror-images (all lowercase)
• Once setup completes, you can use any existing Google Drive folder you like by naming it in the config (see driveRemote option in config above)
• Supported formats: JPG, PNG, GIF, WEBP
• Updates happen automatically (~2 minutes)
• No setup required after initial connection
• If no images appear, upload images to the mirror-images folder

---

Reset

To remove images and disconnect Google Drive:

rm -rf ~/MagicMirror/modules/MMM-DriveImages/public/images/*
rm -f ~/.config/rclone/rclone.conf
pm2 restart MagicMirror

---

License

MIT License