Implement SoftwareSerial in gps component

Author: brentru

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
 
 /*!

src/components/gps/controller.cpp

@@ -72,7 +72,7 @@ bool GPSController::AddGPS(TwoWire *wire, uint32_t i2c_addr,
 }
 
 /*!
- * @brief Adds a GPS hardware instance to the controller.
+ * @brief Adds a GPS hardware serial instance to the controller.
  * @param serial Pointer to the HardwareSerial instance for GPS communication.
  * @param gps_config Pointer to the GPS configuration message.
  * @return True if the GPS was added successfully, false otherwise.
@@ -107,6 +107,44 @@ bool GPSController::AddGPS(HardwareSerial *serial, uint32_t baudrate,
   return true;
 }
 
+#ifdef HAS_SW_SERIAL
+/*!
+ * @brief Adds a GPS software serial instance to the controller.
+ * @param serial Pointer to the SoftwareSerial instance for GPS communication.
+ * @param gps_config Pointer to the GPS configuration message.
+ * @return True if the GPS was added successfully, false otherwise.
+ */
+bool GPSController::AddGPS(SoftwareSerial *serial_sw, uint32_t baudrate,
+                           wippersnapper_gps_GPSConfig *gps_config) {
+  GPSHardware *gps_hw = new GPSHardware();
+
+  if (!gps_hw->SetInterface(serial_sw, baudrate)) {
+    WS_DEBUG_PRINTLN("[gps] ERROR: Failed to set GPS UART interface!");
+    delete gps_hw;
+    return false;
+  }
+
+  if (!gps_hw->begin()) {
+    WS_DEBUG_PRINTLN("[gps] ERROR: Failed to initialize GPS hardware!");
+    delete gps_hw;
+    return false;
+  }
+  // Required - let the GPS spit out its initial data
+  delay(1000);
+
+  if (!gps_hw->Handle_GPSConfig(gps_config)) {
+    WS_DEBUG_PRINTLN("[gps] ERROR: Failed to configure GPS!");
+    delete gps_hw;
+    return false;
+  }
+
+  _gps_drivers.push_back(gps_hw);
+  WS_DEBUG_PRINTLN("[gps] GPS hardware added successfully!");
+  has_gps = true;
+  return true;
+}
+#endif // HAS_SW_SERIAL
+
 /*!
  * @brief Gets the current GPS datetime.
  * @return The current GPS datetime.

src/components/gps/controller.h

@@ -33,6 +33,10 @@ class GPSController {
   ~GPSController();
   bool AddGPS(HardwareSerial *serial, uint32_t baudrate,
               wippersnapper_gps_GPSConfig *gps_config);
+#ifdef HAS_SW_SERIAL
+  bool AddGPS(SoftwareSerial *serial, uint32_t baudrate,
+              wippersnapper_gps_GPSConfig *gps_config);
+#endif // HAS_SW_SERIAL
   bool AddGPS(TwoWire *wire, uint32_t i2c_addr,
               wippersnapper_gps_GPSConfig *gps_config);
   void update();

src/components/gps/hardware.cpp

@@ -80,12 +80,20 @@ bool GPSHardware::Handle_GPSConfig(wippersnapper_gps_GPSConfig *gps_config) {
       }
       WS_DEBUG_PRINT("[gps] Expected response: ");
       WS_DEBUG_PRINTLN(msg_resp);
-      if (_iface_type == GPS_IFACE_UART_HW) {
-        // Flush the RX/TX buffers before sending
+      if (_iface_type == GPS_IFACE_UART_HW ||
+          _iface_type == GPS_IFACE_UART_SW) {
+// Flush the RX/TX buffers before sending
+#ifdef HAS_SW_SERIAL
+        _sw_serial->flush();
+        while (_sw_serial->available() > 0) {
+          _sw_serial->read();
+        }
+#else
         _hw_serial->flush();
         while (_hw_serial->available() > 0) {
           _hw_serial->read();
         }
+#endif // HAS_SW_SERIAL
       } else if (_iface_type == GPS_IFACE_I2C) {
         WS_DEBUG_PRINT("[gps] Flushing I2C buffers...");
         I2cReadDiscard();
@@ -128,6 +136,24 @@ bool GPSHardware::SetInterface(HardwareSerial *serial, uint32_t baudrate) {
   return true;
 }
 
+#ifdef HAS_SW_SERIAL
+/*!
+ * @brief Sets a UART software serial interface for the GPS controller.
+ * @param serial
+ *        Pointer to a SoftwareSerial instance.
+ * @returns True if the interface was set successfully, False otherwise.
+ */
+bool GPSHardware::SetInterface(SoftwareSerial *serial, uint32_t baudrate) {
+  if (serial == nullptr)
+    return false;
+  // Configure the hardware serial interface
+  _sw_serial = serial;
+  _iface_type = GPS_IFACE_UART_SW;
+  _baudrate = baudrate;
+  return true;
+}
+#endif // HAS_SW_SERIAL
+
 /*!
  * @brief Sets a TwoWire (I2C) interface for the GPS controller.
  * @param wire
@@ -259,33 +285,57 @@ bool GPSHardware::DetectMtkUart() {
     return false;
   }
 
-  // Clear the tx and rx buffers before sending the command
+// Clear the tx and rx buffers before sending the command
+#ifdef HAS_SW_SERIAL
+  _sw_serial->flush();
+  while (_sw_serial->available() > 0) {
+    _sw_serial->read();
+  }
+#else
   _hw_serial->flush();
   while (_hw_serial->available() > 0) {
     _hw_serial->read();
   }
+#endif
 
   // Query MediaTek firmware version
   uint16_t timeout = MTK_QUERY_FW_TIMEOUT;
+
+#ifdef HAS_SW_SERIAL
+  while (_sw_serial->available() < MAX_NEMA_SENTENCE_LEN && timeout--) {
+    delay(1);
+  }
+#else
   while (_hw_serial->available() < MAX_NEMA_SENTENCE_LEN && timeout--) {
     delay(1);
   }
+#endif // HAS_SW_SERIAL
+
   if (timeout == 0)
     return false;
 
   // We found a response, let's verify that it's the expected PMTK_DK_RELEASE
   // command by reading out the NMEA sentence string into a buffer
   size_t buf_len = MAX_NEMA_SENTENCE_LEN * 4; // +3 for \r\n and null terminator
   char buffer[buf_len];
-  size_t available = _hw_serial->available();
+  size_t available;
+#ifdef HAS_SW_SERIAL
+  available = _sw_serial->available();
+#else
+  available = _hw_serial->available();
+#endif // HAS_SW_SERIAL
   size_t bytes_to_read = min(available, buf_len - 1);
   // Print the two out
   WS_DEBUG_PRINT("[gps] Reading MediaTek GPS response: ");
   WS_DEBUG_PRINT(available);
   WS_DEBUG_PRINT(" bytes, reading ");
   WS_DEBUG_PRINTLN(bytes_to_read);
   for (size_t i = 0; i < bytes_to_read; i++) {
+#ifdef HAS_SW_SERIAL
+    buffer[i] = _sw_serial->read();
+#else
     buffer[i] = _hw_serial->read();
+#endif // HAS_SW_SERIAL
   }
   buffer[bytes_to_read] = '\0';
   WS_DEBUG_PRINT("[gps] MediaTek GPS response: ");
@@ -295,8 +345,12 @@ bool GPSHardware::DetectMtkUart() {
     return false;
   }
 
-  // Attempt to use Adafruit_GPS
+// Attempt to use Adafruit_GPS
+#ifdef HAS_SW_SERIAL
+  _ada_gps = new Adafruit_GPS(_sw_serial);
+#else
   _ada_gps = new Adafruit_GPS(_hw_serial);
+#endif // HAS_SW_SERIAL
   if (!_ada_gps->begin(_baudrate)) {
     WS_DEBUG_PRINTLN("[gps] ERROR: Failed to initialize Mediatek!");
     return false;

src/components/gps/hardware.h

@@ -70,6 +70,9 @@ class GPSHardware {
   ~GPSHardware();
   bool begin();
   bool SetInterface(HardwareSerial *serial, uint32_t baudrate);
+#ifdef HAS_SW_SERIAL
+  bool SetInterface(SoftwareSerial *serial, uint32_t baudrate);
+#endif // HAS_SW_SERIAL
   bool SetInterface(TwoWire *wire);
   void SetPollPeriod(ulong poll_period);
   void SetPollPeriodPrv(ulong poll_period_prv);
@@ -127,6 +130,9 @@ class GPSHardware {
   GpsInterfaceType _iface_type;         ///< Type of interface used by GPS
   GpsDriverType _driver_type;           ///< Type of GPS driver used by GPS
   HardwareSerial *_hw_serial = nullptr; ///< Optional HardwareSerial instance
+#ifdef HAS_SW_SERIAL
+  SoftwareSerial *_sw_serial = nullptr; ///< Optional SoftwareSerial instance
+#endif                                  // HAS_SW_SERIAL
   TwoWire *_wire = nullptr;             ///< Optional TwoWire instance
   Adafruit_GPS *_ada_gps = nullptr;     ///< Optional Adafruit GPS instance
   Adafruit_UBloxDDC *_ubx_gps_ddc =