Add support for AssistNow

Author: PaulZC

Firmware/RTK_Everywhere/MQTT_Client.ino

@@ -66,10 +66,14 @@ MQTT_Client.ino
 //   mqttClientSubscribedTopics contains the topics we are currently subscribed to
 // While connected, the mqttClientUpdate state machine compares mqttClientSubscribedTopics to mqttSubscribeTopics
 //   New topics on mqttSubscribeTopics are subscribed to one at a time (one topic per call of mqttClientUpdate)
+//   (this will make things easier for cellular - the LARA-R6 can only subscribe to one topic at once)
 //   Topics no longer on mqttSubscribeTopics are unsubscribed one at a time (one topic per call of mqttClientUpdate)
+//   (ditto)
 // Initially we subscribe to the key distribution topic and the continental correction topic (if available)
+// If enabled, we also subscribe to the AssistNow MGA topic
 // If localised distribution is enabled and we have a 3D fix, we subscribe to the dict topic
 // When the dict is received, we subscribe to the nearest localised topic and unsubscribe from the continental topic
+// When the AssistNow MGA data arrives, we unsubscribe and subscribe to AssistNow updates
 
 #ifdef COMPILE_MQTT_CLIENT
 
@@ -108,7 +112,8 @@ const int mqttClientStateNameEntries = sizeof(mqttClientStateName) / sizeof(mqtt
 
 const RtkMode_t mqttClientMode = RTK_MODE_ROVER | RTK_MODE_BASE_SURVEY_IN;
 
-const char MQTT_TOPIC_ASSISTNOW[] = "/pp/ubx/mga"; // AssistNow (MGA) topic
+const String MQTT_TOPIC_ASSISTNOW = "/pp/ubx/mga"; // AssistNow (MGA) topic
+const String MQTT_TOPIC_ASSISTNOW_UPDATES = "/pp/ubx/mga/updates"; // AssistNow (MGA) topic - updates only
 // Note: the key and correction topics are now stored in settings - extracted from ZTP
 const char localizedPrefix[] = "pp/ip/L"; // The localized distribution topic prefix. Note: starts with "pp", not "/pp"
 
@@ -284,9 +289,11 @@ void mqttClientPrintStatus()
 // Called when a subscribed message arrives
 void mqttClientReceiveMessage(int messageSize)
 {
-    const uint16_t mqttLimit = 26000; // The Level 3 localised distribution dictionary topic can be up to 25KB
-    static uint8_t *mqttData = nullptr; // Allocate memory to hold the MQTT data. Never freed
-    if (mqttData == nullptr)
+    // The Level 3 localised distribution dictionary topic can be up to 25KB
+    // The full AssistNow (MGA) topic can be ~11KB
+    const uint16_t mqttLimit = 26000;
+    static uint8_t *mqttData = nullptr;
+    if (mqttData == nullptr) // Allocate memory to hold the MQTT data. Never freed
     {
         if (online.psram == true)
             mqttData = (uint8_t *)ps_malloc(mqttLimit);
@@ -387,6 +394,16 @@ void mqttClientReceiveMessage(int messageSize)
                 break; // Break now - the dict topic should not be pushed
             }
 
+            // Is this the full AssistNow MGA data? If so, unsubscribe and subscribe to updates
+            if (strcmp(topic, MQTT_TOPIC_ASSISTNOW.c_str()) == 0)
+            {
+                std::vector<String>::iterator pos = std::find(mqttSubscribeTopics.begin(), mqttSubscribeTopics.end(), MQTT_TOPIC_ASSISTNOW);
+                if (pos != mqttSubscribeTopics.end())
+                    mqttSubscribeTopics.erase(pos);
+                
+                mqttSubscribeTopics.push_back(MQTT_TOPIC_ASSISTNOW_UPDATES);
+            }
+
             // Are these keys? If so, update our local copy
             if ((strlen(settings.pointPerfectKeyDistributionTopic) > 0 )
                 && (strcmp(topic, settings.pointPerfectKeyDistributionTopic) == 0))
@@ -487,6 +504,10 @@ void mqttClientReceiveMessage(int messageSize)
                 else
                 {
                     // KEYS or MGA
+                    if (((settings.debugMqttClientData == true) || (settings.debugCorrections == true)) &&
+                        !inMainMenu)
+                        systemPrintf("Pushing %d bytes from %s topic to GNSS\r\n", mqttCount, topic);
+
                     gnssPushRawData(mqttData, mqttCount);
                     bytesPushed += mqttCount;
                 }
@@ -812,6 +833,11 @@ void mqttClientUpdate()
         localisedDistributionDictTopic = "";
         localisedDistributionTileTopic = "";
 
+        // Subscribe to AssistNow MGA if enabled
+        if (settings.useAssistNow)
+        {
+            mqttSubscribeTopics.push_back(MQTT_TOPIC_ASSISTNOW);
+        }
         // Subscribe to the key distribution topic
         mqttSubscribeTopics.push_back(String(settings.pointPerfectKeyDistributionTopic));
         // Subscribe to the continental correction topic for our region - if we have one. L-Band-only does not.

Firmware/RTK_Everywhere/menuPP.ino

@@ -975,6 +975,14 @@ void menuPointPerfect()
                 systemPrint(localisedDistributionTileLevelNames[settings.localisedDistributionTileLevel]);
                 systemPrintln(")");
             }
+            if (productVariant != RTK_FACET_MOSAIC)
+            {
+                systemPrint("a) Use AssistNow: ");
+                if (settings.useAssistNow == true)
+                    systemPrintln("Enabled");
+                else
+                    systemPrintln("Disabled");
+            }
 #endif  // COMPILE_NETWORK
 
             systemPrintln("c) Clear the Keys");
@@ -1018,6 +1026,10 @@ void menuPointPerfect()
             if (settings.localisedDistributionTileLevel >= LOCALISED_DISTRIBUTION_TILE_LEVELS)
                 settings.localisedDistributionTileLevel = 0;
         }
+        else if (incoming == 'a' && pointPerfectIsEnabled() && (productVariant != RTK_FACET_MOSAIC))
+        {
+            settings.useAssistNow ^= 1;
+        }
 #endif  // COMPILE_NETWORK
         else if (incoming == 'c' && pointPerfectIsEnabled())
         {

Firmware/RTK_Everywhere/settings.h

@@ -1372,6 +1372,7 @@ struct Settings
     // Localised distribution
     bool useLocalisedDistribution = false;
     uint8_t localisedDistributionTileLevel = 5;
+    bool useAssistNow = false;
 
     // Add new settings to appropriate group above or create new group
     // Then also add to the same group in rtkSettingsEntries below
@@ -1880,6 +1881,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
     // Localised distribution
     { 0, 1, 1, 0, 1, 1, 1, 1, _bool,     0, & settings.useLocalisedDistribution, "useLocalisedDistribution",  },
     { 0, 1, 1, 0, 1, 1, 1, 1, _uint8_t,  0, & settings.localisedDistributionTileLevel, "localisedDistributionTileLevel",  },
+    { 0, 1, 1, 0, 1, 1, 0, 1, _bool,     0, & settings.useAssistNow, "useAssistNow",  },
 
     // Add new settings to appropriate group above or create new group
     // Then also add to the same group in settings above