README.md

MMM-SwissCommute

This is a module for the MagicMirror².

It displays the next departures for your favorite (train) connection including delays and track change information.

This module is based on the search.ch Fahrplan API https://fahrplan.search.ch/api/help

Using the module

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

modules: [
	{
		module: 'MMM-SwissCommute',
		position: 'bottom_left',
		header: 'Train Connections',
		config: {
			from: 'Zürich HB', // Start train station
			to: 'Basel SBB', // Destination station
			maximumEntries: 4, // Max departures displayed
			minWalkingTime: 10 // Minimum time to get to the station
		}
	},
]

Configuration options

Option	Description
from	Required Departure station
to	Required Destination station
maximumEntries	Optional Maximum number of entries in list Type: int Default 10
minWalkingTime	Optional Minimum time in minutes to reach the from station. Used to highlight a connection in red in case cannot be reached in time Type: int Default -1
hideTrackInfo	Optional Hide the track column Type: int Default 0