Merge pull request #254 from wasatch-dev/planets

Add support for displaying the 7 classical planets in our solar syste…

Author: komacke

ESPHamClock/ESPHamClock.cpp

@@ -878,6 +878,8 @@ static void checkTouch()
         // set showing sat in DX box
         dx_info_for_sat = true;
         drawSatPass();
+    } else if (checkPlanetMapTouch (s)) {
+        // handled entirely within checkPlanetMapTouch
     } else if (!overViewBtn(s, DX_R) && s2ll (s, ll)) {
         // tapped map: set flag to run popup after map finishes or set newDX here if special-tap
         if (names_on)
@@ -1715,6 +1717,7 @@ void drawAllSymbols()
     drawADIFSpotsOnMap();
     drawDXPedsOnMap();
     drawHamsatOnMap();
+    drawPlanetsOnMap();
     drawStormsOnMap();
     drawLaunchesOnMap();
     drawActiveNetsOnMap();
@@ -1886,10 +1889,7 @@ void drawDEFormatMenu()
     // number of core menu items
     #define N_DEFMT_CORE        8
 
-    // PLOT_CH_SATACT can't join PANE_0_CH_MASK -- that's a 32-bit bitmask constant and SATACT's
-    // ordinal (32) can never fit in one, by the same design as everywhere else PLOTBIT() is used.
-    // it's offered as one extra, separately-handled menu item instead.
-    MenuItem mitems[N_DEFMT_CORE+N_PANE_0_CH+1] = {
+    MenuItem mitems[N_DEFMT_CORE+N_PANE_0_CH] = {
 
         // outer menu is whether to display the DE pane or use both DE+DX for a pane choice
         {MENU_1OFN, !SHOWING_PANE_0(), 1, mi, "DE format:", NULL},
@@ -1904,40 +1904,28 @@ void drawDEFormatMenu()
 
         {MENU_1OFN, SHOWING_PANE_0(), 1, mi, "Data Panes:", NULL},
 
-            // bottom submenu is list of possible pane choices, see next.
-            // N.B. don't include ones already in play in the top set
-
+            // bottom submenu is filled below from PANE_0_CH_MASK, including high-word choices.
     };
 
-    // set and record PANE_0 choices from successive bits in PANE_0_CH_MASK
-    uint32_t pane_0_bits = PANE_0_CH_MASK;
+    // prepare each suitable Pane 0 choice in PlotChoice order
     PlotChoice menu_ch[N_PANE_0_CH];
-    for (int i = 0; i < N_PANE_0_CH; i++) {
-        // find and zero out the next bit in mask of possible PANE_0 panes
-        int plot_n = 0;
-        for (uint32_t bits = pane_0_bits; bits >>= 1; plot_n++)
+    int n_menu_ch = 0;
+    for (int i = 0; i < PLOT_CH_N; i++) {
+        PlotChoice pc = (PlotChoice)i;
+        if (!PLOT_CH_IS_REAL(pc) || !(PANE_0_CH_MASK & PLOTBIT(pc)))
             continue;
-        pane_0_bits &= ~(1<<plot_n);
-        menu_ch[i] = (PlotChoice)plot_n;
-        // prepare menu item
-        PlotPane pp = findPaneForChoice ((PlotChoice)plot_n);
-        bool available =  plotChoiceIsAvailable((PlotChoice)plot_n) && (pp == PANE_NONE || pp == PANE_0);
-        MenuFieldType type = available ? MENU_AL1OFN : MENU_IGNORE;
-        mitems[N_DEFMT_CORE+i] = {type, !!(plot_rotset[PANE_0] & PLOTBIT(plot_n)), 3, Mi, plot_names[plot_n], 0};
-    }
-    if (pane_0_bits != 0)
-        fatalError ("drawDEFormatMenu() %d %d 0x%x\n", pane_0_bits, N_PANE_0_CH, PANE_0_CH_MASK);
-
-    // extra SATACT item -- can't be represented in plot_rotset (see comment above), so its
-    // "currently set" state is determined the same way paneHasChoice() checks a solo choice
-    const int SATACT_MI = N_DEFMT_CORE + N_PANE_0_CH;
-    {
-        PlotPane pp = findPaneForChoice (PLOT_CH_SATACT);
-        bool available = plotChoiceIsAvailable (PLOT_CH_SATACT) && (pp == PANE_NONE || pp == PANE_0);
+
+        menu_ch[n_menu_ch] = pc;
+        PlotPane pp = findPaneForChoice (pc);
+        bool available = plotChoiceIsAvailable(pc) && (pp == PANE_NONE || pp == PANE_0);
         MenuFieldType type = available ? MENU_AL1OFN : MENU_IGNORE;
-        bool is_set = (plot_ch[PANE_0] == PLOT_CH_SATACT && plot_rotset[PANE_0] == 0);
-        mitems[SATACT_MI] = {type, is_set, 3, Mi, plot_names[PLOT_CH_SATACT], 0};
+        mitems[N_DEFMT_CORE+n_menu_ch] = {
+            type, !!(plot_rotset[PANE_0] & PLOTBIT(pc)), 3, Mi, plot_names[pc], 0
+        };
+        n_menu_ch++;
     }
+    if (n_menu_ch != N_PANE_0_CH)
+        fatalError ("drawDEFormatMenu() found %d of %d Pane 0 choices", n_menu_ch, N_PANE_0_CH);
 
     // create a box for the menu
     SBox menu_b;
@@ -1948,73 +1936,56 @@ void drawDEFormatMenu()
     // run menu
     SBox ok_b;
     MenuInfo menu = {menu_b, ok_b, UF_NOCLOCKS, M_CANCELOK, 1, NARRAY(mitems), mitems};
-    if (runMenu (menu)) {
-
-        // capture and save new state
-
-        if (mitems[0].set) {
-
-            // set desired detime format
-
-            int new_fmt = -1;
-            for (int i = 0; i < DETIME_N; i++) {
-                if (mitems[i+1].set) {
-                    new_fmt = i;
-                    break;
-                }
-            }
-
-            // paranoid
-            if (new_fmt < 0)
-                fatalError ("drawDEFormatMenu: No de fmt");
-
-            // set fmt and turn off PANE_0
-            de_time_fmt = (uint8_t)new_fmt;
-            NVWriteUInt8(NV_DE_TIMEFMT, de_time_fmt);
-            plot_ch[PANE_0] = PLOT_CH_NONE;
-            plot_rotset[PANE_0] = 0;
+    if (!runMenu (menu))
+        return;
 
-        } else {
+    if (mitems[0].set) {
 
-            // get new collection of plot choices
-            uint32_t new_rotset = 0;
-            for (int i = 0; i < N_PANE_0_CH; i++) { 
-                if (mitems[N_DEFMT_CORE+i].set)
-                    new_rotset |= PLOTBIT(menu_ch[i]);
+        // set desired DE time format and restore the normal DE/DX layout
+        int new_fmt = -1;
+        for (int i = 0; i < DETIME_N; i++) {
+            if (mitems[i+1].set) {
+                new_fmt = i;
+                break;
             }
+        }
+        if (new_fmt < 0)
+            fatalError ("drawDEFormatMenu: No de fmt");
 
-            bool satact_set = mitems[SATACT_MI].set;
-
-            if (satact_set && new_rotset == 0) {
+        de_time_fmt = (uint8_t)new_fmt;
+        NVWriteUInt8 (NV_DE_TIMEFMT, de_time_fmt);
+        restoreNormPANE0();
 
-                // SATACT alone: solo, non-rotating choice -- can't be represented in plot_rotset
-                plot_ch[PANE_0] = PLOT_CH_SATACT;
-                plot_rotset[PANE_0] = 0;
+    } else {
 
-            } else if (new_rotset != 0) {
+        // collect low- and high-word choices into one in-memory rotation mask
+        PlotMask new_rotset = 0;
+        for (int i = 0; i < N_PANE_0_CH; i++) {
+            if (mitems[N_DEFMT_CORE+i].set)
+                new_rotset |= PLOTBIT(menu_ch[i]);
+        }
 
-                // one or more mask-based choices (SATACT, if also checked, can't join a
-                // multi-item rotation set the way these can, so it's dropped in that case)
-                plot_rotset[PANE_0] = new_rotset;
+        if (new_rotset == 0) {
+            restoreNormPANE0();
+        } else {
+            plot_rotset[PANE_0] = new_rotset;
 
-                // pick any one as current
+            // retain the current choice when still selected, otherwise choose the first set bit
+            if (!(plot_rotset[PANE_0] & PLOTBIT(plot_ch[PANE_0]))) {
                 for (int i = 0; i < PLOT_CH_N; i++) {
                     if (plot_rotset[PANE_0] & PLOTBIT(i)) {
-                        plot_ch[PANE_0] = (PlotChoice) i;
+                        plot_ch[PANE_0] = (PlotChoice)i;
                         break;
                     }
                 }
             }
+
+            if (!setPlotChoice (PANE_0, plot_ch[PANE_0]))
+                fatalError ("drawDEFormatMenu: can not set Pane 0 choice %d", (int)plot_ch[PANE_0]);
         }
     }
 
-    // set PANE_0 choice, even if none
-    setPlotChoice (PANE_0, plot_ch[PANE_0]);
     logPaneRotSet (PANE_0, plot_ch[PANE_0]);
-
-    // redraw if normal
-    if (!SHOWING_PANE_0())
-        restoreNormPANE0();
 }
 
 /* resume using nearestPrefix

ESPHamClock/HamClock.h

@@ -386,7 +386,9 @@ typedef enum {
 
 // N.B. take care that names will fit in menu built by askPaneChoice()
 // N.B. names should not include blanks, but _ are changed to blanks for prettier printing
-#define PLOTNAMES \
+// Keep the original 32 choices at their historic ordinals. EEPROM value 32 remains NONE forever;
+// choices added after that sentinel are mapped into the new high rotation word by PLOTBIT().
+#define PLOTNAMES_LOW \
     X(PLOT_CH_BC,           "VOACAP_DEDX")      \
     X(PLOT_CH_DEWX,         "DE_Wx")            \
     X(PLOT_CH_DXCLUSTER,    "DX_Cluster")       \
@@ -418,18 +420,23 @@ typedef enum {
     X(PLOT_CH_ACTIVENETS,   "Nets")             \
     X(PLOT_CH_LAUNCHES,     "Launches")         \
     X(PLOT_CH_HFCOND,       "HF_Bands")         \
-    X(PLOT_CH_VHFCOND,      "VHF_Cond")         \
+    X(PLOT_CH_VHFCOND,      "VHF_Cond")
+
+#define PLOTNAMES_HIGH \
     X(PLOT_CH_SATACT,       "Sat_Alerts")
 
-#define X(a,b)  a,              // expands PLOTNAMES to each enum and comma
+#define PLOTNAMES PLOTNAMES_LOW PLOTNAMES_HIGH
+
+#define X(a,b)  a,              // expand the original low-word choices
 typedef enum {
-    PLOTNAMES
+    PLOTNAMES_LOW
+    PLOT_CH_NONE,               // fixed EEPROM sentinel: value 32
+    PLOTNAMES_HIGH              // first high-word choice starts at value 33
     PLOT_CH_N
 } PlotChoice;
 #undef X
 
-// reuse count also handy flag for not found
-#define PLOT_CH_NONE    PLOT_CH_N
+static_assert (PLOT_CH_N - 1 <= 64, "PlotMask high word is full");
 
 typedef enum {
     PANE_0,                             // DE/DX overlay
@@ -1597,6 +1604,15 @@ extern Satellite *lookupSatByName (const char *name, int *norad = NULL);
 
 extern void drawSatGroupSchedule (void);
 extern void drawSatCoVis (void);
+
+/*********************************************************************************************
+ *
+ * planets.cpp
+ *
+ */
+
+extern void drawPlanetsOnMap (void);
+extern bool checkPlanetMapTouch (const SCoord &s);
 extern bool setSatFromTLE (const char *name, const char *t1, const char *t2);
 extern bool initSat(void);
 extern bool getSatNow (SatNow &satnow);
@@ -2231,16 +2247,22 @@ extern void plotServerFile (const char *filename, const char title[], const char
 
 extern const SBox plot_b[PANE_N];          // box for each pane
 extern PlotChoice plot_ch[PANE_N];         // current choice in each pane, or PLOT_CH_NONE for PANE_0
-extern const char *plot_names[PLOT_CH_N];  // must be in same order as PlotChoice
-extern uint32_t plot_rothold;              // bitmask of PlotChoice in rotset but temporarily holding
-extern uint32_t plot_rotset[PANE_N];       // bitmask of each pane's PlotChoice rotation choices
-                                           // N.B. plot_rotset[i] must always include plot_ch[i] unless NONE
-
-// plot_rotset/plot_rothold are only 32 bits wide, but PLOT_CH_N may exceed 32 (e.g. PLOT_CH_SATACT).
-// PLOTBIT() maps any PlotChoice >= 32 to 0 instead of performing an out-of-range shift, which both
-// avoids undefined behavior and, as a deliberate side effect, guarantees such choices can never be
-// captured in a rotation set -- i.e. they can never participate in pane auto rotation.
-#define PLOTBIT(pc)             ((uint32_t)(pc) < 32 ? (1u << (uint32_t)(pc)) : 0u)
+extern const char *plot_names[PLOT_CH_N];  // indexed by PlotChoice; PLOT_CH_NONE entry is "NONE"
+
+typedef uint64_t PlotMask;
+extern PlotMask plot_rothold;              // PlotChoice bits temporarily holding rotation
+extern PlotMask plot_rotset[PANE_N];       // each pane's PlotChoice rotation choices
+                                           // N.B. plot_rotset[i] must include plot_ch[i] unless NONE
+
+// EEPROM value 32 is permanently reserved for PLOT_CH_NONE. Choices below it keep their original
+// low-word bit numbers; real choices above it are packed down by one so PLOT_CH_SATACT uses bit 32
+// (high-word bit 0), the next new choice uses bit 33, and so on.
+#define PLOT_CH_IS_REAL(pc)     ((uint32_t)(pc) < (uint32_t)PLOT_CH_NONE || \
+                                 ((uint32_t)(pc) > (uint32_t)PLOT_CH_NONE && \
+                                  (uint32_t)(pc) < (uint32_t)PLOT_CH_N))
+#define PLOTBIT_INDEX(pc)       ((uint32_t)(pc) < (uint32_t)PLOT_CH_NONE \
+                                    ? (uint32_t)(pc) : (uint32_t)(pc)-1U)
+#define PLOTBIT(pc)             (PLOT_CH_IS_REAL(pc) ? (UINT64_C(1) << PLOTBIT_INDEX(pc)) : UINT64_C(0))
 
 #define ROTHOLD_SET(pc)         (plot_rothold |= PLOTBIT(pc))
 #define ROTHOLD_CLR(pc)         (plot_rothold &= ~PLOTBIT(pc))
@@ -2249,15 +2271,18 @@ extern uint32_t plot_rotset[PANE_N];       // bitmask of each pane's PlotChoice
 #define SHOWING_PANE_0()        (plot_ch[PANE_0] != PLOT_CH_NONE)
 #define BOX_IS_PANE_0(b)        ((b).w == PLOTBOX0_W && (b).h == PLOTBOX0_H)
 
-// bit mask of plot choices suitable for PANE_0
-#define PANE_0_CH_MASK          ((1<<PLOT_CH_DXCLUSTER) | (1<<PLOT_CH_CONTESTS) | (1<<PLOT_CH_ADIF) \
-                                 | (1<<PLOT_CH_ONTA) | (1<<PLOT_CH_DXPEDS) | (1<<PLOT_CH_ACTIVENETS) | (1<<PLOT_CH_LAUNCHES))
+// bit mask of plot choices suitable for PANE_0, including high-word choices
+#define PANE_0_CH_MASK          (PLOTBIT(PLOT_CH_DXCLUSTER) | PLOTBIT(PLOT_CH_CONTESTS) | \
+                                 PLOTBIT(PLOT_CH_ADIF) | PLOTBIT(PLOT_CH_ONTA) | \
+                                 PLOTBIT(PLOT_CH_DXPEDS) | PLOTBIT(PLOT_CH_ACTIVENETS) | \
+                                 PLOTBIT(PLOT_CH_LAUNCHES) | PLOTBIT(PLOT_CH_SATACT))
 
 // compute number of bits set in PANE_0_CH_MASK at compile time :-)
 // https://stackoverflow.com/questions/109023/count-the-number-of-set-bits-in-a-32-bit-integer
 // https://graphics.stanford.edu/~seander/bithacks.html#CountBitsSetParallel
 #define NBITS_SET(v) ((((((((v) - (((v) >> 1) & 0x55555555)) & 0x33333333) + ((((v) - (((v) >> 1) & 0x55555555)) >> 2) & 0x33333333)) + (((((v) - (((v) >> 1) & 0x55555555)) & 0x33333333) + ((((v) - (((v) >> 1) & 0x55555555)) >> 2) & 0x33333333)) >> 4)) & 0xF0F0F0F) * 0x1010101) >> 24)
-#define N_PANE_0_CH             ((int)(NBITS_SET((uint32_t)PANE_0_CH_MASK)))
+#define N_PANE_0_CH             ((int)(NBITS_SET((uint32_t)PANE_0_CH_MASK) + \
+                                                 NBITS_SET((uint32_t)(PANE_0_CH_MASK >> 32))))
 
 #define PLOT_ROTWARN_DT        4           // show rotation about to occur, secs
 
@@ -2278,7 +2303,7 @@ extern void savePlotOps(void);
 extern int tickmarks (float min, float max, int numdiv, float ticks[]);
 extern bool isPaneRotating (PlotPane pp);
 extern bool isSpecialPaneRotating (PlotPane pp);
-extern bool enforceCDownAlone (const SBox &box, uint32_t rotset);
+extern bool enforceCDownAlone (const SBox &box, PlotMask rotset);
 extern bool overHoverPane (const SCoord &s);
 extern void restoreNormPANE0(void);
 
@@ -2771,6 +2796,7 @@ extern bool useOSTime (void);
 extern bool showNewDXDEWx(void);
 extern int getPaneRotationPeriod (void);
 extern bool showPIP(void);
+extern bool showPlanets(void);
 extern bool autoMap(void);
 extern int getMapRotationPeriod(void);
 extern GrayDpy_t getGrayDisplay(void);

ESPHamClock/Makefile

@@ -144,6 +144,7 @@ OBJS = \
 	ontheair.o \
 	parsespot.o \
 	passwd.o \
+	planets.o \
 	plot.o \
 	plotmap.o \
 	plotmgmnt.o \

ESPHamClock/hamsat.cpp

@@ -453,7 +453,10 @@ static void drawHamsatVisAlerts (const SBox &box)
             char cd[8];
             formatCountdown (a.aos_at, now, cd, sizeof(cd));
             char line[24];
-            snprintf (line, sizeof(line), "%-7.7s%-6.6s%s", a.callsign, a.satname, cd);
+            if (box.w < PLOTBOX123_W)
+                snprintf (line, sizeof(line), "%-6.6s%-5.5s%s", a.callsign, a.satname, cd);
+            else
+                snprintf (line, sizeof(line), "%-7.7s%-6.6s%s", a.callsign, a.satname, cd);
             tft.setTextColor (a.is_workable ? RA8875_YELLOW : RA8875_WHITE);
             tft.setCursor (x + badge_w, y);
             tft.print (line);
@@ -477,10 +480,16 @@ static void drawHamsatPane (const SBox &box)
     tft.setCursor (box.x + (box.w-pw)/2, box.y + PANETITLE_H);
     tft.print (title);
 
-    // subtitle: source + whether personalized
+    // subtitle: source + whether personalized. maxStringW() truncates its argument in place,
+    // so this must be writable storage, never a cast-away-const string literal. Pane 0 is also
+    // narrower than the normal panes, so use a compact form there.
     selectFontStyle (LIGHT_FONT, FAST_FONT);
-    const char *sub = hamsat_key[0] ? "https://hams.at (has key)" : "https://hams.at (no key)";
-    uint16_t sw = maxStringW ((char*)sub, box.w-2);
+    char sub[40];
+    if (box.w < PLOTBOX123_W)
+        snprintf (sub, sizeof(sub), "hams.at (%s)", hamsat_key[0] ? "key" : "no key");
+    else
+        snprintf (sub, sizeof(sub), "https://hams.at (%s)", hamsat_key[0] ? "has key" : "no key");
+    uint16_t sw = maxStringW (sub, box.w-2);
     tft.setTextColor (hamsat_key[0] ? RA8875_WHITE : RGB565(180,140,60));
     tft.setCursor (box.x + (box.w-sw)/2, box.y + SUBTITLE_Y0);
     tft.print (sub);

ESPHamClock/nvramenum.h

@@ -370,6 +370,18 @@ typedef enum {
     // 251
     NV_SATGROUP,                 // newline-separated satellite names for group schedule
 
+    // 252
+    NV_SHOWPLANETS,               // whether to show planets on the map
+
+    // 253 -- retain the experimental marker so already-patched EEPROM files remain compatible
+    NV_PLOTSCHEMA,                 // reserved plot settings schema marker
+
+    // 254 -- appended so all prior EEPROM addresses remain unchanged
+    NV_PANE0ROTSET_HI,            // high 32 bits of pane 0 PlotChoice rotation mask
+    NV_PANE1ROTSET_HI,            // high 32 bits of pane 1 PlotChoice rotation mask
+    NV_PANE2ROTSET_HI,            // high 32 bits of pane 2 PlotChoice rotation mask
+    NV_PANE3ROTSET_HI,            // high 32 bits of pane 3 PlotChoice rotation mask
+
 	NV_N
 
 } NV_Name;

ESPHamClock/nvramsize.h

@@ -373,6 +373,18 @@ static const uint8_t nv_sizes[NV_N] = {
     // 251
     NV_SATGROUP_LEN,            // NV_SATGROUP
 
+    // 252
+    1,                          // NV_SHOWPLANETS
+
+    // 253 -- retained compatibility marker
+    1,                          // NV_PLOTSCHEMA
+
+    // 254 -- high words are appended; no existing item moves
+    4,                          // NV_PANE0ROTSET_HI
+    4,                          // NV_PANE1ROTSET_HI
+    4,                          // NV_PANE2ROTSET_HI
+    4,                          // NV_PANE3ROTSET_HI
+
 };
 
 #endif // _NVRAMSIZE_H