Add hour filter for forecast loading

Author: squix78

examples/OpenWeatherMapForecastDemo/OpenWeatherMapForecastDemo.ino

@@ -34,7 +34,7 @@ See more at https://blog.squix.org
 // initiate the client
 OpenWeatherMapForecast client;
 
-String OPEN_WEATHER_MAP_APP_ID = "XXX";
+String OPEN_WEATHER_MAP_APP_ID = "";
 String OPEN_WEATHER_MAP_LOCATION = "Zurich,CH";
 /*
 Arabic - ar, Bulgarian - bg, Catalan - ca, Czech - cz, German - de, Greek - el,
@@ -47,7 +47,7 @@ Chinese Simplified - zh_cn, Chinese Traditional - zh_tw.
 */
 String OPEN_WEATHER_MAP_LANGUAGE = "de";
 boolean IS_METRIC = false;
-uint8_t MAX_FORECASTS = 20;
+uint8_t MAX_FORECASTS = 15;
 
 /**
  * WiFi Settings
@@ -93,11 +93,13 @@ void setup() {
   OpenWeatherMapForecastData data[MAX_FORECASTS];
   client.setMetric(IS_METRIC);
   client.setLanguage(OPEN_WEATHER_MAP_LANGUAGE);
-  client.updateForecasts(data, OPEN_WEATHER_MAP_APP_ID, OPEN_WEATHER_MAP_LOCATION, MAX_FORECASTS);
-
+  uint8_t allowedHours[] = {0,12};
+  client.setAllowedHours(allowedHours, 2);
+  uint8_t foundForecasts = client.updateForecasts(data, OPEN_WEATHER_MAP_APP_ID, OPEN_WEATHER_MAP_LOCATION, MAX_FORECASTS);
+  Serial.printf("Found %d forecasts in this call\n", foundForecasts);
   Serial.println("------------------------------------");
   time_t time;
-  for (uint8_t i = 0; i < MAX_FORECASTS; i++) {
+  for (uint8_t i = 0; i < foundForecasts; i++) {
     Serial.printf("---\nForecast number: %d\n", i);
     // {"dt":1527066000, uint32_t observationTime;
     time = data[i].observationTime;
@@ -135,6 +137,8 @@ void setup() {
     Serial.printf("windSpeed: %f\n", data[i].windSpeed);
     //   "deg":207.501 float windDeg;
     Serial.printf("windDeg: %f\n", data[i].windDeg);
+    // rain: {3h: 0.055}, float rain;
+    Serial.printf("rain: %f\n", data[i].rain);
     // },"sys":{"pod":"d"}
     // dt_txt: "2018-05-23 09:00:00"   String observationTimeText;
     Serial.printf("observationTimeText: %s\n", data[i].observationTimeText.c_str());

src/OpenWeatherMapForecast.cpp

@@ -32,13 +32,13 @@ OpenWeatherMapForecast::OpenWeatherMapForecast() {
 
 }
 
-void OpenWeatherMapForecast::updateForecasts(OpenWeatherMapForecastData *data, String appId, String location, uint8_t maxForecasts) {
+uint8_t OpenWeatherMapForecast::updateForecasts(OpenWeatherMapForecastData *data, String appId, String location, uint8_t maxForecasts) {
   String units = metric ? "metric" : "imperial";
   this->maxForecasts = maxForecasts;
-  doUpdate(data, "http://api.openweathermap.org/data/2.5/forecast?q=" + location + "&appid=" + appId + "&units=" + units + "&lang=" + language);
+  return doUpdate(data, "http://api.openweathermap.org/data/2.5/forecast?q=" + location + "&appid=" + appId + "&units=" + units + "&lang=" + language);
 }
 
-void OpenWeatherMapForecast::doUpdate(OpenWeatherMapForecastData *data, String url) {
+uint8_t OpenWeatherMapForecast::doUpdate(OpenWeatherMapForecastData *data, String url) {
   unsigned long lostTest = 10000UL;
   unsigned long lost_do = millis();
   this->weatherItemCounter = 0;
@@ -80,6 +80,7 @@ void OpenWeatherMapForecast::doUpdate(OpenWeatherMapForecastData *data, String u
     }
   }
   this->data = nullptr;
+  return currentForecast;
 }
 
 void OpenWeatherMapForecast::whitespace(char c) {
@@ -101,11 +102,31 @@ void OpenWeatherMapForecast::value(String value) {
   // {"dt":1527066000,  uint32_t observationTime;
   if (currentKey == "dt") {
     data[currentForecast].observationTime = value.toInt();
+
+    if (allowedHoursCount > 0) {
+      time_t time = data[currentForecast].observationTime;
+      struct tm* timeInfo;
+      timeInfo = localtime(&time);
+      uint8_t currentHour = timeInfo->tm_hour;
+      for (uint8_t i = 0; i < allowedHoursCount; i++) {
+        if (currentHour == allowedHours[i]) {
+          isCurrentForecastAllowed = true;
+          return;
+        }
+      }
+      isCurrentForecastAllowed = false;
+      return;
+    }
+  }
+  if (!isCurrentForecastAllowed) {
+    return;
   }
   // "main":{
   //   "temp":17.35, float temp;
   if (currentKey == "temp") {
     data[currentForecast].temp = value.toFloat();
+    // initialize potentially empty values:
+    data[currentForecast].rain = 0;;
   }
   //   "temp_min":16.89, float tempMin;
   if (currentKey == "temp_min") {
@@ -167,6 +188,10 @@ void OpenWeatherMapForecast::value(String value) {
   if (currentKey == "deg") {
     data[currentForecast].windDeg = value.toFloat();
   }
+  // rain: {3h: 0.055}, float rain;
+  if (currentKey == "3h") {
+    data[currentForecast].rain = value.toFloat();
+  }
   // },"sys":{"pod":"d"}
   // dt_txt: "2018-05-23 09:00:00"   String observationTimeText;
   if (currentKey == "dt_txt") {

src/OpenWeatherMapForecast.h

@@ -26,6 +26,7 @@ See more at https://thingpulse.com
 #pragma once
 #include <JsonListener.h>
 #include <JsonStreamingParser.h>
+#include <time.h>
 
 typedef struct OpenWeatherMapForecastData {
   // {"dt":1527066000,
@@ -63,6 +64,8 @@ typedef struct OpenWeatherMapForecastData {
   float windSpeed;
   //   "deg":207.501
   float windDeg;
+  // rain: {3h: 0.055},
+  float rain;
   // },"sys":{"pod":"d"}
   // dt_txt: "2018-05-23 09:00:00"
   String observationTimeText;
@@ -79,18 +82,24 @@ class OpenWeatherMapForecast: public JsonListener {
     uint8_t currentForecast;
     boolean metric = true;
     String language = "en";
+    uint8_t *allowedHours;
+    uint8_t allowedHoursCount = 0;
+    boolean isCurrentForecastAllowed = true;
 
-
-  void doUpdate(OpenWeatherMapForecastData *data, String url);
+  uint8_t doUpdate(OpenWeatherMapForecastData *data, String url);
 
   public:
     OpenWeatherMapForecast();
-    void updateForecasts(OpenWeatherMapForecastData *data, String appId, String location, uint8_t maxForecasts);
+    uint8_t updateForecasts(OpenWeatherMapForecastData *data, String appId, String location, uint8_t maxForecasts);
 
     void setMetric(boolean metric) { this->metric = metric; }
     boolean isMetric() { return this->metric; }
     void setLanguage(String language) { this->language = language; }
     String getLanguage() { return this->language; }
+    void setAllowedHours(uint8_t *allowedHours, uint8_t allowedHoursCount) {
+      this->allowedHours = allowedHours;
+      this->allowedHoursCount = allowedHoursCount;
+    }
 
 
     String getMeteoconIcon(String icon);