├── .gitignore ├── examples ├── DBTFT │ ├── .gitignore │ ├── esp32_4M.csv │ ├── .vscode │ │ └── extensions.json │ ├── platformio.ini │ └── src │ │ └── DBTFT.ino └── HannoverHBF │ ├── platformio.ini │ └── src │ └── HannoverHBF.ino ├── .vscode └── settings.json ├── .github ├── FUNDING.yml └── workflows │ └── DBTFT-pio-build.yml ├── library.json ├── DBAPI.h ├── README.md ├── DBAPI.cpp └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .vscode/.browse.c_cpp.db* 3 | .vscode/c_cpp_properties.json 4 | .vscode/launch.json 5 | .vscode/ipch 6 | -------------------------------------------------------------------------------- /examples/DBTFT/.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .vscode/.browse.c_cpp.db* 3 | .vscode/c_cpp_properties.json 4 | .vscode/launch.json 5 | .vscode/ipch 6 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.associations": { 3 | "print": "cpp", 4 | "istream": "cpp", 5 | "map": "cpp" 6 | } 7 | } -------------------------------------------------------------------------------- /examples/DBTFT/esp32_4M.csv: -------------------------------------------------------------------------------- 1 | # Name, Type, SubType, Offset, Size, Flags 2 | nvs, data, nvs, 0x9000, 0x5000, 3 | otadata, data, ota, 0xe000, 0x2000, 4 | app0, app, ota_0, 0x10000, 0x180000, 5 | app1, app, ota_1, 0x190000,0x180000, 6 | littlefs, data, littlefs,0x310000,0xE0000, 7 | coredump, data, coredump,0x3F0000,0x10000, -------------------------------------------------------------------------------- /examples/DBTFT/.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | // See http://go.microsoft.com/fwlink/?LinkId=827846 3 | // for the documentation about the extensions.json format 4 | "recommendations": [ 5 | "platformio.platformio-ide" 6 | ], 7 | "unwantedRecommendations": [ 8 | "ms-vscode.cpptools-extension-pack" 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /examples/HannoverHBF/platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; https://docs.platformio.org/page/projectconf.html 10 | 11 | [env:d1_mini] 12 | platform = espressif8266 13 | board = d1_mini 14 | framework = arduino 15 | lib_deps = 16 | soundstorm/DBAPI @ ^2.2.0 17 | bblanchon/ArduinoJson @ ^7.3.0 18 | paulstoffregen/Time @ ^1.6.1 19 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: # Replace with a single Buy Me a Coffee username 14 | thanks_dev: # Replace with a single thanks.dev username 15 | custom: "https://paypal.me/sndstrm" 16 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "DBAPI", 3 | "version": "2.2.0", 4 | "description": "Hacon/Hafas/DB API for ESP8266 / ESP32 (WiFiClientSecure)", 5 | "keywords": "train, deutsche bahn, travel", 6 | "repository": 7 | { 8 | "type": "git", 9 | "url": "https://github.com/ArduinoHannover/DBAPI.git" 10 | }, 11 | "authors": 12 | [ 13 | { 14 | "name": "Luca Schröder", 15 | "url": "https://github.com/soundstorm" 16 | } 17 | ], 18 | "license": "GPL-3.0-only", 19 | "frameworks": "Arduino", 20 | "platforms": ["espressif8266", "espressif32"], 21 | "dependencies": [ 22 | { 23 | "owner": "paulstoffregen", 24 | "name": "Time", 25 | "version": "^1.6.1" 26 | }, 27 | { 28 | "owner": "bblanchon", 29 | "name": "ArduinoJson", 30 | "version": "^7.3.0" 31 | }, 32 | { 33 | "name": "hash", 34 | "version": "https://github.com/bbx10/Hash_tng/archive/refs/heads/master.zip", 35 | "platforms": ["espressif32"] 36 | } 37 | ] 38 | } -------------------------------------------------------------------------------- /.github/workflows/DBTFT-pio-build.yml: -------------------------------------------------------------------------------- 1 | name: PlatformIO CI 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v4 11 | - uses: actions/cache@v4 12 | with: 13 | path: | 14 | ~/.cache/pip 15 | ~/.platformio/.cache 16 | key: ${{ runner.os }}-pio 17 | - uses: actions/setup-python@v5 18 | with: 19 | python-version: '3.11' 20 | - name: Install PlatformIO Core 21 | run: | 22 | python -m pip install --upgrade pip 23 | pip install --upgrade platformio 24 | pip install --upgrade intelhex 25 | 26 | - name: Build PlatformIO Project D1 27 | run: pio ci -c ./examples/DBTFT/platformio.ini -e d1_mini --build-dir /tmp/pio-build --keep-build-dir ./examples/DBTFT/src 28 | 29 | - name: Upload esp8266 30 | uses: actions/upload-artifact@v4 31 | with: 32 | name: ESP8266-ILI9341 33 | path: /tmp/pio-build/.pio/build/d1_mini/firmware.bin 34 | 35 | - name: Build PlatformIO Project CYD 9341 36 | run: pio ci -c ./examples/DBTFT/platformio.ini -e 2432s028r --build-dir /tmp/pio-build --keep-build-dir ./examples/DBTFT/src 37 | 38 | - name: Upload CYD-ILI9341 39 | uses: actions/upload-artifact@v4 40 | with: 41 | name: CYD-ILI9341 42 | path: /tmp/pio-build/.pio/build/2432s028r/firmware.bin 43 | 44 | - name: Build PlatformIO Project CYD 7798 45 | run: pio ci -c ./examples/DBTFT/platformio.ini -e 2432s028r_dualusb --build-dir /tmp/pio-build --keep-build-dir ./examples/DBTFT/src 46 | 47 | - name: Upload CYD-ST7798 48 | uses: actions/upload-artifact@v4 49 | with: 50 | name: CYD-ST7798 51 | path: /tmp/pio-build/.pio/build/2432s028r_dualusb/firmware.bin 52 | -------------------------------------------------------------------------------- /examples/HannoverHBF/src/HannoverHBF.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | const char* ssid = "SSID"; 4 | const char* password = "password"; 5 | 6 | DBAPI db; 7 | 8 | void setup() { 9 | Serial.begin(115200); 10 | WiFi.mode(WIFI_STA); 11 | WiFi.begin(ssid, password); 12 | while (WiFi.status() != WL_CONNECTED) { 13 | Serial.write('.'); 14 | delay(500); 15 | } 16 | Serial.println(); 17 | DBstation* station = db.getStation("Hannover Hbf"); 18 | yield(); 19 | if (station != NULL) { 20 | Serial.println(); 21 | Serial.print("Name: "); 22 | Serial.println(station->name); 23 | Serial.print("ID: "); 24 | Serial.println(station->stationId); 25 | Serial.print("Latitude: "); 26 | Serial.println(station->latitude); 27 | Serial.print("Longitude: "); 28 | Serial.println(station->longitude); 29 | DBdeparr* da = db.getDepartures(station->stationId, NULL, 0, 20, 1, PROD_ICE | PROD_IC_EC | PROD_IR | PROD_RE | PROD_S); 30 | while (da != NULL) { 31 | yield(); 32 | Serial.println(); 33 | Serial.print("Date: "); 34 | char buf[11]; 35 | snprintf(buf, sizeof(buf), "%02d.%02d.%4d", day(da->time), month(da->time), year(da->time)); 36 | Serial.println(buf); 37 | Serial.print("Time: "); 38 | snprintf(buf, sizeof(buf), "%02d:%02d", hour(da->time), minute(da->time)); 39 | Serial.println(buf); 40 | Serial.print("Realtime: "); 41 | snprintf(buf, sizeof(buf), "%02d:%02d", hour(da->realTime), minute(da->realTime)); 42 | Serial.println(buf); 43 | Serial.print("Product: "); 44 | Serial.println(da->product); 45 | Serial.print("Line: "); 46 | Serial.println(da->line); 47 | Serial.print("Target: "); 48 | Serial.println(da->target); 49 | Serial.print("Delay: "); 50 | Serial.println(da->delay); 51 | Serial.print("Platform: "); 52 | Serial.println(da->platform); 53 | da = da->next; 54 | } 55 | } 56 | //station = db.getStationByCoord(52377222, 9741667); 57 | } 58 | 59 | void loop() { 60 | } 61 | -------------------------------------------------------------------------------- /examples/DBTFT/platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; https://docs.platformio.org/page/projectconf.html 10 | 11 | [env:d1_mini] 12 | platform = espressif8266 13 | board = d1_mini 14 | framework = arduino 15 | lib_deps = 16 | soundstorm/DBAPI @ ^2.2.0 17 | arduino-libraries/NTPClient @ ^3.2.1 18 | adafruit/Adafruit GFX Library@^1.11.10 19 | adafruit/Adafruit ILI9341 @ ^1.5.12 20 | tzapu/WifiManager @ ^2.0.0 21 | board_build.filesystem = littlefs 22 | monitor_speed = 115200 23 | #upload_protocol = espota 24 | #upload_flags = --auth=iliketrains 25 | 26 | [env:2432s028r] 27 | platform = espressif32 28 | board = esp32dev 29 | framework = arduino 30 | build_flags = -D BOARD_2432S028R 31 | lib_ldf_mode = deep 32 | lib_deps = 33 | soundstorm/DBAPI @ ^2.2.0 34 | arduino-libraries/NTPClient @ ^3.2.1 35 | adafruit/Adafruit GFX Library@^1.11.10 36 | adafruit/Adafruit ILI9341 @ ^1.5.12 37 | tzapu/WifiManager @ ^2.0.0 38 | board_build.filesystem = littlefs 39 | monitor_speed = 115200 40 | #upload_protocol = espota 41 | #upload_flags = --auth=iliketrains 42 | #board_build.partitions = esp32_4M.csv ;0x140000 by default is apprently not enough in some cases, shrink littlefs. 43 | 44 | [env:2432s028r_dualusb] 45 | platform = espressif32 46 | board = esp32dev 47 | framework = arduino 48 | build_flags = -D BOARD_2432S028R -D USE_ST7798 49 | lib_ldf_mode = deep 50 | lib_deps = 51 | soundstorm/DBAPI @ ^2.2.0 52 | arduino-libraries/NTPClient @ ^3.2.1 53 | adafruit/Adafruit GFX Library@^1.11.10 54 | adafruit/Adafruit ST7735 and ST7789 Library@^1.11.0 55 | tzapu/WifiManager @ ^2.0.0 56 | board_build.filesystem = littlefs 57 | monitor_speed = 115200 58 | #upload_protocol = espota 59 | #upload_flags = --auth=iliketrains 60 | #board_build.partitions = esp32_4M.csv ;0x140000 by default is apprently not enough in some cases, shrink littlefs. 61 | -------------------------------------------------------------------------------- /DBAPI.h: -------------------------------------------------------------------------------- 1 | #ifndef DBAPI_H 2 | #define DBAPI_H 3 | 4 | #include 5 | #include 6 | 7 | struct DBdeparr { 8 | time_t time; 9 | time_t realTime; 10 | int16_t delay; 11 | bool cancelled; 12 | char platform[8]; 13 | char newPlatform[8]; 14 | char target[50]; 15 | char product[12]; 16 | uint16_t line; 17 | char textline[20]; //Apperently there are services like Bus 5/43, so no numeric value 18 | DBdeparr* next; 19 | }; 20 | 21 | struct DBstation { 22 | char name[30]; 23 | char stationId[150]; 24 | float longitude; 25 | float latitude; 26 | DBstation* next; 27 | }; 28 | 29 | enum DBerror { 30 | DBERR_NONE, 31 | DBERR_REQ_FAILED, 32 | DBERR_RESP_INVALID, 33 | DBERR_NOSTATIONID, 34 | DBERR_DESERIALIZATION_FAILED, 35 | DBERR_NO_JSON_FOUND 36 | }; 37 | 38 | enum DBproduct { 39 | PROD_ICE = 1 << 9, 40 | PROD_IC_EC = 1 << 8, 41 | PROD_IR = 1 << 7, 42 | PROD_RE = 1 << 6, 43 | PROD_S = 1 << 5, 44 | PROD_BUS = 1 << 4, 45 | PROD_SHIP = 1 << 3, 46 | PROD_U = 1 << 2, 47 | PROD_STB = 1 << 1, 48 | PROD_AST = 1 << 0 49 | }; 50 | 51 | enum DBumlaut { 52 | REP_NONE, 53 | REP_AGFX, 54 | REP_UML 55 | }; 56 | 57 | class DBAPI { 58 | private: 59 | const char* host = "app.vendo.noncd.db.de"; 60 | time_t parseTime(const char* t); 61 | DBdeparr* deparr = NULL; 62 | DBstation* stations = NULL; 63 | enum DBumlaut repum = REP_NONE; 64 | static const char* services[]; 65 | DBerror err = DBERR_NONE; 66 | public: 67 | DBAPI(); 68 | DBstation* getStation( 69 | const char* name = NULL, 70 | const char* address = NULL, 71 | uint8_t num = 10 72 | ); 73 | DBstation* getStationByCoord( 74 | uint32_t latitude, 75 | uint32_t longitude, 76 | uint8_t num = 10, 77 | uint16_t maxDistance = 500 78 | ); 79 | DBdeparr* getStationBoard( 80 | const char type[8], 81 | const char* stationId, 82 | const char* target = NULL, 83 | time_t time = 0, 84 | uint8_t maxCount = 20, 85 | uint8_t maxDuration = 1, 86 | uint16_t productFilter = 1023 87 | ); 88 | DBdeparr* getDepartures( 89 | const char* stationId, 90 | const char* target = NULL, 91 | time_t time = 0, 92 | uint8_t num = 20, 93 | uint8_t maxDuration = 1, 94 | uint16_t productFilter = 1023 95 | ); 96 | DBdeparr* getArrivals( 97 | const char* stationId, 98 | const char* target = NULL, 99 | time_t time = 0, 100 | uint8_t num = 20, 101 | uint8_t maxDuration = 1, 102 | uint16_t productFilter = 1023 103 | ); 104 | DBerror getError(); 105 | // Output Adafruit GFX compatible Umlauts for default font 106 | void setAGFXOutput(bool gfx); 107 | void setUmlaut(enum DBumlaut uml); 108 | }; 109 | 110 | #endif //DBAPI_H -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DBAPI 2 | Hacon/Hafas/Deutsche Bahn API für ESP8266/ESP32 3 | 4 | [![PlatformIO Registry](https://badges.registry.platformio.org/packages/soundstorm/library/DBAPI.svg)](https://registry.platformio.org/libraries/soundstorm/DBAPI) 5 | 6 | ![tft_hannover_hbf](https://user-images.githubusercontent.com/193273/200298925-0f80dfdb-e17f-4f26-a28f-67b808540332.jpg) 7 | Abfartstafel aus dem DBTFT Beispiel (Design ID 1) auf einem ILI9341 8 | 9 | Wenn die Bibliothek hilfreich ist, gerne den Sponsor-Button von GitHub nutzen (PayPal). 10 | 11 | ## Abhängigkeiten 12 | 13 | Wenn nicht PlatformIO genutzt wird, werden folgende Bibliotheken zusätzlich benötigt: 14 | - https://github.com/bblanchon/ArduinoJson 15 | - https://github.com/paulstoffregen/Time 16 | - https://github.com/bbx10/Hash_tng (nur für ESP32) 17 | 18 | ## Beispielcode 19 | 20 | Der DBTFT-Beispielcode ist für einen ESP8266 mit ILI9341 oder ein "Cheap Yellow Display" (ESP32 mit ILI9341 oder ST7798) ausgelegt. 21 | Mittels Webinterface lassen sich diverse Parameter konfigurieren (zunächst Einrichtung des WLANs, Stationsname, Zuggattungen, verschiedene Designs). 22 | Für das CYD ist darüber hinaus automatisches Dimmen des Displays mittels des eingebauten LDRs verfügbar. 23 | Updates sind sowohl über das Webinterface, als auch espota zusätzlich zur klassischen Installation über USB möglich. 24 | Kompilieren vorzugsweise über platformio, Erstinstallation mit einem fertigen Binary ist auch etwa über den [ESPHome Webinstaller](https://web.esphome.io/) möglich. 25 | 26 | ## Abfrage 27 | 28 | `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). 29 | Ansonsten wird keine Umwandlung vorgenommen. 30 | 31 | ### Stationen 32 | Für weitere Anfragen wird die Stations-ID benötigt. 33 | Daher muss i.d.R. erst einmal diese abgefragt werden (kann dann statisch im Code hinterlegt werden). 34 | 35 | `DBstation* getStation(name, address, num)` 36 | 37 | | Variable | Typ | Standard | Funktion | 38 | | --- | --- | --- | --- | 39 | | `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). | 40 | | `address` | `const char*` | `NULL` | Kann alternativ angegeben werden (`name` auf `NULL` setzen), um die nächstgelegene Station zu einer Anschrift zu finden. | 41 | | `num` | `uint8_t` | `10` | Begrenzt die Anzahl der ausgegebenen Stationen | 42 | 43 | ### Ankunft/Abfahrt 44 | 45 | Die Zeiten werden standardmäßig für einen Zeitraum von einer Stunde ab Wunschzeit (oder "jetzt") abgerufen. 46 | Wird ein längerer Zeitraum ausgewählt, kann es in der Auflistung zu Duplikaten kommen. 47 | 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. 48 | 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. 49 | 50 | `DBdeparr* getStationBoard(type, stationID, target, time, maxCount, maxDuration, productFilter)` 51 | 52 | `DBdeparr* getDepatures(stationID, target, time, maxCount, maxDuration, productFilter)` 53 | 54 | `DBdeparr* getArrivals(stationID, target, time, maxCount, maxDuration, productFilter)` 55 | 56 | `getDepatures` und `getArrivals` verweisen nur auf `getStationBoard` mit dem entsprechenden `type`. 57 | 58 | | Variable | Typ | Standard | Funktion | 59 | | --- | --- | --- | --- | 60 | | `type` | `char[8]` | | Kann entweder `abfahrt` oder `ankunft` sein. | 61 | | `stationID` | `char*` | | ID aus der `DBstation` | 62 | | `target` | `const char*` | `NULL` | entfallen, da nicht mehr in der API vorhanden | 63 | | `time` | `time_t` | `0` | Timestamp für die Abfrage oder `0` für "jetzt" | 64 | | `maxCount` | `uint8_t` | `20` | Anzahl der Ergebnisse, ohne Beschränkung mit offenem Filter reicht der RAM teils nicht an größeren Bahnhöfen | 65 | | `maxDuration` | `uint8_t` | `1` | Maximale Stunden, jede Stunde generiert eine zusätzliche Abfrage | 66 | | `productFilter` | `uint16_t` | `1023`/alle | Verkehrsmittel, die angezeigt werden sollen | 67 | 68 | #### Produktfilter 69 | 70 | Folgende Filter sind möglich: 71 | 72 | * `PROD_ICE` 73 | * `PROD_IC_EC` 74 | * `PROD_IR` 75 | * `PROD_RE` 76 | * `PROD_S` 77 | * `PROD_BUS` 78 | * `PROD_SHIP` 79 | * `PROD_U` 80 | * `PROD_STB` 81 | * `PROD_AST` (Anrufpflichtverkehr) 82 | 83 | Mittels bitweiser Oder-Verknüpfung (`|`) können mehrere Verkehrsmittel angefragt werden. 84 | 85 | ## Datenstrukturen 86 | 87 | ### `DBstation` 88 | | Name | Typ | Funktion | 89 | | --- | --- | --- | 90 | | `name` | `char[30]` | Stationsname | 91 | | `stationId` | `char[50]` | Stations ID | 92 | | `longitude` | `float` | Längengrad | 93 | | `latitude` | `float` | Breitengrad | 94 | | `next` | `DBstation*` | Nächste Station in der Liste | 95 | 96 | ### `DBdeparr` 97 | 98 | | Name | Typ | Funktion | 99 | | --- | --- | --- | 100 | | `time` | `time_t` | Reguläre Abfahrtszeit als Unix-Timestamp | 101 | | `realTime` | `time_t` | Tatsächliche Abfahrtszeit als Unix-Timestamp | 102 | | `delay` | `int16_t` | Verspätung | 103 | | `cancelled` | `bool` | Zug entfällt | 104 | | `platform` | `char[8]` | Geplantes Gleis (ggf. inkl. Abschnitt), sofern existent, sonst leer | 105 | | `newPlatform` | `char[8]` | Tatsächliches Gleis, sofern geändert, sonst leer | 106 | | `target` | `char[50]` | Zielhaltestelle | 107 | | `product` | `char[12]` | Bezeichnung des Verkehrsmittels | 108 | | `line` | `uint16_t` | Liniennummer | 109 | | `textline` | `char[20]` | Liniennummer als String (kann z.B. auch `SEV` sein) | 110 | | `next` | `DBdeparr*` | Nächste Fahrt in Liste | 111 | 112 | ### Hinweise zur Datenstruktur 113 | 114 | Wird eine neue Abfrage gestartet, so werden die zuletzt angefragten Daten überschrieben. 115 | Nutzdaten müssen vorher ggf. gespeichert werden. 116 | Werden etwa Ankunft *und* Abfahrt eines Bahnhofs angefragt, so ist nur das `DBdeparr*` der letzten Anfrage gültig. 117 | 118 | Mittels `for (; t != NULL; t = t->next) {...}` kann über die Stationen bzw. Fahrten iteriert werden (`t` vom Typ einer der beiden obigen Datenstrukturen). 119 | Soll die Referenz auf den Anfang nicht verloren gehen, so muss `t` mittels `Type* t = orig_t;` erstellt werden. 120 | 121 | ## Rechtliche Hinweise 122 | Die Bibliothek fragt direkt die Deutsche Bahn Schnittstelle an. 123 | Für die korrekte Funktion der Schnittstelle bzw. deren Daten kann keine Garantie übernommen werden. 124 | Die Benutzung erfolgt auf eigene Gefahr. 125 | -------------------------------------------------------------------------------- /DBAPI.cpp: -------------------------------------------------------------------------------- 1 | #include "DBAPI.h" 2 | #include 3 | #include 4 | #include 5 | 6 | #ifdef DEBUG_ESP_PORT 7 | #define DB_DEBUG_MSG(...) DEBUG_ESP_PORT.printf( __VA_ARGS__ ) 8 | #else 9 | #define DB_DEBUG_MSG(...) 10 | #endif 11 | 12 | DBAPI::DBAPI() { 13 | 14 | } 15 | 16 | /** 17 | * Get stations matching the name or close to an address 18 | * @param name Name of the station to get 19 | * @param address Address to request nearest stations from - currently not implemented, leave as NULL 20 | * @param num Maxmium of stations to request 21 | * @return DBstation* array, possibly NULL if no results were found 22 | * @note see getError to check if request was successful and is just empty because no station was found 23 | */ 24 | DBstation* DBAPI::getStation( 25 | const char* name, 26 | const char* address, 27 | uint8_t num 28 | ) { 29 | // Assume all is good at first 30 | err = DBERR_NONE; 31 | while (stations != NULL) { 32 | DBstation* next = stations->next; 33 | free(stations); 34 | stations = next; 35 | } 36 | /* 37 | bool isStation; 38 | if (name != NULL) { 39 | isStation = true; 40 | } else if (address != NULL) { 41 | isStation = false; 42 | } else { 43 | return NULL; 44 | } 45 | */ 46 | WiFiClientSecure client; 47 | client.setInsecure(); // Don't check fingerprint 48 | if (!client.connect(host, 443)) { 49 | DB_DEBUG_MSG("DBAPI: Connection to Host failed.\n"); 50 | err = DBERR_REQ_FAILED; 51 | return NULL; 52 | } 53 | String json = String("{\"locationTypes\":[\"ST\"],\"searchTerm\":\"") + name + "\"}"; 54 | client.print(String("POST /mob/location/search HTTP/1.1\r\nConnection: close\r\nX-Correlation-ID: Arduino\r\nContent-Type: application/x.db.vendo.mob.location.v3+json\r\nAccept: application/x.db.vendo.mob.location.v3+json\r\nHost: ") + host + 55 | "\r\nContent-Length: " + json.length() + "\r\n\r\n" + 56 | json 57 | ); 58 | 59 | char endOfHeaders[] = "\r\n\r\n"; 60 | if (!client.find(endOfHeaders)) { 61 | DB_DEBUG_MSG("Did not find headers\n"); 62 | err = DBERR_RESP_INVALID; 63 | return stations; 64 | } 65 | JsonDocument doc; 66 | DeserializationError error = deserializeJson(doc, client); 67 | if (error) { 68 | DB_DEBUG_MSG("deserializeJson() on Station failed"); 69 | DB_DEBUG_MSG(error.c_str()); 70 | err = DBERR_DESERIALIZATION_FAILED; 71 | return stations; 72 | } 73 | DBstation* prev = NULL; 74 | for (uint8_t i = 0; i < doc.size() && i < num; i++) { 75 | DBstation* station = new DBstation(); 76 | JsonObject st = doc[i]; 77 | String stationname = st["name"]; 78 | switch (repum) { 79 | case REP_AGFX: 80 | stationname.replace("ß", "\xE0"); 81 | stationname.replace("Ä", "\x8E"); 82 | stationname.replace("Ö", "\x99"); 83 | stationname.replace("Ü", "\x9A"); 84 | stationname.replace("ä", "\x84"); 85 | stationname.replace("ö", "\x94"); 86 | stationname.replace("ü", "\x81"); 87 | break; 88 | case REP_UML: 89 | stationname.replace("ß", "ss"); 90 | stationname.replace("Ä", "Ae"); 91 | stationname.replace("Ö", "Oe"); 92 | stationname.replace("Ü", "Ue"); 93 | stationname.replace("ä", "ae"); 94 | stationname.replace("ö", "oe"); 95 | stationname.replace("ü", "ue"); 96 | break; 97 | default: 98 | break; 99 | } 100 | strncpy(station->name, stationname.c_str(), sizeof(station->name)); 101 | strncpy(station->stationId, st["locationId"], sizeof(station->stationId)); 102 | station->longitude = st["coordinates"]["longitude"]; 103 | station->latitude = st["coordinates"]["latitude"]; 104 | station->next = NULL; 105 | if (prev == NULL) { // First element 106 | stations = station; 107 | } else { 108 | prev->next = station; 109 | } 110 | prev = station; 111 | } 112 | return stations; 113 | } 114 | 115 | /** 116 | * Get stations by coordinates 117 | * Legacy function, not implemented again 118 | * @return NULL currently 119 | */ 120 | DBstation* DBAPI::getStationByCoord( 121 | uint32_t latitude, 122 | uint32_t longitude, 123 | uint8_t num, 124 | uint16_t maxDistance 125 | ) { 126 | return NULL; 127 | } 128 | 129 | /** 130 | * Get last errorcode to check if the request was successful. 131 | * Most likely to be useful, when NULL is returned, but it can't be distinguished, 132 | * if the request was malformed, any function or request failed or there are simply 133 | * no more results available with the given parameters. 134 | * @return DBerror enum errorcode 135 | */ 136 | DBerror DBAPI::getError() { 137 | return err; 138 | } 139 | 140 | /** 141 | * Requests departures/arrivals from/at given stationID. 142 | * @param type abfahrt or ankunft 143 | * @param stationId ID of stations, can be acquired by getStation(...)->stationId 144 | * @param target target of service, currently not used, leave as NULL 145 | * @param time specify request date/time, leave at 0 if you want to query with current time 146 | * @param maxCount maxiumum of services to request (may be lower if maxDuration is reached before maxCount) 147 | * @param maxDuration maximum of hours to request (each hour will possibly generate a new http request) 148 | * @param productFilter any combination of DBprod values for service types to request 149 | * @return DBdeparr array, possibly NULL if no service is available with the requested parameters or an error occured 150 | * @note see getError to check if request was successful and is just empty because no service is available 151 | */ 152 | DBdeparr* DBAPI::getStationBoard( 153 | const char type[8], 154 | const char* stationId, 155 | const char* target, 156 | time_t time, 157 | uint8_t maxCount, 158 | uint8_t maxDuration, 159 | uint16_t productFilter 160 | ) { 161 | // Assume all is good at first 162 | err = DBERR_NONE; 163 | // sanity check, if no station is supplied, a request would crash ArduinJSON later. 164 | if (stationId == NULL || !strlen(stationId)) { 165 | DB_DEBUG_MSG("DBAPI: StationID was not supplied.\n"); 166 | err = DBERR_NOSTATIONID; 167 | return NULL; 168 | } 169 | while (deparr != NULL) { 170 | DBdeparr* next = deparr->next; 171 | free(deparr); 172 | deparr = next; 173 | } 174 | 175 | bool abfahrt = strcmp(type, "abfahrt") == 0; 176 | DBdeparr* prev = NULL; 177 | uint8_t cnt = 0; 178 | uint8_t hashes[maxCount][20]; 179 | 180 | // Set static request parameters 181 | JsonDocument reqDoc; 182 | JsonArray verkehrsmittel = reqDoc["verkehrsmittel"].to(); 183 | for (uint8_t i = 0; i < 10; i++) { 184 | if (productFilter & (1 << (9 - i))) { 185 | verkehrsmittel.add(services[i]); 186 | } 187 | } 188 | reqDoc["ursprungsBahnhofId"] = stationId; 189 | 190 | for (uint8_t offset = 0; offset < maxDuration && cnt < maxCount; offset++) { 191 | // Get current time, if requesting more than one hour and no request time is set 192 | // Sanity check, that year is > 2020, so only successful synced time is used 193 | // Your device would probably not survive 2020 years without restart, huh? 194 | if (time == 0 && maxDuration > 1 && year() > 2020) { 195 | time = now(); 196 | } 197 | // Set params 198 | if (time != 0) { 199 | // Nobody knows, what happens at DST switch... ¯\_(ツ)_/¯ 200 | char buf[11]; 201 | // Setting the time offset - this might generate duplicates. 202 | // Train would have departed in queried hour but has delay of 70 min: 203 | // Will now be shown in the currently queried hour as the regular time matches. 204 | // But also in the next hour, because it will be reachable due to the delay. 205 | uint32_t tr = time + offset * 3600; 206 | snprintf(buf, 11, "%02d:%02d", hour(tr), minute(tr)); 207 | reqDoc["anfragezeit"] = buf; 208 | snprintf(buf, 11, "%4d-%02d-%02d", year(tr), month(tr), day(tr)); 209 | reqDoc["datum"] = buf; 210 | } 211 | size_t outputCapacity = 350; 212 | char* output = (char*)calloc(outputCapacity, sizeof(char)); 213 | serializeJson(reqDoc, output, outputCapacity); 214 | 215 | // Init new client for each request 216 | WiFiClientSecure client; 217 | client.setInsecure(); // Don't check fingerprint 218 | if (!client.connect(host, 443)) { 219 | DB_DEBUG_MSG("DBAPI: Connection to Host failed.\n"); 220 | free(output); 221 | err = DBERR_REQ_FAILED; 222 | return NULL; 223 | } 224 | 225 | DB_DEBUG_MSG("DBAPI: Requesting StationBoard.\n"); 226 | DB_DEBUG_MSG(output); 227 | client.print(String("POST /mob/bahnhofstafel/") + type + " HTTP/1.1\r\n" + 228 | "Host: " + host + "\r\n" + 229 | "Content-Type: application/x.db.vendo.mob.bahnhofstafeln.v2+json\r\n" + 230 | "Accept: application/x.db.vendo.mob.bahnhofstafeln.v2+json\r\n" + 231 | "X-Correlation-ID: Arduino\r\n" + 232 | "Content-Length: " + strlen(output) + "\r\n" + 233 | "Connection: close\r\n\r\n" + output); 234 | free(output); 235 | char endOfHeaders[] = "\r\n\r\n"; 236 | if (!client.find(endOfHeaders)) { 237 | DB_DEBUG_MSG("DBAPI: Did not find headers\n"); 238 | err = DBERR_RESP_INVALID; 239 | // Return so far accumulated array 240 | return deparr; 241 | } 242 | JsonDocument doc; 243 | if (!client.find(":[")) { // Skip to first element 244 | err = DBERR_NO_JSON_FOUND; 245 | return deparr; 246 | } 247 | do { 248 | DeserializationError error = deserializeJson(doc, client); 249 | if (error) { 250 | DB_DEBUG_MSG("DBAPI: deserializeJson() on departures/arrivals failed"); 251 | DB_DEBUG_MSG(error.c_str()); 252 | //err = DBERR_DESERIALIZATION_FAILED; 253 | //return deparr; 254 | // No data in array, continue with next hour if selected 255 | continue; 256 | } 257 | 258 | uint8_t current_hash[20]; 259 | // hash to save RAM as the ID is >150 chars 260 | sha1(doc["zuglaufId"].as(), current_hash); 261 | 262 | bool match = false; 263 | for (uint8_t i = 0; i < cnt && !match; i++) { 264 | match |= !memcmp(hashes[i], current_hash, sizeof(current_hash)); 265 | } 266 | // duplicate entry found, skipping 267 | if (match) continue; 268 | memcpy(hashes[cnt], current_hash, sizeof(current_hash)); 269 | 270 | DBdeparr* da = new DBdeparr(); 271 | String targ = doc[abfahrt?"richtung":"abgangsOrt"]; 272 | 273 | switch (repum) { 274 | case REP_AGFX: 275 | targ.replace("ß", "\xE0"); 276 | targ.replace("Ä", "\x8E"); 277 | targ.replace("Ö", "\x99"); 278 | targ.replace("Ü", "\x9A"); 279 | targ.replace("ä", "\x84"); 280 | targ.replace("ö", "\x94"); 281 | targ.replace("ü", "\x81"); 282 | break; 283 | case REP_UML: 284 | targ.replace("ß", "ss"); 285 | targ.replace("Ä", "Ae"); 286 | targ.replace("Ö", "Oe"); 287 | targ.replace("Ü", "Ue"); 288 | targ.replace("ä", "ae"); 289 | targ.replace("ö", "oe"); 290 | targ.replace("ü", "ue"); 291 | break; 292 | default: 293 | break; 294 | } 295 | targ.toCharArray(da->target, sizeof(DBdeparr::target)); 296 | strncpy(da->product, doc["kurztext"], sizeof(DBdeparr::product)); 297 | //strncpy(da->product, doc["produktGattung"], sizeof(DBdeparr::product)); 298 | strncpy(da->textline, doc["mitteltext"], sizeof(DBdeparr::textline)); 299 | for (uint8_t i = 0; i < strlen(da->textline); i++) { 300 | if (da->textline[i] >= '0' && da->textline[i] <= '9') { 301 | strncpy(da->textline, &doc["mitteltext"].as()[i], sizeof(DBdeparr::textline)); 302 | da->line = atol(da->textline); 303 | break; 304 | } 305 | } 306 | if (!doc["gleis"].isNull()) { 307 | strncpy(da->platform, doc["gleis"], sizeof(DBdeparr::platform)); 308 | } else { 309 | da->platform[0] = 0; 310 | } 311 | 312 | if (!doc["ezGleis"].isNull()) { 313 | strncpy(da->newPlatform, doc["ezGleis"], sizeof(DBdeparr::newPlatform)); 314 | } else { 315 | da->newPlatform[0] = 0; 316 | } 317 | JsonArray arr = doc["echtzeitNotizen"]; 318 | da->cancelled = false; 319 | for (uint8_t i = 0; i < arr.size(); i++) { 320 | if (arr[i]["text"].as().equals("Halt entfällt")) { 321 | da->cancelled = true; 322 | break; // Not interested in other notes right now 323 | } else { 324 | //Serial.println(arr[i]["text"].as()); 325 | } 326 | } 327 | da->time = this->parseTime(doc[abfahrt ? "abgangsDatum" : "ankunftsDatum"]); 328 | if (doc[abfahrt ? "ezAbgangsDatum" : "ezAnkunftsDatum"].isNull()) { 329 | da->realTime = da->time; 330 | } else { 331 | da->realTime = this->parseTime(doc[abfahrt ? "ezAbgangsDatum" : "ezAnkunftsDatum"]); 332 | } 333 | da->delay = da->realTime - da->time; 334 | da->delay /= 60; 335 | 336 | da->next = NULL; 337 | if (prev == NULL) { 338 | DB_DEBUG_MSG("DBAPI: Got first departure."); 339 | deparr = da; 340 | } else { 341 | DB_DEBUG_MSG("DBAPI: Got next departure."); 342 | prev->next = da; 343 | } 344 | prev = da; 345 | cnt++; 346 | } while (client.findUntil(",","]") && cnt < maxCount); 347 | 348 | if (maxDuration > 0 && time == 0 && prev != NULL) { 349 | // If no synced time available, set request time to last known depature - 59 minutes 350 | time = prev->time - 3540; 351 | } 352 | if (year(time) < 2020) break; // Can't query more hours, as there is no valid timestamp 353 | } 354 | return deparr; 355 | } 356 | 357 | /** 358 | * Helper to parse string to time_t 359 | * @param t Time string in time with potential TZ formatted like 0123-56-89T12:45:67+90:23 360 | * @return time_t timestamp 361 | */ 362 | time_t DBAPI::parseTime(const char* t) { 363 | tmElements_t time; 364 | // 0123-56-89T12:45:67+90:23 365 | // Year in timeElements is years since 1970 366 | time.Year = atoi(&t[0]) - 1970; 367 | time.Month = atoi(&t[5]); 368 | time.Day = atoi(&t[8]); 369 | time.Hour = atoi(&t[11]); 370 | time.Minute = atoi(&t[14]); 371 | time.Second = 0; 372 | return makeTime(time); 373 | } 374 | 375 | /** 376 | * Wrapper for querying departures 377 | * @see getStationBoard 378 | */ 379 | DBdeparr* DBAPI::getDepartures( 380 | const char* stationId, 381 | const char* target, 382 | time_t time, 383 | uint8_t maxCount, 384 | uint8_t maxDuration, 385 | uint16_t productFilter 386 | ) { 387 | return getStationBoard("abfahrt", stationId, target, time, maxCount, maxDuration, productFilter); 388 | } 389 | 390 | /** 391 | * Wrapper for querying arrivals 392 | * @see getStationBoard 393 | */ 394 | DBdeparr* DBAPI::getArrivals( 395 | const char* stationId, 396 | const char* target, 397 | time_t time, 398 | uint8_t maxCount, 399 | uint8_t maxDuration, 400 | uint16_t productFilter 401 | ) { 402 | return getStationBoard("ankunft", stationId, target, time, maxCount, maxDuration, productFilter); 403 | } 404 | 405 | /** 406 | * Replace special characters for AdafruitGFX charset 407 | * @param gfx If true, will replace for AdafruitGFX, otherwise like ä -> ae 408 | */ 409 | void DBAPI::setAGFXOutput(bool gfx) { 410 | repum = gfx ? REP_AGFX : REP_UML; 411 | } 412 | 413 | /** 414 | * Replace special characters for displays 415 | * @param uml `REP_AGFX` for AdafruitGFX, `REP_UML` for simple ä -> ae and REP_NONE for raw output 416 | */ 417 | void DBAPI::setUmlaut(enum DBumlaut uml) { 418 | repum = uml; 419 | } 420 | 421 | /** 422 | * Translate numeric values into strings for 2025+ API version 423 | */ 424 | const char* DBAPI::services[] = { 425 | "HOCHGESCHWINDIGKEITSZUEGE", 426 | "INTERCITYUNDEUROCITYZUEGE", 427 | "INTERREGIOUNDSCHNELLZUEGE", 428 | "NAHVERKEHRSONSTIGEZUEGE", 429 | "SBAHNEN", 430 | "BUSSE", 431 | "SCHIFFE", 432 | "UBAHN", 433 | "STRASSENBAHN", 434 | "ANRUFPFLICHTIGEVERKEHRE" 435 | }; -------------------------------------------------------------------------------- /examples/DBTFT/src/DBTFT.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | 7 | //#define BOARD_2432S028R //ESP32 + ILI9341 2.8" TFT 8 | //#define USE_ST7798 //2432S028R with ST7798 9 | #define AUTOCONFIG 10 | #define ENABLEOTA 11 | //#define DEBUG_BRIGHTNESS 12 | 13 | #ifdef USE_ST7798 14 | #include 15 | #else 16 | #include 17 | #endif 18 | 19 | #ifdef AUTOCONFIG 20 | const char* apSSID = "DBTafel"; 21 | const char* apPassword = "nichtPuenktlich"; 22 | #include 23 | #include 24 | #else 25 | const char* ssid = "SSID"; 26 | const char* password = "password"; 27 | #endif 28 | #ifdef ENABLEOTA 29 | const char* otaPassword = "iliketrains"; 30 | #include 31 | #endif 32 | char fromStationName[40] = "Hannover Hbf"; 33 | uint16_t filter = PROD_RE | PROD_S; 34 | 35 | WiFiUDP ntpUDP; 36 | NTPClient timeClient(ntpUDP, "pool.ntp.org"); 37 | 38 | #define COLOR_RED 0xF800 39 | #define COLOR_WHITE 0xFFFF 40 | #define COLOR_BLACK 0x0000 41 | #define COLOR_BLUE 0x001F 42 | #define COLOR_YELLOW 0xFFE0 43 | #define COLOR_ORANGE 0xFBE0 44 | 45 | // Optional view with large destinations, does interfere with platform when station names are longer 46 | #ifndef ESP8266 // ESP8266 display output is too slow 47 | #define SCROLLING_ENABLED 48 | #endif 49 | #define SCROLL_STALL 5 50 | #define SCROLL_INTERVAL 400 51 | #ifdef ESP32 52 | #define TEXT_FILL 53 | #endif 54 | 55 | typedef struct { 56 | uint8_t id; 57 | uint8_t headerOffset; 58 | uint8_t itemHeight; 59 | uint8_t targetX; 60 | uint8_t maxTextLength; 61 | uint8_t maxEntries; 62 | uint16_t foregroundColor; 63 | uint16_t backgroundColor; 64 | uint16_t highlightColor; 65 | bool canScroll; 66 | } design_t; 67 | 68 | enum designID { 69 | DESIGN_WIDE, 70 | DESIGN_DETAIL, 71 | DESIGN_LED, 72 | MAX_DESIGNS 73 | }; 74 | 75 | design_t designs[] = { 76 | { 77 | DESIGN_WIDE, 78 | 39, //headerOffset 79 | 18, //itemHeight 80 | 11 * 6 + 6, //targetX 81 | 13, //maxTextLength 82 | 11, //maxEntries 83 | COLOR_WHITE, //foreground 84 | COLOR_BLUE, //background 85 | COLOR_YELLOW, //highlight 86 | true //canScroll 87 | }, 88 | { 89 | DESIGN_DETAIL, 90 | 39, //headerOffset 91 | 18, //itemHeight 92 | 9 * 6 + 6, //targetX 93 | 30, //maxTextLength 94 | 11, //maxEntries 95 | COLOR_WHITE, //foreground 96 | COLOR_BLUE, //background 97 | COLOR_YELLOW, //highlight 98 | false //canScroll 99 | }, 100 | { 101 | DESIGN_LED, 102 | 21, //headerOffset 103 | 18, //itemHeight 104 | 4 * 12 + 6, //targetX 105 | 16, //maxTextLength 106 | 12, //maxEntries 107 | COLOR_ORANGE, //foreground 108 | COLOR_BLACK, //background 109 | COLOR_ORANGE, //highlight 110 | true //canScroll 111 | } 112 | }; 113 | 114 | design_t* activeDesign = &designs[0]; 115 | 116 | DBAPI db; 117 | DBstation* fromStation; 118 | DBdeparr* da = NULL; 119 | DBdeparr* departure = NULL; 120 | time_t tdst; 121 | uint32_t nextCheck; 122 | uint32_t nextTime; 123 | uint32_t nextScroll; 124 | uint32_t nextBrightness; 125 | uint32_t scroll; 126 | time_t old_time; 127 | bool updateInhibit = false; 128 | #ifdef SCROLLING_ENABLED 129 | bool scrollingEnabled = true; 130 | #else 131 | bool scrollingEnabled = false; 132 | #endif 133 | uint16_t currentBrightness = 0; 134 | uint8_t rotation = 1; 135 | uint8_t failedConnection = 0; 136 | uint8_t failedUpdates = 0; 137 | char errorMessage[50]; 138 | 139 | #ifdef BOARD_2432S028R 140 | #define HSPI_SCLK 14 141 | #define HSPI_MISO 12 142 | #define HSPI_MOSI 13 143 | #define TFT_DC 2 144 | #define TFT_CS 15 145 | #define TFT_BL 21 146 | #define LDR_IN 34 147 | // GT36516 LDR -> GND, 1M Pullup, 1M Pulldown 148 | // 1V dark 149 | // 0V bright 150 | #else 151 | #define HSPI_SCLK 14 152 | #define HSPI_MISO 12 153 | #define HSPI_MOSI 13 154 | #define TFT_DC 16 155 | #define TFT_CS 15 156 | #define TFT_BL 5 157 | #define LDR_IN A0 // optional LDR 158 | #endif 159 | #define BUT_IN 0 160 | #define MIN_BRIGHTNESS 2 161 | #define MAX_BRIGHTNESS 255 // Nothing above noteworthy 162 | #ifdef ESP32 163 | SPIClass* hspi = new SPIClass(HSPI); 164 | #ifdef USE_ST7798 165 | Adafruit_ST7789 tft = Adafruit_ST7789(hspi, TFT_CS, TFT_DC, -1); 166 | #else 167 | Adafruit_ILI9341 tft = Adafruit_ILI9341(hspi, TFT_DC, TFT_CS); 168 | #endif 169 | #else 170 | #ifdef USE_ST7798 171 | Adafruit_ST7789 tft = Adafruit_ST7789(TFT_CS, TFT_DC, -1); 172 | #else 173 | Adafruit_ILI9341 tft = Adafruit_ILI9341(TFT_CS, TFT_DC); 174 | #endif 175 | #endif 176 | 177 | #ifndef LDR_IN 178 | #define LDR_IN -1 179 | #endif 180 | 181 | int8_t ldr_pin = LDR_IN; 182 | 183 | #ifdef AUTOCONFIG 184 | #endif 185 | 186 | time_t getNtpTime() { 187 | return timeClient.getEpochTime(); 188 | } 189 | 190 | void drawStaticContent() { 191 | tft.fillScreen(activeDesign->backgroundColor); 192 | tft.setTextColor(activeDesign->foregroundColor); 193 | tft.setTextSize(2); 194 | switch (activeDesign->id) { 195 | case DESIGN_WIDE: 196 | case DESIGN_DETAIL: 197 | tft.setCursor(11 * 6 + 6, 2); 198 | tft.print(fromStationName); 199 | tft.fillRect(0, 18, tft.width(), 18, activeDesign->highlightColor); 200 | tft.setTextColor(activeDesign->backgroundColor); 201 | tft.setCursor(2, 20); 202 | tft.print("Zeit"); 203 | tft.setCursor(activeDesign->targetX, 20); 204 | tft.print("Nach"); 205 | tft.setCursor(tft.width() - 7 * 6 * 2, 20); 206 | tft.print("Gleis"); 207 | break; 208 | case DESIGN_LED: 209 | tft.setCursor(0, 2); 210 | tft.print(fromStationName); 211 | } 212 | } 213 | 214 | void drawTime() { 215 | tft.setTextColor(activeDesign->foregroundColor); 216 | tft.setTextSize(2); 217 | switch (activeDesign->id) { 218 | case DESIGN_WIDE: 219 | case DESIGN_DETAIL: 220 | tft.setCursor(2, 2); 221 | tft.fillRect(2, 2, 5 * 6 * 2 , 16, activeDesign->backgroundColor); 222 | break; 223 | case DESIGN_LED: 224 | tft.setCursor(tft.width() - 5 * 12, 2); 225 | tft.fillRect(tft.width() - 5 * 12, 2, 5 * 6 * 2 , 16, activeDesign->backgroundColor); 226 | } 227 | if (hour(tdst) < 10) tft.write('0'); 228 | tft.print(hour(tdst)); 229 | tft.write(':'); 230 | if (minute(tdst) < 10) tft.write('0'); 231 | tft.print(minute(tdst)); 232 | old_time = tdst; 233 | } 234 | 235 | bool drawDeparture(DBdeparr* departure, uint16_t &pos) { 236 | Serial.println("Drawing next departure."); 237 | char buf[10]; 238 | // Next drawn item would be at least partially out of frame 239 | if (pos + activeDesign->itemHeight - 2 > tft.height()) return false; 240 | switch (activeDesign->id) { 241 | case DESIGN_WIDE: 242 | case DESIGN_DETAIL: { 243 | switch (activeDesign->id) { 244 | case DESIGN_DETAIL: 245 | tft.fillRect(0, pos - 1, 9 * 6 + 4 , 17, activeDesign->foregroundColor); 246 | default: 247 | tft.fillRect(0, pos - 1, 11 * 6 + 4 , 17, activeDesign->foregroundColor); 248 | } 249 | tft.setTextColor(activeDesign->backgroundColor); 250 | tft.setTextSize(1); 251 | tft.setCursor(2, pos); 252 | snprintf(buf, sizeof(buf), "%02d:%02d", hour(departure->time), minute(departure->time)); 253 | tft.print(buf); 254 | if (activeDesign->id != DESIGN_DETAIL) { 255 | if (!departure->cancelled && departure->delay) { 256 | tft.print(" +"); 257 | tft.print(departure->delay); 258 | } 259 | } 260 | tft.setCursor(2, pos + 8); 261 | tft.print(departure->product); 262 | if (strcmp("", departure->textline)) { 263 | tft.write(' '); 264 | tft.print(departure->textline); 265 | } 266 | tft.setTextColor(activeDesign->foregroundColor); 267 | if (activeDesign->id == DESIGN_DETAIL) { 268 | tft.fillRect(9 * 6 + 4, pos - 1, tft.width(), 17, activeDesign->backgroundColor); 269 | tft.setCursor(9 * 6 + 6, pos); 270 | tft.setTextSize(1); 271 | tft.print(departure->target); 272 | 273 | tft.setTextColor(activeDesign->highlightColor); 274 | tft.setCursor(9 * 6 + 6, pos + 8); 275 | if (departure->cancelled) { 276 | tft.print("Fahrt f\x84llt aus"); 277 | tft.drawFastHLine(9 * 6 + 6, pos + 3, strlen(departure->target) * 6 - 1, activeDesign->foregroundColor); 278 | } else if (departure->delay) { 279 | tft.print("ca. "); 280 | tft.print(departure->delay); 281 | tft.print(" Minuten sp\x84ter"); 282 | } 283 | } else { 284 | tft.fillRect(11 * 6 + 4, pos - 1, tft.width(), 17, activeDesign->backgroundColor); 285 | printScroll(departure->target, pos, true, departure->cancelled); 286 | } 287 | tft.setTextColor(activeDesign->foregroundColor); 288 | tft.setTextSize(2); 289 | tft.setCursor(tft.width() - 7 * 6 * 2, pos); 290 | if (strcmp("", departure->newPlatform) && strcmp(departure->platform, departure->newPlatform)) { 291 | tft.setTextColor(activeDesign->highlightColor); 292 | //tft.print("->"); 293 | tft.print(departure->newPlatform); 294 | } else { 295 | tft.print(departure->platform); 296 | } 297 | break; 298 | } 299 | case DESIGN_LED: 300 | tft.fillRect(0, pos - 1, tft.width(), 17, activeDesign->backgroundColor); 301 | tft.setTextColor(activeDesign->foregroundColor); 302 | tft.setTextSize(2); 303 | tft.setCursor(2, pos); 304 | const char padding[] = " "; 305 | //snprintf(buf, sizeof(buf), "%*.*s%s", 3, 3, padding, departure->textline); 306 | snprintf(buf, 5, "% 4s", departure->textline); 307 | //buf[4] = 0; 308 | tft.print(buf); 309 | printScroll(departure->target, pos, true, departure->cancelled); 310 | tft.setCursor(tft.width() - 5 * 12, pos); 311 | snprintf(buf, sizeof(buf), "%02d:%02d", hour(departure->realTime), minute(departure->realTime)); 312 | tft.print(buf); 313 | break; 314 | } 315 | pos += activeDesign->itemHeight; 316 | return true; 317 | } 318 | 319 | void printScroll(String text, uint16_t y, bool force, bool cancelled) { 320 | #ifdef TEXT_FILL 321 | tft.setTextColor(activeDesign->foregroundColor, activeDesign->backgroundColor); 322 | #else // TEXT_FILL 323 | tft.setTextColor(activeDesign->foregroundColor); 324 | #endif // TEXT_FILL 325 | tft.setTextSize(2); 326 | if (text.length() > activeDesign->maxTextLength || force) { 327 | uint32_t p = 0; 328 | if (scrollingEnabled && activeDesign->canScroll) { 329 | p = scroll; 330 | int16_t ts = text.length() - activeDesign->maxTextLength; 331 | if (ts < 0) { 332 | ts = 0; 333 | } 334 | uint32_t to_scroll = ts; 335 | p %= to_scroll * 2 + SCROLL_STALL * 2; 336 | if (p <= to_scroll) { 337 | if (!force && p == 0) return; // do not update 0 position 338 | } else if (p <= to_scroll + SCROLL_STALL) { 339 | p = to_scroll; 340 | if (!force) return; // do not update on stall, if no update is forced 341 | } else if (p <= to_scroll * 2 + SCROLL_STALL) { 342 | p = SCROLL_STALL + to_scroll * 2 - p; 343 | } else { 344 | p = 0; 345 | if (!force) return; // do not update on stall, if no update is forced 346 | } 347 | } else { 348 | if (!force) return; 349 | } 350 | #ifndef TEXT_FILL 351 | tft.fillRect(activeDesign->targetX - 2, y - 1, activeDesign->maxTextLength * 6 * 2, activeDesign->itemHeight, activeDesign->backgroundColor); 352 | #endif // TEXT_FILL 353 | tft.setCursor(activeDesign->targetX, y); 354 | text = text.substring(p, p + activeDesign->maxTextLength); 355 | tft.print(text); 356 | switch (activeDesign->id) { 357 | case DESIGN_WIDE: 358 | case DESIGN_LED: 359 | if (cancelled) { 360 | uint8_t len = text.length(); 361 | tft.drawFastHLine(activeDesign->targetX, y + 6, (len * 6 - 1) * 2, activeDesign->foregroundColor); 362 | tft.drawFastHLine(activeDesign->targetX, y + 7, (len * 6 - 1) * 2, activeDesign->foregroundColor); 363 | } 364 | break; 365 | default: 366 | break; 367 | } 368 | } 369 | } 370 | 371 | #ifdef ENABLEOTA 372 | void updateStarted() { 373 | updateInhibit = true; 374 | Serial.println("Update started..."); 375 | tft.fillScreen(COLOR_BLACK); 376 | tft.setTextColor(COLOR_WHITE); 377 | tft.setCursor(0, 0); 378 | tft.setFont(); 379 | tft.setTextSize(2); 380 | tft.println("Update..."); 381 | } 382 | #endif 383 | 384 | #ifdef AUTOCONFIG 385 | WiFiManager wifiManager; 386 | WiFiManagerParameter stationNameParameter("stationName", "Stationsname", fromStationName, sizeof(fromStationName)); 387 | WiFiManagerParameter rotationParameter("rotation", "Rotation (1 oder 3)", String(rotation).c_str(), 1); 388 | #ifdef ESP8266 389 | WiFiManagerParameter ldrParameter("ldrpin", "Lichtsensor (-1 zum Deaktivieren, 17 sonst)", String(ldr_pin).c_str(), 2); 390 | #else 391 | WiFiManagerParameter ldrParameter("ldrpin", "Lichtsensor (-1 zum Deaktivieren, CYD z.B. 34 zum Aktivieren)", String(ldr_pin).c_str(), 2); 392 | #endif 393 | #ifdef SCROLLING_ENABLED 394 | WiFiManagerParameter scrollingParameter("scrolling", "Lange Stationen scrollen (1 zum Aktivieren)", String(scrollingEnabled).c_str(), 1); 395 | #endif 396 | String maxDesignString = String("Design-ID (min 0, max ") + String(MAX_DESIGNS - 1) + ")"; 397 | WiFiManagerParameter designParameter("design", (maxDesignString).c_str(), String(activeDesign->id).c_str(), 2); 398 | WiFiManagerParameter filterICEParameter("filterICE", "Hochgeschwindigkeitszüge (1 zum Aktivieren)", String((filter & PROD_ICE) > 0).c_str(), 1); 399 | WiFiManagerParameter filterICECParameter("filterICEC", "Intercity- und Eurocityzüge 1 zum Aktivieren)", String((filter & PROD_IC_EC) > 0).c_str(), 1); 400 | WiFiManagerParameter filterIRParameter("filterIR", "Interregio- und Schnellzüge (1 zum Aktivieren)", String((filter & PROD_IR) > 0).c_str(), 1); 401 | WiFiManagerParameter filterREParameter("filterRE", "Nahverkehr, sonstige Züge (1 zum Aktivieren)", String((filter & PROD_RE) > 0).c_str(), 1); 402 | WiFiManagerParameter filterSParameter("filterS", "S-Bahnen (1 zum Aktivieren)", String((filter & PROD_S) > 0).c_str(), 1); 403 | WiFiManagerParameter filterBUSParameter("filterBUS", "Busse (1 zum Aktivieren)", String((filter & PROD_BUS) > 0).c_str(), 1); 404 | WiFiManagerParameter filterSHIPParameter("filterSHIP", "Schiffe (1 zum Aktivieren)", String((filter & PROD_SHIP) > 0).c_str(), 1); 405 | WiFiManagerParameter filterUParameter("filterU", "U-Bahnen (1 zum Aktieren)", String((filter & PROD_U) > 0).c_str(), 1); 406 | WiFiManagerParameter filterSTBParameter("filterSTB", "Straßenbahnen (1 zum Aktivieren)", String((filter & PROD_STB) > 0).c_str(), 1); 407 | WiFiManagerParameter filterASTParameter("filterAST", "Anrufpflichtige Verkehre (1 zum Aktivieren)", String((filter & PROD_AST) > 0).c_str(), 1); 408 | bool shouldSaveConfig = false; 409 | 410 | void configModeCallback (WiFiManager *myWiFiManager) { 411 | if (strlen(errorMessage)) { 412 | tft.fillScreen(COLOR_RED); 413 | } else { 414 | tft.fillScreen(COLOR_BLACK); 415 | } 416 | tft.setTextColor(COLOR_WHITE); 417 | tft.setFont(); 418 | tft.setTextSize(2); 419 | tft.setCursor(0, 0); 420 | if (strlen(errorMessage)) { 421 | tft.println(errorMessage); 422 | } 423 | tft.println("Zur Konfiguration mit\nAccess-Point verbinden:"); 424 | tft.println(apSSID); 425 | tft.println(apPassword); 426 | if (WiFi.isConnected()) { 427 | tft.println("Oder im lokalen WLAN:"); 428 | tft.println(WiFi.localIP()); 429 | } 430 | } 431 | 432 | void failedConfig() { 433 | tft.fillScreen(COLOR_RED); 434 | tft.setTextColor(COLOR_WHITE); 435 | tft.setTextSize(2); 436 | tft.setCursor(0, 0); 437 | tft.println("WLAN Verbindung fehl\n-geschlagen"); 438 | tft.println("Konfiguration nicht\nerfolgt"); 439 | tft.print("Starte neu..."); 440 | delay(5000); 441 | ESP.restart(); 442 | delay(5000); 443 | } 444 | 445 | void saveConfigCallback () { 446 | shouldSaveConfig = true; 447 | Serial.println("New data to save"); 448 | } 449 | 450 | void readParams() { 451 | Serial.println("Reading saved Paramters."); 452 | if (LittleFS.exists("/station")) { 453 | File f = LittleFS.open("/station", "r"); 454 | if (f) { 455 | uint8_t i = 0; 456 | while (f.available() && i < sizeof(fromStationName)) { 457 | fromStationName[i++] = f.read(); 458 | } 459 | if (i < sizeof(fromStationName)) 460 | fromStationName[i] = 0; 461 | } else { 462 | Serial.println("File /station not open"); 463 | } 464 | } else { 465 | Serial.println("File /station not found"); 466 | } 467 | if (LittleFS.exists("/rotation")) { 468 | File f = LittleFS.open("/rotation", "r"); 469 | if (f) { 470 | uint8_t r = f.read() - '0'; 471 | if (r == 1 || r == 3) { 472 | rotation = r; 473 | } 474 | } else { 475 | Serial.println("File /rotation not open"); 476 | } 477 | } else { 478 | Serial.println("File /rotation not found"); 479 | } 480 | if (LittleFS.exists("/ldr")) { 481 | File f = LittleFS.open("/ldr", "r"); 482 | if (f) { 483 | ldr_pin = f.readString().toInt(); 484 | } else { 485 | Serial.println("File /ldr not open"); 486 | } 487 | } else { 488 | Serial.println("File /ldr not found"); 489 | } 490 | #ifdef SCROLLING_ENABLED 491 | if (LittleFS.exists("/scrolling")) { 492 | File f = LittleFS.open("/scrolling", "r"); 493 | if (f) { 494 | scrollingEnabled = f.read(); 495 | } else { 496 | Serial.println("File /scrolling not open"); 497 | } 498 | } else { 499 | Serial.println("File /scrolling not found"); 500 | } 501 | #endif 502 | if (LittleFS.exists("/design")) { 503 | File f = LittleFS.open("/design", "r"); 504 | if (f) { 505 | uint8_t d = f.read(); 506 | if (d < MAX_DESIGNS) { 507 | activeDesign = &designs[d]; 508 | } 509 | } else { 510 | Serial.println("File /design not open"); 511 | } 512 | } else { 513 | Serial.println("File /design not found"); 514 | } 515 | if (LittleFS.exists("/filter")) { 516 | File f = LittleFS.open("/filter", "r"); 517 | if (f) { 518 | String s = f.readString(); 519 | long val = s.toInt(); 520 | if (val > 0 && val <= 1023) { 521 | filter = val; 522 | } else { 523 | Serial.print("Invalid filter value: "); 524 | Serial.print(s); 525 | Serial.print(" / "); 526 | Serial.println(val); 527 | } 528 | } else { 529 | Serial.println("File /filter not open"); 530 | } 531 | } else { 532 | Serial.println("File /filter not found"); 533 | } 534 | Serial.println("Done loading settings."); 535 | } 536 | 537 | bool doReconfig() { 538 | bool state = wifiManager.startConfigPortal(apSSID, apPassword); 539 | afterConfigCallback(); 540 | drawStaticContent(); 541 | updateInhibit = false; 542 | nextCheck = 0; 543 | errorMessage[0] = 0; // delete error message, set next time if neccessary 544 | return state; 545 | } 546 | 547 | void checkConfigRequest() { 548 | if (!digitalRead(BUT_IN)) { 549 | doReconfig(); 550 | } 551 | } 552 | 553 | void afterConfigCallback() { 554 | if (shouldSaveConfig) { 555 | { 556 | strncpy(fromStationName, stationNameParameter.getValue(), sizeof(fromStationName)); 557 | Serial.print("Stationsname gesetzt: "); 558 | Serial.println(fromStationName); 559 | File f = LittleFS.open("/station", "w"); 560 | f.print(fromStationName); 561 | f.close(); 562 | fromStation = db.getStation(fromStationName); 563 | } 564 | uint8_t r = rotationParameter.getValue()[0]; 565 | if (r == '1' || r == '3') { 566 | rotation = r - '0'; 567 | File f = LittleFS.open("/rotation", "w"); 568 | f.write(r); 569 | f.close(); 570 | tft.setRotation(rotation); 571 | Serial.print("Rotation gesetzt: "); 572 | Serial.println(rotation); 573 | } 574 | ldr_pin = atoi(ldrParameter.getValue()); 575 | { 576 | File f = LittleFS.open("/ldr", "w"); 577 | f.print(ldrParameter.getValue()); 578 | f.close(); 579 | } 580 | #ifdef SCROLLING_ENABLED 581 | scrollingEnabled = scrollingParameter.getValue()[0] == '1'; 582 | { 583 | File f = LittleFS.open("/design", "w"); 584 | f.write(scrollingEnabled); 585 | f.close(); 586 | } 587 | #endif 588 | uint8_t d = atoi(designParameter.getValue()); 589 | if (d < MAX_DESIGNS) { 590 | File f = LittleFS.open("/design", "w"); 591 | f.write(d); 592 | f.close(); 593 | activeDesign = &designs[d]; 594 | } 595 | ldr_pin = atoi(ldrParameter.getValue()); 596 | { 597 | File f = LittleFS.open("/ldr", "w"); 598 | f.print(ldrParameter.getValue()); 599 | f.close(); 600 | } 601 | uint16_t val = 602 | (filterICEParameter.getValue()[0] == '1') * PROD_ICE | 603 | (filterICECParameter.getValue()[0] == '1') * PROD_IC_EC | 604 | (filterIRParameter.getValue()[0] == '1') * PROD_IR | 605 | (filterREParameter.getValue()[0] == '1') * PROD_RE | 606 | (filterSParameter.getValue()[0] == '1') * PROD_S | 607 | (filterBUSParameter.getValue()[0] == '1') * PROD_BUS | 608 | (filterSHIPParameter.getValue()[0] == '1') * PROD_SHIP | 609 | (filterUParameter.getValue()[0] == '1') * PROD_U | 610 | (filterSTBParameter.getValue()[0] == '1') * PROD_STB | 611 | (filterASTParameter.getValue()[0] == '1') * PROD_AST; 612 | if (val > 0) { 613 | File f = LittleFS.open("/filter", "w"); 614 | f.print(val); 615 | f.close(); 616 | filter = val; 617 | Serial.print("Filter gesetzt: "); 618 | Serial.println(filter); 619 | } else { 620 | Serial.print("Filter setzen fehlgeschlagen: "); 621 | Serial.println(val); 622 | } 623 | } else { 624 | Serial.println("Nicht speichern."); 625 | } 626 | } 627 | #endif 628 | 629 | void setup() { 630 | Serial.begin(115200); 631 | #ifdef ESP32 632 | //hspi->begin(); 633 | hspi->begin(HSPI_SCLK, HSPI_MISO, HSPI_MOSI, TFT_CS); 634 | #endif 635 | 636 | #ifdef USE_ST7798 637 | tft.init(240, 320, SPI_MODE0); 638 | tft.invertDisplay(0); 639 | #else 640 | tft.begin(); 641 | #endif 642 | #ifdef BOARD_2432S028R 643 | pinMode(4, OUTPUT); //LED RED 644 | digitalWrite(4, 1); 645 | pinMode(16, OUTPUT); //LED GREEN 646 | digitalWrite(16, 1); 647 | pinMode(17, OUTPUT); //LED BLUE 648 | digitalWrite(17, 1); 649 | #endif 650 | WiFi.mode(WIFI_STA); 651 | pinMode(BUT_IN, INPUT_PULLUP); 652 | #ifndef AUTOCONFIG 653 | WiFi.mode(WIFI_STA); 654 | WiFi.begin(ssid, password); 655 | #else 656 | #ifdef ESP32 657 | if (!LittleFS.begin(1)) { 658 | #else 659 | if (!LittleFS.begin()) { 660 | #endif 661 | Serial.println("LittleFS mount failed"); 662 | } else { 663 | readParams(); 664 | } 665 | wifiManager.setAPCallback(configModeCallback); 666 | stationNameParameter.setValue(fromStationName, sizeof(fromStationName)); 667 | wifiManager.addParameter(&stationNameParameter); 668 | rotationParameter.setValue(String(rotation).c_str(), 1); 669 | wifiManager.addParameter(&rotationParameter); 670 | ldrParameter.setValue(String(ldr_pin).c_str(), 2); 671 | wifiManager.addParameter(&ldrParameter); 672 | #ifdef SCROLLING_ENABLED 673 | scrollingParameter.setValue(String(scrollingEnabled).c_str(), 1); 674 | wifiManager.addParameter(&scrollingParameter); 675 | #endif 676 | designParameter.setValue(String(activeDesign->id).c_str(), 2); 677 | wifiManager.addParameter(&designParameter); 678 | filterICEParameter.setValue(String((filter & PROD_ICE) > 0).c_str(), 1); 679 | wifiManager.addParameter(&filterICEParameter); 680 | filterICECParameter.setValue(String((filter & PROD_IC_EC) > 0).c_str(), 1); 681 | wifiManager.addParameter(&filterICECParameter); 682 | filterIRParameter.setValue(String((filter & PROD_IR) > 0).c_str(), 1); 683 | wifiManager.addParameter(&filterIRParameter); 684 | filterREParameter.setValue(String((filter & PROD_RE) > 0).c_str(), 1); 685 | wifiManager.addParameter(&filterREParameter); 686 | filterSParameter.setValue(String((filter & PROD_S) > 0).c_str(), 1); 687 | wifiManager.addParameter(&filterSParameter); 688 | filterBUSParameter.setValue(String((filter & PROD_BUS) > 0).c_str(), 1); 689 | wifiManager.addParameter(&filterBUSParameter); 690 | filterSHIPParameter.setValue(String((filter & PROD_SHIP) > 0).c_str(), 1); 691 | wifiManager.addParameter(&filterSHIPParameter); 692 | filterUParameter.setValue(String((filter & PROD_U) > 0).c_str(), 1); 693 | wifiManager.addParameter(&filterUParameter); 694 | filterSTBParameter.setValue(String((filter & PROD_STB) > 0).c_str(), 1); 695 | wifiManager.addParameter(&filterSTBParameter); 696 | filterASTParameter.setValue(String((filter & PROD_AST) > 0).c_str(), 1); 697 | wifiManager.addParameter(&filterASTParameter); 698 | wifiManager.setSaveConfigCallback(saveConfigCallback); 699 | wifiManager.setConnectTimeout(30); 700 | wifiManager.setConfigPortalTimeout(120); 701 | #endif 702 | pinMode(TFT_BL, OUTPUT); 703 | digitalWrite(TFT_BL, HIGH); 704 | tft.fillScreen(COLOR_BLACK); 705 | tft.setTextColor(COLOR_WHITE); 706 | tft.setRotation(rotation); 707 | tft.setTextSize(2); 708 | tft.print("Verbinde..."); 709 | Serial.print("Verbinde..."); 710 | #ifdef AUTOCONFIG 711 | if (!wifiManager.autoConnect(apSSID, apPassword)) { 712 | afterConfigCallback(); // try to save either way 713 | failedConfig(); 714 | } 715 | afterConfigCallback(); 716 | #else 717 | while (WiFi.status() != WL_CONNECTED) { 718 | tft.write('.'); 719 | Serial.write('.'); 720 | delay(500); 721 | } 722 | #endif 723 | #ifdef ENABLEOTA 724 | ArduinoOTA.onStart(updateStarted); 725 | ArduinoOTA.onEnd([]() { 726 | updateInhibit = false; 727 | tft.println("Fertig, starte neu."); 728 | }); 729 | ArduinoOTA.onError([](ota_error_t e) { 730 | updateInhibit = false; 731 | tft.println("Fehler."); 732 | delay(5000); 733 | drawStaticContent(); 734 | }); 735 | ArduinoOTA.setPassword(otaPassword); 736 | ArduinoOTA.begin(); 737 | #endif 738 | #ifdef ESP32 739 | analogSetAttenuation(ADC_2_5db); // ESP8266 equivalent 1.1V max 740 | #endif 741 | db.setAGFXOutput(true); 742 | Serial.println(); 743 | // Retry if no data available 744 | for (uint8_t i = 0; i < 3 && fromStation == NULL; i++) { 745 | fromStation = db.getStation(fromStationName); 746 | } 747 | yield(); 748 | timeClient.begin(); 749 | timeClient.setTimeOffset(3600); // CET 750 | adjustTime(3600); 751 | setSyncProvider(getNtpTime); 752 | drawStaticContent(); 753 | } 754 | 755 | void loop() { 756 | if (nextTime < millis() && !updateInhibit) { 757 | timeClient.update(); 758 | time_t tnow = timeClient.getEpochTime(); 759 | tdst = dst(tnow); 760 | if (old_time / 60 != tdst / 60) { 761 | drawTime(); 762 | } 763 | nextTime = millis() + 1000; 764 | } 765 | if (nextCheck < millis() && !updateInhibit) { 766 | if (WiFi.status() != WL_CONNECTED) { 767 | Serial.println("Disconnected"); 768 | failedConnection++; 769 | } else { 770 | failedConnection = 0; 771 | } 772 | // Try to refetch station 773 | if (fromStation == NULL) { 774 | fromStation = db.getStation(fromStationName); 775 | } 776 | // Reconfigure if station is still unknown 777 | if (fromStation == NULL) { 778 | strncpy(errorMessage, "Station konnte nicht\nabgerufen werden.", sizeof(errorMessage)); 779 | // No changes made, connection issue? Try to restart. 780 | if (doReconfig()) { 781 | ESP.restart(); 782 | } 783 | } 784 | Serial.println("Reload"); 785 | da = db.getDepartures(fromStation->stationId, NULL, tdst, activeDesign->maxEntries, 3, filter); 786 | Serial.println(db.getError()); 787 | departure = da; 788 | if (departure != NULL) { 789 | failedConnection = 0; // Reset, as we got a result anyways. 790 | failedUpdates = 0; 791 | } else { 792 | failedUpdates++; 793 | Serial.print("Update failed, currently at "); 794 | Serial.println(failedUpdates); 795 | } 796 | uint16_t pos = activeDesign->headerOffset; 797 | while (departure != NULL) { 798 | if (!drawDeparture(departure, pos)) break; 799 | departure = departure->next; 800 | } 801 | tft.setTextColor(COLOR_RED); 802 | // clear empty spots (not enough departures) only if the request succeeded. 803 | while (pos + activeDesign->itemHeight - 2 <= tft.height() && db.getError() == DBERR_NONE) { 804 | tft.fillRect(0, pos - 1, tft.width(), 18, activeDesign->backgroundColor); 805 | pos += activeDesign->itemHeight; 806 | } 807 | if (failedConnection == 5) { 808 | tft.fillScreen(COLOR_RED); 809 | tft.setTextColor(COLOR_WHITE); 810 | tft.setFont(); 811 | tft.setTextSize(2); 812 | tft.setCursor(0, 0); 813 | tft.println("WLAN Verbindung fehl\n-geschlagen"); 814 | tft.print("Starte neu..."); 815 | delay(5000); 816 | ESP.restart(); 817 | } 818 | nextCheck = millis() + 50000; 819 | } 820 | if (scrollingEnabled && activeDesign->canScroll && nextScroll < millis() && !updateInhibit && da != NULL) { 821 | departure = da; 822 | uint16_t pos = activeDesign->headerOffset; 823 | while (departure != NULL && pos + activeDesign->itemHeight - 2 < tft.height()) { 824 | printScroll(departure->target, pos, false, departure->cancelled); 825 | pos += activeDesign->itemHeight; 826 | departure = departure->next; 827 | } 828 | scroll++; 829 | nextScroll = millis() + SCROLL_INTERVAL; 830 | } 831 | #ifdef ENABLEOTA 832 | ArduinoOTA.handle(); 833 | #endif 834 | #ifdef AUTOCONFIG 835 | checkConfigRequest(); 836 | #endif 837 | if (ldr_pin > 0) { //0 is never an analog in 838 | if (nextBrightness < millis()) { 839 | uint16_t b = analogRead(ldr_pin); 840 | #ifdef ESP32 841 | b >>= 2; 842 | #endif 843 | if (b < currentBrightness) { 844 | currentBrightness--; 845 | } else if (b > currentBrightness) { 846 | currentBrightness++; 847 | } 848 | uint16_t brightness = map(currentBrightness, 1023, 0, MIN_BRIGHTNESS, MAX_BRIGHTNESS); 849 | analogWrite(TFT_BL, brightness); 850 | #ifdef DEBUG_BRIGHTNESS 851 | Serial.print("B:\t"); 852 | Serial.print(b); 853 | Serial.print("\tCB:\t"); 854 | Serial.print(currentBrightness); 855 | Serial.print("\tL:\t"); 856 | Serial.println(brightness); 857 | #endif 858 | nextBrightness = millis() + 10; 859 | } 860 | } 861 | } 862 | 863 | time_t dst(time_t t) { 864 | if (month(t) > 3 && month(t) < 10) { //Apr-Sep 865 | return t + 3600; 866 | } else if (month(t) == 3 && day(t) - weekday(t) >= 24) { //Date at or after last sunday in March 867 | if (weekday(t) == 1) { //Sunday to switch to dst 868 | if (hour(t) >= 2) { //Time after 2AM 869 | return t + 3600; 870 | } 871 | } else { //Date after last sunday in March 872 | return t + 3600; 873 | } 874 | } else if (month(t) == 10 && day(t) - weekday(t) < 24) { //Date before last sunday in October 875 | return t + 3600; 876 | } else if (month(t) == 10 && day(t) - weekday(t) >= 24) { //Date at or after last sunday in March 877 | if (weekday(t) == 1) { //Sunday to switch back from dst 878 | if (hour(t) < 3) { //Time before 2AM without DST (3AM DST, which doesn't exist) 879 | return t + 3600; 880 | } 881 | } 882 | } 883 | return t; 884 | } 885 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------