-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added installation and configuration information
- Loading branch information
Showing
2 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,53 @@ | ||
# ÖBB Station arrivals and departures | ||
# ÖBB Station Board | ||
|
||
Show arrivals and departures of a specific ÖBB station | ||
|
||
![Screenshot of the module in Action. Shows the name of the station and the next 4 connections.](./assets/screenshot.jpg) | ||
|
||
> Thanks to @mymro for creating the [oebb-api](https://github.com/mymro/oebb-api) which is used the get information for the stations. | ||
## Installation | ||
|
||
1. Clone the Repo into your MagicMirror modules folder `git clone [email protected]:mscharl/MMM-oebb-station-board.git` | ||
2. Install some node dependencies `cd MMM-oebb-station-board && npm install --production` | ||
3. [Configure](#configuration) and enjoy | ||
|
||
## Configuration | ||
|
||
| Property | Description | | ||
|---------------------|---------------------------------------------------| | ||
| `stationNumber` | The number of the station. Can be determined with the [helper script](#get-a-station-id).| | ||
| `direction` | The number of the station in which the shown connection are heading. Can be determined with the [helper script](#get-a-station-id). | | ||
| `boardType` | Switch between `dep` for departure or `arr` for arrival. Default is `dep`. | | ||
| `maxConnections` | The maximum number of connections to show. Default is `4`.| | ||
| `connectionTypes` | Filter the shown transportation types. See [Connection Types](#connection-types) for more. Shows all connections by default. | | ||
|
||
|
||
### Get a station ID | ||
To load data for you desired station you first need the ID of the station. The module includes a little helper to get this ID. | ||
|
||
1. Run `npm install --production` if you did not already. | ||
2. Run `npm run stationFinder`. | ||
3. Follow the instructions. | ||
|
||
### Connection Types | ||
|
||
The `connectionTypes` property can be undefined to show all connections. | ||
To show only specific types pass an object with one or more of the following flags. | ||
|
||
| Property | Description | | ||
|----------|-------------| | ||
| `Railjet` | Shows Railjet trains when `true`. | | ||
| `ECandICE` | Shows EC and ICE trains when `true`. | | ||
| `DandEuronightAndNightjet` | Shows D, Euronight and Nightjet trains when `true`. | | ||
| `Regional` | Shows regional trains when `true`. | | ||
| `SBahn` | Shows Schnellbahn trains when `true`. | | ||
| `Bus` | Shows Buses when `true`. | | ||
| `Subway` | Shows Subways when `true`. | | ||
| `Tram` | Shows Trams when `true`. | | ||
| `Westbahn` | Shows Westbahn trains when `true`. | | ||
| `AST` | Shows AST when `true`. | | ||
|
||
## Planned Features | ||
- [ ] Combine multiple stations in one board | ||
- [ ] Combine multiple directions per station |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.