Skip to content

Commit

Permalink
Add warning to direction option
Browse files Browse the repository at this point in the history
See #193 for details.
  • Loading branch information
KristjanESPERANTO committed Jan 18, 2025
1 parent 41377db commit 2ac3e4c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ The module is quite configurable. The only option you really have to set is `sta
| `headerPrefix` | <p>The text to be prepended to the `stationName`.</p><p>**Type:** `string`<br>**Example:** `"von"` (Will result in “von Wilhelm-Leuschner-Platz” being displayed.)<br>**Default value:** `""`</p><p>**Note:** A blank between `headerPrefix` and `stationName` is automatically inserted.</p>|
| `headerAppendix` | <p>The text to be prepended to the `stationName`.</p><p>**Type:** `string`<br>**Example:** `"(Richtung HBF)"`<br>**Default value:** `""`</p><p>**Note:** A blank between `headerAppendix` and `stationName` is automatically inserted.</p>|
| `updatesEvery` | <p>The time in seconds when the displayed departures should be updated.</p><p>**Type:** `integer`<br>**Example:** `60` (The departures will be refreshed every minute.)<br>**Default value:** `120`<br>**Unit:** `seconds`</p><p>**Note:** The minimal refresh time is 30 seconds.</p>|
| `direction` | <p>An ID of a station. It is used to display only those departures heading to this station.</p><p>**Type:** `string`<br>**Example:** `"954609"`<br>**Default value:** `""`</p><p>**Note:** It is not necessary to find the ID of the end station. Just use the next station which is on the route you are after.<br>It is not possible to list multiple IDs. If you want to display different directions for one station use multiple instances of this module.</p>|
| `direction` | <p>An ID of a station. It is used to display only those departures heading to this station.</p><p>**Type:** `string`<br>**Example:** `"954609"`<br>**Default value:** `""`</p><p>**Note:** It is not necessary to find the ID of the end station. Just use the next station which is on the route you are after.<br>It is not possible to list multiple IDs. If you want to display different directions for one station use multiple instances of this module.</p><p>**Warning!** This option now doesn't work as expected when using the default db profile. Please check out the issue [#193](https://github.com/KristjanESPERANTO/MMM-PublicTransportHafas/issues/193#issuecomment-2599743884) for more details.</p>|
| `ignoredLines` | <p>An array of strings describing the lines you want to exclude from the displayed departures.</p><p>**Type:** `array`<br>**Example:** `[ "STR 11", "STR 10" ]` (Displays all lines except tram 10 and 11.)<br>**Default value:** `[]`</p><p>**Note:** You need to provide the line names exactly as they are otherwise displayed. This setting is case sensitive. Blanks need to be exactly as they are display. If a line is usually displays as `BUS 89` (two blanks) you need to type exactly that into the array.</p>|
| `ignoreRelatedStations` | <p>Ignore departures from related stations or not.</p><p>**Type:** `boolean`<br>**Default value:** `false`<br>**Possible values:** `true` and `false`<p>**Note:** Usually you don't need to touch this option.</p>|
| `excludedTransportationTypes` | <p>An array of strings describing the transportation types you want to exclude from the displayed departures.</p><p>**Type:** `array`<br>**Example:** `[ "suburban", "bus" ]`<br>**Default value:** `[]`<br>**Possible values:** <table><tr><th>Type</th><th>Use in Germany</th></tr><tr><td>`"bus"`</td><td>bus</td></tr><tr><td>`"ferry"`</td><td>F&auml;hre</td></tr><tr><td>`"express"`</td><td>?</td></tr><tr><td>`"national"`</td><td>IC trains</td></tr><tr><td>`"nationalExpress"`</td><td>ICE trains</td></tr><tr><td>`"regional"`</td><td>RB or RE</td></tr><tr><td>`"suburban"`</td><td>S-Bahn</td></tr><tr><td>`"subway"`</td><td>U-Bahn</td></tr><tr><td>`"tram"`</td><td>Tram</td></tr><tr><td>`"taxi"`</td><td>Taxi</td></tr></table></p>|
Expand Down

0 comments on commit 2ac3e4c

Please sign in to comment.