Skip to content

Latest commit

 

History

History
130 lines (118 loc) · 4.25 KB

README.md

File metadata and controls

130 lines (118 loc) · 4.25 KB
Raw

MMM-vvsDeparture

A MagicMirror2 Module to display information about public transport in Stuttgart, Germany.

The MMM-vvsDeparture module is a module designed to display the departures times as stations along the Stuttgart public transportation system. It is configurable based on the stations to get destination times for, destinations to exclude and other options.

It also will show any delays, based on the real time information provided by VVS.

Example:

Full

Installation

Run these commands at the root of your magic mirror install.

cd modules
git clone https://github.com/niklaskappler/MMM-vvsDeparture

Using the module

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

var config = {
    modules: [
        {
            module: 'MMM-vvsDeparture',
            position: "top_right",
            config: {
                station_id: '<YOUR_STATION_ID_HERE>',
                // See below for more configurable options
            }
        }
    ]
}

Note that a position setting is not required.

Configuration options

The following properties can be configured:

Option Description
station_id A value which represents the station id of the station. The id is combined of the area prefix de:08111 and the unique station id e.g 6112 which result to de:08111:2201. Here is a full list of all station with corespnding ids within the VVS public transport network, to find your station (https://www.openvvs.de/dataset/1f7ec4c1-b590-4751-a25b-57ef988c14b6/resource/d87d1f01-5c14-4d08-8452-e405a6472ab4/download/vvs_haltestellen.csv).

Possible values: integer
Default value: de:08111:6112
station_name The displayed name for your station.

Possible values: string
Default value: undefined
maximumEntries Number of departure entries which will be shown.

Possible values: integer
Default value: 6
reloadInterval The refresh rate departure entries will be updated in milliseconds.

Possible values: integer
Default value: 1 * 60 * 1000 e.q. one minute
colorDelay Define if the delay value should be colorized.

Possible values: boolean
Default value: true
colorNoDelay Define if the no delay value should be colorized.

Possible values: boolean
Default value: true
number Define the lane number which should be displayed. With this you can hide numbers you don't want to see.

Possible values: String / Array / Function
Default value: undefined
direction Define the lane direction which should be displayed. With this you can hide numbers you don't wont to see.

Possible values: String / Array / Function
Default value: undefined
offset Define the offset in minutes. Show connections only starting in the offset minutes.

Possible values: integer
Default value: undefined