Skip to content

Latest commit

 

History

History
118 lines (94 loc) · 3.4 KB

README.md

File metadata and controls

118 lines (94 loc) · 3.4 KB
Raw

MMM-GmailNotifier

MMM-GmailNotifier is a MagicMirror module that displays the user's Gmail profile picture and name, and checks for unread emails in the inbox.

Features
   - Displays the profile name and profile picture from the Gmail account.
   - Shows the number of unread emails.
   - Automatically hides email notifications if there are no unread emails.

Screenshot

Installation

Follow these steps to install and configure MMM-GmailNotifier:

1. Clone the Repository

cd ~/MagicMirror/modules
git clone https://github.com/kurtern84/MMM-GmailNotifier.git
cd MMM-GmailNotifier

2. Install Dependencies

  npm install

3. Configure Google API

  1. Go to the Google Cloud Console.
  2. Create a new project or select an existing project.
  3. Navigate to "API & Services" > "Library" and enable the following APIs:
  • Gmail API
  • Google People API
  1. Go to "API & Services" > "Credentials" and click on "Create Credentials".
  2. Select "OAuth client ID".
  3. Configure the OAuth consent screen if you haven't already.
  4. Select "Desktop app" as the application type.
  5. Download the OAuth 2.0 Client ID JSON file and note down the client_id and client_secret.

4. Update the Configuration File

{
    module: "MMM-GmailNotifier",
    position: "top_right", // Choose your desired position
    config: {
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET",
        userName: "Your Name"
    }
},

5. Authorize the Application

  1. Start MagicMirror:
npm start
  1. Follow the instructions in the console to authorize the application. You will be prompted to visit a URL to grant permissions.
  2. Copy the authorization code from the browser and paste it into the console.

Directory Structure

MMM-GmailNotifier/
├── node_helper.js
├── MMM-GmailNotifier.js
├── package.json
└── README.md

Updates

Keep the module up-to-date by pulling the latest changes:

cd ~/MagicMirror/modules/MMM-GmailNotifier
git pull
npm install

Troubleshooting

If you encounter issues while using MMM-GmailNotifier, follow these steps to diagnose and resolve common problems:

  1. invalid_grant Error
  • This error can occur for several reasons, including expired or revoked tokens, issues with OAuth2 configuration, or problems with the authorization code. Try the following steps to resolve it:

1.1 Delete token.json File

  • Delete the token.json file in the MMM-GmailNotifier directory. This will force the application to generate a new authorization token on the next start.
cd ~/MagicMirror/modules/MMM-GmailNotifier
rm token.json
  1. Check OAuth Configuration
  • Ensure that your client_id and client_secret are correct and up-to-date in config.js.
  • If you have regenerated the client secret, update config.js with the new values.
  1. Reauthorize the Application
  • Restart MagicMirror and follow the authorization process again to obtain a new authorization token.
npm start
  • Follow the instructions in the console, visit the provided URL, and paste the authorization code.

Logging

To further diagnose issues, check the MagicMirror logs for error messages:

pm2 logs mm

For more details or questions, you can open an issue on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.