Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cbrooker/MMM-Todoist
This is an extension for the MagicMirror2 platform. It will display your Todoist todos on your MagicMirror.
https://github.com/cbrooker/MMM-Todoist
magicmirror mmm-todoist todoist-todos
Last synced: 23 days ago
JSON representation
This is an extension for the MagicMirror2 platform. It will display your Todoist todos on your MagicMirror.
- Host: GitHub
- URL: https://github.com/cbrooker/MMM-Todoist
- Owner: cbrooker
- License: mit
- Created: 2016-08-31T19:46:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T18:43:33.000Z (4 months ago)
- Last Synced: 2024-08-14T20:24:41.249Z (4 months ago)
- Topics: magicmirror, mmm-todoist, todoist-todos
- Language: JavaScript
- Homepage:
- Size: 731 KB
- Stars: 151
- Watchers: 10
- Forks: 58
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-Todoist**
README
# MMM-Todoist
** Developer is not actively maintaining this Extension. **
This an extension for the [MagicMirror](https://github.com/MichMich/MagicMirror). It can display your Todoist todos. You can add multiple instances with different lists. Only one account supported.
The requests to the server will be paused is the module is not displayed (use of a carousel or hidden by Remote-Control for example) or by the use of a PIR sensor and the module MMM-PIR-Sensor. An immediate update will occurs at the return of the module display.
## Installation
1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/cbrooker/MMM-Todoist.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:
````javascript
modules: [
{
module: 'MMM-Todoist',
position: 'top_right', // This can be any of the regions. Best results in left or right regions.
header: 'Todoist', // This is optional
config: { // See 'Configuration options' for more information.
hideWhenEmpty: false,
accessToken: 'accessToken from Todoist',
maximumEntries: 60,
updateInterval: 10*60*1000, // Update every 10 minutes
fade: false,
// projects and/or labels is mandatory:
projects: [ 166564794 ],
labels: [ "MagicMirror", "Important" ] // Tasks for any projects with these labels will be shown.
}
}
]
````
## Configuration options
The following properties can be configured:
Option
Description
accessToken
Your Todoist access token
Possible values: string
Default value: none
Note: You can use one of three values here.
- the access token created during the oAuth process associated with your app in the App Management consol
- the "test token" generated in the App Management consol without going through the steps of the oAuth token (For the web site value requested, you can use "http://example.com" if you don't have a website)
- the "API token" found in your account's Integration > Developer settings
blacklistProjects
When this option is enabled,
projects becomes a blacklist.
Any project that is not in
projects will be used.Possible values:
boolean
Default value:
false
Example:
true
NB: If used in combination with
labels, tasks that are in a blacklisted
project but match a label will still be shown!
projects
Array of ProjectIDs you want to display.
Possible values:
array
Default value:
[ ]
Example:
[166564794, 166564792]
Getting the Todoist ProjectID:
1) Go to Todoist (Log in if you aren't)
2) Click on a Project in the left menu
3) Your browser URL will change to something like
"https://todoist.com/app?lang=en&v=818#project%2F166564897"Everything after %2F is the Project ID. In this case "166564897"
Alternatively, if you add debug=true in your config.js the Projects and ProjectsIDs will be displayed on MagicMirror as well as in the Browser console.
This value and/or the labels entry must be specified. If both projects and labels are specified, then tasks from both will be shown.
labels
Array of label names you want to display.
Possible values:
array
Default value:
[ ]
Example:
["MagicMirror", "Important", "DoInTheMorning"]
This value and/or the projects entry must be specified. If both projects and labels are specified, then tasks from both will be shown.
maximumEntries
Maximum number of todos to be shown.
Possible values:
int
Default value:
10
updateInterval
How often the module should load new todos. Be careful, this is in ms, NOT seconds! So, too low a number will lock you out for repeated server attempts!
Possible values:
int in milliseconds
Default value:
10*60*1000
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
fadeMinimumOpacity
Opacity of the last item if fade is enabled.
Possible values:
0 (last item is completely transparent) - 1 (no fade)
Default value:
0.25
showProject
If true this will display the Project to the right of the DueDates as it does on Todost.
Possible values:
boolean
Default value:
true
sortType
This will determine the sorting method used when displaying your Todos.
Possible values:
"todoist" - Sort based on the order in Todoist.
"priority" - Sort based on the priority, in Descending order. (Highest priority first)
"dueDateAsc" - Sort based on the Due Date of the Todo Ascending. (Oldest date first)
"dueDateDesc" - Sort based on the Due Date of the Todo Descending. (Newest date first)
"dueDateDescPriority" - Sort based on the Due Date of the Todo Descending and by priority high to low.
Default value:
"todoist"
displayLastUpdate
If true this will display the last update time at the end of the task list. See screenshot below
Possible values:
boolean
Default value:
false
displayLastUpdateFormat
Format to use for the time display if displayLastUpdate:true
Possible values: See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/)
Default value:
'dd - HH:mm:ss'
wrapEvents
If true this will display the long tasks on several lines, according on the value
maxTitleLength. See screenshot below. Possible values:
boolean
Default value:
false
maxTitleLength
Value cut the display of long tasks on several lines. See screenshot below
Possible values:
10 - 50
Default value:
25
displayTasksWithinDays
If non-negative, only display tasks with a due date within
displayTasksWithinDays days. For instance, setting this to 0 will only show tasks due today or overdue. This will not affect tasks without a due date, displayTasksWithoutDue controls those.Possible values:
-1 - ∞
Default value:
-1 (filtering disabled)
displayTasksWithoutDue
Controls if tasks without a due date are displayed.
Possible values:
boolean
Default value:
true
displaySubtasks
Controls if subtasks are displayed or not.
Possible values:
boolean
Default value:
true
displayAvatar
Display avatar images of collaborators assigned to tasks in shared projects.
Possible values:
boolean
Default value:
false
hideWhenEmpty
Hide widget when all lists are empty (including header).
Possible values:
boolean
Default value:
false
## Dependencies
- [request](https://www.npmjs.com/package/request) (installed via `npm install`)
# Screen shots
A few sample Screen Shots to show you what this module looks like. It's fairly configurable and changes considerably depending on how you use Todoist, how many projects you include, and how you sort.
Option enabled: displayAvatar: true
Option enabled: displayLastUpdate: true, wrapEvents: true, maxTitleLenght: 25
Options enabled: orderBy:todoist, showProjects: true
Options enabled: orderBy:dueDateAsc, showProjects: true
Options enabled: orderBy:dueDateAsc, showProjects: false
Options enabled: orderBy:todoist, showProjects: false
Options enabled: orderBy:todoist, showProjects: true
Options enabled: orderBy:dueDateAsc, showProjects: true
Options enabled: orderBy:dueDateAsc, showProjects: false
## Attribution
This project is based on work done by Paul-Vincent Roll in the MMM-Wunderlist module. (https://github.com/paviro/MMM-Wunderlist)
The MIT License (MIT)
=====================
Copyright © 2016 Chris Brooker
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.**