MagicMirror a module for MagicMirror to display notes from a Google Doc.
MagicMirror:
https://magicmirror.builders/
https://github.com/MichMich/MagicMirror
MMM-GoogleDocs-Notes:
https://github.com/No3x/MMM-GoogleDocs-Notes
Installation
- Navigate to your MagicMirror
modulesdirectory and executegit clone https://github.com/No3x/MMM-GoogleDocs-Notes.git - Enter the new
MMM-GoogleDocs-Notesdirectory and executenpm install. - Create a Google Doc and write the note you want to display at the MagicMirror. (use
MMMas title or remember it for later configuration of thenotesPrefixkey) - 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.
- 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.
- Once you’ve created your project, click Continue, then Go to credentials.
- On the Add credentials to your project page, click the Cancel button.
- At the top of the page, select the OAuth consent screen tab.
- Enter the Product name
Magic Mirror Notes. - 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.
- Click the Save button.
- Select the Credentials tab, click the Create credentials button and select OAuth client ID.
- Select the application type Other
- Enter the name
Magic Mirror Notes. It is important that this matches exactly. - Click the Create button.
- Click OK to dismiss the resulting dialog.
- Click the file download icon button to the right of the client ID.
- Rename this file
client_secret.jsonand copy it to your MMM-GoogleDocs-Notes directory. - In the MMM-GoogleDocs-Notes directory execute
sudo -u pi -- node authorize.js(Changepito the user that runs the Magic Mirror application). - 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:
1 2 3 | 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 NumberDefaults to 2 |
pollFrequency | How frequently to poll Drive for documents. Type NumberDefaults to 300000 (5 minutes) |
showDatePosted | Whether to show the date when the note was created Type BooleanDefaults 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 StringDefaults 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 StringDefaults to HH:mm |
notesPrefix | the prefix of your documents titles you store your note in. Type StringDefaults 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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | { 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
- 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 - Widths and heights of elements are removed for all elements to support responsive images (e.g. see the table column widths)
- Use all Google Docs features like embedding charts from a Google Sheet. The embedded chart has a recolor image effect
Negativethat 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.