Skip to content

Latest commit

 

History

History
106 lines (72 loc) · 5.29 KB

README.md

File metadata and controls

106 lines (72 loc) · 5.29 KB

MagicMirror Module: MMM-Random-local-image

A MagicMirror module that displays random images and videos from a local folder on your mirror.

Screenshot

Installing the module

To install the module, clone the repo and install dependencies:

cd ~/MagicMirror/modules
git clone https://github.com/miccl/MMM-Random-local-image.git
cd MMM-Random-local-image
npm ci

Finally, configure the module in the config.js file (instructions below).

Updating the module

To update the module to the latest version, pull the latest changes and reinstall the dependencies:

cd ~/MagicMirror/modules/MMM-Random-local-image
git pull
npm ci

Using the module

To use this module, add the following configuration to the modules array in your config/config.js:

modules: [
  {
    module: "MMM-Random-local-image",
    position: "bottom_right",
    config: {
      // See configuration options below
    },
  },
];

Configuration options

The following properties can be configured:

Option Description Possible Values Default Value
photoDir Path to the folder containing your media (relative to the MagicMirror root directory) Local file path ./modules/MMM-Random-local-image/exampleImages/
photoUpdateInterval Time interval between displayed media Positive integer (ms) 30.000 (every 30 seconds)
photoLoadInitialDelay Initial delay before loading the first media Positive integer (ms) 1000 (1 second)
photoLoadUpdateInterval Interval for refreshing the media directory Positive integer (ms) 43200000 (every 12 hours)
randomOrder Whether to display medias in random order true or false true
selectFromSubdirectories Whether to select medias from random subdirectories inside photoDir. true or false false
ignoreDirRegex Regular expression for ignoring specific subdirectories (requires selectFromSubdirectories = true) Regex string "a^" (No ignored directories)
ignoreVideos Wether to ignore videos true or false false
opacity Opacity of the displayed media 0.0 to 1.0 1.0
showAdditionalInformation Show the media’s directory path true or false false
maxWidth Maximum width of media container css values (e.g. 100%, 30px) 100%
maxHeight Maximum height of media container css values (e.g. 100%, 30px) 100%

Notes

Large photo directories

If your photoDir contains many images and video, the initial load time might increase. To address this, use selectFromSubdirectories to load them from a randomly selected subdirectory.

You can organize media files in folders (e.g., by year) for better structure and display the origin using the property showAdditionalInformation (shown in the example video).

Transferring files to your MagicMirror

Here are a few ways to upload photos to your MagicMirror:

A) Direct copy

Copy files directly to your MagicMirror system, for example, using a USB drive or downloading files from the web.

B) NFS

Sync files using NFS. Configure a mounting point in /etc/fstab:

192.xxx.2.xxx:/nfs/Public /home/pi/cloud/modules/MMM-Random-local-image/nfs_image_cloud nfs ro,soft,bg,intr,x-systemd.automount 0   0

For detailed instructions, refer to the Raspberry Pi NFS Client guide.

Changelog

The followings lists relevant changes for using the module:

2025-02-07

  • Added support for displaying videos

2024-12

  • Fixed initial loading bug (PR #9)