README
ioBroker.fahrplan
Fahrplan Adapter für ioBroker
Deutsch
Dieser Adapter für ioBroker verwendet die mobile API von HAFAS verwendet. HAFAS steht für HaCon Fahrplan-Auskunfts-System und wird von vielen europäischen Verkehrsunternehmen verwendet, unter anderem auch von der Deutschen Bahn. Der Zugriff auf HAFAS erfolgt hierbei über HAFAS-Client.
Der Adapter bietet hierbei drei Funktionen:
Fahrplan für Verbindungen (Routen)
Die gewünschten Routen müssen in der Adapterkonfiguration eingerichtet und aktiviert werden. Über einen konfigurierbaren Intervall ruft der Adapter dann regelmäßig die Verbindungsinformationen ab. Die nächsten drei Verbindungen werden als HTML und optional auch detailiert als Objekte in ioBroker dargestellt. Das HTML-Objekt kann einfach in VIS eingebunden werden.
Benachrichtigung bei Verspätungen der Routen
Für die konfigurierten Routen kann ein Verspätungsalarm aktiviert werden. So kann beispielsweise eine Benachrichtigung via Telegram oder Alexa erfolgen, falls alle oder eine bestimmte Verbindung verspätet ist.
Abfahrtstafeln für Stationen
Zusätzlich bietet der Adapter eine Abfahrtstafel für konfigurierte Stationen. Hierbei werden die nächsten drei Abfahrten einer Station abgerufen und als Objekte und HTML dargestellt.
Dieser Adapter verwendet die Sentry Bibliotheken um automatisch Abstürze und Programmfehler an die Entwickler zu übermitteln. Weitere Details und für Informationen zur Deaktivierung der Fehlerberichterstattung in der Sentry-Plugin Dokumentation! Sentry Reporting wird ab JS-Controller 3.0 verwendet.
English
This adapter for ioBroker uses the mobile API of HAFAS. HAFAS is a public transport management system used by public transport providers across Europe, e.g. Deutsche Bahn. HAFAS-Client is used to access HAFAS.
The adapter provides three functions:
Timetable for Connections (Routes)
The desired routes has to be configured and enabled in the adapter configuration. The Adapter retrieves the connection information by a configured interval automatically. The next three connections are saved in ioBroker as HTML and optional as detailed objects. The HTML-object could easily be used in VIS.
Notification for delays on routes
A delay notification can be activated for configured routes. For example, there can be a notification by Telegram or Alexa when all or one specific connection is delayed.
Departure timetable for stations
Additionally the Adapter provides a departure timetable for configured stations. Here the next three connections are reveived and created as objects and HTML.
This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.
Konfiguration
Deutsch
Die Start- und Zielorte sowie Zwischenziele müssen mit ihrer numerischen ID angegeben werden. Eine Suchfunktion ist im Tab Einstellungen integriert.
Tab Einstellungen
| Einstellung | Beschreibung |
|---|---|
| Anbieter | Auswahl des zu verwendenden Anbieters, aktuell DB und ÖBB |
| Aktualisierungsintervall | Intervall in dem die Route aktualisiert werden, Angabe in Minuten |
| Verspätet markieren ab | Verspätung in Minuten ab der die Verbindung als verspätet markiert wird. Standardmäßig werden nur Verspätungen ab zwei Minuten markiert |
| Farbe für Pünktlich | Farbwert für bestätigte Pünktlichkeit |
| Farbe für Verspätungen | Farbwert für Verspätungen |
| Überschriftenerstellung | HTML-Tabellen werden mit Überschriften erzeugt |
| HTML-Ansicht erzeugen für Route | Erzeugt pro Route eine konfigurierbare HTML-Tabelle in einem Objekt |
| HTML-Ansicht erzeugen pro Verbindung | Erzeugt pro einzelner Verbindung eine HTML-Tabelle in einem Objekt |
| Detailierte Objekte speichern | Konfiguration der auszugebenden Objekte |
| JSON-Elemente speichern | Die Rückgabe von HAFAS erfolgt als JSON, diese sollten zur Fehlerbehebung gespeichert werden |
Auf der rechten Seite ist die Suchfunktion integriert. Zuerst muss ein Anbieter ausgewählt werden. Danach kann über das Suchfeld und Drücken des Knopfs "Suche" nach einer Station gesucht werden. Die Suchergebnisse der aktuellen Suche werden in der Tabelle angezeigt.
Tab Routen
Mit dem +-Button können neue Einträge zur Tabelle hinzugefügt werden.
| Einstellung | Beschreibung |
|---|---|
| Nr | Die Nummer entspricht dem Unterknoten in den Objekten und wird automatisch vergeben. |
| Aktiv | Wenn die Route aktiviert ist werden die Verbindungsinfos aktualisiert |
| Von | Numerische ID von Startbahnhof oder Starthaltestelle (Ermittlung über Suche) |
| Von (Eigener Name) | Benutzerdefinierter Name von Startbahnhof oder Starthaltestelle, für HTML- und Verspätungstext verwendet |
| Nach | Numerische ID von Zielbahnhof oder Zielhaltestelle (Ermittlung über Suche) |
| Nach (Eigener Name) | Benutzerdefinierter Name von Zielbahnhof oder Zielhaltestelle, für HTML- und Verspätungstext verwendet |
| Via | Fahrt über bestimmten Ort angegeben als numerische ID (optional, sonst leer) |
| Verkehrsmittel | Auswahl des Verkehrsmittels, z.B. Bus, S-Bahn, usw. Standardmäßig werden alle Verkehrsmittel ausgewählt |
| Max. Umstiege | Maximale Anzahl an Umstiegen. 0 für nur direkte Verbindungen. |
| Abfahrten | Anzahl abzurufender Fahrten |
| Fahrradmitnahme | Nur Verbindungen mit Fahrradmitnahme auswählen |
| Zeit-Offset | Abfahrtszeit: 0 = Jetzt, sonst n Minuten = Jetzt plus n Minuten |
Tab Verspätungsalarm
Mit dem +-Button können neue Einträge zur Tabelle hinzugefügt werden.
| Einstellung | Beschreibung |
|---|---|
| Nr | Die Nummer entspricht dem Unterknoten in den Objekten und wird automatisch vergeben. |
| Aktiv | Wenn der Verspätungsalarm aktiviert ist wird dieser geprüft |
| Route | Route auf die sich der Alarm beziehen soll |
| Geplante Abfahrt | Geplante Abfahrtszeit der zu prüfenden Route (Leer = Alle Verbindungen) |
| Wochentag | Wochentage an denen die Prüfung erfolgen soll |
| Benachrichtigung in Minuten | Anzahl der Minuten vor der Abfahrt, in denen benachrichtigt werden soll |
| Objekt für Ausgabetext | Angabe eines vorhandenen Objekts |
Hinweis zum Ausgabetext: Hier kann neben einfachen Objekten für VIS z.B. auch das "speak"-Objekt des Alexa-Adapters oder das "reponse"-Objekt des Telegram-Adapters verwendet werden.
Tab Abfahrtstafeln
Mit dem +-Button können neue Einträge zur Tabelle hinzugefügt werden.
| Einstellung | Beschreibung |
|---|---|
| Nr | Die Nummer entspricht dem Unterknoten in den Objekten und wird automatisch vergeben. |
| Aktiv | Wenn der Eintrag aktiviert ist wird dieser abgerufen |
| Von | Numerische ID von Startbahnhof oder Starthaltestelle (Ermittlung über Suche) |
| Von (Eigener Name) | Benutzerdefinierter Name von Startbahnhof oder Starthaltestelle, für HTML-Ausgabe verwendet |
| Abfahrten | Anzahl abzurufender Abfahrten |
| Verkehrsmittel | Auswahl des Verkehrsmittels, z.B. Bus, S-Bahn, usw. Standardmäßig werden alle Verkehrsmittel ausgewählt |
| Zeit-Offset | Abfahrtszeit: 0 = Jetzt, sonst n Minuten = Jetzt plus n Minuten |
English
Start and Desination and stopovers has to be identified with a numeric id. Search function for theses IDs is integrated in Tab Settings.
Tab Settings
| Setting | Description |
|---|---|
| Provider | Selection of public transport provider, currently DB and ÖBB |
| Update interval | Interval for updates of the routes in minutes |
| Mark delayed after Delay in | Define minutes after a delay should be marked as delay, per default a delay is marked when the delay is larger than one minute |
| Color for on time | Color for confirmed on time |
| Color for delays | Color for delays |
| Headlines creation for HTML tables | Create headlines for HTML tables |
| Create HTML view for route | Creates per route a configurable HTML table in an object |
| Create HTML view per journey | Creates per journey a HTML table in an object |
| Save detailed objects | Configuration of output objects |
| Save JSON elements | Return from HAFAS is JSON, should be saved for troubleshooting |
Tab Routes
With +-Button new entries can be added to the table.
| Setting | Description |
|---|---|
| Nr | The number match the subnode in objects and is assigned automatically |
| Activ | Connection information is updated when route is activ |
| From | Numeric ID of start station oder start stop |
| From (Custom name) | Custom name for start station oder start stop, used in HTML- and delay notification output |
| To | Numeric ID of destination station oder destination stop |
| From (Custom name) | Custom name for destination station oder destination stop, used in HTML- and delay notification output |
| Via | Ride over special station as numeric ID (optional, empty per default) |
| Vehicle | Selection of vehicle, e.g. Bus, S-Bahn, etc. Per default all vehicles are selected |
| Max. transfers | Maximum transfers on route, 0 for direct connections only |
| Departures | Number of departures to receive |
| Bycicle | Select only connections where bycicles allowed |
| Time Offset | Departure Time: 0 = now, otherwise n minutes = now plus n minutes |
Tab Delay alarm
With +-Button new entries can be added to the table.
| Einstellung | Beschreibung |
|---|---|
| Nr | The number match the subnode in objects and is assigned automatically |
| Activ | Check for delay alarm is activated |
| Route | Route concerning this delay alarm |
| Planned Departure | Planned departure of connection to be checked (Empty = All Routes) |
| Weekdays | Weekdays when connection should be checked |
| Notification in minutes | Minutes before departure when delay alarm is active |
| Object for output text | ioBroker state for text output |
Hint for "Object for output text": Simple states for usage in VIS could be used, but also "speak"-state of Alexa adapter or "response"-state of Telegram adapter.
Tab Departure Timetables
With +-Button new entries can be added to the table.
| Setting | Description |
|---|---|
| Nr | The number match the subnode in objects and is assigned automatically |
| Activ | Connection information is updated when item is activ |
| From | Numeric ID of start station oder start stop |
| From (Custom name) | Custom name for start station oder start stop, used in HTML- and delay notification output |
| Departures | Number of departures to receive |
| Vehicle | Selection of vehicle, e.g. Bus, S-Bahn, etc. Per default all vehicles are selected |
| Time Offset | Departure Time: 0 = now, otherwise n minutes = now plus n minutes |
Changelog
1.2.0 (2021-09-19)
- (Gaudes) Remove support for SBB, not using HAFAS anymore
- (Gaudes) Fix Hafas error "Bad Gateway" with code 502 (Sentry #26)
- (Gaudes) Fix unkown station in route (Sentry #7)
- (Gaudes) Remove support for Node 10
- (Gaudes) Update to newest Adapter creator for internal dependencies
- (Gaudes) Include Dependabot updates
1.1.1 (2021-06-22)
- (Gaudes) Advanced error reporting for HAFAS errors
- (Gaudes) Include Dependabot updates
1.1.0 (2021-06-04)
- (Gaudes) Time offset for routes and departure tables (Git #88)
- (Gaudes) Check if unloaded before writing/deleting objects (Sentry #7)
- (Gaudes) Include Dependabot updates
1.0.7 (2021-04-06)
- (Gaudes) Update HAFAS client to 5.15.2 (Fix error 'invalid json response body' with OEBB profile)
- (Gaudes) Configurable colors for delays and on time
- (Gaudes) Prepare for WebLate translations
- (Gaudes) Include Dependabot updates
1.0.6 (2021-03-16)
- (Gaudes) Fix route selection in delay config
- (Gaudes) Fix SBB product suburban-train (Sentry #21)
- (Gaudes) Include Dependabot updates
License
MIT License
Copyright (c) 2021 Ralf Gaudes ralf@gaudes.net
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.