Change algorithm to determine moon icon

Includes suggestions & fixes by @Th0mg, thanks. Fixes #143.

Author: marcelstoer

esp8266-weather-station-color.ino

@@ -87,9 +87,9 @@ TouchControllerWS touchController(&ts);
 void calibrationCallback(int16_t x, int16_t y);
 CalibrationCallback calibration = &calibrationCallback;
 
-
 OpenWeatherMapCurrentData currentWeather;
 OpenWeatherMapForecastData forecasts[MAX_FORECASTS];
+
 SunMoonCalc::Moon moonData;
 
 void updateData();
@@ -100,6 +100,7 @@ void drawCurrentWeather();
 void drawForecast();
 void drawForecastDetail(uint16_t x, uint16_t y, uint8_t dayIndex);
 void drawAstronomy();
+char determineMoonIcon();
 void drawCurrentWeatherDetail();
 void drawLabelValue(uint8_t line, String label, String value);
 void drawForecastTable(uint8_t start);
@@ -386,8 +387,8 @@ void updateData() {
   delete forecastClient;
   forecastClient = nullptr;
 
-  drawProgress(80, "Updating astronomy data...");
-  // 'now' has to be UTC, lat/lng in degrees not radians
+  drawProgress(80, "Updating astronomy...");
+  // 'now' has to be epoch instant, lat/lng in degrees not radians
   SunMoonCalc *smCalc = new SunMoonCalc(now, currentWeather.lat, currentWeather.lon);
   moonData = smCalc->calculateSunAndMoonData().moon;
   delete smCalc;
@@ -519,13 +520,14 @@ void drawForecastDetail(uint16_t x, uint16_t y, uint8_t dayIndex) {
   gfx.drawString(x + 25, y + 60, String(forecasts[dayIndex].rain, 1) + (IS_METRIC ? "mm" : "in"));
 }
 
-// draw moonphase and sunrise/set and moonrise/set
+// draw moonphase, sunrise/set and moonrise/set
 void drawAstronomy() {
 
   gfx.setFont(MoonPhases_Regular_36);
   gfx.setColor(MINI_WHITE);
   gfx.setTextAlignment(TEXT_ALIGN_CENTER);
-  gfx.drawString(120, 275, String((char) (97 + (moonData.illumination * 26))));
+  // gfx.drawString(120, 275, String((char) (97 + (moonData.illumination * 26))));
+  gfx.drawString(120, 275, String(determineMoonIcon()));
 
   gfx.setColor(MINI_WHITE);
   gfx.setFont(ArialRoundedMTBold_14);
@@ -548,12 +550,35 @@ void drawAstronomy() {
   gfx.setColor(MINI_YELLOW);
   gfx.drawString(235, 250, SUN_MOON_TEXT[3]);
   gfx.setColor(MINI_WHITE);
+
+  float lunarMonth = 29.53;
+  // approximate moon age
   gfx.drawString(190, 276, SUN_MOON_TEXT[4] + ":");
   gfx.drawString(235, 276, String(moonData.age, 1) + "d");
   gfx.drawString(190, 291, SUN_MOON_TEXT[5] + ":");
   gfx.drawString(235, 291, String(moonData.illumination * 100, 0) + "%");
 }
 
+// The Moon Phases font has 26 icons for gradiations, 1 full icon, and 1 empty icon: https://www.dafont.com/moon-phases.font
+// All of them are an approximation. 
+// Depending on date and location they would have to be rotated left or right by a varying degree.
+// GOTCHA  I: as we use white to display the moon icon, what is black on that font page (link above) will effectively be rendered white!
+// GOTCHA II: illumination in the range {0,1} will with near certainty never be exactly 0 or 1; rounding is, therefore, essential to ever get full/new moon!
+char determineMoonIcon() {
+  char moonIcon;
+  // index in range of 0..14
+  char index = round(moonData.illumination * 14);
+//  Serial.printf("Moon illumination: %f -> moon icon index: %d\n", moonData.illumination, index);
+  if (moonData.phase.index > 4) {
+    // waning (4 = full moon)
+    moonIcon = currentWeather.lat > 0 ? MOON_ICONS_NORTH_WANING[index] : MOON_ICONS_SOUTH_WANING[index];
+  } else {
+    // waxing
+    moonIcon = currentWeather.lat > 0 ? MOON_ICONS_NORTH_WAXING[index] : MOON_ICONS_SOUTH_WAXING[index];
+  }
+  return moonIcon;
+}
+
 void drawCurrentWeatherDetail() {
   gfx.setFont(ArialRoundedMTBold_14);
   gfx.setTextAlignment(TEXT_ALIGN_CENTER);
@@ -791,6 +816,8 @@ void loadPropertiesFromSpiffs() {
           Serial.printf(msg, "is12hStyle");
         }
       }
+    } else {
+      Serial.println("Does not exist.");
     }
     f.close();
     Serial.println("Effective properties now as follows:");

settings.h

@@ -37,6 +37,7 @@ const boolean HARD_SLEEP = false;         // true go into deepSleep false = turn
 // OpenWeatherMap Settings
 // Sign up here to get an API key: https://docs.thingpulse.com/how-tos/openweathermap-key/
 String OPEN_WEATHER_MAP_API_KEY = "";
+
 /*
 Go to https://openweathermap.org/find?q= and search for a location. Go through the
 result set and select the entry closest to the actual location you want to display 
@@ -45,6 +46,13 @@ at the end is what you assign to the constant below.
  */
 String OPEN_WEATHER_MAP_LOCATION_ID = "2657896";
 String DISPLAYED_LOCATION_NAME = "Zurich";
+//String OPEN_WEATHER_MAP_LOCATION_ID = "3833367";
+//String DISPLAYED_LOCATION_NAME = "Ushuaia";
+//String OPEN_WEATHER_MAP_LOCATION_ID = "2147714";
+//String DISPLAYED_LOCATION_NAME = "Sydney";
+//String OPEN_WEATHER_MAP_LOCATION_ID = "5879400";
+//String DISPLAYED_LOCATION_NAME = "Anchorage";
+
 /*
 Arabic -> ar, Bulgarian -> bg, Catalan -> ca, Czech -> cz, German -> de, Greek -> el,
 English -> en, Persian (Farsi) -> fa, Finnish -> fi, French -> fr, Galician -> gl,
@@ -79,6 +87,15 @@ bool IS_STYLE_HHMM = false; // true => HH:MM
 #define NTP_SERVERS "pool.ntp.org"
 // #define NTP_SERVERS "us.pool.ntp.org", "time.nist.gov", "pool.ntp.org"
 
+// Locations on the northern hemisphere (latitude > 0) and those on the southern hemisphere need 
+// an inverted set of moon phase icons/characters.
+// fully illuminated -> full moon -> char 48
+// zero illumination -> new moon -> char 64
+const char MOON_ICONS_NORTH_WANING[] = {64, 77, 76, 75, 74, 73, 72, 71, 70, 69, 68, 67, 66, 65, 48};
+const char MOON_ICONS_NORTH_WAXING[] = {64, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 48};
+const char MOON_ICONS_SOUTH_WANING[] = {64, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 48};
+const char MOON_ICONS_SOUTH_WAXING[] = {64, 77, 76, 75, 74, 73, 72, 71, 70, 69, 68, 67, 66, 65, 48};
+
 // August 1st, 2018
 #define NTP_MIN_VALID_EPOCH 1533081600