Hacon/Hafas/Deutsche Bahn API für ESP8266/ESP32
Abfartstafel aus dem DBTFT Beispiel (Design ID 1) auf einem ILI9341
Wenn die Bibliothek hilfreich ist, gerne den Sponsor-Button von GitHub nutzen (PayPal).
Wenn nicht PlatformIO genutzt wird, werden folgende Bibliotheken zusätzlich benötigt:
- https://github.com/bblanchon/ArduinoJson
- https://github.com/paulstoffregen/Time
- https://github.com/bbx10/Hash_tng (nur für ESP32)
Der DBTFT-Beispielcode ist für einen ESP8266 mit ILI9341 oder ein "Cheap Yellow Display" (ESP32 mit ILI9341 oder ST7798) ausgelegt. Mittels Webinterface lassen sich diverse Parameter konfigurieren (zunächst Einrichtung des WLANs, Stationsname, Zuggattungen, verschiedene Designs). Für das CYD ist darüber hinaus automatisches Dimmen des Displays mittels des eingebauten LDRs verfügbar. Updates sind sowohl über das Webinterface, als auch espota zusätzlich zur klassischen Installation über USB möglich. Kompilieren vorzugsweise über platformio, Erstinstallation mit einem fertigen Binary ist auch etwa über den ESPHome Webinstaller möglich.
setAGFXOutput(bool) kann aufgerufen werden, um die automatische Ersetzung von Umlauten für Adafruit GFX vorzunehmen (true) oder Umlaute in ue, oe, ss, etc. umzuwandeln(false). Ansonsten wird keine Umwandlung vorgenommen.
Für weitere Anfragen wird die Stations-ID benötigt. Daher muss i.d.R. erst einmal diese abgefragt werden (kann dann statisch im Code hinterlegt werden).
DBstation* getStation(name, address, num)
| Variable | Typ | Standard | Funktion |
|---|---|---|---|
name | const char* | NULL | Entspricht dem Stationsnamen, hier können Variationen den Unterschied machen. Während Hannover Hbf den DB Bahnhof ausgibt, kommen bei Hauptbahnhof Hannover hingegen die Haltestellen des Nahverkehrs (Bus/Bahn). |
address | const char* | NULL | Kann alternativ angegeben werden (name auf NULL setzen), um die nächstgelegene Station zu einer Anschrift zu finden. |
num | uint8_t | 10 | Begrenzt die Anzahl der ausgegebenen Stationen |
Die Zeiten werden standardmäßig für einen Zeitraum von einer Stunde ab Wunschzeit (oder "jetzt") abgerufen. Wird ein längerer Zeitraum ausgewählt, kann es in der Auflistung zu Duplikaten kommen. Ein Zug der um 17:12 abfahren sollte und 70 Minuten Verspätung hat wird sowohl in der Anfrage um 17 Uhr, als auch um 18 Uhr ausgegeben, weil dieser mit der Abfragezeit von 18 Uhr und effektiver Abfahrt um 18:22 immer noch erreichbar ist. Um diese Duplikate zu filtern, wird der Zuglauf (eindeutige Kennung der Fahrt) gegen bisher erfasste Fahrten geprüft und die Fahrt verworfen, wenn es eine Übereinstimmung gibt.
DBdeparr* getStationBoard(type, stationID, target, time, maxCount, maxDuration, productFilter)
DBdeparr* getDepatures(stationID, target, time, maxCount, maxDuration, productFilter)
DBdeparr* getArrivals(stationID, target, time, maxCount, maxDuration, productFilter)
getDepatures und getArrivals verweisen nur auf getStationBoard mit dem entsprechenden type.
| Variable | Typ | Standard | Funktion |
|---|---|---|---|
type | char[8] | Kann entweder abfahrt oder ankunft sein. | |
stationID | char* | ID aus der DBstation | |
target | const char* | NULL | entfallen, da nicht mehr in der API vorhanden |
time | time_t | 0 | Timestamp für die Abfrage oder 0 für "jetzt" |
maxCount | uint8_t | 20 | Anzahl der Ergebnisse, ohne Beschränkung mit offenem Filter reicht der RAM teils nicht an größeren Bahnhöfen |
maxDuration | uint8_t | 1 | Maximale Stunden, jede Stunde generiert eine zusätzliche Abfrage |
productFilter | uint16_t | 1023/alle | Verkehrsmittel, die angezeigt werden sollen |
Folgende Filter sind möglich:
PROD_ICEPROD_IC_ECPROD_IRPROD_REPROD_SPROD_BUSPROD_SHIPPROD_UPROD_STBPROD_AST(Anrufpflichtverkehr)
Mittels bitweiser Oder-Verknüpfung (|) können mehrere Verkehrsmittel angefragt werden.
| Name | Typ | Funktion |
|---|---|---|
name | char[30] | Stationsname |
stationId | char[50] | Stations ID |
longitude | float | Längengrad |
latitude | float | Breitengrad |
next | DBstation* | Nächste Station in der Liste |
| Name | Typ | Funktion |
|---|---|---|
time | time_t | Reguläre Abfahrtszeit als Unix-Timestamp |
realTime | time_t | Tatsächliche Abfahrtszeit als Unix-Timestamp |
delay | int16_t | Verspätung |
cancelled | bool | Zug entfällt |
platform | char[8] | Geplantes Gleis (ggf. inkl. Abschnitt), sofern existent, sonst leer |
newPlatform | char[8] | Tatsächliches Gleis, sofern geändert, sonst leer |
target | char[50] | Zielhaltestelle |
product | char[12] | Bezeichnung des Verkehrsmittels |
line | uint16_t | Liniennummer |
textline | char[20] | Liniennummer als String (kann z.B. auch SEV sein) |
next | DBdeparr* | Nächste Fahrt in Liste |
Wird eine neue Abfrage gestartet, so werden die zuletzt angefragten Daten überschrieben. Nutzdaten müssen vorher ggf. gespeichert werden. Werden etwa Ankunft und Abfahrt eines Bahnhofs angefragt, so ist nur das DBdeparr* der letzten Anfrage gültig.
Mittels for (; t != NULL; t = t->next){...} kann über die Stationen bzw. Fahrten iteriert werden (t vom Typ einer der beiden obigen Datenstrukturen). Soll die Referenz auf den Anfang nicht verloren gehen, so muss t mittels Type* t = orig_t; erstellt werden.
Die Bibliothek fragt direkt die Deutsche Bahn Schnittstelle an. Für die korrekte Funktion der Schnittstelle bzw. deren Daten kann keine Garantie übernommen werden. Die Benutzung erfolgt auf eigene Gefahr.