Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.81 KB

README.md

File metadata and controls

52 lines (39 loc) · 2.81 KB
Raw

DWDOpenDataPollenflugGefahrenindex

DWDOpenDataPollenflugGefahrenindex is a C++ library for ESP8266 Microcontrollers that can load and parse OpenData information from Deutscher Wetterdienst (DWD) what different pollen types spreads through the air.

Quickstart

The library also includes an example Sketch that demonstrate the basic usage.

Create a Client and load data

For every use case you need to initalize the library and load the data from the DWD OpenData Server. Also check Configuration section how to use the region_id parameter.

PollenflugData pollenflugData;
PollenflugGefahrenindex *pollenflugClient;

// see https://opendata.dwd.de/climate_environment/health/alerts/Beschreibung_pollen_s31fg.pdf for region_id
pollenflugClient->updateData(&pollenflugData, 31);

The returned forecast data is encoded as uint8_t values between 1 (no load) and 7 (high load). These are suitable if you want to create graphs or other visual representations. You can always use the getDescription method to get a description of the value.

Get the max. Load Index

The getMaxLoadIndex method returns the highest value of all pollen load found for a specific forecast.

Serial.println(pollenflugClient->getDescription(pollenflugClient->getMaxLoadIndex(&pollenflugData.today)));

Get the max. Load Index with filter for specific pollen types

The getMaxLoadIndex method also accepts an filter, to find the highest load value of specific pollen types. Following call f.e. will ignore Rogen and Graeser types.

Serial.println(pollenflugClient->getDescription(pollenflugClient->getMaxLoadIndex(&pollenflugData.today, true, true, true, false, true, true, true, false)));

Get an specific value

short use case description

Serial.println(pollenflugClient->getDescription(pollenflugData.today.graeser));

Configuration

An region_id is required to update the data. The library uses the region_ids from DWD, that are documented in the following PDF file on page 3ff. If an greater region (id ending with 0) is used, all sub-regions will be aggregated using an maximum function. The parameter 0 will parse all regions of germany.

License and credits

Copyright (c) 2018 Chris Klinger. Licensed under MIT license, see LICENSE for the full license.

DWDOpenDataPollenflugGefahrenindex uses the following libraries and frameworks, which have their own licenses:

Support the project

Do you like this library? I would appreciate if you star this project on GitHub!

Issues and support

See https://github.com/c-klinger/DWDOpenDataPollenflugGefahrenindex/issues.