MMM-RemoteCompliments is a module for the open source MagicMirror² platform.

MMM-RemoteCompliments provides seamless integration with Google Drive™ to display compliments and images from Drive on the MagicMirror² interface.

A full demo of the module can be found at: https://www.youtube.com/watch?v=cEcp47C1jPw

• Navigate to the MagicMirror/modules directory.
• Enter git clone https://github.com/mitchelltmarino/MMM-RemoteCompliments.git
• Follow the setup instructions located in the Drive directory.
• Restart MagicMirror.

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

var config = {
    modules: [
        {
            module: "MMM-RemoteCompliments",
            header: "MMM-RemoteCompliments",
            config: {
                // See below for configurable options
            }
        }
    ]
}

The following properties can be configured in the config/config.js file:

The majority of configurations for MMM-RemoteCompliments done via Google Drive, in the configuration spreadsheet. This way the module configurations can be easily modified at any time, without a direct connection to the mirror.

The configurations options available are broken down by sections. The default value is used if the value is invalid or left empty.

After the module is setup you will find a file hierarchy setup on your Google Drive like so:

Smart Mirror - Remote Compliments
└─── Scheduled Compliments
└─── Current Compliment
└─── Random Compliments
└─── Configuration
└─── images

Once the files are created on your Google Drive, you can rename them however you like, and move the files wherever you want. The modules keeps track of the files by using their unique file IDs. The following table gives a breakdown of each file and folder:

Note that for compliments, there is a priority mechanism which chooses which type of compliment to display in the case that multiple compliment types are present. The priority is as follows:

• Scheduled Compliments > Current Compliment > Random Compliments

The scheduled compliments spreadsheet allows for compliments to appear between given date and time intervals.

Compliments offers a generous amount of formatting and input options.

• YYYY-MM-DD

  • This is the ISO 8601 standard.
  • Example: 1997-02-28

• Month Day, Year

  • Works for short form of month as well. (Example: Feb)
  • Example: February 28, 1997

• Month Day

  • In this case, the module assumes the current year.
  • Example: February 28 --> February 28, 2018 (Assuming 2018 is the current year)

• HH:MM XM

  • Examples:
    • 5:30 AM
    • 5:30 PM
    • 10:00 AM
    • 10:00 PM

• HH:MM (Military Time)

  • Examples:
    • 8:00 (8:00 AM)
    • 20:00 (8:00 PM)

• If only start date is specified, the compliment will be displayed for that entire day.

• If only start date and start time are specified, the compliment will be displayed from the start time until 12:00 AM the next day.

• If only start date, start time, and end time are specified, the compliment will be displayed between the given time interval for that day.

Google Drive is a trademark of Google Inc. Use of this trademark is subject to Google Permissions.