Skip to content
/ MMM-Vrr Public

๐ŸšŒ๐Ÿš๐Ÿš… Displays information about the upcoming departure of public transport within Germany, NRW. Module for MagicMirror

License

Notifications You must be signed in to change notification settings

Klizzy/MMM-Vrr

Repository files navigation

MMM-Vrr and more areas

setup and tests

This is a module for the MagicMirrorยฒ.

This module is designed to provide users with up-to-date information about the upcoming departure times of trains, subways, and buses from any station in the North Rhine-Westphalia VRR region of Germany.

This module was intended for the public transport of VRR, but it also supports the following areas.

If you like this module, consider to give this project a โญ on GitHub to show support.

displayType detail ย ย  displayType digital

Installation

  1. Navigate into your MagicMirror's modules folder.
  2. Execute git clone https://github.com/Klizzy/MMM-Vrr.git.
  3. Execute cd MMM-Vrr.
  4. Execute npm install.

Using the module

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

{
    module: 'MMM-Vrr',
    position: "top_right",
    config: {
        city: 'Dรผsseldorf',
        station: 'Hauptbahnhof',
        numberOfResults: 10,
        displayTimeOption: 'countdown',
        displayType: 'detail'
    }
}

Configuration options

Option Description Options LCD type support
city Required German City Name

Type: String (default: Dรผsseldorf)
Any City Name in North Rhine-Westphalia โœ…
station Required German Station Name

Type: String (default: Hauptbahnhof)
Any Station Name in North Rhine-Westphalia โœ…
numberOfResults Optional Number of results to be displayed

Type: Int (default: 10)
* โœ…
displayType Optional Changes the display type

Type: String (default: 'detail')
'detail', 'lcd' โœ…
displayIcons Optional Display fontawsome icons

Type: boolean (default: true)
false โŒ
updateInterval Optional Sets the Update Interval int

Type: int(milliseconds)
Default 60000 milliseconds (1 minute)
* (API result is always cached for 1 Min) โœ…
displayTimeOption Optional Changes the type of time

Type: String (default: 'countdown')
'time', 'time+countdown', 'countdown' โŒ
setWidth Optional Sets the width of the module in pixel

Type: int (default: false)
Any posible size like: 450 โŒ
lcdWidth Optional Sets the width of the lcd display type

Type: int (default: 450)
any possible size โœ…
scrollAfter Optional Scrolls the destination text after the specified characters

Type: int (default: false)
any possible size or false โŒ
withoutDestination Optional Only show results without destination. Supports a list of strings, separated by comma (",").

Type: list of strings (default: empty list (show all destinations))
any possible list (e.g., ["Aachen, Hbf,Aachen","Duisburg Hbf"]) โŒ
platform Optional Only show platform. Supports multiple strings, separated by comma (",").

Type: string (default: empty (show all platforms))
any possible string (e.g., "2,3") โœ…
line Optional Only show lines that start with the given string. Supports multiple strings, separated by comma (",").

Type: string (default: empty (i.e., show all lines))
any possible string (e.g., "RB33,U") โœ…

Support

If you like my module and want to thank, you could consider:

  • buying Buy me a โ˜• & plant a ๐ŸŒณ at the same time
  • give this Project a โญ on GitHub.

Buy Me A Coffee

Supported Languages

Currently only de and en is supported. Gets the Value from the Global Magic Mirror language config.

"LCD" Display

This view can be set if displayType: 'lcd' has been set.

Not all config parameters are supported in this mode. Check the parameters within the "Configuration options" table.

lcd

Visualization of the scrollAfter option

If you set scrollAfter:15, the text will be scrolled horizontally if it has 15 or more characters.

Auto scroll

EFA Support for other Areas

Please keep in mind, that everything besides VRR is not full supported. You can check your station and city combination beforehand here

Possible Side effects for non VRR areas:

  • Icons don't match correctly
  • not all configured transport types hide correctly

Partly supported Areas:

  • ASEAG
  • BSVG
  • DING
  • IVB
  • KVV
  • LinzAG
  • NVBW
  • SVV
  • TLEM
  • VBL
  • VGN
  • VMV
  • VOR
  • VRN
  • VVO
  • VVS
  • VVV
  • BVG
  • DB
  • NAHSH
  • NASA
  • NVV
  • RSAG
  • SBB
  • VBB
  • VBN
  • ร–BB

Check if your station is supported

This application uses the provided API from vrrf.finalrewind.org. If your desired station and city combination returns a result, its highly possible that MMM-Vrr supoorts it also.

Feedback

It's my first Open Source Project, so it would be nice if you share your experience with this module with me hello@klizzy.com! Feel free to suggest additional features and / or improvements trough a Github issue.

Changelog

See changelogs.md to view changes and contributors.

About

๐ŸšŒ๐Ÿš๐Ÿš… Displays information about the upcoming departure of public transport within Germany, NRW. Module for MagicMirror

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •