GPS - Add support for GPS location in the logfile as a timestamp, #699

Author: brentru

platformio.ini

@@ -98,6 +98,7 @@ lib_deps =
     https://github.com/bblanchon/ArduinoStreamUtils.git
     https://github.com/Sensirion/arduino-i2c-scd4x.git
     adafruit/Adafruit GPS Library
+    adafruit/Adafruit uBlox
 
 ; Common build environment for ESP32 platform
 [common:esp32]

src/Wippersnapper_V2.h

@@ -30,7 +30,9 @@
 */
 #ifdef WS_DEBUG
 #define WS_DEBUG_PRINT(...)                                                    \
-  { WS_PRINTER.print(__VA_ARGS__); } /**< Print debug message to serial */
+  {                                                                            \
+    WS_PRINTER.print(__VA_ARGS__);                                             \
+  } /**< Print debug message to serial */
 #define WS_DEBUG_PRINTLN(...)                                                  \
   {                                                                            \
     WS_PRINTER.println(__VA_ARGS__);                                           \
@@ -42,9 +44,11 @@
   } /**< Print debug message in hexadecimal */
 #else
 #define WS_DEBUG_PRINT(...)                                                    \
-  {} /**< Debug print */
+  {                                                                            \
+  } /**< Debug print */
 #define WS_DEBUG_PRINTLN(...)                                                  \
-  {} /**< Debug println */
+  {                                                                            \
+  } /**< Debug println */
 #endif
 
 /*!
@@ -83,6 +87,7 @@
 #include "Adafruit_MQTT.h"      // MQTT Client
 #include "Adafruit_SleepyDog.h" // Watchdog
 #include "Arduino.h"            // Wiring
+#include "RTClib.h"             // RTC
 #include <SPI.h>                // SPI
 #include <Wire.h>               // I2C
 

src/Wippersnapper_demo.ino

@@ -10,8 +10,7 @@
 // All text above must be included in any redistribution.
 
 #include "ws_adapters.h"
-//ws_adapter_wifi wipper;
-ws_adapter_offline wipper;
+ws_adapter_wifi wipper;
 #define WS_DEBUG // Enable debug output!
 
 void setup() {

src/components/gps/controller.cpp

@@ -18,7 +18,10 @@
 /*!
  * @brief Constructor for GPSController.
  */
-GPSController::GPSController() { _gps_model = new GPSModel(); }
+GPSController::GPSController() {
+  _gps_model = new GPSModel();
+  has_gps = false;
+}
 
 /*!
  * @brief Destructor for GPSController.
@@ -29,6 +32,7 @@ GPSController::~GPSController() {
     delete _gps_model;
     _gps_model = nullptr;
   }
+  has_gps = false;
 }
 
 /*!
@@ -63,6 +67,7 @@ bool GPSController::AddGPS(TwoWire *wire, uint32_t i2c_addr,
 
   _gps_drivers.push_back(gps_hw);
   WS_DEBUG_PRINTLN("[gps] GPS hardware added successfully!");
+  has_gps = true;
   return true;
 }
 
@@ -98,9 +103,18 @@ bool GPSController::AddGPS(HardwareSerial *serial, uint32_t baudrate,
 
   _gps_drivers.push_back(gps_hw);
   WS_DEBUG_PRINTLN("[gps] GPS hardware added successfully!");
+  has_gps = true;
   return true;
 }
 
+/*!
+ * @brief Gets the current GPS datetime.
+ * @return The current GPS datetime.
+ */
+DateTime GPSController::GetGPSDateTime() {
+  return _gps_model->GetPrvGPSDateTime();
+}
+
 /*!
  * @brief Updates the GPSController, polling the GPS hardware for data.
  * This function checks if the read period has elapsed and processes the GPS
@@ -165,6 +179,7 @@ void GPSController::update() {
             WS_DEBUG_PRINTLN("...ok!");
           }
         } else {
+          // Set the Datetime for the GPSEvent
           // Log the GPSEvent to SD card
           if (!WsV2._sdCardV2->LogEventGps(_gps_model->GetGPSEvent())) {
             WS_DEBUG_PRINTLN("[gps] ERROR: Failed to log GPSEvent!");

src/components/gps/controller.h

@@ -36,6 +36,8 @@ class GPSController {
   bool AddGPS(TwoWire *wire, uint32_t i2c_addr,
               wippersnapper_gps_GPSConfig *gps_config);
   void update();
+  bool has_gps;
+  DateTime GetGPSDateTime();
 
 private:
   GPSModel *_gps_model;                    ///< GPS model instance

src/components/gps/model.cpp

@@ -195,26 +195,37 @@ bool GPSModel::AddGpsEventGGA(wippersnapper_gps_GPSDateTime datetime,
   return true;
 }
 
+/*!
+ * @brief Returns the previous GPS datetime as a DateTime object.
+ * @returns A DateTime object representing the previous GPS datetime.
+ */
+DateTime GPSModel::GetPrvGPSDateTime() {
+  // Create a DateTime object from the previous GPS datetime
+  return DateTime(_prv_msg_gps_datetime.year, _prv_msg_gps_datetime.month,
+                  _prv_msg_gps_datetime.day, _prv_msg_gps_datetime.hour,
+                  _prv_msg_gps_datetime.minute, _prv_msg_gps_datetime.seconds);
+}
+
 bool GPSModel::ProcessNMEASentence(char *sentence, GPSHardware *drv) {
   // Check for prefix: $GP or $GN
   if (strncmp(sentence, "$GP", 3) != 0 && strncmp(sentence, "$GN", 3) != 0)
     return false;
 
-  wippersnapper_gps_GPSDateTime datetime = CreateGpsDatetime(
+  _prv_msg_gps_datetime = CreateGpsDatetime(
       drv->GetHour(), drv->GetMinute(), drv->GetSeconds(),
       drv->GetMilliseconds(), drv->GetDay(), drv->GetMonth(), drv->GetYear());
   char lat_dir = drv->GetLatDir();
   char lon_dir = drv->GetLonDir();
   if (sentence[3] == 'R' && sentence[4] == 'M' && sentence[5] == 'C') {
     // Process RMC sentence
-    if (!AddGpsEventRMC(datetime, drv->GetFix(), drv->GetLat(), &lat_dir,
-                        drv->GetLon(), &lon_dir, drv->GetSpeed(),
+    if (!AddGpsEventRMC(_prv_msg_gps_datetime, drv->GetFix(), drv->GetLat(),
+                        &lat_dir, drv->GetLon(), &lon_dir, drv->GetSpeed(),
                         drv->GetAngle()))
       return false;
   } else if (sentence[3] == 'G' && sentence[4] == 'G' && sentence[5] == 'A') {
     // Process GGA sentence
-    if (!AddGpsEventGGA(datetime, drv->GetFix(), drv->GetLat(), &lat_dir,
-                        drv->GetLon(), &lon_dir, drv->GetNumSats(),
+    if (!AddGpsEventGGA(_prv_msg_gps_datetime, drv->GetFix(), drv->GetLat(),
+                        &lat_dir, drv->GetLon(), &lon_dir, drv->GetNumSats(),
                         drv->GetHDOP(), drv->GetAltitude(),
                         drv->GetGeoidHeight()))
       return false;

src/components/gps/model.h

@@ -48,9 +48,12 @@ class GPSModel {
                       uint8_t fix_status, float lat, char *lat_dir, float lon,
                       char *lon_dir, uint8_t num_sats, float hdop, float alt,
                       float geoid_height);
+  DateTime GetPrvGPSDateTime();
 
 private:
   wippersnapper_gps_GPSConfig _msg_gps_config; ///< GPS configuration message
   wippersnapper_gps_GPSEvent _msg_gps_event;   ///< GPS event message
+  wippersnapper_gps_GPSDateTime
+      _prv_msg_gps_datetime; ///< Previous GPS datetime
 };
 #endif // WS_GPS_MODEL_H

src/provisioning/sdcard/ws_sdcard.cpp

@@ -1021,6 +1021,8 @@ uint32_t ws_sdcard::GetTimestamp() {
     TickSoftRTC();
     return cur_time; // early-return as we are not converting this "soft rtc" to
                      // unixtime
+  } else if (WsV2._gps_controller->has_gps) {
+    now = WsV2._gps_controller->GetGPSDateTime();
   } else { // we're either using a simulator or have undefined behavior
     return 0;
   }

src/provisioning/sdcard/ws_sdcard.h

@@ -14,7 +14,6 @@
  */
 #ifndef WS_SDCARD_H
 #define WS_SDCARD_H
-#include "RTClib.h"
 #include "SdFat_Adafruit_Fork.h"
 #include "StreamUtils.h"
 #include "Wippersnapper_V2.h"