Add src/components/uart/serial_config.h

Author: brentru

src/components/gps/controller.cpp

@@ -107,7 +107,7 @@ bool GPSController::AddGPS(HardwareSerial *serial, uint32_t baudrate,
   return true;
 }
 
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
 /*!
  * @brief Adds a GPS software serial instance to the controller.
  * @param serial Pointer to the SoftwareSerial instance for GPS communication.

src/components/gps/controller.h

@@ -15,6 +15,7 @@
  */
 #ifndef WS_GPS_CONTROLLER_H
 #define WS_GPS_CONTROLLER_H
+#include "../uart/serial_config.h"
 #include "Wippersnapper_V2.h"
 #include "hardware.h"
 #include "model.h"
@@ -33,7 +34,7 @@ class GPSController {
   ~GPSController();
   bool AddGPS(HardwareSerial *serial, uint32_t baudrate,
               wippersnapper_gps_GPSConfig *gps_config);
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   bool AddGPS(SoftwareSerial *serial, uint32_t baudrate,
               wippersnapper_gps_GPSConfig *gps_config);
 #endif // HAS_SW_SERIAL

src/components/gps/hardware.cpp

@@ -83,7 +83,7 @@ bool GPSHardware::Handle_GPSConfig(wippersnapper_gps_GPSConfig *gps_config) {
       if (_iface_type == GPS_IFACE_UART_HW ||
           _iface_type == GPS_IFACE_UART_SW) {
 // Flush the RX/TX buffers before sending
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
         _sw_serial->flush();
         while (_sw_serial->available() > 0) {
           _sw_serial->read();
@@ -136,7 +136,7 @@ bool GPSHardware::SetInterface(HardwareSerial *serial, uint32_t baudrate) {
   return true;
 }
 
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
 /*!
  * @brief Sets a UART software serial interface for the GPS controller.
  * @param serial
@@ -286,7 +286,7 @@ bool GPSHardware::DetectMtkUart() {
   }
 
 // Clear the tx and rx buffers before sending the command
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   _sw_serial->flush();
   while (_sw_serial->available() > 0) {
     _sw_serial->read();
@@ -301,7 +301,7 @@ bool GPSHardware::DetectMtkUart() {
   // Query MediaTek firmware version
   uint16_t timeout = MTK_QUERY_FW_TIMEOUT;
 
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   while (_sw_serial->available() < MAX_NEMA_SENTENCE_LEN && timeout--) {
     delay(1);
   }
@@ -319,7 +319,7 @@ bool GPSHardware::DetectMtkUart() {
   size_t buf_len = MAX_NEMA_SENTENCE_LEN * 4; // +3 for \r\n and null terminator
   char buffer[buf_len];
   size_t available;
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   available = _sw_serial->available();
 #else
   available = _hw_serial->available();
@@ -331,7 +331,7 @@ bool GPSHardware::DetectMtkUart() {
   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
+#if HAS_SW_SERIAL
     buffer[i] = _sw_serial->read();
 #else
     buffer[i] = _hw_serial->read();
@@ -346,7 +346,7 @@ bool GPSHardware::DetectMtkUart() {
   }
 
 // Attempt to use Adafruit_GPS
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   _ada_gps = new Adafruit_GPS(_sw_serial);
 #else
   _ada_gps = new Adafruit_GPS(_hw_serial);

src/components/gps/hardware.h

@@ -70,7 +70,7 @@ class GPSHardware {
   ~GPSHardware();
   bool begin();
   bool SetInterface(HardwareSerial *serial, uint32_t baudrate);
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
   bool SetInterface(SoftwareSerial *serial, uint32_t baudrate);
 #endif // HAS_SW_SERIAL
   bool SetInterface(TwoWire *wire);
@@ -130,7 +130,7 @@ 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
+#if HAS_SW_SERIAL
   SoftwareSerial *_sw_serial = nullptr; ///< Optional SoftwareSerial instance
 #endif                                  // HAS_SW_SERIAL
   TwoWire *_wire = nullptr;             ///< Optional TwoWire instance

src/components/uart/drivers/drvUartPm25.h

@@ -90,7 +90,7 @@ class drvUartPm25 : public drvUartBase {
 
     delay(1000); // Wait for the sensor to boot
 
-#ifdef HAS_SW_SERIAL
+#if HAS_SW_SERIAL
     return _pm25->begin_UART(_sw_serial);
 #else
     return _pm25->begin_UART(_hw_serial);

src/components/uart/hardware.h

@@ -15,26 +15,13 @@
 #ifndef WS_UART_HARDWARE_H
 #define WS_UART_HARDWARE_H
 #include "Wippersnapper_V2.h"
+#include "serial_config.h"
 #include <Arduino.h>
 #include <HardwareSerial.h>
 #ifdef ARDUINO_ARCH_RP2040
 #include <SerialUART.h>
 #endif
 
-#if defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_ARCH_SAMD) ||              \
-    defined(ARDUINO_ARCH_ESP8266)
-// SAMD supports native Arduino SoftwareSerial API
-// ESP8266 supports SoftwareSerial in the ESP8266 Arduino core
-// RP2040/RP2350 supports a wrapper around SoftwareSerial and emulation via
-// PIOUART (see:
-// https://arduino-pico.readthedocs.io/en/latest/piouart.html#softwareserial-emulation)
-#include <SoftwareSerial.h>
-#define HAS_SW_SERIAL 1 ///< Indicates that the board supports SoftwareSerial
-#else
-#define HAS_SW_SERIAL                                                          \
-  0 ///< Indicates that the board DOES NOT support SoftwareSerial
-#endif
-
 /*!
     @brief  Interface for interacting with the UART hardware.
 */

src/components/uart/serial_config.h

@@ -0,0 +1,32 @@
+/*!
+ * @file src/components/uart/serial_config.h
+ *
+ * Serial configuration definitions for WipperSnapper components.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef WS_UART_SERIAL_CONFIG_H
+#define WS_UART_SERIAL_CONFIG_H
+
+#if defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_ARCH_SAMD) ||              \
+    defined(ARDUINO_ARCH_ESP8266)
+// SAMD supports native Arduino SoftwareSerial API
+// ESP8266 supports SoftwareSerial in the ESP8266 Arduino core
+// RP2040/RP2350 supports a wrapper around SoftwareSerial and emulation via
+// PIOUART (see:
+// https://arduino-pico.readthedocs.io/en/latest/piouart.html#softwareserial-emulation)
+#include <SoftwareSerial.h>
+#define HAS_SW_SERIAL 1 ///< Indicates that the board supports SoftwareSerial
+#else
+#define HAS_SW_SERIAL                                                          \
+  0 ///< Indicates that the board DOES NOT support SoftwareSerial
+#endif
+
+#endif // WS_UART_SERIAL_CONFIG_H