MagicMirror Canvas Calendar

This is a module for MagicMirror² which displays upcoming assignments from the Canvas LMS via the built-in iCal calendar feed. No API token is required. The Canvas LMS is used by colleges, universities and other institutions for coursework.

1. Clone this repository into your MagicMirror modules folder.

cd /MagicMirror/modules
git clone https://github.com/dbeltjr/MMM-CanvasCalendar.git
cd MMM-CanvasCalendar
npm install

2. Get your Canvas iCal feed URL. In Canvas, go to Calendar → Calendar Feed (bottom left of the calendar page). Copy the URL shown.

3. Edit your configuration file under config/config.js with the following configuration.

{
  module: "MMM-CanvasCalendar",
  position: "top_right",
  header: "CANVAS | OT 511 | PP500",
  config: {
    maximumEntries: 5,
    maximumNumberOfDays: 365,
    maxTitleLength: 50,
    fontSize: "small",
    keywordColors: [
      { keyword: "OT 511", color: "lightsalmon" },
      { keyword: "PP500",  color: "cyan" },
    ],
    calendars: [
      { url: "https://yourschool.instructure.com/feeds/calendars/user_XXXXX.ics" }
    ],
  }
},

The keywordColors array drives color coding for both the assignment list and the module header. Any keyword found in the header string will also be colorized, so your header doubles as a color-coded legend.

header: "Assignments | OT 511 | PP500",
keywordColors: [
  { keyword: "OT 511", color: "lightsalmon" },
  { keyword: "PP500",  color: "cyan" },
],

This accepts all CSS color values. Named colors like lightsalmon, cyan, and lightgreen work well for readability on a dark background. See CSS Colors for the full list.

If there are assignments you do not want displayed, add any part of the title to excludedEvents:

excludedEvents: [
  "Student Introductions",
  "Course Preparation Verification",
],

Any assignment whose title contains that text will be hidden from the list.

• The Canvas iCal feed does not include submission status. Completed assignments will remain visible until their due date has passed.
• The feed updates on Canvas's own schedule (typically within minutes of changes). MagicMirror polls the feed every hour by default, configurable via fetchInterval.
• If your institution has locked down API token generation, this module is designed as a token-free alternative using the standard iCal feed.

MagicMirror²: MagicMirror²

Original MMM-Canvas module: dbeltjr/MMM-Canvas

Based on the MagicMirror² default Calendar module: MagicMirrorOrg/MagicMirror