view_events.h

#pragma once   // Please format this file with clang before check-in to GitHub
/*
  File:     view_events.h

  Special Event Calendar Count - "How many days since Groundhog Day 2020"
            or "How many days until June VHF Contest"

  Version history:
            2021-06-24 added multiple choices of count-down-to-date
            2020-10-15 refactored from .cpp to .h
            2020-10-02 created

  Software: Barry Hansen, K7BWH, barry@k7bwh.com, Seattle, WA
  Hardware: John Vanderbeck, KM7O, Seattle, WA

  Purpose:  This is a frivolous calendar display showing the number
            of days in a row that we've celebrated some special event.
            I happen to be amused by wishing people "Happy Groundhog Day"
            during the pandemic and self-isolation. This is a reference to
            the film "Groundhog Day," a 1993 comedy starring Bill Murray who
            is caught in a time loop and relives February 2 repeatedly.
            The first cases of covid-19 were reported near the end of January
            in Washington State near where I live. So Feb 2 is a reasonable
            stand-in for the start of the pandemic.

            This is "total days spanned" and not "days since the event".
            The difference is whether or not the first day is included in the count.
            I want Feb 2 as "Groundhog Day #1" and Feb 3 as "Groundhog Day #2."
            In contrast, calculating "days since" would show Feb 3 as Day #1.

  Inspired by: https://days.to/groundhog-day/2020

            +-----------------------------------------+
            | *        How many days since          > |
            |       Sunday, February 2, 2020          |
            |            Groundhog Day                |
            |                                         |
            |           NNNNN NNNNN NNNNN             |
            |           NNNNN NNNNN NNNNN             |
            |           NNNNN NNNNN NNNNN             |
            |           NNNNN NNNNN NNNNN             |
            |                                         |
            |            HH    MM    SS               |
            |           hours  min   sec              |
            |                                         |
            |               Today is                  |
            | -7h          Oct 2, 2020             6# |
            +-----------------------------------------+

  Units of Time:
         This relies on "TimeLib.h" which uses "time_t" to represent time.
         The basic unit of time (time_t) is the number of seconds since Jan 1, 1970,
         a compact 4-byte integer.
         https://github.com/PaulStoffregen/Time

*/

#include <Adafruit_ILI9341.h>   // TFT color display library
#include <TimeLib.h>            // time_t=seconds since Jan 1, 1970, https://github.com/PaulStoffregen/Time
#include "constants.h"          // Griduino constants and colors
#include "logger.h"             // conditional printing to Serial port
#include "date_helper.h"        // date/time conversions
#include "model_gps.h"          // Model of a GPS for model-view-controller
#include "TextField.h"          // Optimize TFT display text for proportional fonts
#include "view.h"               // Base class for all views

// ========== extern ===========================================
extern Logger logger;   // Griduino.ino
extern Model *model;    // "model" portion of model-view-controller

extern void showDefaultTouchTargets();   // Griduino.ino

// ===== definitions to manage the count up/down events
#define DAYS_SINCE   true    // count UP after a date has passed
#define COUNTDOWN_TO false   // count DOWN until a date is reached

#define SHOW_HMS true
#define HIDE_HMS false

struct DefinedEvent {
  int countup;     // = DAYS_SINCE | COUNTDOWN_TO
  bool show_HMS;   // = SHOW_HMS | HIDE_HMS
  char line1[24];
  char line2[26];
  char line3[26];
  TimeElements eventGMT;
};

// ======= some interesting target events for count up/down display ========

DefinedEvent aug_microwave{
    // Time until August ARRL 10 HGz & Up Contest
    // "Third full weekend of August and September"
    // http://www.arrl.org/10-ghz-up
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "Aug 19, 2023, 6 am local",
    "ARRL 10 GHz & Up Contest",
    // s,m,h, dow, dd, mm, yy
    {0, 0, 13, 1, 19, 8, 2023 - 1970},
};

DefinedEvent sept_vhf{
    // Time until Sept VHF Contest
    // "Second full weekend in September"
    // http://www.arrl.org/september-vhf
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "Sept 9, 2023 at 1800z",
    "ARRL Sept VHF Contest",
    // s,m,h, dow, dd, mm, yy
    {0, 0, 18, 1, 9, 9, 2023 - 1970},
};

DefinedEvent june_vhf{
    // Time until June VHF Contest
    // "Second full weekend in June"
    // http://www.arrl.org/june-vhf
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "June 10, 2023 at 1800z",
    "ARRL June VHF Contest",
    // s,m,h, dow, dd, mm, yy GMT
    {0, 0, 18, 1, 10, 6, 2023 - 1970},
};

DefinedEvent groundhog{
    // Number of "Groundhog Days"
    DAYS_SINCE,
    HIDE_HMS,
    "Total days including",
    "Sunday, Feb 2, 2020",
    "Groundhog Day",
    // s,m,h, dow, dd, mm, yy
    {0, 0, 7, 1, 1, 2, 2020 - 1970},   // Use the day before Feb 2, so the counter includes "Groundhog Day #1" on 2/2/2020
};

DefinedEvent halloween{
    // Time until Halloween Trick'r Treaters knock on door
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "Halloween 6pm",
    "Days til Trick'r Treaters",
    // s,m,h,     dow, dd, mm, yy
    {0, 0, 7 + 18, 1, 31, 10, 2023 - 1970},   // 6pm Halloween in Pacific time (encoded in GMT by adding 7 hours)
};

DefinedEvent christmas{
    // Time until Christmas Eve
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "Santa's Arrival",
    "Christmas Eve",
    // s,m,h,    dow, dd, mm, yy
    {0, 0, 7 + 0, 1, 25, 12, 2023 - 1970},   // Midnight in Pacific time (encoded in GMT by adding 7 hours)
};

DefinedEvent valentines{
    // Time until Valentines Day
    COUNTDOWN_TO,
    SHOW_HMS,
    "Countdown to",
    "Monday, Feb 14, 2023",
    "Valentine's Day",
    // s,m,h,    dow, dd, mm, yy
    {0, 0, 7 + 0, 1, 14, 02, 2023 - 1970},   // Midnight in Pacific time (encoded in GMT by adding 7 hours PDT)
};

// ---- list of target events
DefinedEvent eventList[] = {
    aug_microwave,
    sept_vhf,
    sept_vhf,
    june_vhf,
    groundhog,
    // halloween,
    christmas,
    // valentines,
};

// ----- choose target event
DefinedEvent target = eventList[0];

// ========== class ViewEvents ===================================
class ViewEvents : public View {
public:
  // ---------- public interface ----------
  // This derived class must implement the public interface:
  ViewEvents(Adafruit_ILI9341 *vtft, int vid)   // ctor
      : View{vtft, vid} {
    background = cBACKGROUND;   // every view can have its own background color
  }
  void updateScreen();
  void startScreen();
  void endScreen();
  bool onTouch(Point touch);
  // void loadConfig();
  // void saveConfig();

protected:
  // ---------- local data for this derived class ----------
  // color scheme: see constants.h

  int whichEvent = 0;   // keep track of which count-down event to display
  // ----- main clock view helpers -----
  // these are names for the array indexes, must be named in same order as array below
  enum txtIndex {
    TITLE1 = 0,
    TITLE2,
    TITLE3,
    COUNTDAYS,
    COUNTTIME,
    LOCALDATE,
    LOCALTIME,
    TIMEZONE,
    NUMSATS,
  };

#define numDateFields 9
  TextField txtDate[numDateFields] = {
      // text            x,y    color       alignment    size
      {"line1", -1, 20, cTEXTCOLOR, ALIGNCENTER, eFONTSMALLEST},        // [TITLE1] program title, centered
      {"line2", -1, 44, cTEXTCOLOR, ALIGNCENTER, eFONTSMALLEST},        // [TITLE2]
      {"line3", -1, 86, cVALUE, ALIGNCENTER, eFONTSMALL},               // [TITLE3]
      {"nnn", -1, 152, cVALUE, ALIGNCENTER, eFONTGIANT},                // [COUNTDAYS] counted number of days
      {"01:02:03", -1, 182, cVALUEFAINT, ALIGNCENTER, eFONTSMALLEST},   // [COUNTTIME] counted number of hms
      {"MMM dd, yyyy", 66, 226, cFAINT, ALIGNLEFT, eFONTSMALLEST},      // [LOCALDATE] Local date
      {"hh:mm:ss", 178, 226, cFAINT, ALIGNLEFT, eFONTSMALLEST},         // [LOCALTIME] Local time
      {"-7h", 8, 226, cFAINT, ALIGNLEFT, eFONTSMALLEST},                // [TIMEZONE]  addHours time zone
      {"6#", 308, 226, cFAINT, ALIGNRIGHT, eFONTSMALLEST},              // [NUMSATS]   numSats
  };

  enum buttonID {
    eMore,
  };
#define nDateButtons 1
  FunctionButton dateButtons[nDateButtons] = {
      // label            origin   size      touch-target
      // text              x,y      w,h      x,y      w,h    radius  color     functionID
      {"", 280, 70, 39, 84, {240, 84, 78, 88}, 4, cTEXTCOLOR, eMore},   // show next "count-down" item
  };

// ----- helpers -----
#define DATE_FOLDER  "/GMTclock"   // 8.3 names
#define DATE_FILE    DATE_FOLDER "/DateView.cfg"
#define DATE_VERSION "v01"

  // advance to show next date event counter
  void nextDateEvent() {
    whichEvent = (whichEvent + 1) % (sizeof(eventList) / sizeof(eventList[0]));
    target     = eventList[whichEvent];
    // logger.info(". Changed event to #%d, %d", whichEvent, eventList[whichEvent].line3);
  }

  // Formatted elapsed time
  //    this is similar to getTimeLocal (view_date.cpp)
  void getTimeElapsed(char *result, int len, time_t elapsed) {
    // @param result = char[10] = string buffer to modify
    // @param len = string buffer length

    int dd = elapsedDays(elapsed);
    int hh = numberOfHours(elapsed);
    int mm = numberOfMinutes(elapsed);
    int ss = numberOfSeconds(elapsed);
    snprintf(result, len, "%02d:%02d:%02d",
             hh, mm, ss);
  }

};   // end class ViewEvents
// ============== implement public interface ================
void ViewEvents::updateScreen() {
  // called on every pass through main()
  if (GPS.seconds == 0) {
    // report GMT to console, but not too often
    char msg[128];
    snprintf(msg, sizeof(msg), "%02d:%02d:%02d GMT",
             GPS.hour, GPS.minute, GPS.seconds);
    logger.info(msg);
  }

  //                       s,m,h, dow, d,m,y
  // TimeElements eventGMT{ 1,1,1,  1,  2,2,2020-1970};    // GMT Groundhog Day
  // meElements todaysDate{ 1,1,1,  1,  2,2,2020-1970};    // debug: verify the first Groundhog Day is "day #1"
  // meElements todaysDate{ 1,1,1,  1,  2,10,2020-1970};   // debug: verify Oct 2nd is "day #244" i.e. one more than shown on https://days.to/groundhog-day/2020
  TimeElements todaysDate{GPS.seconds, GPS.minute, GPS.hour,
                          1, GPS.day, GPS.month, (byte)(2000 - 1970 + GPS.year)};   // GMT current date/time

  time_t adjustment = model->gTimeZone * SECS_PER_HOUR;

  time_t date1local = makeTime(target.eventGMT);
  time_t date2local = makeTime(todaysDate);

  time_t elapsed;
  if (target.countup) {
    elapsed = (date2local - date1local);   // e.g. "days SINCE target date"
  } else {
    elapsed = (date1local - date2local);   // e.g. "days UNTIL target date"
  }

  int elapsedDays = elapsed / SECS_PER_DAY;
  // if (GPS.seconds == 0) {   // debug
  //   logger.info("elapsed time count: ", (int)elapsed);   // typecast to int, required by compiler
  // }
  char sTime[24];   // strlen("01:23:45") = 8
  getTimeElapsed(sTime, sizeof(sTime), elapsed);

  txtDate[COUNTDAYS].print(elapsedDays);
  txtDate[COUNTTIME].print(sTime);

  // Local Date
  char sDate[16];                         // strlen("Jan 12, 2020 ") = 14
  model->getDate(sDate, sizeof(sDate));   // todo - make this local not GMT date
  txtDate[LOCALDATE].print(sDate);

  // Hours to add/subtract from GMT for local time
  char sign[2] = {0, 0};                              // prepend a plus-sign when >=0
  sign[0]      = (model->gTimeZone >= 0) ? '+' : 0;   // (don't need to add a minus-sign bc the print stmt does that for us)
  char sTimeZone[6];                                  // strlen("-10h") = 4
  snprintf(sTimeZone, sizeof(sTimeZone), "%s%dh", sign, model->gTimeZone);
  txtDate[TIMEZONE].print(sTimeZone);

  // Local Time
  model->getTimeLocal(sTime, sizeof(sTime));
  txtDate[LOCALTIME].print(sTime);

  // Satellite Count
  char sBirds[4];   // strlen("5#") = 2
  snprintf(sBirds, sizeof(sBirds), "%d#", model->gSatellites);
  // change colors by number of birds
  txtDate[NUMSATS].color = (model->gSatellites < 1) ? cWARN : cFAINT;
  txtDate[NUMSATS].print(sBirds);
  // txtDate[NUMSATS].dump();          // debug
}   // end updateScreen

void ViewEvents::startScreen() {
  // called once each time this view becomes active
  this->clearScreen(this->background);               // clear screen
  txtDate[0].setBackground(this->background);        // set background for all TextFields in this view
  TextField::setTextDirty(txtDate, numDateFields);   // make sure all fields get re-printed on screen change

  drawAllIcons();                                  // draw gear (settings) and arrow (next screen)
  showDefaultTouchTargets();                       // optionally draw box around default button-touch areas
  showMyTouchTargets(dateButtons, nDateButtons);   // optionally show this view's touch targets
  showScreenBorder();                              // optionally outline visible area
  showScreenCenterline();                          // optionally draw visual alignment bar

  // ----- draw page title
  txtDate[TITLE1].print(target.line1);
  txtDate[TITLE2].print(target.line2);
  txtDate[TITLE3].print(target.line3);

  // ----- draw giant fields
  if (target.show_HMS) {
    txtDate[COUNTTIME].setColor(cTEXTCOLOR);   // show the elapsed h:m:s
  } else {
    txtDate[COUNTTIME].setColor(cBACKGROUND);   // make invisible the elapsed h:m:s
  }

  // ----- draw text fields
  for (int ii = LOCALDATE; ii < numDateFields; ii++) {
    txtDate[ii].print();
  }

  // ----- draw text vertically onto  "More" button
  // for vertical text, temporarily rotate TFT screen into portrait mode
  int savedRotation = tft->getRotation();
  int newRotation   = (savedRotation + 3) % 4;
  tft->setRotation(newRotation);   // set portrait mode
  const int xx = tft->width() / 2 - 30;
  const int yy = tft->height() - 10;
  TextField sync("More", xx, yy, cFAINT);
  sync.print();
  tft->setRotation(savedRotation);   // restore screen orientation

  updateScreen();   // update UI immediately, don't wait for laggy mainline loop
}   // end startScreen()

void ViewEvents::endScreen() {
  // Called once each time this view becomes INactive
  // This is a 'goodbye kiss' to do cleanup work
  // For the altimeter view, save our settings here instead of on each
  // button press because writing to NVR is slow (0.5 sec) and would delay the user
  // while trying to press a button many times in a row.
  // saveConfig();   // todo - save/restore which of several count-down displays is active
}

bool ViewEvents::onTouch(Point touch) {
  logger.info("->->-> Touched date screen.");

  bool handled = false;   // assume a touch target was not hit
  for (int ii = 0; ii < nDateButtons; ii++) {
    FunctionButton item = dateButtons[ii];
    if (item.hitTarget.contains(touch)) {
      switch (item.functionIndex)   // do the thing
      {
      case eMore:
        nextDateEvent();
        handled = true;
        break;
      default:
        logger.error("Error, unknown function ", item.functionIndex);
        break;
      }
      startScreen();
      updateScreen();   // update UI immediately, don't wait for laggy mainline loop
    }
  }
  return handled;   // true=handled, false=controller uses default action
}   // end onTouch()