README.md

MMM-SwissStationboard

This is a module for the MagicMirror².

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

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

Special thanks to nixnuex https://github.com/nixnuex/MMM-SwissCommute

Example

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/vanhoekd/MMM-SwissStationboard

Configure the module in your config.js file.

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-SwissStationboard',
		position: 'bottom_left',
		header: 'Train Connections',
		config: {
			stop: 'Bern', // Start train station
			maximumEntries: 4, // Max departures displayed
			minWalkingTime: 10, // Minimum time to get to the station
			hideNotReachable: 0, //Will hide all the not reachable connections
		}
	},
]

Configuration options

Option	Description
stop	Required Departure station or its ID. can by found through https://fahrplan.search.ch/api/stationboard.json?limit=1&stop=Einsiedeln
maximumEntries	Optional Maximum number of entries in list Type: int Default 10
minWalkingTime	Optional Minimum time in minutes to reach the stop station. Used to display the connection in dark grey in case it is not reachable in time Type: int Default -1
hideTrackInfo	Optional Hide the track column Type: int Default 0
hideNotReachable	Optional Hide the connections that are not reachable within walking time Type: int Default 0

Dependencies

This module uses the https://fahrplan.search.ch API Which is free for up to 1000 Calls per day and does not require a key.

Troubleshooting

I try to maintain this module in best effort. If there is any Problem, please write a detailed description into this forum and i will try to look into it as soon as possible: https://forum.magicmirror.builders/topic/6342/mmm-swissstationboard