Awesome

MMM-PublicTransportBerlin

MMM-PublicTransportBerlin is a module for MagicMirror². It shows live public transport information for Berlin and Brandenburg based on BVG HAFAS data.

MMM-PublicTransportBerlin uses the hafas-client with a BVG-specific profile by derhuerst.

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.

Status

The current development status of this module is: maintained

This means: I'm open for feature requests, pull requests, bug reports, ...

Screenshot

The module looks like this:

Installation

Just clone the module into your MagicMirror modules directory and install the dependencies:

cd ~/MagicMirror/modules
git clone https://github.com/deg0nz/MMM-PublicTransportBerlin
cd MMM-PublicTransportBerlin
npm ci

Update

Just enter your MMM-PublicTransportBerlin directory, pull the update and install the dependencies:

cd ~/MagicMirror/modules/MMM-PublicTransportBerlin
git pull
npm ci

How to get the stationId

You need the stationId for the station whose departures should be displayed.

Here's how to find out the stationId:

1. You have to be in the modules directory (~/MagicMirror/modules/MMM-PublicTransportBerlin).
2. Then run the following command: npm run query.
3. Enter a station name.
4. The result could contain one or more possible stations with valid IDs.
5. Use the appropriate ID as stationId in the configuration of the module.

Note: If you have used our instructions to get the stationId befor March 2023, you certainly use long IDs (12 digits) in your config. We will be upgrading our main dependency (hafas-client) to version 6 in a few months. From this point on, the old (long) IDs will no longer work. We recommend that you switch to the short IDs now. Both short and long IDs currently work.

Configuration

The module is quite configurable. These are the possible options:

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

    {
        module: "MMM-PublicTransportBerlin",
        position: "top_right",
        config: {
            stationName: "Alexanderplatz",
            stationId: "900100003",
            hidden: false,
            ignoredLines: ["U5", "U8", "S75", "Bus 100"],
            excludedTransportationTypes: "bus,suburban,subway",
            travelTimeToStation: 10,
            interval: 120000,
            departureMinutes: 10,
            marqueeLongDirections: true,
            showColoredLineSymbols: true,
            useColorForRealtimeInfo: true,
            showTableHeaders: true,
            showTableHeadersAsSymbols: true,
            maxUnreachableDepartures: 3,
            maxReachableDepartures: 7,
            fadeUnreachableDepartures: true,
            fadeReachableDepartures: true,
            fadePointForReachableDepartures: 0.25,
            excludeDelayFromTimeLabel: true,
            useBrightScheme: true
        }
    },

Multiple Modules

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

Special Thanks

• Michael Teeuw for inspiring me and many others to build a MagicMirror.
• Jannis Redmann for creating the hafas-client. You made my life a lot easier with this! Please consider supporting him on Patreon!
• The community of magicmirror.builders for help in the development process and all contributors for finding and fixing errors in this module.

Contributing

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

Pull requests are of course also very welcome 🙂

Developer commands

• npm run lint - Run linting and formatter checks.
• npm run lint:fix - Fix linting and formatter issues.
• npm run release - Bump version for release.
• npm run test - Run linting and formatter checks + Run spelling check.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.