Skip to content
MagicMirror module to display public transport in Germany (including local networks) using DB-Hafas data.
JavaScript CSS
Branch: master
Clone or download
#2 Compare This branch is 7 commits ahead, 119 commits behind deg0nz:master.
Latest commit 1d1efc4 Mar 22, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img
vendor
.gitignore Fixed an issue, where no departures are shown, if the departures arra… Nov 24, 2016
DbFetcher.js
LICENSE Update LICENSE Dec 2, 2016
MMM-PublicTransportDB.js made some text blocks brighter Dec 7, 2016
README.md Update README.md Dec 2, 2016
node_helper.js Initial change to db-hafas, with some additional features & stuff Dec 1, 2016
package.json
style.css Initial change to db-hafas, with some additional features & stuff Dec 1, 2016

README.md

MMM-PublicTransportDB

MMM-PublicTransportDB is a module for the MagicMirror project by Michael Teeuw.

It shows live public transport information for Germany based on DB-Hafas data. MMM-PublicTransportDB uses the db-hafas library by derhuerst. It primarily displays data from the Deutsche Bahn, but also includes local networks that integrate their data into the DB network. Most, if not all, local transport networks in Germany should work. Following ones are tested:

  • RMV (Rhein-Main/Hessen): missing delays for buses, trams and subway

Notes:

  • The module is working fine. But I think some value combinations could still lead to strange behaviour. I'd appreciate any error report.
  • Fading for departures with delay = 0 is not yet implemented

You can enter a delay time for "How long does it take to get to my station?". Then the module calculates the next reachable departures and draws a line between reachable and unreachable departures.

Screenshot

The module looks like this:

Example for Alexanderplatz with time delay

Installation

Just clone the module into your MagicMirror modules folder and execute npm install in the module directory:

git clone https://github.com/olexs/MMM-PublicTransportDB.git
cd MMM-PublicTransportDB
npm install

How to get the stationId

You will need a stationId for your module from the DB network. TODO Link full list or query target to get station IDs.

Configuration

The module quite configurable. These are the possible options:

Option Description
name The name of the module instance (if you want multiple modules).

Type: string
stationId The ID of the station. How to get the ID for your station is described below.

Type: integer This value is Required.
ignoredStations To allow appearance of multiple transportation methods, vbb-hafas returns departures of multiple stations in the area of the main station (including bus and tram stations for example). You can exclude those stations by adding them to this array. Usually, this can be empty.

Type: integer array (comma separated integers in the array).
Default value: <empty>
excludedTransportationTypes Transportation types to be excluded from appearing on a module instance can be listed here.

Type: string, comma-separated list
Default vaule: <empty>
Possible values: bus, tram, suburban, subway, regional, ferry
marqueeLongDirections Makes a marquee/ticker text out of all direction descriptions with more than 25 characters. If this value is false, the descriptions are trimmed to the station names. You can see a video of it here (rendered by a regular computer).

Note: The rendering on the mirror is not perfect, but it is OK in my opinion. If the movement is not fluent enough for you, you should turn it off.

Type: boolean
Default vaule: true
interval How often the module should be updated. The value is given in milliseconds.

Type: integer
Default value: 120000 // 2 minutes
hidden Visibility of the module.

Type: boolean
Default vaule: false
delay How long does it take you to get from the mirror to the station? The value is given in minutes.

Type: integer
Default vaule: 10 // 10 minutes
departureMinutes For how many minutes in the future should departures be fetched? If delay is set > 0, then this time will be added to now() + delay. (This could be obsolete in future versions but is needed for now.)

Type: integer
Default vaule: 10
showColoredLineSymbols If you want the line colored and shaped or text only.

Type: boolean
Default vaule: true
useColorForRealtimeInfo Set colors for realtime information

Type: boolean
Default vaule: true
showTableHeadersAsSymbols Show the table headers as text or symbols.

Type: boolean
Default vaule: true
maxUnreachableDepartures How many unreachable departures should be shown. Only necessary, of you set delay > 0

Type: integer
Default vaule: 3
maxReachableDepartures How many reachable departures should be shown. If your delay = 0, this is the value for the number of departures you want to see.

Type: integer
Default vaule: 7
fadeUnreachableDepartures Activates/deactivates fading for unreachable departures.

Type: boolean
Default vaule: true
fadeReachableDepartures Activates/deactivates fading for reachable departures.

Type: boolean
Default vaule: true
fadePointForReachableDepartures Fading point for reachable departures.

Type: float
Default vaule: 0.5
Possible values: 0.0 - 1.0

TODO: Add new configuration values

Here is an example of an entry in config.js:

{
    module: 'MMM-PublicTransportBerlin',
    position: 'top_right',
    config: {
        name: "Alexanderplatz",
        stationId: 9160003,
        hidden: false,
        ignoredStations: [9100003,2342,1337], 
        excludedTransportationTypes: 'bus,suburban,subway',   
        delay: 10,
        interval: 120000,
        departureMinutes: 10,          
        maxDepartures: 15,
        marqueeLongDirections: true,
        showColoredLineSymbols: true,  
        useColorForRealtimeInfo: true,
        showTableHeadersAsSymbols: true,
        maxUnreachableDepartures: 3,    
        maxReachableDepartures: 7,
        fadeUnreachableDepartures: true,
        fadeReachableDepartures: true,
        fadePointForReachableDepartures: 0.25
    }
},

Multiple Modules

Multiple instances of this module are possible. Just add another entry of the MMM-PublicTransportBerlin module to the config.js of your mirror.

Special Thanks

Issues

If you find any problems, bugs or have questions, please open a GitHub issue in this repository.

You can’t perform that action at this time.