From 1619d1867b76a8a2ad550d6ee238fbeaf9d5022d Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Sat, 6 Mar 2021 11:01:01 +0100 Subject: [PATCH] Add updates for "Apicast beeflight forecast access" release 0.8.3 --- CHANGES.rst | 3 + lib/apicast/README.rst | 176 ++++++++++++++++++----------------- lib/apicast/apicast_client.h | 2 - src/hiveeyes_config.h | 9 +- 4 files changed, 97 insertions(+), 93 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 9815cca..d148134 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -7,6 +7,8 @@ Hiveeyes e-Paper display CHANGELOG In progress *********** +- Update Apicast beeflight forecast access, see also `Apicast 0.8.3 release`_. + **************** 2021-01-15 0.1.1 @@ -41,3 +43,4 @@ In progress .. _Using the Hiveeyes HTTP export interface from Arduino: https://community.hiveeyes.org/t/erschliessung-der-http-datenexportschnittstelle-via-arduino/3254 .. _Apicast HTTP API: https://community.hiveeyes.org/t/dwd-prognose-bienenflug/787/15 .. _Anzeige von PNG-Bitmaps aus Grafana auf einem e-Paper Display: https://community.hiveeyes.org/t/anzeige-von-png-bitmaps-aus-grafana-auf-einem-e-paper-display/3286 +.. _Apicast 0.8.3 release: https://community.hiveeyes.org/t/dwd-prognose-bienenflug/787/22 diff --git a/lib/apicast/README.rst b/lib/apicast/README.rst index 0a206c2..f95fc2b 100644 --- a/lib/apicast/README.rst +++ b/lib/apicast/README.rst @@ -1,96 +1,100 @@ -##################################### -Apicast HTTP to Json data export for Arduino -##################################### +############################################ +Apicast HTTP to JSON data export for Arduino +############################################ ***** About ***** -This code fetches data from the Apicast-Hiveeyes-Platform. -It converts data from the bee flight forecast of the German Weather Service (DWD)into the .Json format -Manny Thanks to Andreas Mot -Example of the API: -http://apicast.hiveeyes.org/beeflight/forecast/germany/berlin_brandenburg/potsdam +This code fetches data from the *Hiveeyes Apicast* service. -available locations for the forecast: +It converts data from the bee flight forecast information published by the +German Weather Service (DWD) into JSON format. -baden-wuerttemberg, Baden-Württemberg - freudenstadt, Freudenstadt im Schwarzwald - konstanz, Konstanz am Bodensee - lahr, Lahr - mannheim, Mannheim - oehringen, Öhringen - rheinstetten, Rheinstetten - stoetten, Stötten (Geislingen an der Steige) - stuttgart, Stuttgart (Flughafen) -bayern, Bayern - augsburg, Augsburg - bamberg, Bamberg - fuerstenzell, Fürstenzell - hof, Hof - hohenpeissenberg, Hohenpeißenberg - kempten, Kempten (Allgäu) - muenchen, München (Flughafen) - nuernberg, Nürnberg (Flughafen) - oberstdorf, Oberstdorf (Allgäu) - regensburg, Regensburg - straubing, Straubing - weiden, Weiden in der Oberpfalz - wuerzburg, Würzburg -berlin_brandenburg, Berlin und Brandenburg - angermuende, Angermünde - berlin, Berlin-Tempelhof - cottbus, Cottbus - lindenberg, Lindenberg (Tauche) - neuruppin, Neuruppin - potsdam, Potsdam -hessen, Hessen - frankfurt, Frankfurt/Main (Flughafen) - fritzlar, Fritzlar - offenbach, Offenbach/Main (Wetterpark) - wasserkuppe, Wasserkuppe - wettenberg, Wettenberg bei Gießen -mecklenburg-vorpommern, Mecklenburg-Vorpommern - arkona, Arkona (Putgarten) - greifswald, Greifswald - marnitz, Marnitz - rostock, Rostock-Warnemünde - schwerin, Schwerin -niedersachsen_bremen, Niedersachsen und Bremen - bremen, Bremen (Flughafen) - cuxhaven, Cuxhaven - emden, Emden - hannover, Hannover (Flughafen) - norderney, Norderney -nordrhein-westfalen, Nordrhein-Westfalen - aachen, Aachen-Orsbach - lippspringe, Bad Lippspringe - duesseldorf, Düsseldorf (Flughafen) - greven, Greven (Flughafen Münster/Osnabrück) - kahler_asten, Kahler Asten (Winterberg) - koeln, Köln (Flughafen Köln/Bonn) -rheinland-pfalz_saarland, Rheinland-Pfalz und Saarland - hahn, Hahn (Flughafen) - nuerburg, Nürburg-Barweiler - saarbruecken, Saarbrücken (Flughafen) - trier, Trier-Petrisberg -sachsen, Sachsen Sachsen-Anhalt - dresden, Dresden (Flughafen) - goerlitz, Görlitz - leipzig, Leipzig (Flughafen Leipzig/Halle) -sachsen-anhalt, Sachsen-Anhalt - magdeburg, Magdeburg -schleswig-holstein_hamburg, Schleswig-Holstein und Hamburg - fehmarn, Fehmarn - hamburg, Hamburg (Flughafen) - helgoland, Helgoland - kiel, Kiel-Holtenau - list, List auf Sylt - schleswig, Schleswig -thueringen, Thüringen - erfurt, Erfurt (Flughafen Erfurt-Weimar) - gera, Gera - meiningen, Meiningen +Manny thanks to the DWD and Andreas Motl. +******** +Synopsis +******** + +Example of the data endpoint:: + + http://apicast.hiveeyes.org/beeflight/forecast/germany/brandenburg/potsdam + +The list of possible location slugs can be obtained from: + + http://apicast.hiveeyes.org/beeflight/stations/germany/locations + +The available locations as of 2021 are:: + + [ + "baden-wurttemberg/freudenstadt", + "baden-wurttemberg/konstanz", + "baden-wurttemberg/lahr", + "baden-wurttemberg/mannheim", + "baden-wurttemberg/ohringen", + "baden-wurttemberg/rheinstetten", + "baden-wurttemberg/stotten", + "baden-wurttemberg/stuttgart-flughafen", + "bayern/augsburg", + "bayern/bamberg", + "bayern/furstenzell", + "bayern/hof", + "bayern/hohenpeissenberg", + "bayern/kempten", + "bayern/munchen-flughafen", + "bayern/nurnberg-flughafen", + "bayern/oberstdorf", + "bayern/regensburg", + "bayern/straubing", + "bayern/weiden", + "bayern/wurzburg", + "berlin/berlin-tempelhof", + "brandenburg/angermunde", + "brandenburg/cottbus", + "brandenburg/lindenberg", + "brandenburg/potsdam", + "bremen/bremen-flughafen", + "hamburg/hamburg-flughafen", + "hessen/frankfurt-flughafen", + "hessen/fritzlar", + "hessen/offenbach-wetterpark", + "hessen/wasserkuppe", + "hessen/wettenberg-bei-giessen", + "mecklenburg-vorpommern/arkona", + "mecklenburg-vorpommern/greifswald", + "mecklenburg-vorpommern/marnitz", + "mecklenburg-vorpommern/rostock-warnemunde", + "mecklenburg-vorpommern/schwerin", + "mecklenburg-vorpommern/waren-muritz", + "niedersachsen/cuxhaven", + "niedersachsen/emden", + "niedersachsen/hannover-flughafen", + "niedersachsen/luchow", + "niedersachsen/norderney", + "nordrhein-westfalen/aachen-orsbach", + "nordrhein-westfalen/bad-lippspringe", + "nordrhein-westfalen/dusseldorf-flughafen", + "nordrhein-westfalen/essen-bredeney", + "nordrhein-westfalen/kahler-asten", + "nordrhein-westfalen/koln-bonn-flughafen", + "nordrhein-westfalen/munster-osnabruck-flughafen", + "rheinland-pfalz/hahn", + "rheinland-pfalz/nurburg-barweiler", + "rheinland-pfalz/trier-petrisberg", + "saarland/saarbrucken-flughafen", + "sachsen-anhalt/magdeburg", + "sachsen/dresden-klotzsche-flughafen", + "sachsen/gorlitz", + "sachsen/leipzig-halle-flughafen", + "schleswig-holstein/fehmarn", + "schleswig-holstein/helgoland", + "schleswig-holstein/kiel-holtenau", + "schleswig-holstein/list-auf-sylt", + "schleswig-holstein/schleswig", + "thuringen/erfurt-weimar-flughafen", + "thuringen/gera-leumnitz", + "thuringen/meiningen" + ] diff --git a/lib/apicast/apicast_client.h b/lib/apicast/apicast_client.h index bf224b4..a48e096 100644 --- a/lib/apicast/apicast_client.h +++ b/lib/apicast/apicast_client.h @@ -41,12 +41,10 @@ bool decode_beeflight(WiFiClient& json) { bool obtain_apicast_data(WiFiClient& client) { // Define URI. - // https://getkotori.org/docs/handbook/export/ HTTPClient http; http.useHTTP10(true); String server = apicast_server; - // TODO: Improve Kotori by requesting only last reading. String uri = apicast_uri; // Make HTTP request. diff --git a/src/hiveeyes_config.h b/src/hiveeyes_config.h index 488cbe9..e81c6ec 100644 --- a/src/hiveeyes_config.h +++ b/src/hiveeyes_config.h @@ -24,18 +24,17 @@ String ReadingRssi = "system.wifi.rssi"; #endif //############################################################################################ -//############ Forecast beeflight - Get Data from DWD by Apicast-Hiveeyes #################### +//############### Beeflight forecast - Get DWD data from Hiveeyes Apicast #################### //############################################################################################ //#define Apicast // uncomment with "//"" if not use #ifdef Apicast String apicast_server = "apicast.hiveeyes.org"; String apicast_uri_1 = "/beeflight/forecast/germany/"; -String apicast_uri_2 = "berlin_brandenburg/berlin"; // * federal-state and Station +String apicast_uri_2 = "brandenburg/potsdam"; // * federal state and station #endif -// * You can get a list of available Stations here http://apicast.hiveeyes.org/ under Index/List of side slugs -// or build yourself from here https://www.dwd.de/DE/leistungen/biene_flug/bienenflug.html from "Bundesland" and Station -// Example: String apicast_uri_2 = "Bundesland"+"/"+"Station"; +// To get an idea about Apicast, please visit http://apicast.hiveeyes.org/. +// You can get a list of available locations at http://apicast.hiveeyes.org/beeflight/stations/germany/locations. //########################################################################### //############### get Pictures from Http/Https ##############################