This module is a customization from MagicMirror's default calendar module to display your Google calendars (including the Google Family calendar) without needing to make calendars public or using iCals. Inspired by the GoogleTask module.

This guide will walk you through installing and configuring the MMM-GoogleCalendar module.

• MagicMirror² installed.
• Node.js: This module requires Node.js version 22.14.0 or higher. Please ensure your MagicMirror installation is running on a compatible Node.js version. You can check this via the .nvmrc file in the module directory and use a Node version manager like nvm to switch if needed (e.g., nvm use).

1. Open Your Command Line Tool: Access your terminal or command prompt.

2. Navigate to MagicMirror's Modules Folder: Change to the directory where your MagicMirror modules are stored. Typically, this is: cd ~/MagicMirror/modules

3. Clone the Module Repository: Download the MMM-GoogleCalendar module: git clone https://github.com/randomBrainstormer/MMM-GoogleCalendar.git

4. Install Dependencies:

   • Navigate into the newly cloned module's directory: cd MMM-GoogleCalendar
   • Install the necessary Node.js dependencies. This module uses updated libraries like googleapis for better performance and security. npm install

With the module downloaded and dependencies installed, the next step is to configure Google Cloud access.

To allow this module to access your Google Calendar, you need to set up a project in Google Cloud Platform and get API credentials.

1. Create or Select a Google Cloud Project:

   • Go to the Google Cloud Console.
   • Create a new project or select an existing one. For detailed instructions, see Creating a project.

2. Enable the Google Calendar API:

   • In your Google Cloud Project, ensure the Google Calendar API is enabled.
   • Follow the instructions at Enable the Google Calendar API (you only need to do the "Enable the API" part).

3. Configure the OAuth Consent Screen:

   • This is crucial for allowing the module to ask for permission to access your calendar.
   • Follow the guide at Configure the OAuth consent screen.
   • Important: While your app is in "Testing" mode during setup, add your Google account email address to the "Test users" list. If you don't, you'll encounter errors during the authorization step.

4. Create OAuth 2.0 Client ID Credentials:

   • In the Google Cloud Console, navigate to "APIs & Services" > "Credentials".
   • Click "+ CREATE CREDENTIALS" and select "OAuth client ID".
   • Application type: Select "Desktop application". This is the only type supported by this module. Using other types will result in authentication errors.
   • Give it a name (e.g., "MMM-GoogleCalendar Client").
   • Click "CREATE".
   • A dialog will show your client ID and client secret. Click "DOWNLOAD JSON" to download the credentials file. This file will likely be named something like client_secret_[...].json.
   • Rename the downloaded file to credentials.json. This file must contain an installed key which in turn contains client_id, client_secret, redirect_uris, etc.

5. Place credentials.json in the Module Folder:

   • Move the renamed credentials.json file into the MMM-GoogleCalendar module directory (e.g., ~/MagicMirror/modules/MMM-GoogleCalendar/credentials.json).

1. Run the Authorization Script:

   • In your terminal, ensure you are in the MMM-GoogleCalendar directory: cd ~/MagicMirror/modules/MMM-GoogleCalendar
   • Execute the authorization script: node authorize.js
   • The script will output a URL. Copy this URL.

2. Authorize in Your Browser:

   • Paste the copied URL into a web browser on any device (your computer, phone, etc.).
   • Sign in with the Google account whose calendar you want to display.
   • You may encounter a "Google hasn’t verified this app" warning. This is expected if your OAuth consent screen is still in "Testing" mode and you haven't published it. Click "Advanced" (or similar) and then choose to "Go to [Your Project Name] (unsafe)" or "Continue".
   • Grant the requested permissions for Google Calendar access.

3. Provide Authorization Code to Script:

   • After granting permissions, your browser will be redirected to a page (it might appear as a "This site can’t be reached" error, a blank page, or show a "Success" message depending on your setup – this is normal).
   • Copy the entire URL from your browser's address bar. This URL contains the authorization code needed by the script (it will be in the code query parameter).
   • Paste this full URL back into the terminal where authorize.js is waiting and press Enter.

4. Token Generation:

   • If successful, the script will exchange the code for tokens, and a token.json file will be created in the MMM-GoogleCalendar directory. This file stores the authorization, allowing the module to access your calendar.

You have now successfully configured the module to access your Google Calendar. The next step is to add it to your MagicMirror config.js.

A note for contributors: The codebase has been modernized to ES6+ standards, includes ESLint for code quality, and has initial unit tests with Jest.

Now it's time to bring your calendar to life on your MagicMirror! To do this, you need to add a specific configuration block to your MagicMirror's settings. This block of code tells your MagicMirror how to display your Google Calendar and which calendar to show.

Here's how you set it up:

1. Open the config/config.js file in your MagicMirror directory. Remember, you should now be in the main directory of MagicMirror², not in the MMM-GoogleCalendar module directory. If you're not sure you're in the right place, the path should look something like this: ~/MagicMirror/config/config.js.
2. Add Module Configuration:

   • Now, integrate the module into your MagicMirror² by adding the following configuration block to the modules array in the config/config.js file. It's crucial to replace "MyGoogleCalendarIDHere" with your actual calendar ID.

     {
         module: 'MMM-GoogleCalendar',
         header: "My Google Private Cal",
         position: "top_left",
         config: {
             calendars: [
                 {
                   symbol: "calendar-week",
                   calendarID: "MyGoogleCalendarIDHere"
                 },
                 // To add more calendars, replicate the above entry within this array with the respective ID
             ],
         }
     },

     Finding Your Google Calendar ID: If you're unsure where to find your Google Calendar ID, it's quite straightforward:

     • Head over to your Google Calendar by visiting https://calendar.google.com.
     • Look for the settings icon (resembling a gear) in the upper right corner and click on it to access Settings.
     • On the left side, navigate to Settings for my calendars, and select the calendar you wish to display on MMM-GoogleCalendar.
     • Scroll until you find the Integrate calendar section. Your calendar ID is listed there. This ID usually ends with @group.calendar.google.com.
     • There's no need to modify any settings here—just copy the Calendar ID and replace "MyGoogleCalendarIDHere" in the module configuration with your actual ID.

This module is designed specifically for Google calendars, but it inherits many customizable features from the original MagicMirror² calendar module. To explore all the available options and tailor your calendar display to your liking, please refer to the MagicMirror² documentation.

We are committed to improving and updating this module, so if you have enhancements or updates, feel free to contribute. Merge requests with the latest changes are always appreciated and welcome!

We welcome translations! If you'd like to translate the module into your language:

1. Copy the translations/en.json file.
2. Rename it to your language code (e.g., de.json for German).
3. Translate the string values in your new file.
4. Add your new translation file to the getTranslations function in MMM-GoogleCalendar.js.
5. Submit your changes as a pull request or issue on GitHub. Thank you for your contribution!

What happened to the old types of OAuth credentials? Previously, this module might have worked with or documentation might have confusingly referenced Web Application or TV & Limited Input devices OAuth credential types. This module now exclusively supports the Desktop app credential type. This change simplifies the setup process significantly with the current Google authentication libraries. Ensure you download the credentials.json for a "Desktop application" from Google Cloud Console.

Can this module display .ICS calendars or any other format? Unfortunately, this module is designed to work exclusively with Google Calendar. Google Calendar data is formatted differently, which is why there's no support for other calendar types within this module. If you need to display .ICS calendars or other formats, consider using the default MagicMirror² calendar module.

I'm having trouble getting this module to work. What should I do? First, don't worry! We have a troubleshooting guide that addresses common issues and their solutions. If you're still stuck after consulting the guide, please feel free to [open an issue here](https://github.com/randomBrainstormer/MMM-G