Skip to content

MirrorCommand Contents

Jump to bottom
Ronald Record edited this page Aug 24, 2023 · 1 revision

A brief description of the Utilities and Config files contained in the MirrorCommand project along with links to each.

Utilities

  • camsnap Snap a photo with your MagicMirror webcam
  • chkconfig Validate active/installed MagicMirror configuration file syntax
  • chkinst Check if currently installed MagicMirror scripts are up to date
  • chktemp Check and report the Raspberry Pi temperature
  • get_temps Get your MagicMirror Raspberry Pi temperature
  • gethue Get your Hue Hub properties
  • getquote Get a stock symbol quote
  • mirror Main MagicMirror management script
  • mirror_start PM2 startup script for MagicMirror
  • mknewartist Create a new Artist image folder, filtered for portrait mode images
  • mknewmodel Create a new Model image folder, filtered for portrait mode images
  • mknewphotographer Create a new Photographer image folder, filtered for portrait mode images
  • mknewtop Create a new top level image folder, filtered for portrait mode images
  • mmapiactions Get the MMM-Remote-Control API actions
  • mmgetb Get the MagicMirror screen brightness level
  • mmsetb Set the MagicMirror screen brightness level
  • mm Convenience script to remotely execute the main mirror script
  • mmscene Manage MMM-Scenes MagicMirror module scenes
  • mmupdall Update all image folders with new files, symlinks, and filter for portrait mode
  • myreboot Perform additional actions before reboot, executed as a normal user using sudo
  • myshutdown Perform additional actions before shutdown, executed as a normal user using sudo
  • play Invoke omxplayer
  • rand_back Select a random desktop wallpaper
  • remountusb Clean and remount a mounted USB disk
  • send_sms Send an SMS message using Nexmo
  • showkeys Automates editing of config files to reveal API keys and other secrets
  • updallartists Update Artist image folders with new files, symlinks, and filter for portrait mode
  • updallmodels Update Model image folders with new files, symlinks, and filter for portrait mode
  • updallphotographers Update Photographer image folders with new files, symlinks, and filter for portrait mode
  • updalltop Update top level image folders with new files, symlinks, and filter for portrait mode
  • updarpscan Updates the ARP scan databases
  • updartist Update specific Artist image folders with new files, symlinks, and filter for portrait mode
  • updlinks Update specified image folder with new files, symlinks, and filter for portrait mode
  • updmodel Update specific Model image folders with new files, symlinks, and filter for portrait mode
  • updphotographer Update specific Photographer image folders with new files, symlinks, and filter for portrait mode
  • updtop Update specific top level image folders with new files, symlinks, and filter for portrait mode
  • vncview Remote script to start a VNC server on your MagicMirror and a VNC viewer on your desktop
  • vol Script to control volume level of MagicMirror audio output
  • wireless_conf Configure wireless using WPA Supplicant
  • wireless_dot_sample Sample $HOME/.wireless to assist in wireless configuration
  • zerologs Zero out the PM2 log files

Config files

The mirror command can be used to easily switch between previously prepared config files with a filename of the form `config-.js with the command:

mirror <name>

The mirror command will attempt to perform some pattern matching allowing you to provide only the first few characters of the . For example, to set your config.js to config-Sammy_Davis_Junior.js you could use the command:

mirror Sammy

List of provided config files and templates

Clone this wiki locally