Add NTRIP_SERVER_DATA structure

Author: LeeLeahy2

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -60,6 +60,28 @@
 //    the minor firmware version
 #define RTK_IDENTIFIER (FIRMWARE_VERSION_MAJOR * 0x10 + FIRMWARE_VERSION_MINOR)
 
+#ifdef COMPILE_ETHERNET
+#include <Ethernet.h> // http://librarymanager/All#Arduino_Ethernet
+#include "SparkFun_WebServer_ESP32_W5500.h" //http://librarymanager/All#SparkFun_WebServer_ESP32_W5500 v1.5.5
+#endif // COMPILE_ETHERNET
+
+#ifdef COMPILE_WIFI
+#include "ESP32OTAPull.h" //http://librarymanager/All#ESP-OTA-Pull Used for getting
+#include "esp_wifi.h" //Needed for esp_wifi_set_protocol()
+#include <DNSServer.h>        //Built-in.
+#include <ESPmDNS.h>      //Built-in.
+#include <HTTPClient.h>   //Built-in. Needed for ThingStream API for ZTP
+#include <PubSubClient.h> //http://librarymanager/All#PubSubClient_MQTT_Lightweight by Nick O'Leary v2.8.0 Used for MQTT obtaining of keys
+#include <WiFi.h>             //Built-in.
+#include <WiFiClientSecure.h> //Built-in.
+#include <WiFiMulti.h>        //Built-in.
+#endif // COMPILE_WIFI
+
+#if COMPILE_NETWORK
+#include <SSLClientESP32.h> // http://librarymanager/All#SSLClientESP32
+#include "X509_Certificate_Bundle.h" // Root certificates
+#endif // COMPILE_NETWORK
+
 #include "settings.h"
 
 #define MAX_CPU_CORES 2
@@ -200,10 +222,6 @@ char logFileName[sizeof("SFE_Reference_Station_230101_120101.ubx_plusExtraSpace"
 // Over-the-Air (OTA) update support
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
-#if COMPILE_NETWORK
-#include <SSLClientESP32.h> // http://librarymanager/All#SSLClientESP32
-#include "X509_Certificate_Bundle.h" // Root certificates
-#endif // COMPILE_NETWORK
 #include <ArduinoJson.h>  //http://librarymanager/All#Arduino_JSON_messagepack v6.19.4
 
 #include "esp_ota_ops.h" //Needed for partition counting and updateFromSD
@@ -216,7 +234,6 @@ char logFileName[sizeof("SFE_Reference_Station_230101_120101.ubx_plusExtraSpace"
     }
 
 #ifdef COMPILE_WIFI
-#include "ESP32OTAPull.h" //http://librarymanager/All#ESP-OTA-Pull Used for getting
 
 #define WIFI_STOP()                                                         \
 {                                                                           \
@@ -237,19 +254,6 @@ unsigned int binBytesSent = 0;         // Tracks firmware bytes sent over WiFi O
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 // Connection settings to NTRIP Caster
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-#ifdef COMPILE_WIFI
-#include <ESPmDNS.h>      //Built-in.
-#include <HTTPClient.h>   //Built-in. Needed for ThingStream API for ZTP
-#include <PubSubClient.h> //http://librarymanager/All#PubSubClient_MQTT_Lightweight by Nick O'Leary v2.8.0 Used for MQTT obtaining of keys
-#include <WiFi.h>             //Built-in.
-#include <WiFiClientSecure.h> //Built-in.
-#include <WiFiMulti.h>        //Built-in.
-#include <DNSServer.h>        //Built-in.
-
-#include "esp_wifi.h" //Needed for esp_wifi_set_protocol()
-
-#endif  // COMPILE_WIFI
-
 #include "base64.h" //Built-in. Needed for NTRIP Client credential encoding.
 
 bool enableRCFirmware = false;                // Goes true from AP config page
@@ -574,7 +578,6 @@ const uint8_t ESPNOW_MAX_PEERS = 5; // Maximum of 5 rovers
 // Ethernet
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 #ifdef COMPILE_ETHERNET
-#include <Ethernet.h> // http://librarymanager/All#Arduino_Ethernet
 IPAddress ethernetIPAddress;
 IPAddress ethernetDNS;
 IPAddress ethernetGateway;
@@ -591,15 +594,11 @@ class derivedEthernetUDP : public EthernetUDP
 volatile struct timeval ethernetNtpTv; // This will hold the time the Ethernet NTP packet arrived
 bool ntpLogIncreasing;
 
-#include "SparkFun_WebServer_ESP32_W5500.h" //http://librarymanager/All#SparkFun_WebServer_ESP32_W5500 v1.5.5
 #endif  // COMPILE_ETHERNET
 
 unsigned long lastEthernetCheck = 0; // Prevents cable checking from continually happening
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
-#include "NetworkClient.h" //Supports both WiFiClient and EthernetClient
-#include "NetworkUDP.h" //Supports both WiFiUdp and EthernetUdp
-
 // Global variables
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 #define lbandMACAddress btMACAddress

Firmware/RTK_Surveyor/settings.h

@@ -1,3 +1,6 @@
+#ifndef __SETTINGS_H__
+#define __SETTINGS_H__
+
 // System can enter a variety of states
 // See statemachine diagram at:
 // https://lucid.app/lucidchart/53519501-9fa5-4352-aa40-673f88ca0c9b/edit?invitationId=inv_ebd4b988-513d-4169-93fd-c291851108f8
@@ -274,6 +277,35 @@ enum WiFiState
 };
 volatile byte wifiState = WIFI_STATE_OFF;
 
+#include "NetworkClient.h" // Built-in - Supports both WiFiClient and EthernetClient
+#include "NetworkUDP.h"    //Built-in - Supports both WiFiUdp and EthernetUdp
+
+// NTRIP Server data
+typedef struct _NTRIP_SERVER_DATA
+{
+    // Network connection used to push RTCM to NTRIP caster
+    NetworkClient *networkClient;
+    volatile uint8_t state;
+
+    // Count of bytes sent by the NTRIP server to the NTRIP caster
+    uint32_t bytesSent;
+
+    // Throttle the time between connection attempts
+    // ms - Max of 4,294,967,295 or 4.3M seconds or 71,000 minutes or 1193 hours or 49 days between attempts
+    uint32_t connectionAttemptTimeout;
+    uint32_t lastConnectionAttempt;
+    int connectionAttempts; // Count the number of connection attempts between restarts
+
+    // NTRIP server timer usage:
+    //  * Reconnection delay
+    //  * Measure the connection response time
+    //  * Receive RTCM correction data timeout
+    //  * Monitor last RTCM byte received for frame counting
+    uint32_t timer;
+    uint32_t startTime;
+    int connectionAttemptsTotal; // Count the number of connection attempts absolutely
+} NTRIP_SERVER_DATA;
+
 typedef enum
 {
     ESPNOW_OFF,
@@ -1177,3 +1209,4 @@ rqXRfboQnoZsG4q5WTP468SQvvG5
 )=====";
 #endif // COMPILE_L_BAND
 #endif // COMPILE_WIFI
+#endif // __SETTINGS_H__