paviro / MMM-Wunderlist

This an extension for the MagicMirror. It can display your Wunderlist todos.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MMM-Wunderlist

Note: As of May 6, 2020, Microsoft has ended support for Wunderlist. Syncing between devices is no longer possible.

This an extension for the MagicMirror. It can display your Wunderlist todos. You can add multiple instances from different accounts with different lists.

MMM-Wunderlist Screenshot

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/paviro/MMM-Wunderlist.git. A new folder will appear navigate into it.
  2. Execute npm install to install the node dependencies.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MMM-Wunderlist',
		position: 'top_right',	// This can be any of the regions. Best results in left or right regions.
		header: 'Wunderlist', // This is optional
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Retrieving API Token

FYI: There is no additional registration required, you may use your Wunderlist Creds

Go to Developer.Wunderlist. It does not really matter what you type in here, so you may go with:

Name: MMM-Wunderlist
APP URL: http://localhost
AUTH CALLBACK URL: http://localhost

Hit save and you'll be displayed your clientID. Click on create access token and you'll get the accessToken.

Configuration options

The following properties can be configured:

Option Description
accessToken Your Wunderlist access token, you can get it here.

Possible values: string
Default value: none
clientID Your Wunderlist client id, you can get it here.

Possible values: string
Default value: none
lists Array of lists you want to display.

Possible values: array
Default value: ["inbox"]
Example: ["inbox", "ViRO Entertainment"]
order Order of tasks on the list.

Possible values: "normal", "reversed"
Default value: "normal"
maximumEntries Maximum number of todos to be shown.

Possible values: time in min
Default value: 60
interval How often the module should load new todos.

Possible values: int in seconds
Default value: 60
fade Fade todos to black. (Gradient)

Possible values: true or false
Default value: true
fadePoint Where to start fade?

Possible values: 0 (top of the list) - 1 (bottom of list)
Default value: 0.25
language Localisation for this plugin

Possible values: Moment.js Languages (See node_modules/moment/languages )
Default value: Global Language (As in config.js)
showDeadline Show deadline of a task

Possible values: true or false
Default value: false
deadlineFormat Format for deadlines

Possible values: formats from Moment.js
Default value: L
showAssignee Show assigned user of a task

Possible values: true or false
Default value: false

Dependencies

Known issues

  • After changing your password you'll have to generate a new API-Token
  • When you grant access to a new user and set showAssignee: true , you might have to restart MM to correctly display the assignees
  • Some of requests for users list returns 404 error

The MIT License (MIT)

Copyright © 2016 Paul-Vincent Roll

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

About

This an extension for the MagicMirror. It can display your Wunderlist todos.


Languages

Language:JavaScript 100.0%