├── .github └── FUNDING.yml ├── .gitignore ├── DBAPI.cpp ├── DBAPI.h ├── LICENSE ├── README.md ├── examples ├── DBTFT │ ├── .gitignore │ ├── .vscode │ │ └── extensions.json │ ├── platformio.ini │ └── src │ │ └── DBTFT.ino └── HannoverHBF │ ├── platformio.ini │ └── src │ └── HannoverHBF.ino └── library.json /.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 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .vscode/.browse.c_cpp.db* 3 | .vscode/c_cpp_properties.json 4 | .vscode/launch.json 5 | .vscode/ipch 6 | -------------------------------------------------------------------------------- /DBAPI.cpp: -------------------------------------------------------------------------------- 1 | #include "DBAPI.h" 2 | #include 3 | #include 4 | 5 | #ifdef DEBUG_ESP_PORT 6 | #define DB_DEBUG_MSG(...) DEBUG_ESP_PORT.printf( __VA_ARGS__ ) 7 | #else 8 | #define DB_DEBUG_MSG(...) 9 | #endif 10 | 11 | DBAPI::DBAPI() { 12 | 13 | } 14 | 15 | 16 | DBstation* DBAPI::getStation( 17 | const char* name, 18 | const char* address, 19 | uint8_t num 20 | ) { 21 | while (stations != NULL) { 22 | DBstation* next = stations->next; 23 | free(stations); 24 | stations = next; 25 | } 26 | /* 27 | bool isStation; 28 | if (name != NULL) { 29 | isStation = true; 30 | } else if (address != NULL) { 31 | isStation = false; 32 | } else { 33 | return NULL; 34 | } 35 | */ 36 | WiFiClientSecure client; 37 | client.setInsecure(); // Don't check fingerprint 38 | if (!client.connect(host, 443)) { 39 | DB_DEBUG_MSG("DBAPI: Connection to Host failed.\n"); 40 | return NULL; 41 | } 42 | String json = String("{\"locationTypes\":[\"ST\"],\"searchTerm\":\"") + name + "\"}"; 43 | 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 + 44 | "\r\nContent-Length: " + json.length() + "\r\n\r\n" + 45 | json 46 | ); 47 | 48 | char endOfHeaders[] = "\r\n\r\n"; 49 | if (!client.find(endOfHeaders)) { 50 | DB_DEBUG_MSG("Did not find headers\n"); 51 | return stations; 52 | } 53 | JsonDocument doc; 54 | DeserializationError error = deserializeJson(doc, client); 55 | if (error) { 56 | DB_DEBUG_MSG("deserializeJson() on Station failed"); 57 | DB_DEBUG_MSG(error.c_str()); 58 | return stations; 59 | } 60 | DBstation* prev = NULL; 61 | for (uint8_t i = 0; i < doc.size(); i++) { 62 | DBstation* station = new DBstation(); 63 | JsonObject st = doc[i]; 64 | String stationname = st["name"]; 65 | switch (repum) { 66 | case REP_AGFX: 67 | stationname.replace("ß", "\xE0"); 68 | stationname.replace("Ä", "\x8E"); 69 | stationname.replace("Ö", "\x99"); 70 | stationname.replace("Ü", "\x9A"); 71 | stationname.replace("ä", "\x84"); 72 | stationname.replace("ö", "\x94"); 73 | stationname.replace("ü", "\x81"); 74 | break; 75 | case REP_UML: 76 | stationname.replace("ß", "ss"); 77 | stationname.replace("Ä", "Ae"); 78 | stationname.replace("Ö", "Oe"); 79 | stationname.replace("Ü", "Ue"); 80 | stationname.replace("ä", "ae"); 81 | stationname.replace("ö", "oe"); 82 | stationname.replace("ü", "ue"); 83 | break; 84 | default: 85 | break; 86 | } 87 | strncpy(station->name, stationname.c_str(), sizeof(station->name)); 88 | strncpy(station->stationId, st["locationId"], sizeof(station->stationId)); 89 | station->longitude = st["coordinates"]["longitude"]; 90 | station->latitude = st["coordinates"]["latitude"]; 91 | station->next = NULL; 92 | if (prev == NULL) { // First element 93 | stations = station; 94 | } else { 95 | prev->next = station; 96 | } 97 | prev = station; 98 | } 99 | return stations; 100 | } 101 | 102 | DBstation* DBAPI::getStationByCoord( 103 | uint32_t latitude, 104 | uint32_t longitude, 105 | uint8_t num, 106 | uint16_t maxDistance 107 | ) { 108 | return NULL; 109 | } 110 | 111 | DBdeparr* DBAPI::getStationBoard( 112 | const char type[8], 113 | const char* stationId, 114 | const char* target, 115 | time_t time, 116 | uint8_t maxCount, 117 | uint8_t maxDuration, 118 | uint16_t productFilter 119 | ) { 120 | while (deparr != NULL) { 121 | DBdeparr* next = deparr->next; 122 | free(deparr); 123 | deparr = next; 124 | } 125 | 126 | bool abfahrt = strcmp(type, "abfahrt") == 0; 127 | DBdeparr* prev = NULL; 128 | uint8_t cnt = 0; 129 | 130 | // Set static request parameters 131 | JsonDocument reqDoc; 132 | JsonArray verkehrsmittel = reqDoc["verkehrsmittel"].to(); 133 | for (uint8_t i = 0; i < 10; i++) { 134 | if (productFilter & (1 << (9 - i))) { 135 | verkehrsmittel.add(services[i]); 136 | } 137 | } 138 | reqDoc["ursprungsBahnhofId"] = stationId; 139 | 140 | for (uint8_t offset = 0; offset < maxDuration; offset++) { 141 | // Get current time, if requesting more than one hour and no request time is set 142 | // Sanity check, that year is > 2020, so only successful synced time is used 143 | // Your device would probably not survive 2020 years without restart, huh? 144 | if (time == 0 && maxDuration > 1 && year() > 2020) { 145 | time = now(); 146 | } 147 | // Set params 148 | if (time != 0) { 149 | // Nobody knows, what happens at DST switch... ¯\_(ツ)_/¯ 150 | char buf[11]; 151 | // Setting the time offset - this might generate duplicates. 152 | // Train would have departed in queried hour but has delay of 70 min: 153 | // Will now be shown in the currently queried hour as the regular time matches. 154 | // But also in the next hour, because it will be reachable due to the delay. 155 | uint32_t tr = time + offset * 3600; 156 | snprintf(buf, 11, "%02d:%02d", hour(tr), minute(tr)); 157 | reqDoc["anfragezeit"] = buf; 158 | snprintf(buf, 11, "%4d-%02d-%02d", year(tr), month(tr), day(tr)); 159 | reqDoc["datum"] = buf; 160 | } 161 | size_t outputCapacity = 350; 162 | char* output = (char*)calloc(outputCapacity, sizeof(char)); 163 | serializeJson(reqDoc, output, outputCapacity); 164 | 165 | // Init new client for each request 166 | WiFiClientSecure client; 167 | client.setInsecure(); // Don't check fingerprint 168 | if (!client.connect(host, 443)) { 169 | DB_DEBUG_MSG("DBAPI: Connection to Host failed.\n"); 170 | free(output); 171 | return NULL; 172 | } 173 | 174 | DB_DEBUG_MSG("DBAPI: Requesting StationBoard.\n"); 175 | DB_DEBUG_MSG(output); 176 | client.print(String("POST /mob/bahnhofstafel/") + type + " HTTP/1.1\r\n" + 177 | "Host: " + host + "\r\n" + 178 | "Content-Type: application/x.db.vendo.mob.bahnhofstafeln.v2+json\r\n" + 179 | "Accept: application/x.db.vendo.mob.bahnhofstafeln.v2+json\r\n" + 180 | "X-Correlation-ID: Arduino\r\n" + 181 | "Content-Length: " + strlen(output) + "\r\n" + 182 | "Connection: close\r\n\r\n" + output); 183 | free(output); 184 | char endOfHeaders[] = "\r\n\r\n"; 185 | if (!client.find(endOfHeaders)) { 186 | DB_DEBUG_MSG("Did not find headers\n"); 187 | return deparr; 188 | } 189 | JsonDocument doc; 190 | client.find(":["); // Skip to first element 191 | do { 192 | DeserializationError error = deserializeJson(doc, client); 193 | if (error) { 194 | DB_DEBUG_MSG("deserializeJson() on departures/arrivals failed"); 195 | DB_DEBUG_MSG(error.c_str()); 196 | return deparr; 197 | } 198 | DBdeparr* da = new DBdeparr(); 199 | String targ = doc[abfahrt?"richtung":"abgangsOrt"]; 200 | 201 | switch (repum) { 202 | case REP_AGFX: 203 | targ.replace("ß", "\xE0"); 204 | targ.replace("Ä", "\x8E"); 205 | targ.replace("Ö", "\x99"); 206 | targ.replace("Ü", "\x9A"); 207 | targ.replace("ä", "\x84"); 208 | targ.replace("ö", "\x94"); 209 | targ.replace("ü", "\x81"); 210 | break; 211 | case REP_UML: 212 | targ.replace("ß", "ss"); 213 | targ.replace("Ä", "Ae"); 214 | targ.replace("Ö", "Oe"); 215 | targ.replace("Ü", "Ue"); 216 | targ.replace("ä", "ae"); 217 | targ.replace("ö", "oe"); 218 | targ.replace("ü", "ue"); 219 | break; 220 | default: 221 | break; 222 | } 223 | targ.toCharArray(da->target, sizeof(DBdeparr::target)); 224 | strncpy(da->product, doc["kurztext"], sizeof(DBdeparr::product)); 225 | //strncpy(da->product, doc["produktGattung"], sizeof(DBdeparr::product)); 226 | strncpy(da->textline, doc["mitteltext"], sizeof(DBdeparr::textline)); 227 | for (uint8_t i = 0; i < strlen(da->textline); i++) { 228 | if (da->textline[i] >= '0' && da->textline[i] <= '9') { 229 | strncpy(da->textline, &doc["mitteltext"].as()[i], sizeof(DBdeparr::textline)); 230 | da->line = atol(da->textline); 231 | break; 232 | } 233 | } 234 | if (!doc["gleis"].isNull()) { 235 | strncpy(da->platform, doc["gleis"], sizeof(DBdeparr::platform)); 236 | } else { 237 | da->platform[0] = 0; 238 | } 239 | 240 | if (!doc["ezGleis"].isNull()) { 241 | strncpy(da->newPlatform, doc["ezGleis"], sizeof(DBdeparr::newPlatform)); 242 | } else { 243 | da->newPlatform[0] = 0; 244 | } 245 | JsonArray arr = doc["echtzeitNotizen"]; 246 | da->cancelled = false; 247 | for (uint8_t i = 0; i < arr.size(); i++) { 248 | if (arr[i]["text"].as().equals("Halt entfällt")) { 249 | da->cancelled = true; 250 | break; // Not interested in other notes right now 251 | } else { 252 | //Serial.println(arr[i]["text"].as()); 253 | } 254 | } 255 | da->time = this->parseTime(String(doc[abfahrt ? "abgangsDatum" : "ankunftsDatum"])); 256 | if (doc[abfahrt ? "ezAbgangsDatum" : "ezAnkunftsDatum"].isNull()) { 257 | da->realTime = da->time; 258 | } else { 259 | da->realTime = this->parseTime(String(doc[abfahrt ? "ezAbgangsDatum" : "ezAnkunftsDatum"])); 260 | } 261 | da->delay = da->realTime - da->time; 262 | da->delay /= 60; 263 | 264 | da->next = NULL; 265 | if (prev == NULL) { 266 | DB_DEBUG_MSG("DBAPI: Got first departure."); 267 | deparr = da; 268 | } else { 269 | DB_DEBUG_MSG("DBAPI: Got next departure."); 270 | prev->next = da; 271 | } 272 | prev = da; 273 | cnt++; 274 | } while (client.findUntil(",","]") && cnt < maxCount); 275 | 276 | if (maxDuration > 0 && time == 0 && prev != NULL) { 277 | // If no synced time available, set request time to last known depature - 59 minutes 278 | time = prev->time - 3540; 279 | } 280 | if (year(time) < 2020) break; // Can't query more hours, as there is no valid timestamp 281 | } 282 | return deparr; 283 | } 284 | 285 | time_t DBAPI::parseTime(String t) { 286 | tmElements_t time; 287 | // 0123-56-89T12:45:67+90:23 288 | // Year in timeElements is years since 1970 289 | time.Year = atoi(t.substring(0,4).c_str()) - 1970; 290 | time.Month = atoi(t.substring(5,7).c_str()); 291 | time.Day = atoi(t.substring(8,10).c_str()); 292 | time.Hour = atoi(t.substring(11,13).c_str()); 293 | time.Minute = atoi(t.substring(14,16).c_str()); 294 | time.Second = 0; 295 | return makeTime(time); 296 | } 297 | 298 | DBdeparr* DBAPI::getDepartures( 299 | const char* stationId, 300 | const char* target, 301 | time_t time, 302 | uint8_t maxCount, 303 | uint8_t maxDuration, 304 | uint16_t productFilter 305 | ) { 306 | return getStationBoard("abfahrt", stationId, target, time, maxCount, maxDuration, productFilter); 307 | } 308 | 309 | DBdeparr* DBAPI::getArrivals( 310 | const char* stationId, 311 | const char* target, 312 | time_t time, 313 | uint8_t maxCount, 314 | uint8_t maxDuration, 315 | uint16_t productFilter 316 | ) { 317 | return getStationBoard("ankunft", stationId, target, time, maxCount, maxDuration, productFilter); 318 | } 319 | 320 | void DBAPI::setAGFXOutput(bool gfx) { 321 | repum = gfx ? REP_AGFX : REP_UML; 322 | } 323 | 324 | void DBAPI::setUmlaut(enum DBumlaut uml) { 325 | repum = uml; 326 | } 327 | 328 | const char* DBAPI::services[] = { 329 | "HOCHGESCHWINDIGKEITSZUEGE", 330 | "INTERCITYUNDEUROCITYZUEGE", 331 | "INTERREGIOUNDSCHNELLZUEGE", 332 | "NAHVERKEHRSONSTIGEZUEGE", 333 | "SBAHNEN", 334 | "BUSSE", 335 | "SCHIFFE", 336 | "UBAHN", 337 | "STRASSENBAHN", 338 | "ANRUFPFLICHTIGEVERKEHRE" 339 | }; -------------------------------------------------------------------------------- /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 DBproduct { 30 | PROD_ICE = 1 << 9, 31 | PROD_IC_EC = 1 << 8, 32 | PROD_IR = 1 << 7, 33 | PROD_RE = 1 << 6, 34 | PROD_S = 1 << 5, 35 | PROD_BUS = 1 << 4, 36 | PROD_SHIP = 1 << 3, 37 | PROD_U = 1 << 2, 38 | PROD_STB = 1 << 1, 39 | PROD_AST = 1 << 0 40 | }; 41 | 42 | enum DBumlaut { 43 | REP_NONE, 44 | REP_AGFX, 45 | REP_UML 46 | }; 47 | 48 | class DBAPI { 49 | private: 50 | const char* host = "app.vendo.noncd.db.de"; 51 | time_t parseTime(String t); 52 | DBdeparr* deparr = NULL; 53 | DBstation* stations = NULL; 54 | enum DBumlaut repum = REP_NONE; 55 | static const char* services[]; 56 | public: 57 | DBAPI(); 58 | DBstation* getStation( 59 | const char* name = NULL, 60 | const char* address = NULL, 61 | uint8_t num = 10 62 | ); 63 | DBstation* getStationByCoord( 64 | uint32_t latitude, 65 | uint32_t longitude, 66 | uint8_t num = 10, 67 | uint16_t maxDistance = 500 68 | ); 69 | DBdeparr* getStationBoard( 70 | const char type[8], 71 | const char* stationId, 72 | const char* target = NULL, 73 | time_t time = 0, 74 | uint8_t maxCount = 20, 75 | uint8_t maxDuration = 1, 76 | uint16_t productFilter = 1023 77 | ); 78 | DBdeparr* getDepartures( 79 | const char* stationId, 80 | const char* target = NULL, 81 | time_t time = 0, 82 | uint8_t num = 20, 83 | uint8_t maxDuration = 1, 84 | uint16_t productFilter = 1023 85 | ); 86 | DBdeparr* getArrivals( 87 | const char* stationId, 88 | const char* target = NULL, 89 | time_t time = 0, 90 | uint8_t num = 20, 91 | uint8_t maxDuration = 1, 92 | uint16_t productFilter = 1023 93 | ); 94 | // Output Adafruit GFX compatible Umlauts for default font 95 | void setAGFXOutput(bool gfx); 96 | void setUmlaut(enum DBumlaut uml); 97 | }; 98 | 99 | #endif //DBAPI_H -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DBAPI 2 | Hacon/Hafas/Deutsche Bahn API für ESP8266 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 8 | 9 | Wenn die Bibliothek hilfreich ist, gerne den Sponsor-Button von GitHub nutzen (PayPal). 10 | 11 | ## Abfrage 12 | 13 | `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). 14 | Ansonsten wird keine Umwandlung vorgenommen. 15 | 16 | ### Stationen 17 | Für weitere Anfragen wird die Stations-ID benötigt. 18 | Daher muss i.d.R. erst einmal diese abgefragt werden (kann dann statisch im Code hinterlegt werden). 19 | 20 | `DBstation* getStation(name, address, num)` 21 | 22 | | Variable | Typ | Standard | Funktion | 23 | | --- | --- | --- | --- | 24 | | `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). | 25 | | `address` | `const char*` | `NULL` | Kann alternativ angegeben werden (`name` auf `NULL` setzen), um die nächstgelegene Station zu einer Anschrift zu finden. | 26 | | `num` | `uint8_t` | `10` | Begrenzt die Anzahl der ausgegebenen Stationen | 27 | 28 | ### Ankunft/Abfahrt 29 | 30 | Die Zeiten werden standardmäßig für einen Zeitraum von einer Stunde ab Wunschzeit (oder "jetzt") abgerufen. 31 | Wird ein längerer Zeitraum ausgewählt, kann es zu Duplikaten kommen, da die Ergebnisse nicht gefiltert werden. 32 | 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 angezeigt, weil dieser immer noch erreichbar ist. 33 | 34 | `DBdeparr* getStationBoard(type, stationID, target, time, maxCount, maxDuration, productFilter)` 35 | 36 | `DBdeparr* getDepatures(stationID, target, time, maxCount, maxDuration, productFilter)` 37 | 38 | `DBdeparr* getArrivals(stationID, target, time, maxCount, maxDuration, productFilter)` 39 | 40 | `getDepatures` und `getArrivals` verweisen nur auf `getStationBoard` mit dem entsprechenden `type`. 41 | 42 | | Variable | Typ | Standard | Funktion | 43 | | --- | --- | --- | --- | 44 | | `type` | `char[8]` | | Kann entweder `abfahrt` oder `ankunft` sein. | 45 | | `stationID` | `char*` | | ID aus der `DBstation` | 46 | | `target` | `const char*` | `NULL` | entfallen, da nicht mehr in der API vorhanden | 47 | | `time` | `time_t` | `0` | Timestamp für die Abfrage oder `0` für "jetzt" | 48 | | `maxCount` | `uint8_t` | `20` | Anzahl der Ergebnisse, ohne Beschränkung mit offenem Filter reicht der RAM teils nicht an größeren Bahnhöfen | 49 | | `maxDuration` | `uint8_t` | `1` | Maximale Stunden, jede Stunde generiert eine zusätzliche Abfrage | 50 | | `productFilter` | `uint16_t` | `1023`/alle | Verkehrsmittel, die angezeigt werden sollen | 51 | 52 | #### Produktfilter 53 | 54 | Folgende Filter sind möglich: 55 | 56 | * `PROD_ICE` 57 | * `PROD_IC_EC` 58 | * `PROD_IR` 59 | * `PROD_RE` 60 | * `PROD_S` 61 | * `PROD_BUS` 62 | * `PROD_SHIP` 63 | * `PROD_U` 64 | * `PROD_STB` 65 | * `PROD_AST` (Anrufpflichtverkehr) 66 | 67 | Mittels bitweiser Oder-Verknüpfung (`|`) können mehrere Verkehrsmittel angefragt werden. 68 | 69 | ## Datenstrukturen 70 | 71 | ### `DBstation` 72 | | Name | Typ | Funktion | 73 | | --- | --- | --- | 74 | | `name` | `char[30]` | Stationsname | 75 | | `stationId` | `char[50]` | Stations ID | 76 | | `longitude` | `float` | Längengrad | 77 | | `latitude` | `float` | Breitengrad | 78 | | `next` | `DBstation*` | Nächste Station in der Liste | 79 | 80 | ### `DBdeparr` 81 | 82 | | Name | Typ | Funktion | 83 | | --- | --- | --- | 84 | | `time` | `time_t` | Reguläre Abfahrtszeit als Unix-Timestamp | 85 | | `realTime` | `time_t` | Tatsächliche Abfahrtszeit als Unix-Timestamp | 86 | | `delay` | `int16_t` | Verspätung | 87 | | `cancelled` | `bool` | Zug entfällt | 88 | | `platform` | `char[8]` | Geplantes Gleis (ggf. inkl. Abschnitt), sofern existent, sonst leer | 89 | | `newPlatform` | `char[8]` | Tatsächliches Gleis, sofern geändert, sonst leer | 90 | | `target` | `char[50]` | Zielhaltestelle | 91 | | `product` | `char[12]` | Bezeichnung des Verkehrsmittels | 92 | | `line` | `uint16_t` | Liniennummer | 93 | | `textline` | `char[20]` | Liniennummer als String (kann z.B. auch `SEV` sein) | 94 | | `next` | `DBdeparr*` | Nächste Fahrt in Liste | 95 | 96 | ### Hinweise zur Datenstruktur 97 | 98 | Wird eine neue Abfrage gestartet, so werden die zuletzt angefragten Daten überschrieben. 99 | Nutzdaten müssen vorher ggf. gespeichert werden. 100 | Werden etwa Ankunft *und* Abfahrt eines Bahnhofs angefragt, so ist nur das `DBdeparr*` der letzten Anfrage gültig. 101 | 102 | Mittels `for (; t != NULL; t = t->next) {...}` kann über die Stationen bzw. Fahrten iteriert werden (`t` vom Typ einer der beiden obigen Datenstrukturen). 103 | Soll die Referenz auf den Anfang nicht verloren gehen, so muss `t` mittels `Type* t = orig_t;` erstellt werden. 104 | 105 | ## Rechtliche Hinweise 106 | Die Bibliothek fragt direkt die Deutsche Bahn Schnittstelle an. 107 | Für die korrekte Funktion der Schnittstelle bzw. deren Daten kann keine Garantie übernommen werden. 108 | Die Benutzung erfolgt auf eigene Gefahr. 109 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /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/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.1.0 17 | paulstoffregen/Time @ ^1.6.1 18 | arduino-libraries/NTPClient @ ^3.2.1 19 | adafruit/Adafruit ILI9341 @ ^1.5.12 20 | bblanchon/ArduinoJson @ ^7.3.0 21 | -------------------------------------------------------------------------------- /examples/DBTFT/src/DBTFT.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | const char* ssid = "SSID"; 10 | const char* password = "password"; 11 | const char* fromStationName = "Hannnover Hbf"; 12 | 13 | WiFiUDP ntpUDP; 14 | NTPClient timeClient(ntpUDP, "pool.ntp.org"); 15 | 16 | #define BACKGROUND_COLOR 0x001F // Blue 17 | #define FOREGROUND_COLOR 0xFFFF // White 18 | #define HIGHLIGHT_COLOR 0xFFE0 // Yellow 19 | 20 | // Optional view with large destinations, does interfere with platform when station names are longer 21 | #define WIDE_MODE 22 | #define SCROLL_CHARS 13 23 | #define SCROLL_STALL 5 24 | #define SCROLL_INTERVAL 400 25 | //#define SCROLLING_ENABLED 26 | //#define TEXT_FILL 27 | 28 | DBAPI db; 29 | DBstation* fromStation; 30 | DBdeparr* da = NULL; 31 | DBdeparr* departure = NULL; 32 | uint32_t nextCheck; 33 | uint32_t nextTime; 34 | uint32_t nextScroll; 35 | time_t old_time; 36 | 37 | #define TFT_DC 16 38 | #define TFT_CS 15 39 | #define TFT_BL 5 40 | Adafruit_ILI9341 tft = Adafruit_ILI9341(TFT_CS, TFT_DC); 41 | 42 | time_t getNtpTime() { 43 | return timeClient.getEpochTime(); 44 | } 45 | 46 | void setup() { 47 | Serial.begin(115200); 48 | tft.begin(); 49 | WiFi.mode(WIFI_STA); 50 | WiFi.begin(ssid, password); 51 | pinMode(TFT_BL, OUTPUT); 52 | digitalWrite(TFT_BL, HIGH); 53 | tft.fillScreen(BACKGROUND_COLOR); 54 | tft.setTextColor(FOREGROUND_COLOR); 55 | tft.setRotation(1); 56 | tft.print("Verbinde..."); 57 | Serial.print("Verbinde..."); 58 | while (WiFi.status() != WL_CONNECTED) { 59 | tft.write('.'); 60 | Serial.write('.'); 61 | delay(500); 62 | } 63 | db.setAGFXOutput(true); 64 | Serial.println(); 65 | fromStation = db.getStation(fromStationName); 66 | yield(); 67 | timeClient.begin(); 68 | timeClient.setTimeOffset(3600); // CET 69 | adjustTime(3600); 70 | setSyncProvider(getNtpTime); 71 | 72 | // Draw static content 73 | tft.fillScreen(BACKGROUND_COLOR); 74 | tft.setTextColor(FOREGROUND_COLOR); 75 | tft.setTextSize(2); 76 | //tft.setCursor((tft.width() - (strlen(fromStationName) * 6 - 1) * 2) / 2, 2); 77 | tft.setCursor(11 * 6 + 6, 2); 78 | tft.print(fromStationName); 79 | tft.fillRect(0, 18, tft.width(), 18, HIGHLIGHT_COLOR); 80 | tft.setTextColor(BACKGROUND_COLOR); 81 | tft.setCursor(2, 20); 82 | tft.print("Zeit"); 83 | #ifdef WIDE_MODE 84 | tft.setCursor(11 * 6 + 6, 20); 85 | #else // WIDE_MODE 86 | tft.setCursor(9 * 6 + 6, 20); 87 | #endif // WIDE_MODE 88 | tft.print("Nach"); 89 | tft.setCursor(tft.width() - 7 * 6 * 2, 20); 90 | tft.print("Gleis"); 91 | } 92 | 93 | uint32_t scroll; 94 | time_t tdst; 95 | void loop() { 96 | if (nextTime < millis()) { 97 | timeClient.update(); 98 | time_t tnow = timeClient.getEpochTime(); 99 | tdst = dst(tnow); 100 | if (old_time / 60 != tdst / 60) { 101 | tft.setTextColor(FOREGROUND_COLOR); 102 | tft.setTextSize(2); 103 | tft.setCursor(2, 2); 104 | tft.fillRect(2, 2, 5 * 6 * 2 , 16, BACKGROUND_COLOR); 105 | if (hour(tdst) < 10) tft.write('0'); 106 | tft.print(hour(tdst)); 107 | tft.write(':'); 108 | if (minute(tdst) < 10) tft.write('0'); 109 | tft.print(minute(tdst)); 110 | old_time = tdst; 111 | } 112 | nextTime = millis() + 1000; 113 | } 114 | if (nextCheck < millis()) { 115 | if (WiFi.status() != WL_CONNECTED) { 116 | Serial.println("Disconnected"); 117 | } 118 | Serial.println("Reload"); 119 | da = db.getDepartures(fromStation->stationId, NULL, tdst, 11, 3, PROD_RE | PROD_S); 120 | Serial.println(); 121 | departure = da; 122 | uint16_t pos = 21; 123 | char buf[10]; 124 | while (departure != NULL) { 125 | pos += 18; 126 | if (pos + 16 > tft.height()) break; 127 | #ifdef WIDE_MODE 128 | tft.fillRect(0, pos - 1, 11 * 6 + 4 , 17, FOREGROUND_COLOR); 129 | #else // WIDE_MODE 130 | tft.fillRect(0, pos - 1, 9 * 6 + 4 , 17, FOREGROUND_COLOR); 131 | #endif // WIDE_MODE 132 | tft.setTextColor(BACKGROUND_COLOR); 133 | tft.setTextSize(1); 134 | tft.setCursor(2, pos); 135 | char buf[6]; 136 | snprintf(buf, sizeof(buf), "%02d:%02d", hour(departure->time), minute(departure->time)); 137 | tft.print(buf); 138 | #ifdef WIDE_MODE 139 | if (!departure->cancelled && departure->delay) { 140 | tft.print(" +"); 141 | tft.print(departure->delay); 142 | } 143 | #endif // WIDE_MODE 144 | tft.setCursor(2, pos + 8); 145 | tft.print(departure->product); 146 | if (strcmp("", departure->textline) != 0) { 147 | tft.write(' '); 148 | tft.print(departure->textline); 149 | } 150 | tft.setTextColor(FOREGROUND_COLOR); 151 | #ifdef WIDE_MODE 152 | tft.fillRect(11 * 6 + 4, pos - 1, tft.width(), 17, BACKGROUND_COLOR); 153 | printScroll(departure->target, 11 * 6 + 6, pos, true, departure->cancelled); 154 | #else // WIDE_MODE 155 | tft.fillRect(9 * 6 + 4, pos - 1, tft.width(), 17, BACKGROUND_COLOR); 156 | tft.setCursor(9 * 6 + 6, pos); 157 | tft.setTextSize(1); 158 | tft.print(departure->target); 159 | #endif // WIDE_MODE 160 | 161 | #ifndef WIDE_MODE 162 | tft.setTextColor(HIGHLIGHT_COLOR); 163 | tft.setCursor(9 * 6 + 6, pos + 8); 164 | if (departure->cancelled) { 165 | tft.print("Fahrt f\x84llt aus"); 166 | tft.drawFastHLine(9 * 6 + 6, pos + 3, strlen(departure->target) * 6 - 1, FOREGROUND_COLOR); 167 | } else if (departure->delay) { 168 | tft.print("ca. "); 169 | tft.print(departure->delay); 170 | tft.print(" Minuten sp\x84ter"); 171 | } 172 | #endif 173 | tft.setTextColor(FOREGROUND_COLOR); 174 | tft.setTextSize(2); 175 | tft.setCursor(tft.width() - 7 * 6 * 2, pos); 176 | if (strcmp("", departure->newPlatform) != 0) { 177 | tft.setTextColor(HIGHLIGHT_COLOR); 178 | tft.print("->"); 179 | tft.print(departure->newPlatform); 180 | } else { 181 | tft.print(departure->platform); 182 | } 183 | departure = departure->next; 184 | } 185 | nextCheck = millis() + 50000; 186 | } 187 | #ifdef WIDE_MODE 188 | if (nextScroll < millis()) { 189 | departure = da; 190 | uint16_t pos = 21; 191 | while (departure != NULL) { 192 | pos += 18; 193 | printScroll(departure->target, 11 * 6 + 6, pos, false, departure->cancelled); 194 | departure = departure->next; 195 | } 196 | scroll++; 197 | nextScroll = millis() + SCROLL_INTERVAL; 198 | } 199 | #endif 200 | } 201 | 202 | void printScroll(String text, uint16_t x, uint16_t y, bool force, bool cancelled) { 203 | #ifdef TEXT_FILL 204 | tft.setTextColor(FOREGROUND_COLOR, BACKGROUND_COLOR); 205 | #else // TEXT_FILL 206 | tft.setTextColor(FOREGROUND_COLOR); 207 | #endif // TEXT_FILL 208 | tft.setTextSize(2); 209 | if (text.length() > SCROLL_CHARS || force) { 210 | #ifdef SCROLLING_ENABLED 211 | uint32_t p = scroll; 212 | int16_t ts = text.length() - SCROLL_CHARS; 213 | if (ts < 0) { 214 | ts = 0; 215 | } 216 | uint32_t to_scroll = ts; 217 | p %= to_scroll * 2 + SCROLL_STALL * 2; 218 | if (p <= to_scroll) { 219 | if (!force && p == 0) return; // do not update 0 position 220 | } else if (p <= to_scroll + SCROLL_STALL) { 221 | p = to_scroll; 222 | if (!force) return; // do not update on stall, if no update is forced 223 | } else if (p <= to_scroll * 2 + SCROLL_STALL) { 224 | p = SCROLL_STALL + to_scroll * 2 - p; 225 | } else { 226 | p = 0; 227 | if (!force) return; // do not update on stall, if no update is forced 228 | } 229 | #else // SCOLLING_ENABLED 230 | if (!force) return; 231 | uint32_t p = 0; 232 | #endif // SCROLLING_ENABLED 233 | #ifndef TEXT_FILL 234 | tft.fillRect(x - 2, y - 1, SCROLL_CHARS * 6 * 2, 17, BACKGROUND_COLOR); 235 | #endif // TEXT_FILL 236 | tft.setCursor(x, y); 237 | text = text.substring(p, p + SCROLL_CHARS); 238 | tft.print(text); 239 | if (cancelled) { 240 | uint8_t len = min((uint8_t) text.length(), (uint8_t) SCROLL_CHARS); 241 | tft.drawFastHLine(x, y + 6, (len * 6 - 1) * 2, FOREGROUND_COLOR); 242 | tft.drawFastHLine(x, y + 7, (len * 6 - 1) * 2, FOREGROUND_COLOR); 243 | } 244 | } 245 | } 246 | 247 | time_t dst(time_t t) { 248 | if (month(t) > 3 && month(t) < 10) { //Apr-Sep 249 | return t + 3600; 250 | } else if (month(t) == 3 && day(t) - weekday(t) >= 24) { //Date at or after last sunday in March 251 | if (weekday(t) == 1) { //Sunday to switch to dst 252 | if (hour(t) >= 2) { //Time after 2AM 253 | return t + 3600; 254 | } 255 | } else { //Date after last sunday in March 256 | return t + 3600; 257 | } 258 | } else if (month(t) == 10 && day(t) - weekday(t) < 24) { //Date before last sunday in October 259 | return t + 3600; 260 | } else if (month(t) == 10 && day(t) - weekday(t) >= 24) { //Date at or after last sunday in March 261 | if (weekday(t) == 1) { //Sunday to switch back from dst 262 | if (hour(t) < 3) { //Time before 2AM without DST (3AM DST, which doesn't exist) 263 | return t + 3600; 264 | } 265 | } 266 | } 267 | return t; 268 | } 269 | -------------------------------------------------------------------------------- /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.1.0 17 | bblanchon/ArduinoJson @ ^7.3.0 18 | paulstoffregen/Time @ ^1.6.1 19 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "DBAPI", 3 | "version": "2.1.1", 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 | "paulstoffregen/Time": "^1.6.1", 23 | "bblanchon/ArduinoJson": "^7.3.0" 24 | } 25 | } --------------------------------------------------------------------------------