Skip to content
📝 MagicMirror Module to display notes from a Google Doc
JavaScript CSS
Branch: master
Clone or download
Latest commit c0fad1d Jan 4, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
translations Added translations Dec 30, 2019
.eslintrc.json
.gitignore
LICENSE.txt Added license Dec 31, 2019
MMM-GoogleDocs-Notes.css Switched to cheerio and support images Jan 3, 2020
MMM-GoogleDocs-Notes.js Renamed dateFormatRel to dateFormatShort Jan 4, 2020
README.md
authorize.js
node_helper.js Renamed noteTitle to notesPrefix Jan 4, 2020
package-lock.json Switched to cheerio and support images Jan 3, 2020
package.json Prepare version 2 Jan 4, 2020

README.md

MMM-GoogleDocs-Notes

This a module for MagicMirror
https://magicmirror.builders/
https://github.com/MichMich/MagicMirror

This module displays a Google Doc as note from your Google account.

result

Installation

  1. Navigate to your MagicMirror modules directory and execute
    git clone https://github.com/No3x/MMM-GoogleDocs-Notes.git

  2. Enter the new MMM-GoogleDocs-Notes directory and execute npm install.

  3. Create a Google Doc and write the note you want to display at the MagicMirror. (use MMM as title or remember it for later configuration of the notesPrefix key)

  4. Add the module to your config (see below).

Google Keep

Unfortunately Google does not provide an API for Keep to query the content for a note from there. Therefore we use a Google Doc that can be edited by multiple users.

Authorization

It is very important that you follow these steps although they are not very exact but you should be able to follow. Before this module will work, you need to grant authorization for this module to access your Google Drive account.

  1. Go to https://console.developers.google.com/flows/enableapi?apiid=drive&pli=1 and create a new project. Don't use an existing one, as we need to make some specific configurations that may conflict with your existing project.
  2. Once you've created your project, click Continue, then Go to credentials.
  3. On the Add credentials to your project page, click the Cancel button.
  4. At the top of the page, select the OAuth consent screen tab.
  5. Enter the Product name Magic Mirror Notes.
  6. Select your GMail address. This is just the account with which you are associating your developer account. It doesn't need to be the same as the Google account for which you want to display notes.
  7. Click the Save button.
  8. Select the Credentials tab, click the Create credentials button and select OAuth client ID.
  9. Select the application type Other
  10. Enter the name Magic Mirror Notes. It is important that this matches exactly.
  11. Click the Create button.
  12. Click OK to dismiss the resulting dialog.
  13. Click the file download icon button to the right of the client ID.
  14. Rename this file client_secret.json and copy it to your MMM-GoogleDocs-Notes directory.
  15. In the MMM-GoogleDocs-Notes directory execute sudo -u pi -- node authorize.js (Change pi to the user that runs the Magic Mirror application).
  16. Follow the instructions to authorize the Google account for which you want to display notes on your mirror.

If everything went well, you should see MMM-GoogleDocs-Notes is authorized in your console. Now you can configure your module as below.

Note: This application uses the following scopes:

https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive.file

Configuration

Option Description
maxNotes The maximum number of your most recent documents to display

Type Number
Defaults to 2
pollFrequency How frequently to poll Drive for documents.

Type Number
Defaults to 300000 (5 minutes)
showDatePosted Whether to show the date when the note was created

Type Boolean
Defaults to true (5 minutes)
dateFormatExact the date format to use for the exact posted date (not today and not yesterday). Uses Moment.js supported date formats (https://momentjs.com/docs/#/displaying/)

Type String
Defaults to YYYY-MM-DD HH:mm
dateFormatShort the short date format to use for the posted date (today and yesterday). Uses Moment.js supported date formats (https://momentjs.com/docs/#/displaying/)

Type String
Defaults to HH:mm
notesPrefix the prefix of your documents titles you store your note in.

Type String
Defaults to MMM

Sample Config

The current procedure: it queries for all documents, filters by titles that start with notesPrefix, orders by the last edited document and displays at most maxNotes number of noes.

{
  module: 'MMM-GoogleDocs-Notes',
  header: "Notes",
  position: 'top_right',
  classes: 'default everyone',
  config: {
    maxNotes: 2,
    pollFrequency: 5 * 60 * 1000, //5 minutes;
    showDatePosted: true,
    dateFormatExact: 'YYYY-MM-DD HH:mm',
    dateFormatShort: 'HH:mm',
    notesPrefix: 'MMM'
  }
},

Troubleshooting

OAuth

Since the OAuth-Authorization-Token is stored in the users home directory make sure to execute node authorize.js as the same user that runs the MagicMirror instance (user pi in my case). To ensure it execute the command explicitly as user pi: sudo -u pi -- node authorize.js

Outputs

While setup watch the logs: tail -f /home/pi/.pm2/logs/mm-out.log. Log messages are prefixed with [MMM-GoogleDocs-Notes]. Watch out for scope errors and urls to open your browser in case the scope is not sufficient (like The drive API returned an error: Error: Insufficient Permission: Request had insufficient authentication scopes.).

Tips

contents

  1. Change the background color of your Google Doc to match your MagicMirror background. This way you can design your contents to look good on the mirror. File > Page setup > Page color
  2. Widths and heights of elements are removed for all elements to support responsive images (e.g. see the table column widths)
  3. Use all Google Docs features like embedding charts from a Google Sheet. The embedded chart has a recolor image effect Negative that is unfortunately not properly exported. But you can change the colors of the diagram in the source document - with this the export works fine.

Credits

This module uses the scaffolding of https://github.com/jclarke0000/MMM-MyNotes.git which served as starting point. Most functionality was taken from it but the interaction with the Drive API was added and some modifications were made.

You can’t perform that action at this time.