/MMM-WebUntis

A MagicMirror² module to display WebUntis timetables.

Primary LanguageJavaScriptMIT LicenseMIT

MMM-WebUntis

A MagicMirror² module to display WebUntis timetables.

Dependencies

Installation

  1. Navigate to the /modules folder of you MagicMirror²
  2. Clone this repository using the following command: git clone https://github.com/amonelias/MMM-WebUntis.git
  3. Navigate to the /MMM-WebUntis folder and install dependencies using the following command: npm install

Config

Option Description
refreshTime Default: 100000
Time interval to refresh data in miliseconds

Type: number
url WebUntis URL of the school

Type: string
school Name of the school

Type: string
class Name of the class

Type: string
days Default: 1
Days to fetch and display starting from the current day

Type: number
dateformat Default: "en-EN"
Format of the displayed dates

Type: string
timeformat Default: "en-DE"
Format of the displayed times

Type: string

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

  {
    module: 'MMM-WebUntis',
    position: 'top_right', // any possible region
    config: {
      refreshTime: 100000,
      url: "",
      school: "",
      class: "",
      days: 1,
      dateformat: "en-EN",
      timeformat: "en-DE",
    },
  },

Update

Navigate to the folder of the module in the /modules folder and get the latest version using the command git pull.