Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Elaniobro/MMM-nyc-transit
MTA transit module for Magic Mirror
https://github.com/Elaniobro/MMM-nyc-transit
Last synced: 22 days ago
JSON representation
MTA transit module for Magic Mirror
- Host: GitHub
- URL: https://github.com/Elaniobro/MMM-nyc-transit
- Owner: Elaniobro
- License: mit
- Created: 2018-09-08T19:03:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T12:05:54.000Z (6 months ago)
- Last Synced: 2024-08-04T10:03:17.805Z (4 months ago)
- Language: JavaScript
- Size: 1.58 MB
- Stars: 20
- Watchers: 7
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-NYC-Transit**
README
# MTA transit module for MagicMirror²
## 🛡 Badges
 
 [](#contributors)  
  
## ℹ️ How to use this module
1. clone this repo into your moducles directory with the following command: `git clone https://github.com/Elaniobro/MMM-nyc-transit`
2. install all the npm modules with either `yarn install` or `npm install`
3. update your [MagicMirror² Config](https://github.com/MichMich/MagicMirror/blob/master/config/config.js.sample), by adding the following object:
```javascript
{
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
}
}
```
## 🛠️ Config
* `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 list
* `list` - 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](#🔑-mta-api-Key) on where to obtain yours.
* `mtaType` _coming soon, choose bus and or train_
* `stations` array to store each station config.
* `stationId` find your [station(s)](#-station-list) 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 show
* `upTown` boolean value
* `downTown` boolean value
* `updateInterval` default is set to 5 minutes
* __low interval will result in your MTA api key timing out__
## 🔑 MTA API Key
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](https://api.mta.info/).
## 🚆 Station List
Find the corresponding `Name` and `id` in the [STATION_LIST.md](STATION_LIST.md) object to insert into the config array.
## ✨ Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please open an issue](https://github.com/elaniobro/mmm-nyc-transit/issues)
## 👨🏻 Author
**Elan Trybuch**
* [github](https://www.github.com/elaniobro)
* [twitter](https://www.twitter.com/elaniobro)
### ⚖️ License
This project is licensed under the MIT License - see the LICENSE.md file for details
### 🙏🏽 Acknowledgments
* [Eric Lewis](https://github.com/ericandrewlewis/mta-realtime-subway-departures/blob/master/package.json)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Elan Trybuch
🎨 💻 👀 📖 🚧 🚇
Eric Lewis
💻
Kendiggity973
🤔 🐛
dahlio
🤔 🐛
jon7187
🐛 🤔 💡
nipper2000h
🐛
Kurt Raschke
🐛 💻
Julian Graham
🐛 💻
Kristjan ESPERANTO
🚧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!