Merge branch 'main' into main

pr3y · Nov 21, 2024 · a10671e · a10671e
2 parents 867744a + f895bd7
commit a10671e
Show file tree

Hide file tree

Showing 4 changed files with 300 additions and 4 deletions.
diff --git a/.github/workflows/buil_parallel.yml b/.github/workflows/buil_parallel.yml
@@ -232,6 +232,7 @@
                     0x10000 .pio/build/${{ matrix.board.env }}/firmware.bin
 
                   js_content="{\"name\":\"${{ matrix.board.name }}\",\"builds\":[{\"chipFamily\":\"${{ matrix.board.family }}\",\"improv\":false,\"parts\":[{\"path\":\"Bruce-${{ matrix.board.env }}.bin\",\"offset\":0}]}]}"
+
                   echo "$js_content" > "./Bruce-${{ matrix.board.env }}.json"
 
                   html="<input type='radio' name='type' value='${{ matrix.board.env }}' id='${{ matrix.board.env }}' /><label for='${{ matrix.board.env }}'>${{ matrix.board.name }}</label>"

diff --git a/src/core/menu_items/OthersMenu.cpp b/src/core/menu_items/OthersMenu.cpp
@@ -2,6 +2,7 @@
 #include "core/display.h"
 #include "core/sd_functions.h"
 #include "modules/others/openhaystack.h"
+#include "modules/others/gps_tracker.h"
 #include "modules/others/tururururu.h"
 #include "modules/others/webInterface.h"
 #include "modules/others/qrcode_menu.h"
@@ -19,17 +20,18 @@ void OthersMenu::optionsMenu() {
         {"LittleFS",     [=]() { loopSD(LittleFS); }},
         {"WebUI",        [=]() { loopOptionsWebUi(); }},
         {"QRCodes",      [=]() { qrcode_menu(); }},
+        {"GPS Tracker",  [=]() { GPSTracker(); }},
         {"Megalodon",    [=]() { shark_setup(); }},
     #ifdef MIC_SPM1423
         {"Mic Spectrum", [=]() { mic_test(); }},
     #endif
         {"BadUSB",       [=]()  { usb_setup(); }},
-        #if defined(HAS_KEYBOARD_HID)
+    #ifdef HAS_KEYBOARD_HID
         {"USB Keyboard", [=]()  { usb_keyboard(); }},
-        #endif
+    #endif
     #ifdef HAS_RGB_LED
-        {"LED Control",  [=]()  { ledrgb_setup(); }}, //IncursioHack
-        {"LED FLash",    [=]()  { ledrgb_flash(); }}, // IncursioHack
+        {"LED Control",  [=]()  { ledrgb_setup(); }},  // IncursioHack
+        {"LED FLash",    [=]()  { ledrgb_flash(); }},  // IncursioHack
     #endif
     #ifndef LITE_VERSION
         {"Openhaystack", [=]()  { openhaystack_setup(); }},

diff --git a/src/modules/others/gps_tracker.cpp b/src/modules/others/gps_tracker.cpp
@@ -0,0 +1,230 @@
+/**
+ * @file gps_tracker.cpp
+ * @author Rennan Cockles (https://github.com/rennancockles)
+ * @brief GPS tracker
+ * @version 0.1
+ * @date 2024-11-20
+ */
+
+
+#include "gps_tracker.h"
+#include "core/display.h"
+#include "core/mykeyboard.h"
+#include "core/sd_functions.h"
+
+#define MAX_WAIT 5000
+#define CURRENT_YEAR 2024
+
+
+GPSTracker::GPSTracker() {
+    setup();
+}
+
+GPSTracker::~GPSTracker() {
+    add_final_file_data();
+    if (gpsConnected) end();
+}
+
+void GPSTracker::setup() {
+    display_banner();
+    padprintln("Initializing...");
+
+    if (!begin_gps()) return;
+
+    delay(500);
+    return loop();
+}
+
+bool GPSTracker::begin_gps() {
+    GPSserial.begin(9600, SERIAL_8N1, SERIAL_RX, SERIAL_TX);
+
+    int count = 0;
+    padprintln("Waiting for GPS data");
+    while(GPSserial.available() <= 0) {
+        if(checkEscPress()) {
+            end();
+            return false;
+        }
+        displayRedStripe("Waiting GPS: " + String(count)+ "s", TFT_WHITE, bruceConfig.priColor);
+        count++;
+        delay(1000);
+    }
+
+    gpsConnected = true;
+    return true;
+}
+
+void GPSTracker::end() {
+    GPSserial.end();
+
+    returnToMenu = true;
+    gpsConnected = false;
+
+    delay(500);
+}
+
+void GPSTracker::loop() {
+    int count = 0;
+    returnToMenu = false;
+    while(1) {
+        display_banner();
+
+        if (checkEscPress() || returnToMenu) return end();
+
+        if (GPSserial.available() > 0) {
+            count = 0;
+            while (GPSserial.available() > 0) gps.encode(GPSserial.read());
+
+            if (gps.location.isUpdated()) {
+                padprintln("GPS location updated");
+                set_position();
+                add_coord();
+            } else {
+                padprintln("GPS location not updated");
+                dump_gps_data();
+
+                if (filename == "" && gps.date.year() >= CURRENT_YEAR && gps.date.year() < CURRENT_YEAR+5)
+                    create_filename();
+            }
+        } else {
+            if (count > 5) {
+                displayError("GPS not Found!");
+                return end();
+            }
+            padprintln("No GPS data available");
+            count++;
+        }
+
+        int tmp = millis();
+        while(millis()-tmp < MAX_WAIT && !gps.location.isUpdated()){
+            if (checkEscPress() || returnToMenu) return end();
+        }
+    }
+}
+
+void GPSTracker::set_position() {
+    double lat = gps.location.lat();
+    double lng = gps.location.lng();
+
+    if (initial_position_set) distance += gps.distanceBetween(cur_lat, cur_lng, lat, lng);
+    else initial_position_set = true;
+
+    cur_lat = lat;
+    cur_lng = lng;
+}
+
+void GPSTracker::display_banner() {
+    drawMainBorderWithTitle("GPS Tracker");
+    padprintln("");
+
+    if (gpsCoordCount > 0){
+        padprintln("File: " + filename.substring(0, filename.length()-4), 2);
+        padprintln("GPS Coordinates: " + String(gpsCoordCount), 2);
+        padprintf(2, "Distance: %.2fkm\n", distance / 1000);
+    }
+
+    padprintln("");
+}
+
+void GPSTracker::dump_gps_data() {
+    if (!date_time_updated && (!gps.date.isUpdated() || !gps.time.isUpdated())) {
+        padprintln("Waiting for valid GPS data");
+        return;
+    }
+    date_time_updated = true;
+    padprintf(2, "Date: %02d-%02d-%02d\n", gps.date.year(), gps.date.month(), gps.date.day());
+    padprintf(2, "Time: %02d:%02d:%02d\n", gps.time.hour(), gps.time.minute(), gps.time.second());
+    padprintf(2, "Sat:  %d\n", gps.satellites.value());
+    padprintf(2, "HDOP: %.2f\n", gps.hdop.hdop());
+}
+
+void GPSTracker::create_filename() {
+    char timestamp[20];
+    sprintf(
+        timestamp,
+        "%02d%02d%02d_%02d%02d%02d",
+        gps.date.year(),
+        gps.date.month(),
+        gps.date.day(),
+        gps.time.hour(),
+        gps.time.minute(),
+        gps.time.second()
+    );
+    filename = String(timestamp) + "_gps_tracker.gpx";
+}
+
+void GPSTracker::add_initial_file_data(File file) {
+    file.println("<?xml version=\"1.0\" encoding=\"ISO-8859-1\" standalone=\"yes\"?>");
+    file.println("<?xml-stylesheet type=\"text/xsl\" href=\"details.xsl\"?>");
+    file.println("<gpx");
+    file.println("  version=\"1.1\"");
+    file.println("  creator=\"Bruce Firmware\"");
+    file.println("  xmlns=\"http://www.topografix.com/GPX/1/1\"");
+    file.println("  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"");
+    file.println("  xsi:schemaLocation=\"http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd\"");
+    file.println(">");
+    file.println("  <metadata>");
+    file.println("    <name>Bruce GPS Tracker</name>");
+    file.println("    <desc>GPS Tracker using Bruce Firmware</desc>");
+    file.println("    <link href=\"https://bruce.computer\">");
+    file.println("      <text>Bruce Website</text>");
+    file.println("    </link>");
+    file.println("  </metadata>");
+    file.println("  <trk>");
+    file.println("    <name>Bruce Route</name>");
+    file.println("    <desc>GPS route captured by Bruce firmware</desc>");
+    file.println("    <trkseg>");
+}
+
+void GPSTracker::add_final_file_data() {
+    FS *fs;
+    if(!getFsStorage(fs)) return;
+    if (filename == "" || !(*fs).exists("/BruceGPS/"+filename)) return;
+
+    File file = (*fs).open("/BruceGPS/"+filename, FILE_APPEND);
+
+    if (!file) return;
+    file.println("    </trkseg>");
+    file.println("  </trk>");
+    file.println("</gpx>");
+
+    file.close();
+}
+
+void GPSTracker::add_coord() {
+    FS *fs;
+    if(!getFsStorage(fs)) {
+        padprintln("Storage setup error");
+        returnToMenu = true;
+        return;
+    }
+
+    if (filename == "") create_filename();
+
+    if (!(*fs).exists("/BruceGPS")) (*fs).mkdir("/BruceGPS");
+
+    bool is_new_file = false;
+    if(!(*fs).exists("/BruceGPS/"+filename)) is_new_file = true;
+    File file = (*fs).open("/BruceGPS/"+filename, is_new_file ? FILE_WRITE : FILE_APPEND);
+
+    if (!file) {
+        padprintln("Failed to open file for writing");
+        returnToMenu = true;
+        return;
+    }
+
+    if (is_new_file) add_initial_file_data(file);
+
+    file.printf( "      <trkpt lat=\"%f\" lon=\"%f\">\n", gps.location.lat(), gps.location.lng());
+    file.println("        <sym>Waypoint</sym>");
+    file.printf( "        <ele>%f</ele>\n", gps.altitude.meters());
+    file.printf( "        <hdop>%f</hdop>\n", gps.hdop.hdop());
+    file.printf( "        <sat>%d</sat>\n", gps.satellites.value());
+    file.println("      </trkpt>");
+
+    gpsCoordCount++;
+
+    file.close();
+
+    padprintf(2, "Coord: %.6f, %.6f\n", gps.location.lat(), gps.location.lng());
+}
diff --git a/src/modules/others/gps_tracker.h b/src/modules/others/gps_tracker.h
@@ -0,0 +1,63 @@
+/**
+ * @file gps_tracker.h
+ * @author Rennan Cockles (https://github.com/rennancockles)
+ * @brief GPS tracker
+ * @version 0.1
+ * @date 2024-11-20
+ */
+
+#ifndef GPS_TRACKER_H
+#define GPS_TRACKER_H
+
+#include "core/globals.h"
+#include <TinyGPS++.h>
+
+
+class GPSTracker {
+public:
+    /////////////////////////////////////////////////////////////////////////////////////
+    // Constructor
+    /////////////////////////////////////////////////////////////////////////////////////
+    GPSTracker();
+    ~GPSTracker();
+
+    /////////////////////////////////////////////////////////////////////////////////////
+    // Life Cycle
+    /////////////////////////////////////////////////////////////////////////////////////
+    void setup();
+    void loop();
+
+private:
+    bool date_time_updated = false;
+    bool initial_position_set = false;
+    double cur_lat;
+    double cur_lng;
+    double distance = 0;
+    String filename = "";
+    TinyGPSPlus gps;
+    HardwareSerial GPSserial = HardwareSerial(2);
+    int gpsCoordCount = 0;
+
+    /////////////////////////////////////////////////////////////////////////////////////
+    // Setup
+    /////////////////////////////////////////////////////////////////////////////////////
+    bool begin_gps(void);
+    void end(void);
+
+    /////////////////////////////////////////////////////////////////////////////////////
+    // Display functions
+    /////////////////////////////////////////////////////////////////////////////////////
+    void display_banner(void);
+    void dump_gps_data(void);
+
+    /////////////////////////////////////////////////////////////////////////////////////
+    // Operations
+    /////////////////////////////////////////////////////////////////////////////////////
+    void set_position(void);
+    void add_coord(void);
+    void add_initial_file_data(File file);
+    void add_final_file_data(void);
+    void create_filename(void);
+};
+
+#endif // GPS_TRACKER_H