GPS - Refactor GPSEvent and processing, datetime construction

Author: brentru

src/components/gps/controller.cpp

@@ -165,12 +165,19 @@ void GPSController::update() {
     _gps_model->CreateGPSEvent();
     char nmea_sentence[MAX_LEN_NMEA_SENTENCE];
     bool has_gps_event = false;
+    // TODO: You were here
+    // Thoughts:
+    // 1. Split out the parsing into the hardware HAL API
+    // 2. Return the sentence back to the controller func, here
+    // 3. Controller will then the sentence to the model for parsing/inclusion
+    // into a GPSEvent
+    // 4. controller sends it
     while (drv->NmeaBufPop(nmea_sentence) != -1) {
       // Parse the NMEA sentence
       WS_DEBUG_PRINT("[gps] Parsing NMEA sentence: ");
       WS_DEBUG_PRINTLN(nmea_sentence);
-      if (!ada_gps->parse(nmea_sentence)) {
-        continue; // Skip parsing this sentence if parsing failed
+      if (!drv->ParseNMEASentence(nmea_sentence)) {
+        continue; // Skip this sentence if parsing failed
       }
       has_gps_event = true;
       // Build a GPSEvent message from the sentence

src/components/gps/hardware.cpp

@@ -610,4 +610,87 @@ int GPSHardware::NmeaBufPop(char *sentence) {
   strcpy(sentence, _nmea_buff.sentences[_nmea_buff.tail]);
   _nmea_buff.tail = next; // Advance tail
   return 0;
+}
+
+/*!
+ * @brief Parses a NMEA sentence and returns true if it was successfully parsed.
+ * @param sentence Pointer to the NMEA sentence to be parsed.
+ * @returns True if the sentence was parsed successfully, False otherwise.
+ */
+bool GPSHardware::ParseNMEASentence(char *sentence) {
+  if (!sentence)
+    return false;
+  if (_driver_type == GPS_DRV_MTK) {
+    // Parse the NMEA sentence using Adafruit_GPS
+    return _ada_gps->parse(sentence);
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // Parse the NMEA sentence using SFE_UBLOX_GNSS
+    // TODO!
+    // return _sfe_gps->parseNMEA(sentence);
+  }
+
+  return false;
+}
+
+uint8_t GPSHardware::GetHour() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->hour;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint8_t GPSHardware::GetMinute() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->minute;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint8_t GPSHardware::GetSeconds() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->seconds;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint16_t GPSHardware::GetMilliseconds() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->milliseconds;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint8_t GPSHardware::GetDay() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->day;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint8_t GPSHardware::GetMonth() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->month;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
+}
+
+uint8_t GPSHardware::GetYear() {
+  if (_driver_type == GPS_DRV_MTK) {
+    return _ada_gps->year;
+  } else if (_driver_type == GPS_DRV_UBLOX) {
+    // TODO: Implement for UBLOX
+  }
+  return 0;
 }

src/components/gps/hardware.h

@@ -86,11 +86,20 @@ class GPSHardware {
   SFE_UBLOX_GNSS *GetUbxGps();
   GpsDriverType GetDriverType();
   GpsInterfaceType GetIfaceType();
+  int NmeaBufPop(char *sentence);
   // HAL Abstraction for GPS driver commands
   // Used to abstract the Adafruit_GPS and SFE_UBLOX_GNSS libraries
   // and intelligently handle the differences between them
   void ReadDiscardBuffer();
   void PollStoreSentences();
+  bool ParseNMEASentence(char *sentence);
+  uint8_t GetHour();
+  uint8_t GetMinute();
+  uint8_t GetSeconds();
+  uint16_t GetMilliseconds();
+  uint8_t GetDay();
+  uint8_t GetMonth();
+  uint8_t GetYear();
 
 private:
   bool QueryModuleType();
@@ -117,9 +126,8 @@ class GPSHardware {
   char _micro_nmea_buf[100]; ///< Optional Buffer for MicroNMEA parsing
   // NMEA sentence ring buffer
   int NmeaBufPush(
-      const char *new_sentence);  ///< Push a sentence to the NMEA buffer
-  int NmeaBufPop(char *sentence); ///< Pop a sentence from the NMEA buffer
-  nmea_buffer_t _nmea_buff;       ///< NMEA buffer for storing sentences
+      const char *new_sentence); ///< Push a sentence to the NMEA buffer
+  nmea_buffer_t _nmea_buff;      ///< NMEA buffer for storing sentences
 };
 extern Wippersnapper_V2 WsV2; ///< Wippersnapper V2 instance
 #endif                        // WS_GPS_HARDWARE_H

src/components/gps/model.cpp

@@ -193,4 +193,13 @@ bool GPSModel::AddGpsEventGGA(wippersnapper_gps_GPSDateTime datetime,
   _msg_gps_event.gga_responses[0] = gga_response;
   _msg_gps_event.gga_responses_count = 1;
   return true;
+}
+
+bool GPSModel::ProcessNMEASentence(char *sentence, GPSHardware *drv) {
+  // Build datetime
+  wippersnapper_gps_GPSDateTime datetime = CreateGpsDatetime(
+      drv->GetHour(), drv->GetMinute(), drv->GetSeconds(),
+      drv->GetMilliseconds(), drv->GetDay(), drv->GetMonth(), drv->GetYear());
+
+  return true;
 }

src/components/gps/model.h

@@ -32,6 +32,7 @@ class GPSModel {
   void CreateGPSEvent();
   bool EncodeGPSEvent();
   wippersnapper_gps_GPSEvent *GetGPSEvent();
+  bool ProcessNMEASentence(char *sentence, GPSHardware *drv);
   wippersnapper_gps_GPSDateTime CreateGpsDatetime(uint8_t hour, uint8_t minute,
                                                   uint8_t seconds,
                                                   uint8_t milliseconds,