Module for the MagicMirror² smart mirror.
Displays tasks from Google Tasks App in a Kanban board (backlog/InProgress/Done columns)
Implementation is based on:
The Google Node.js client library
To install the module, use your terminal to:
- Navigate to your MagicMirror's modules folder. If you are using the default installation directory, use the command:
cd ~/MagicMirror/modules
- Clone the module:
git clone https://github.com/lpage30/MMM-GoogleTasksKanban.git
- Navigate to your module directory:
cd ~/MagicMirror/modules/MMM-GoogleTasksKanban
- install the cloned module:
npm install
Google Tasks API an authenticated OAuth2 client:
- Go here, and click "Enable the Google Tasks API" button. Follow the steps to download the credentials.json file.
- copy credentials.json to your MagicMirror config directory (MagicMirror/config). Rename it if you are using more than 1 set of credentials.
- Enable Google Tasks API. Select the same project as in step 1.
- Run CreateTokens.js:
node CreateTokens.js
- Follow the instructions. Copy the resulting Token.json files (RO and RW) to your MagicMirror config directory (MagicMirror/config). Rename them if you are using more than 1 set.
- Backlog: A Task that is NOT completed and does NOT have a due date
- In Progress: A Task that is NOT completed but DOES HAVE a due date
- Done: Any Task that is completed
To use this module, add the following configuration block to the modules array in the config/config.js
file:
var config = {
modules: [
...
{
module: 'MMM-GoogleTasksKanban',
position: 'top_left',
config: {
listName: 'To-Do',
credentialsRelativeFilepath: './credentials.json',
roTokenRelativeFilepath: './rotoken.json',
rwTokenRelativeFilepath: './rwtoken.json',
}
},
...
]
}
Option | Details |
---|---|
listID or listName |
Required - List ID or Name from your Google Tasks application |
inprogressDays |
Optional - When changing task to inprogress the task due date will be set to current day plus this many days. Default value: 10 (10 days) |
updateInterval |
Optional - Interval at which content updates (Milliseconds) Possible values: 2000 - 86400000 (Tasks API has default maximum of 50,000 calls per day.) Default value: 10000 (10 seconds) |
animationSpeed |
Optional - Speed of the update animation. (Milliseconds) Possible values: 0 - 5000 Default value: 2000 (2 seconds) |
credentialsRelativeFilepath |
Required - Filepath relative to MagicMirror/config directory for the credentials used by this instance. |
roTokenRelativeFilepath or rwTokenRelativeFilepath |
Required - Filepath relative to MagicMirror/config directory for the tokens used by this instance. If rw is provided than that token will be used exclusively and enable moving of tasks to in progress or completed or backlog. |