README.md

MMM-MTA-NextBus

This is a module for the MagicMirror². It tells you when the next bus arrives at your bus stop. This is for people that live in New York City.

Installation

Navigate into your MagicMirror's modules folder and execute git clone https://github.com/tie624/MMM-MTA-NextBus.git.

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-MTA-NextBus',
            position: "bottom_right",   // This can be any of the regions.
            config: {
                // See below for configurable options
            }
        }
    ]
}

Configuration options

Option	Description
apiKey	Required Your MTA Bus Time API key. If you don't have one, you can request one here. Type: string Default value: none
busStopCode	Required The 6 digit bus stop code to monitor. You can get it from your bus stop or find it here. Type: string Default value: none
timeFormat	Optional Use 12 or 24 hour format. Possible values: 12 or 24 Default value: uses value of config.timeFormat
maxEntries	Optional The maximum number of buses to display. Possible values: 1 to 10 Default value: 5
updateInterval	Optional How often to check for the next bus. Type: int Default value: 60000 milliseconds (1 minute)