Network clients start and stop depending upon operating modes

Define the RTK operating modes and set these modes in States.ino.

For each network user:
* Add a bit mask specifying which modes the network user is active
* Stop the network user when the enable or mode changes
* Start the network user when the mode and enable are set

Author: LeeLeahy2

Firmware/RTK_Surveyor/Developer.ino

@@ -50,10 +50,6 @@ void networkVerifyTables() {}
 //----------------------------------------
 
 void ntripClientPrintStatus() {systemPrint("NTRIP Client not compiled");}
-void ntripClientStart()
-{
-    systemPrintln("NTRIP Client not available: Ethernet and WiFi not compiled");
-}
 void ntripClientStop(bool clientAllocated) {online.ntripClient = false;}
 void ntripClientUpdate() {}
 void ntripClientValidateTables() {}
@@ -65,10 +61,6 @@ void ntripClientValidateTables() {}
 bool ntripServerIsCasting() {return false;}
 void ntripServerPrintStatus() {systemPrint("NTRIP Server not compiled");}
 void ntripServerProcessRTCM(uint8_t incoming) {}
-void ntripServerStart()
-{
-    systemPrintln("NTRIP Server not available: Ethernet and WiFi not compiled");
-}
 void ntripServerStop(bool clientAllocated) {online.ntripServer = false;}
 void ntripServerUpdate() {}
 void ntripServerValidateTables() {}

Firmware/RTK_Surveyor/NTP.ino

@@ -75,6 +75,8 @@ const char * const ntpServerStateName[] =
 };
 const int ntpServerStateNameEntries = sizeof(ntpServerStateName) / sizeof(ntpServerStateName[0]);
 
+const RtkMode_t ntpServerMode = RTK_MODE_NTP;
+
 //----------------------------------------
 // Locals
 //----------------------------------------
@@ -762,17 +764,6 @@ bool configureUbloxModuleNTP()
 // NTP Server routines
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
-// Stop the NTP server
-void ntpServerEnd()
-{
-}
-
-// Determine if the NTP server is enabled
-bool ntpServerIsEnabled()
-{
-    return (systemState >= STATE_NTPSERVER_NOT_STARTED) && (systemState <= STATE_NTPSERVER_SYNC);
-}
-
 // Update the state of the NTP server state machine
 void ntpServerSetState(uint8_t newState)
 {
@@ -830,6 +821,14 @@ void ntpServerUpdate()
     if (!HAS_ETHERNET)
         return;
 
+    // Shutdown the NTP server when the mode or setting changes
+    if (NEQ_RTK_MODE(ntpServerMode))
+    {
+        if (ntpServerState > NTP_STATE_OFF)
+            ntpServerStop();
+        return;
+    }
+
     // Process the NTP state
     DMW_st(ntpServerSetState, ntpServerState);
     switch (ntpServerState)
@@ -839,7 +838,7 @@ void ntpServerUpdate()
 
     case NTP_STATE_OFF:
         // Determine if the NTP server is enabled
-        if (ntpServerIsEnabled())
+        if (EQ_RTK_MODE(ntpServerMode))
         {
             // Start the network
             if (networkUserOpen(NETWORK_USER_NTP_SERVER, NETWORK_TYPE_ETHERNET))
@@ -850,7 +849,7 @@ void ntpServerUpdate()
     // Wait for the network conection
     case NTP_STATE_NETWORK_STARTING:
         // Determine if the network has failed
-        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER) || (!ntpServerIsEnabled()))
+        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER))
             // Stop the NTP server, restart it if possible
             ntpServerStop();
 
@@ -861,7 +860,7 @@ void ntpServerUpdate()
 
     case NTP_STATE_NETWORK_CONNECTED:
         // Determine if the network has failed
-        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER) || (!ntpServerIsEnabled()))
+        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER))
             // Stop the NTP server, restart it if possible
             ntpServerStop();
 
@@ -889,7 +888,7 @@ void ntpServerUpdate()
 
     case NTP_STATE_SERVER_RUNNING:
         // Determine if the network has failed
-        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER) || (!ntpServerIsEnabled()))
+        if (networkIsShuttingDown(NETWORK_USER_NTP_SERVER))
             // Stop the NTP server, restart it if possible
             ntpServerStop();
 

Firmware/RTK_Surveyor/Network.ino

@@ -1160,17 +1160,14 @@ void networkUpdate()
     if (PERIODIC_DISPLAY(PD_NETWORK_STATE))
         PERIODIC_CLEAR(PD_NETWORK_STATE);
 
-    // Skip updates if in configure-via-ethernet mode
-    if (!configureViaEthernet)
-    {
-        ntpServerUpdate();   // Process any received NTP requests
-        ntripClientUpdate(); // Check the NTRIP client connection and move data NTRIP --> ZED
-        ntripServerUpdate(); // Check the NTRIP server connection and move data ZED --> NTRIP
-        otaClientUpdate();   // Perform automatic over-the-air firmware updates
-        pvtClientUpdate();   // Turn on the PVT client as needed
-        pvtServerUpdate();   // Turn on the PVT server as needed
-        pvtUdpServerUpdate();   // Turn on the PVT UDP server as needed
-    }
+    // Update the network services
+    ntpServerUpdate();   // Process any received NTP requests
+    ntripClientUpdate(); // Check the NTRIP client connection and move data NTRIP --> ZED
+    ntripServerUpdate(); // Check the NTRIP server connection and move data ZED --> NTRIP
+    otaClientUpdate();   // Perform automatic over-the-air firmware updates
+    pvtClientUpdate();   // Turn on the PVT client as needed
+    pvtServerUpdate();   // Turn on the PVT server as needed
+    pvtUdpServerUpdate();   // Turn on the PVT UDP server as needed
 
     // Display the IP addresses
     networkPeriodicallyDisplayIpAddress();

Firmware/RTK_Surveyor/NtripClient.ino

@@ -175,6 +175,9 @@ const char * const ntripClientStateName[] =
 
 const int ntripClientStateNameEntries = sizeof(ntripClientStateName) / sizeof(ntripClientStateName[0]);
 
+const RtkMode_t ntripClientMode = RTK_MODE_ROVER
+                                | RTK_MODE_BASE_SURVEY_IN;
+
 //----------------------------------------
 // Locals
 //----------------------------------------
@@ -307,6 +310,10 @@ bool ntripClientConnectLimitReached()
     // Retry the connection a few times
     bool limitReached = (ntripClientConnectionAttempts >= MAX_NTRIP_CLIENT_CONNECTION_ATTEMPTS);
 
+    // Attempt to restart the network if possible
+    if (settings.enableNtripClient && (!limitReached))
+        networkRestart(NETWORK_USER_NTRIP_CLIENT);
+
     // Restart the NTRIP client
     ntripClientStop(limitReached || (!settings.enableNtripClient));
 
@@ -345,28 +352,6 @@ bool ntripClientConnectLimitReached()
     return limitReached;
 }
 
-// Determine if NTRIP Client is needed
-bool ntripClientIsNeeded()
-{
-    if (settings.enableNtripClient == false)
-    {
-        // If user turns off NTRIP Client via settings, stop server
-        if (ntripClientState > NTRIP_CLIENT_OFF)
-            ntripClientShutdown();
-        return (false);
-    }
-
-    if (wifiInConfigMode())
-        return (false); // Do not service NTRIP during network config
-
-    // Allow NTRIP Client to run during Survey-In,
-    // but do not allow NTRIP Client to run during Base
-    if (systemState == STATE_BASE_TEMP_TRANSMITTING)
-        return (false);
-
-    return (true);
-}
-
 // Print the NTRIP client state summary
 void ntripClientPrintStateSummary()
 {
@@ -504,20 +489,12 @@ void ntripClientShutdown()
 // Start the NTRIP client
 void ntripClientStart()
 {
-    // Stop NTRIP client
-    ntripClientShutdown();
-
     // Display the heap state
     reportHeapNow(settings.debugNtripClientState);
 
-    // Start the NTRIP client if enabled
-    if (settings.enableNtripClient == true)
-    {
-        systemPrintln("NTRIP Client start");
-        ntripClientSetState(NTRIP_CLIENT_ON);
-    }
-
-    ntripClientConnectionAttempts = 0;
+    // Start the NTRIP client
+    systemPrintln("NTRIP Client start");
+    ntripClientStop(false);
 }
 
 // Shutdown or restart the NTRIP client
@@ -529,14 +506,6 @@ void ntripClientStop(bool shutdown)
         if (ntripClient->connected())
             ntripClient->stop();
 
-        // Attempt to restart the network if possible
-        if (!shutdown)
-            networkRestart(NETWORK_USER_NTRIP_CLIENT);
-
-        // Done with the network
-        if (networkGetUserNetwork(NETWORK_USER_NTRIP_CLIENT))
-            networkUserClose(NETWORK_USER_NTRIP_CLIENT);
-
         // Free the NTRIP client resources
         delete ntripClient;
         ntripClient = nullptr;
@@ -545,9 +514,15 @@ void ntripClientStop(bool shutdown)
 
     // Increase timeouts if we started the network
     if (ntripClientState > NTRIP_CLIENT_ON)
+    {
         // Mark the Client stop so that we don't immediately attempt re-connect to Caster
         ntripClientTimer = millis();
 
+        // Done with the network
+        if (networkGetUserNetwork(NETWORK_USER_NTRIP_CLIENT))
+            networkUserClose(NETWORK_USER_NTRIP_CLIENT);
+    }
+
     // Return the Main Talker ID to "GN".
     if (online.gnss)
     {
@@ -556,23 +531,42 @@ void ntripClientStop(bool shutdown)
     }
 
     // Determine the next NTRIP client state
-    ntripClientSetState(shutdown ? NTRIP_CLIENT_OFF : NTRIP_CLIENT_ON);
     online.ntripClient = false;
     netIncomingRTCM = false;
+    if (shutdown)
+    {
+        ntripClientSetState(NTRIP_CLIENT_OFF);
+        settings.enableNtripClient = false;
+        ntripClientConnectionAttempts = 0;
+        ntripClientConnectionAttemptTimeout = 0;
+    }
+    else
+        ntripClientSetState(NTRIP_CLIENT_ON);
 }
 
 // Check for the arrival of any correction data. Push it to the GNSS.
 // Stop task if the connection has dropped or if we receive no data for maxTimeBeforeHangup_ms
 void ntripClientUpdate()
 {
-    if (ntripClientIsNeeded() == false)
-        return;
+    // Shutdown the NTRIP client when the mode or setting changes
+    DMW_st(ntripClientSetState, ntripClientState);
+    if (NEQ_RTK_MODE(ntripClientMode) || (!settings.enableNtripClient))
+    {
+        if (ntripClientState > NTRIP_CLIENT_OFF)
+        {
+            ntripClientStop(false);
+            ntripClientConnectionAttempts = 0;
+            ntripClientConnectionAttemptTimeout = 0;
+            ntripClientSetState(NTRIP_CLIENT_OFF);
+        }
+    }
 
     // Enable the network and the NTRIP client if requested
-    DMW_st(ntripClientSetState, ntripClientState);
     switch (ntripClientState)
     {
     case NTRIP_CLIENT_OFF:
+        if (EQ_RTK_MODE(ntripClientMode) && settings.enableNtripClient)
+            ntripClientStart();
         break;
 
     // Start the network