MMM-Vrr
MMM-Vrr copied to clipboard
Klizzy
🚌🚏🚅 Displays information about the upcoming departure of public transport within Germany, NRW. Module for MagicMirror
MMM-Vrr and more areas
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 :star: on GitHub to show support.
Installation
- Navigate into your MagicMirror's
modulesfolder. - Execute
git clone https://github.com/Klizzy/MMM-Vrr.git. - Execute
cd MMM-Vrr. - 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 :coffee: & plant a 🌳 at the same time
- give this Project a :star: on GitHub.
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.
Visualization of the scrollAfter option
If you set scrollAfter:15, the text will be scrolled horizontally if it has 15 or more characters.
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 [email protected]! Feel free to suggest additional features and / or improvements trough a Github issue.
Changelog
See changelogs.md to view changes and contributors.
Klizzy