Merge pull request #527 from LeeLeahy2/wifi-comments

Change NTRIP to use network or NTRIP instead of WiFi

Author: nseidle

Firmware/RTK_Surveyor/NtripClient.ino

@@ -11,10 +11,10 @@ void ntripClientUpdate() {}
 
 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   NTRIP Client States:
-    NTRIP_CLIENT_OFF: WiFi off or using NTRIP server
+    NTRIP_CLIENT_OFF: Network off or using NTRIP server
     NTRIP_CLIENT_ON: WIFI_START state
-    NTRIP_CLIENT_WIFI_ETHERNET_STARTED: Connecting to WiFi access point or Ethernet network
-    NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED: WiFi connected to an access point or network
+    NTRIP_CLIENT_NETWORK_STARTED: Connecting to the network
+    NTRIP_CLIENT_NETWORK_CONNECTED: Connected to the network
     NTRIP_CLIENT_CONNECTING: Attempting a connection to the NTRIP caster
     NTRIP_CLIENT_CONNECTED: Connected to the NTRIP caster
 
@@ -26,11 +26,11 @@ void ntripClientUpdate() {}
                                        |                      |
                                        |                      | ntripClientStop(false)
                                        v                Fail  |
-                     NTRIP_CLIENT_WIFI_ETHERNET_STARTED ----->+
+                         NTRIP_CLIENT_NETWORK_STARTED ------->+
                                        |                      ^
                                        |                      |
                                        v                Fail  |
-                     NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED --->+
+                        NTRIP_CLIENT_NETWORK_CONNECTED ------>+
                                        |                      ^
                                        |                      |
                                        v                Fail  |
@@ -72,7 +72,7 @@ static const int NTRIPCLIENT_MS_BETWEEN_GGA = 5000; // 5s between transmission o
 // Locals - compiled out
 //----------------------------------------
 
-// The WiFi / Ethernet connection to the NTRIP caster to obtain RTCM data.
+// The network connection to the NTRIP caster to obtain RTCM data.
 static NetworkClient *ntripClient;
 
 // Throttle the time between connection attempts
@@ -174,7 +174,7 @@ bool ntripClientConnect()
 bool ntripClientConnectLimitReached()
 {
     // Shutdown the NTRIP client
-    ntripClientStop(false); // Allocate new wifiClient
+    ntripClientStop(false); // Allocate new ntripClient
 
     // Retry the connection a few times
     bool limitReached = (ntripClientConnectionAttempts >= MAX_NTRIP_CLIENT_CONNECTION_ATTEMPTS);
@@ -194,8 +194,8 @@ bool ntripClientConnectLimitReached()
         // No more connection attempts, switching to Bluetooth
         systemPrintln("NTRIP Client connection attempts exceeded!");
 
-        // Stop WiFi operations
-        ntripClientStop(true); // Do not allocate new wifiClient
+        // Stop NTRIP client operations
+        ntripClientStop(true); // Do not allocate new ntripClient
     }
     return limitReached;
 }
@@ -241,11 +241,11 @@ void ntripClientSetState(NTRIPClientState newState)
     case NTRIP_CLIENT_ON:
         systemPrintln("NTRIP_CLIENT_ON");
         break;
-    case NTRIP_CLIENT_WIFI_ETHERNET_STARTED:
-        systemPrintln("NTRIP_CLIENT_WIFI_ETHERNET_STARTED");
+    case NTRIP_CLIENT_NETWORK_STARTED:
+        systemPrintln("NTRIP_CLIENT_NETWORK_STARTED");
         break;
-    case NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED:
-        systemPrintln("NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED");
+    case NTRIP_CLIENT_NETWORK_CONNECTED:
+        systemPrintln("NTRIP_CLIENT_NETWORK_CONNECTED");
         break;
     case NTRIP_CLIENT_CONNECTING:
         systemPrintln("NTRIP_CLIENT_CONNECTING");
@@ -262,8 +262,8 @@ void ntripClientSetState(NTRIPClientState newState)
 
 void ntripClientStart()
 {
-    // Stop NTRIP client and WiFi
-    ntripClientStop(true); // Do not allocate new wifiClient
+    // Stop NTRIP client
+    ntripClientStop(true); // Do not allocate new ntripClient
 
     // Start the NTRIP client if enabled
     if (settings.enableNtripClient == true)
@@ -275,7 +275,7 @@ void ntripClientStart()
         // Allocate the ntripClient structure
         ntripClient = new NetworkClient(false);
 
-        // Startup WiFi and the NTRIP client
+        // Startup the network and the NTRIP client
         if (ntripClient)
             ntripClientSetState(NTRIP_CLIENT_ON);
     }
@@ -284,7 +284,7 @@ void ntripClientStart()
 }
 
 // Stop the NTRIP client
-void ntripClientStop(bool wifiClientAllocated)
+void ntripClientStop(bool clientAllocated)
 {
     if (ntripClient)
     {
@@ -297,11 +297,11 @@ void ntripClientStop(bool wifiClientAllocated)
         ntripClient = nullptr;
 
         // Allocate the ntripClient structure if not done
-        if (wifiClientAllocated == false)
+        if (clientAllocated == false)
             ntripClient = new NetworkClient(false);
     }
 
-    // Increase timeouts if we started WiFi
+    // Increase timeouts if we started the network
     if (ntripClientState > NTRIP_CLIENT_ON)
     {
         ntripClientLastConnectionAttempt =
@@ -318,7 +318,7 @@ void ntripClientStop(bool wifiClientAllocated)
     }
 
     // Determine the next NTRIP client state
-    ntripClientSetState((ntripClient && (wifiClientAllocated == false)) ? NTRIP_CLIENT_ON : NTRIP_CLIENT_OFF);
+    ntripClientSetState((ntripClient && (clientAllocated == false)) ? NTRIP_CLIENT_ON : NTRIP_CLIENT_OFF);
     online.ntripClient = false;
     netIncomingRTCM = false;
 }
@@ -330,12 +330,12 @@ bool ntripClientIsNeeded()
     {
         // If user turns off NTRIP Client via settings, stop server
         if (ntripClientState > NTRIP_CLIENT_OFF)
-            ntripClientStop(true); // Don't allocate new wifiClient
+            ntripClientStop(true); // Don't allocate new ntripClient
         return (false);
     }
 
     if (wifiInConfigMode())
-        return (false); // Do not service NTRIP during WiFi config
+        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
@@ -366,20 +366,20 @@ void ntripClientUpdate()
         lastNtripClientState = millis();
     }
 
-    // Enable WiFi and the NTRIP client if requested
+    // Enable the network and the NTRIP client if requested
     switch (ntripClientState)
     {
     case NTRIP_CLIENT_OFF:
         break;
 
-    // Start WiFi
+    // Start the network
     case NTRIP_CLIENT_ON: {
         if (HAS_ETHERNET) // && !settings.ntripClientUseWiFiNotEthernet) //For future expansion
         {
             if (online.ethernetStatus == ETH_NOT_STARTED)
             {
                 systemPrintln("Ethernet not started. Can not start NTRIP Client");
-                ntripClientStop(false); // Do allocate new WiFi / Ethernet Client
+                ntripClientStop(false); // Allocate a new ntripClient
             }
             else if ((online.ethernetStatus >= ETH_STARTED_CHECK_CABLE) && (online.ethernetStatus <= ETH_CONNECTED))
             {
@@ -389,21 +389,21 @@ void ntripClientUpdate()
                     ntripClientLastConnectionAttempt = millis();
                     log_d("NTRIP Client starting on Ethernet");
                     ntripClientTimer = millis();
-                    ntripClientSetState(NTRIP_CLIENT_WIFI_ETHERNET_STARTED);
+                    ntripClientSetState(NTRIP_CLIENT_NETWORK_STARTED);
                 }
             }
             else
             {
                 systemPrintln("Error: Please connect Ethernet before starting NTRIP Client");
-                ntripClientStop(true); // Do not allocate new wifiClient
+                ntripClientStop(true); // Do not allocate new ntripClient
             }
         }
         else
         {
             if (wifiNetworkCount() == 0)
             {
                 systemPrintln("Error: Please enter at least one SSID before starting NTRIP Client");
-                ntripClientStop(true); // Do not allocate new wifiClient
+                ntripClientStop(true); // Do not allocate new ntripClient
             }
             else
             {
@@ -414,30 +414,30 @@ void ntripClientUpdate()
                     log_d("NTRIP Client starting WiFi");
                     wifiStart();
                     ntripClientTimer = millis();
-                    ntripClientSetState(NTRIP_CLIENT_WIFI_ETHERNET_STARTED);
+                    ntripClientSetState(NTRIP_CLIENT_NETWORK_STARTED);
                 }
             }
         }
     }
     break;
 
-    case NTRIP_CLIENT_WIFI_ETHERNET_STARTED:
+    case NTRIP_CLIENT_NETWORK_STARTED:
         if ((millis() - ntripClientTimer) > (1 * 60 * 1000))
             // Failed to connect to to the network, attempt to restart the network
             ntripClientStop(false);
         else if (HAS_ETHERNET) // && !settings.ntripClientUseWiFiNotEthernet) //For future expansion
         {
             if (online.ethernetStatus == ETH_CONNECTED)
-                ntripClientSetState(NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED);
+                ntripClientSetState(NTRIP_CLIENT_NETWORK_CONNECTED);
         }
         else
         {
             if (wifiIsConnected())
-                ntripClientSetState(NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED);
+                ntripClientSetState(NTRIP_CLIENT_NETWORK_CONNECTED);
         }
         break;
 
-    case NTRIP_CLIENT_WIFI_ETHERNET_CONNECTED: {
+    case NTRIP_CLIENT_NETWORK_CONNECTED: {
         // If GGA transmission is enabled, wait for GNSS lock before connecting to NTRIP Caster
         // If GGA transmission is not enabled, start connecting to NTRIP Caster
         if ((settings.ntripClient_TransmitGGA == true && (fixType == 3 || fixType == 4 || fixType == 5)) ||
@@ -478,8 +478,8 @@ void ntripClientUpdate()
                 {
                     systemPrintln("NTRIP Caster failed to respond. Do you have your caster address and port correct?");
 
-                    // Stop WiFi operations
-                    ntripClientStop(true); // Do not allocate new wifiClient
+                    // Stop NTRIP client operations
+                    ntripClientStop(true); // Do not allocate new ntripClient
                 }
                 else
                 {
@@ -541,25 +541,25 @@ void ntripClientUpdate()
                     "NTRIP Caster responded with bad news: %s. Are you sure your caster credentials are correct?\r\n",
                     response);
 
-                // Stop WiFi operations
-                ntripClientStop(true); // Do not allocate new wifiClient
+                // Stop NTRIP client operations
+                ntripClientStop(true); // Do not allocate new ntripClient
             }
             else if (strstr(response, "banned") != nullptr)
             {
                 // Look for 'HTTP/1.1 200 OK' and banned IP information
                 systemPrintf("NTRIP Client connected to caster but caster responded with problem: %s\r\n", response);
 
-                // Stop WiFi operations
-                ntripClientStop(true); // Do not allocate new wifiClient
+                // Stop NTRIP client operations
+                ntripClientStop(true); // Do not allocate new ntripClient
             }
             else if (strstr(response, "SOURCETABLE") != nullptr)
             {
                 // Look for 'SOURCETABLE 200 OK'
                 systemPrintf("Caster may not have mountpoint %s. Caster responded with problem: %s\r\n",
                              settings.ntripClient_MountPoint, response);
 
-                // Stop WiFi operations
-                ntripClientStop(true); // Do not allocate new wifiClient
+                // Stop NTRIP client operations
+                ntripClientStop(true); // Do not allocate new ntripClient
             }
             // Other errors returned by the caster
             else
@@ -590,7 +590,7 @@ void ntripClientUpdate()
         {
             // Broken connection, retry the NTRIP client connection
             systemPrintln("NTRIP Client connection to caster was broken");
-            ntripClientStop(false); // Allocate new wifiClient
+            ntripClientStop(false); // Allocate new ntripClient
         }
         else
         {
@@ -601,7 +601,7 @@ void ntripClientUpdate()
                 {
                     // Timeout receiving NTRIP data, retry the NTRIP client connection
                     systemPrintln("NTRIP Client: No data received timeout");
-                    ntripClientStop(false); // Allocate new wifiClient
+                    ntripClientStop(false); // Allocate new ntripClient
                 }
             }
             else