Quick Start - HeikoGr/MMM-Webuntis GitHub Wiki

Quick Start

This page gives you the fastest route to a working setup.

Minimal QR-Code Example

{
  module: 'MMM-Webuntis',
  position: 'top_right',
  config: {
    displayMode: 'grid, lessons, exams',
    students: [
      {
        title: 'Alice',
        qrcode: 'untis://setschool?url=myschool.webuntis.com&school=myschool&user=alice&key=ABC123...',
      },
    ],
  },
}

Minimal Username/Password Example

{
  module: 'MMM-Webuntis',
  position: 'top_right',
  config: {
    displayMode: 'lessons, exams',
    students: [
      {
        title: 'Alice',
        username: 'alice.smith',
        password: 'secret',
        school: 'myschool',
        server: 'myschool.webuntis.com',
      },
    ],
  },
}

Good Defaults For A First Run

  • Leave logLevel unset unless you are debugging; MagicMirror's global logLevel then applies.
  • Start with one student only.
  • Use displayMode: 'lessons, exams' or displayMode: 'grid, lessons, exams'.
  • Prefer QR login if your school uses SSO.

What To Configure Next