Add mqttClientIsNeeded() and productVariantSupportsAssistNow()

Author: PaulZC

Firmware/RTK_Everywhere/MQTT_Client.ino

@@ -154,6 +154,34 @@ static uint32_t mqttClientTimer;
 // MQTT Client Routines
 //----------------------------------------
 
+bool mqttClientIsNeeded()
+{
+    // If PointPerfectCorrections are not enabled, return false
+    if (!settings.enablePointPerfectCorrections)
+        return false;
+
+    // For the mosaic-X5, settings.enablePointPerfectCorrections will be true if
+    // we are using the PPL and getting keys via ZTP. BUT the Facet mosaic-X5
+    // uses the L-Band (only) plan. It should not and can not subscribe to PP IP
+    // MQTT corrections. So, return false - even though the L-Band frequencies topic
+    // and key distribution topic could be beneficial.
+    // We could use present.gnss_mosaicX5, but let's not. See notes on EVK below.
+    if (productVariant == RTK_FACET_MOSAIC)
+        return false;
+
+    // For the Facet v2 L-Band, the same is true. It uses the L-Band (only) plan.
+    // We get keys during ZTP (HTTP_Client). It should not and can not subscribe
+    // to PP IP MQTT corrections. So, return true only if AssistNow is enabled -
+    // even though the L-Band frequencies topic and key distribution topic could
+    // be beneficial.
+    // Note: EVK supports both L-Band and IP, so we cannot use present.lband_neo
+    if (productVariant == RTK_FACET_V2_LBAND)
+        if (!settings.useAssistNow)
+            return false;
+
+    return true;
+}
+
 // Determine if another connection is possible or if the limit has been reached
 bool mqttClientConnectLimitReached()
 {
@@ -163,9 +191,7 @@ bool mqttClientConnectLimitReached()
     // Retry the connection a few times
     limitReached = (mqttClientConnectionAttempts >= MAX_MQTT_CLIENT_CONNECTION_ATTEMPTS);
 
-    bool enableMqttClient = true;
-    if (!settings.enablePointPerfectCorrections)
-        enableMqttClient = false;
+    bool enableMqttClient = mqttClientIsNeeded();
 
     // Restart the MQTT client
     MQTT_CLIENT_STOP(limitReached || (!enableMqttClient));
@@ -242,18 +268,7 @@ void mqttClientPrintStatus()
     byte minutes;
     byte seconds;
 
-    bool enableMqttClient = true;
-    if (!settings.enablePointPerfectCorrections)
-        enableMqttClient = false;
-
-    // For the mosaic-X5, settings.enablePointPerfectCorrections will be true if
-    // we are using the PPL and getting keys via ZTP. BUT the Facet mosaic-X5
-    // uses the L-Band (only) plan. It should not and can not subscribe to PP IP
-    // MQTT corrections. So, if present.gnss_mosaicX5 is true, set enableMqttClient
-    // to false.
-    // TODO : review this. This feels like a bit of a hack...
-    if (present.gnss_mosaicX5)
-        enableMqttClient = false;
+    bool enableMqttClient = mqttClientIsNeeded();
 
     // Display MQTT Client status and uptime
     if (enableMqttClient && (EQ_RTK_MODE(mqttClientMode)))
@@ -595,7 +610,7 @@ void mqttClientSetState(uint8_t newState)
         }
         systemPrintln();
         systemPrint("MQTT Client subscribed topics: ");
-        for (auto it = mqttSubscribedTopics.begin(); it != mqttSubscribedTopics.end(); it = std::next(it))
+        for (auto it = mqttClientSubscribedTopics.begin(); it != mqttClientSubscribedTopics.end(); it = std::next(it))
         {
             String topic = *it;
             systemPrint(topic);
@@ -692,18 +707,7 @@ bool mqttClientNeedsNetwork()
 // MQTT_CLIENT_RECEIVE_DATA_TIMEOUT
 void mqttClientUpdate()
 {
-    bool enableMqttClient = true;
-    if (!settings.enablePointPerfectCorrections)
-        enableMqttClient = false;
-
-    // For the mosaic-X5, settings.enablePointPerfectCorrections will be true if
-    // we are using the PPL and getting keys via ZTP. BUT the Facet mosaic-X5
-    // uses the L-Band (only) plan. It should not and can not subscribe to PP IP
-    // MQTT corrections. So, if present.gnss_mosaicX5 is true, set enableMqttClient
-    // to false.
-    // TODO : review this. This feels like a bit of a hack...
-    if (present.gnss_mosaicX5)
-        enableMqttClient = false;
+    bool enableMqttClient = mqttClientIsNeeded();
 
     // Shutdown the MQTT client when the mode or setting changes
     DMW_st(mqttClientSetState, mqttClientState);

Firmware/RTK_Everywhere/menuPP.ino

@@ -28,6 +28,17 @@ MqttClient *menuppMqttClient;
 // L-Band Routines - compiled out
 //----------------------------------------
 
+bool productVariantSupportsAssistNow()
+{
+    if (productVariant == RTK_FACET_MOSAIC)
+        return false;
+    if (productVariant == RTK_TORCH)
+        return false;
+    if (productVariant == RTK_POSTCARD)
+        return false;
+    return true;
+}
+
 void menuPointPerfectKeys()
 {
     while (1)
@@ -979,7 +990,7 @@ void menuPointPerfect()
                 systemPrint(localizedDistributionTileLevelNames[settings.localizedDistributionTileLevel]);
                 systemPrintln(")");
             }
-            if (productVariant != RTK_FACET_MOSAIC)
+            if (productVariantSupportsAssistNow())
             {
                 systemPrint("a) Use AssistNow: ");
                 if (settings.useAssistNow == true)
@@ -1030,7 +1041,7 @@ void menuPointPerfect()
             if (settings.localizedDistributionTileLevel >= LOCALIZED_DISTRIBUTION_TILE_LEVELS)
                 settings.localizedDistributionTileLevel = 0;
         }
-        else if (incoming == 'a' && pointPerfectIsEnabled() && (productVariant != RTK_FACET_MOSAIC))
+        else if (incoming == 'a' && pointPerfectIsEnabled() && productVariantSupportsAssistNow())
         {
             settings.useAssistNow ^= 1;
         }