- clone this repo into your moducles directory with the following command:
git clone https://github.com/Elaniobro/MMM-nyc-transit
- install all the npm modules with either
yarn install
ornpm install
- update your MagicMirrorΒ² Config, by adding the following object:
{
module: 'MMM-nyc-transit',
position: "top_bar",
header: "Next Train",
config: {
apiKey: 'YOUR_KEY_HERE',
displayType: 'list',
mtaType: 'train',
stations: [
{
stationId: 237,
walkingTime: 5,
dir: {
upTown: false,
downTown: true
}
},
{
stationId: 177,
walkingTime: 5,
dir: {
upTown: true,
downTown: false
}
}
],
updateInterval: 300000
}
}
module
the name of the module you are installing.position
where you want the mmm-nyc-transit module to appear.- note: configurable, see MM documentation
header
display name for what you want to call your module on screen- note: optional
displayType
choose between scrolling marquee (default) or listlist
- shows next 3 trains for each line, both uptown and downtown- note: works best on side
marquee
- shows next 6 trains, 3 for uptown and 3 for downtown- note: works best on top
apiKey
see mta api Key on where to obtain yours.mtaType
coming soon, choose bus and or trainstations
array to store each station config.stationId
find your station(s) id(s).walkingTime
allows you to pad the realtime data time, with travel time to the station.dir
object to hold which directions of the train to showupTown
boolean valuedownTown
boolean value
updateInterval
default is set to 5 minutes- low interval will result in your MTA api key timing out
You will need to sign up for the MTA Real-Time Data Feeds API. To get a key, please visit their website: api.mta.info.
Find the corresponding Name
and id
in the STATION_LIST.md object to insert into the config array.
Pull requests and stars are always welcome. For bugs and feature requests, please open an issue
Elan Trybuch
This project is licensed under the MIT License - see the LICENSE.md file for details
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!