MMM-Webuntis

This an extension for the MagicMirror². It allows to display your kids' cancelled and irregular lessons for schools using Untis software to organize school's timetables. You are able to configure access for each of your kids.

Installation

1. Navigate into your MagicMirror²'s modules folder and execute git clone https://github.com/HeikoGr/MMM-Webuntis.
2. Navigate into the new folder MMM-Webuntis and execute npm install to generate the node dependencies.

Update

1. Navigate into your MMM-Webuntis folder and execute git pull.
2. execute npm install to (re-)generate 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-Webuntis",
        position: "top_right",
        header: "Untis",
        config: { // see 'Configuration options' for more information
            students: [
                {
                    title: "1st child's name",
                    qrcode: "untis:[...] "
                },
                {
                    title: "2nd child's name",
                    qrcode: "untis:[...] "
                },
            ]
        }
    }

Configuration options

I Am only able to use (and test) the qrcode login, as the school of our kids unfortunately use MS365 logins. If you have any problems with the other login methods i am not able to help you!

The following properties can be configured:

Option	Description	default value
header	(optional) Printed by MagicMirror² if set
students	Array of untis login credentials objects Possible values: array of objects with the following attributes: title Title of the entry, e.g. kid's name qrcode preferred login-string from qrcode provided by webuntis. You need to login in the student account and go to -> Profile -> Data Access to generate a QR code. Adjust the QR code string to match your credentials: 'untis://setschool?url=[...]&school=[...]&user=[...]&key=[...]&schoolNumber=[...]'; school alternative to qr School name as in the URL after having logged in at webuntis.com. A plus sign (+) in the URL can be replaced by a space. username alternative to qr Username used to login at Untis (optional, only required if the student has a custom login) password alternative to qr Password used to login at Untis (optional, only required if the student has a custom login) server alternative to qr Server as shown in the URL after having logged in at webuntis.com, e.g. kephiso.webuntis.com class Name of class to show (optional, only required if anonymous mode is used) useClassTimetable It seems, that some schools do not provide an individual timetable but only the class timetable. Try to set this to true if you don't receive any elements. Default value: false
days	Number of days to look ahead Possible values: int from 0 to 10. Set to 0 to disable. Can also be specified in the students object to override the module's default value.	7
fetchInterval	Interval in milliseconds to fetch data. (default is 15 minutes)	15 * 60 * 1000
showStartTime	Whether time or lesson order number shall be shown Possible values: true or false The module tries to achieve the timetable of the school and currently assumes that Monday's lesson times are valid for the whole week. When set to false the module matches a start time like "07:40" to "1." for example. Can also be specified in the students object to override the module's default value.	false
showRegularLessons	Boolean to show regular lessons. Can also be specified in the students object to override the module's default value.	false
showTeacher	Boolean to show the teacher's name. Can also be specified in the students object to override the module's default value.	true
shortSubject	Boolean to show the short form of the subject. Can also be specified in the students object to override the module's default value.	false
showSubstText	Boolean to show substitution text. Can also be specified in the students object to override the module's default value.	false
examsDays	Number of days to fetch exams data for. Set to 0 to disable. Can also be specified in the students object to override the module's default value.	0
examsShowTeacher	Boolean to show the teacher's name in exams data. Can also be specified in the students object to override the module's default value.	true
examsShowSubject	Boolean to show the subject in exams data. Can also be specified in the students object to override the module's default value.	true
mode	Show each student as own table, or compact in one table. Possible values: verbose or compact	"compact"
debug	Use only for debug purposes! If set to true, the timetable from WebUntis and the parsed lessons will be printed to the MM log Possible values: true or false	false

How it works

This module may be useful for students at schools using Untis for the organization of time tables. It uses the node.js wrapper of the WebUnits API by TheNoim and retrieves all lessons in a specified number of days time period. It displays cancelled or irregular subjects so that kids are able to prepare for the next day without pulling the information from the Untis app. The module can be configured for several students.

Dependencies

• node.js Wrapper for WebUntis API (installed via npm install)

Screenshot

"mode: verbose":

Attribution

This project is based on work done by Paul-Vincent Roll in the MMM-Wunderlist module. (https://github.com/paviro/MMM-Wunderlist)