Merge pull request #253 from wasatch-dev/satalerts

Add support for Sat Alerts via hams.at; add satellite co-visibility p…

Author: wasatch-dev

ESPHamClock/ESPHamClock.cpp

@@ -1714,6 +1714,7 @@ void drawAllSymbols()
     drawDXClusterSpotsOnMap();
     drawADIFSpotsOnMap();
     drawDXPedsOnMap();
+    drawHamsatOnMap();
     drawStormsOnMap();
     drawLaunchesOnMap();
     drawActiveNetsOnMap();
@@ -1885,7 +1886,10 @@ void drawDEFormatMenu()
     // number of core menu items
     #define N_DEFMT_CORE        8
 
-    MenuItem mitems[N_DEFMT_CORE+N_PANE_0_CH] = {
+    // 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] = {
 
         // 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},
@@ -1919,11 +1923,22 @@ void drawDEFormatMenu()
         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] & (1<<plot_n)), 3, Mi, plot_names[plot_n], 0};
+        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);
+        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};
+    }
+
     // create a box for the menu
     SBox menu_b;
     menu_b.x = de_info_b.x + 4;
@@ -1965,18 +1980,26 @@ void drawDEFormatMenu()
             uint32_t new_rotset = 0;
             for (int i = 0; i < N_PANE_0_CH; i++) { 
                 if (mitems[N_DEFMT_CORE+i].set)
-                    new_rotset |= (1<<menu_ch[i]);
+                    new_rotset |= PLOTBIT(menu_ch[i]);
             }
 
-            // might not be any if user clicked this section but made no choice
-            if (new_rotset != 0) {
+            bool satact_set = mitems[SATACT_MI].set;
+
+            if (satact_set && new_rotset == 0) {
+
+                // 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 if (new_rotset != 0) {
 
-                // ok!
+                // 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;
 
                 // pick any one as current
                 for (int i = 0; i < PLOT_CH_N; i++) {
-                    if (plot_rotset[PANE_0] & (1 << i)) {
+                    if (plot_rotset[PANE_0] & PLOTBIT(i)) {
                         plot_ch[PANE_0] = (PlotChoice) i;
                         break;
                     }

ESPHamClock/HamClock.h

@@ -418,7 +418,8 @@ 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")         \
+    X(PLOT_CH_SATACT,       "Sat_Alerts")
 
 #define X(a,b)  a,              // expands PLOTNAMES to each enum and comma
 typedef enum {
@@ -682,12 +683,16 @@ extern SBox de_info_b;                  // de info pane
 extern SBox map_b;                      // main map 
 extern SBox view_btn_b;                 // map view menu button
 extern SBox motd_btn_b;                 // MOTD mailbox icon (next to UTC button)
+extern SBox adsb_btn_b;                 // ADS-B airplane icon (next to MOTD icon)
 
 // MOTD (Message of the Day) functions
 extern void checkMOTD (void);
 extern bool motdIsPresent (void);
 extern void drawMOTDIcon (void);
 extern void motdClicked (void);
+
+// ADS-B airplane icon -- opens https://adsb.lol
+extern void drawADSBIcon (void);
 extern SBox dx_maid_b;                  // dx maidenhead pick
 extern SBox de_maid_b;                  // de maidenhead pick
 extern SBox lkscrn_b;                   // screen lock icon button
@@ -1582,6 +1587,16 @@ extern void drawSatName(void);
 extern void drawOneTimeDX(void);
 extern void drawOneTimeDE(void);
 extern bool setSatFromName (const char *new_name);
+extern Satellite *lookupSatByName (const char *name, int *norad = NULL);
+
+/*********************************************************************************************
+ *
+ * satsked.cpp
+ *
+ */
+
+extern void drawSatGroupSchedule (void);
+extern void drawSatCoVis (void);
 extern bool setSatFromTLE (const char *name, const char *t1, const char *t2);
 extern bool initSat(void);
 extern bool getSatNow (SatNow &satnow);
@@ -2110,6 +2125,16 @@ extern void reportEESize (uint16_t &ee_used, uint16_t &ee_size);
 
 extern bool updateOnTheAir (const SBox &box, bool fresh);
 extern bool checkOnTheAirTouch (const SCoord &s, const SBox &box);
+
+/*********************************************************************************************
+ *
+ * hamsat.cpp
+ *
+ */
+
+extern bool updateHamsat (const SBox &box, bool fresh);
+extern bool checkHamsatTouch (const SCoord &s, const SBox &box);
+extern void drawHamsatOnMap (void);
 extern bool getOnTheAirSpots (DXSpot **spp, uint8_t *nspotsp);
 extern void drawOnTheAirSpotsOnMap (void);
 extern bool getClosestOnTheAirSpot (LatLong &ll, DXSpot *sp, LatLong *llp);
@@ -2211,9 +2236,15 @@ extern uint32_t plot_rothold;              // bitmask of PlotChoice in rotset bu
 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
 
-#define ROTHOLD_SET(pc)         (plot_rothold |= (1<<(pc)))
-#define ROTHOLD_CLR(pc)         (plot_rothold &= ~(1<<(pc)))
-#define ROTHOLD_TST(pc)         ((plot_rothold & (1<<(pc))) != 0)
+// 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)
+
+#define ROTHOLD_SET(pc)         (plot_rothold |= PLOTBIT(pc))
+#define ROTHOLD_CLR(pc)         (plot_rothold &= ~PLOTBIT(pc))
+#define ROTHOLD_TST(pc)         ((plot_rothold & PLOTBIT(pc)) != 0)
 
 #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)

ESPHamClock/Makefile

@@ -115,6 +115,7 @@ OBJS = \
 	dxpeds.o \
 	dxpeds_hide.o \
 	hamqsl.o \
+	hamsat.o \
 	hurricane.o \
 	earthmap.o \
 	earthsat.o \
@@ -155,6 +156,7 @@ OBJS = \
 	runner.o \
 	santa.o \
 	sattool.o \
+	satsked.o \
 	scrollbar.o \
 	scrollstate.o \
 	sdo.o \

ESPHamClock/clocks.cpp

@@ -4,6 +4,12 @@
 
 #include "HamClock.h"
 
+// ADS-B airplane icon -- opens https://adsb.lol, sits just below the MOTD mailbox icon
+#define ADSB_ICON_W             14
+#define ADSB_ICON_H             14
+#define ADSB_ICON_GAP           6               // gap below MOTD icon
+SBox adsb_btn_b;
+
 // format flags
 uint8_t de_time_fmt;                            // one of DETIME_*
 uint8_t desrss, dxsrss;                         // show actual de/dx sun rise/set else time to
@@ -71,6 +77,43 @@ static void drawUTCButton()
 
     // draw the MOTD mailbox icon to the left of the UTC button (or blank slot if no MOTD)
     drawMOTDIcon();
+
+    // draw the ADS-B airplane icon just below that -- always shown, opens adsb.lol when tapped
+    drawADSBIcon();
+}
+
+/* draw the ADS-B airplane icon immediately below the MOTD mailbox icon. always shown
+ * (unlike the MOTD icon, which blanks itself when there's no message) -- tapping it opens
+ * https://adsb.lol, a live ADS-B aircraft tracking site. should be called right after
+ * drawMOTDIcon() since it positions itself relative to motd_btn_b.
+ */
+void drawADSBIcon()
+{
+    adsb_btn_b.x = motd_btn_b.x;
+    adsb_btn_b.y = motd_btn_b.y + motd_btn_b.h + ADSB_ICON_GAP;
+    adsb_btn_b.w = ADSB_ICON_W;
+    adsb_btn_b.h = ADSB_ICON_H;
+
+    tft.fillRect (adsb_btn_b.x, adsb_btn_b.y, adsb_btn_b.w, adsb_btn_b.h, RA8875_BLACK);
+
+    // airplane silhouette: fuselage nose-to-tail, wide wings ~1/3 back from the nose, a smaller
+    // tail stabilizer near the back -- the classic top-down airplane pictogram, not a paper dart.
+    // no icon font available, so this is built from basic line primitives, same approach
+    // drawMOTDIcon() uses for its envelope shape.
+    const uint16_t x = adsb_btn_b.x + 1;
+    const uint16_t y = adsb_btn_b.y + 1;
+    const uint16_t w = 12;
+    const uint16_t h = 12;
+    const uint16_t col = GRAY;
+
+    uint16_t nose_x = x + w, tail_x = x, mid_y = y + h/2;
+    tft.drawLine (tail_x, mid_y, nose_x, mid_y, col);                       // fuselage
+    tft.drawLine (nose_x, mid_y, nose_x-3, mid_y-1, col);                   // nose taper
+    tft.drawLine (nose_x, mid_y, nose_x-3, mid_y+1, col);
+    uint16_t wing_x = x + (w*5)/8;
+    tft.drawLine (wing_x, y, wing_x, y+h-1, col);                          // main wings
+    uint16_t tail_wing_x = x + w/6;
+    tft.drawLine (tail_wing_x, mid_y-2, tail_wing_x, mid_y+2, col);        // tail stabilizer
 }
 
 /* function given to TimeLib's setSyncProvider() to resync its time base occasionally.
@@ -1166,6 +1209,15 @@ bool checkClockTouch (SCoord &s)
         return (true);
     }
 
+    // ADS-B airplane icon: always present, opens adsb.lol centered on DE's location
+    if (inBox (s, adsb_btn_b)) {
+        char url[100];
+        snprintf (url, sizeof(url), "https://adsb.lol/?lat=%.3f&lon=%.3f&zoom=10",
+                    de_ll.lat_d, de_ll.lng_d);
+        openURL (url);
+        return (true);
+    }
+
     if (inBox (s, auxtime_b)) {
 
         runAuxTimeMenu();

ESPHamClock/earthsat.cpp

@@ -1467,6 +1467,23 @@ static bool checkSatUpToDate (SatState &s, bool *updated)
     return (true);
 }
 
+/* lightweight TLE lookup for a satellite NOT part of the globally-tracked sat_state[] --
+ * does not disturb sat_state[], the map display, or NVRAM. used by satsked.cpp's group
+ * schedule feature to get orbital elements for many satellites at once.
+ * returns a heap-allocated Satellite* the caller owns (delete when done), or NULL if the
+ * name isn't found or its TLE is unavailable/stale.
+ */
+Satellite *lookupSatByName (const char *name, int *norad)
+{
+    SatState tmp{};
+    strncpySubChar (tmp.name, name, '_', ' ', NV_SATNAME_LEN);
+    if (!checkSatUpToDate (tmp, NULL))
+        return (NULL);
+    if (norad)
+        *norad = tmp.norad;
+    return (tmp.sat);
+}
+
 /* show pass time of sat_rs(void)
  */
 static void drawSatRSEvents(SatState &s)
@@ -3842,6 +3859,8 @@ void drawDXSatMenu (const SCoord &s)
         _SMI_ORBTRACK2,
         _SMI_SATNOGS2,
         _SMI_AMSAT_STATUS,
+        _SMI_GROUPSKED,
+        _SMI_COVIS,
         _SMI_N,
     };
 
@@ -3900,6 +3919,8 @@ void drawDXSatMenu (const SCoord &s)
         {menu_sat2,   false, 1, _DXS_INDENT2,  "Show OrbTrack", NULL},
         {menu_sat2,   false, 1, _DXS_INDENT2,  "Show SatNogs",  NULL},
         {MENU_1OFN,   false, 1, _DXS_INDENT1,  "Show Status",   NULL},
+        {MENU_1OFN,   false, 1, _DXS_INDENT1,  "Group Schedule", NULL},
+        {MENU_1OFN,   false, 1, _DXS_INDENT1,  "Co-Visibility", NULL},
     };
 
     // box for menu
@@ -4045,6 +4066,14 @@ void drawDXSatMenu (const SCoord &s)
                 case _SMI_AMSAT_STATUS:
                     openURL ("https://www.amsat.org/status/");
                     break;
+                case _SMI_GROUPSKED:
+                    drawSatGroupSchedule ();
+                    initEarthMap ();
+                    break;
+                case _SMI_COVIS:
+                    drawSatCoVis ();
+                    initEarthMap ();
+                    break;
                 case _SMI_N:
                     // lint
                     fatalError ("sat menu bogus entry %d", i);