Suppress RTCM output by PPL if not enabled

Fix #633

Author: nseidle

Firmware/RTK_Everywhere/GNSS.h

@@ -132,6 +132,9 @@ class GNSS
     // Return the number of active/enabled messages
     virtual uint8_t getActiveMessageCount();
 
+    // Return the number of active/enabled RTCM messages
+    virtual uint8_t getActiveRtcmMessageCount();
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_LG290P.h

@@ -195,6 +195,9 @@ class GNSS_LG290P : GNSS
     // Return the number of active/enabled messages
     uint8_t getActiveMessageCount();
 
+    // Return the number of active/enabled RTCM messages
+    uint8_t getActiveRtcmMessageCount();
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_Mosaic.h

@@ -694,6 +694,9 @@ class GNSS_MOSAIC : GNSS
     // Return the number of active/enabled messages
     uint8_t getActiveMessageCount();
 
+    // Return the number of active/enabled RTCM messages
+    uint8_t getActiveRtcmMessageCount() {return(0);}
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_None.h

@@ -151,6 +151,12 @@ class GNSS_None : public GNSS
         return 0;
     }
 
+    // Return the number of active/enabled RTCM messages
+    uint8_t getActiveRtcmMessageCount()
+    {
+        return 0;
+    }
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_UM980.h

@@ -130,8 +130,6 @@ class GNSS_UM980 : GNSS
 
     uint8_t getActiveNmeaMessageCount();
 
-    uint8_t getActiveRtcmMessageCount();
-
     // Given the name of an NMEA message, return the array number
     uint8_t getNmeaMessageNumberByName(const char *msgName);
 
@@ -235,6 +233,9 @@ class GNSS_UM980 : GNSS
     // Return the number of active/enabled messages
     uint8_t getActiveMessageCount();
 
+    // Return the number of active/enabled RTCM messages
+    uint8_t getActiveRtcmMessageCount();
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_ZED.h

@@ -459,6 +459,9 @@ class GNSS_ZED : GNSS
     // Return the number of active/enabled messages
     uint8_t getActiveMessageCount();
 
+    // Return the number of active/enabled RTCM messages
+    uint8_t getActiveRtcmMessageCount();
+
     // Get the altitude
     // Outputs:
     //   Returns the altitude in meters or zero if the GNSS is offline

Firmware/RTK_Everywhere/GNSS_ZED.ino

@@ -1049,6 +1049,19 @@ uint8_t GNSS_ZED::getActiveMessageCount()
     return (count);
 }
 
+//----------------------------------------
+// Return the number of active/enabled RTCM messages
+//----------------------------------------
+uint8_t GNSS_ZED::getActiveRtcmMessageCount()
+{
+    uint8_t count = 0;
+
+    for (int x = 0; x < MAX_UBX_MSG; x++)
+        if (settings.ubxMessageRatesBase[x] > 0)
+            count++;
+    return (count);
+}
+
 //----------------------------------------
 //   Returns the altitude in meters or zero if the GNSS is offline
 //----------------------------------------

Firmware/RTK_Everywhere/Tasks.ino

@@ -763,6 +763,22 @@ void processUart1Message(SEMP_PARSE_STATE *parse, uint16_t type)
         pushGPGGA((char *)parse->buffer);
     }
 
+    // If the user has not specifically enabled RTCM used by the PPL, then suppress it
+    if (inRoverMode() && gnss->getActiveRtcmMessageCount() == 0 && type == RTK_RTCM_PARSER_INDEX)
+    {
+        // Erase buffer
+        parse->buffer[0] = 0;
+        parse->length = 0;
+    }
+
+    // Suppress binary messages from UM980. Not needed by end GIS apps.
+    if (type == RTK_UNICORE_BINARY_PARSER_INDEX)
+    {
+        // Erase buffer
+        parse->buffer[0] = 0;
+        parse->length = 0;
+    }
+
     // Determine if this message will fit into the ring buffer
     bytesToCopy = parse->length;
     space = availableHandlerSpace;