https://github.com/falafel2222/MMM-BartTimes

https://github.com/falafel2222/MMM-BartTimes

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/falafel2222/MMM-BartTimes
• Owner: falafel2222
• License: mit
• Created: 2019-04-15T06:57:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-23T23:37:16.000Z (over 4 years ago)
• Last Synced: 2024-08-04T10:03:17.954Z (4 months ago)
• Language: JavaScript
• Size: 26.4 KB
• Stars: 1
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-BartTimes**

README

        
# MMM-BartTimes

Magic Mirror module that displays the upcoming departure times for all BART (Bay Area Rapid Transit) lines at a certain station.

This exists thanks to BART providing an easy public API, which can be found [here](http://api.bart.gov/docs/overview/index.aspx)

### Installation

1. Navigate to the magic mirror modules directory and clone this repository there.

2. Inside the `MMM-BartTimes` folder, run `npm install url requests` to install the two required dependencies.

3. Modify `config.js` to include `MMM-BartTimes`. An example config can be seen below.

### Configuration

| Config Option | Type | Description |

|:------------- |:--------- |:----------- |

| `station` | string | The station abbreviation for your BART station of choice. Abbreviations can be found [here](http://api.bart.gov/api/stn.aspx?cmd=stns&key=MW9S-E7SL-26DU-VV8V) (under the tag ``). |

| `key` | string (optional) | API key if you want your own so you aren't at the mercy of BART changing their public one.  You can request a key [here](http://api.bart.gov/api/register.aspx). |

| `train_blacklist` | list of strings (optional) | Line names included in this list will not be displayed on your Magic Mirror.|

Example configuration file:

```

{

	module: 'MMM-BartTimes',

	position: 'top_left',

	config: {

		station: '19th',

		train_blacklist: ['Dublin/Pleasanton'],

		key: 'IFYO-UWAN-TYOU-ROWN',

	}

},

```

### Screenshot

When working, the display should look something like this:

![MMM-BartTimes screenshot](screenshot.png)