Work in progress - needs the ability to wait on Ethernet before attempting provisioning

Author: PaulZC

Firmware/RTK_Everywhere/Display.ino

@@ -404,17 +404,6 @@ void displayUpdate()
             case (STATE_KEYS_NEEDED):
                 // Do nothing. Quick, fall through state.
                 break;
-            case (STATE_KEYS_WIFI_STARTED):
-                setWiFiIcon(&iconPropertyList); // Blink WiFi in center
-                paintGettingKeys();
-                break;
-            case (STATE_KEYS_WIFI_CONNECTED):
-                setWiFiIcon(&iconPropertyList); // Blink WiFi in center
-                paintGettingKeys();
-                break;
-            case (STATE_KEYS_WIFI_TIMEOUT):
-                // Do nothing. Quick, fall through state.
-                break;
             case (STATE_KEYS_EXPIRED):
                 // Do nothing. Quick, fall through state.
                 break;
@@ -431,9 +420,11 @@ void displayUpdate()
                 setWiFiIcon(&iconPropertyList); // Blink WiFi in center
                 paintGettingKeys();
                 break;
-            case (STATE_KEYS_PROVISION_CONNECTED):
+            case (STATE_KEYS_PROVISION_SUCCESS):
+                setWiFiIcon(&iconPropertyList); // Blink WiFi in center
+                break;
+            case (STATE_KEYS_PROVISION_FAIL):
                 setWiFiIcon(&iconPropertyList); // Blink WiFi in center
-                paintGettingKeys();
                 break;
 
             case (STATE_ESPNOW_PAIRING_NOT_STARTED):
@@ -2724,12 +2715,12 @@ void paintKeyDaysRemaining(int daysRemaining, uint16_t displayTime)
     }
 }
 
-void paintKeyWiFiFail(uint16_t displayTime)
+void paintKeyUpdateFail(uint16_t displayTime)
 {
     // PP
     // Update
     // Failed
-    // No WiFi
+    // No Network
 
     if (online.display == true)
     {
@@ -2749,7 +2740,7 @@ void paintKeyWiFiFail(uint16_t displayTime)
         printTextCenter("Failed", y, QW_FONT_8X16, 1, false); // text, y, font type, kerning, inverted
 
         y += fontHeight + 1;
-        printTextCenter("No WiFi", y, QW_FONT_5X7, 1, false); // text, y, font type, kerning, inverted
+        printTextCenter("No Network", y, QW_FONT_5X7, 1, false); // text, y, font type, kerning, inverted
 
         oled->display();
 

Firmware/RTK_Everywhere/MQTT_Client.ino

@@ -78,6 +78,7 @@ enum MQTTClientState
 {
     MQTT_CLIENT_OFF = 0,             // Using Bluetooth or NTRIP server
     MQTT_CLIENT_ON,                  // WIFI_STATE_START state
+    MQTT_CLIENT_CHECK_CERTS,         // Check certs are available - with timeout
     MQTT_CLIENT_NETWORK_STARTED,     // Connecting to WiFi access point or Ethernet
     MQTT_CLIENT_CONNECTING_2_SERVER, // Connecting to the MQTT server
     MQTT_CLIENT_SUBSCRIBE_KEY,       // Subscribe to the MQTT_TOPIC_KEY
@@ -91,6 +92,7 @@ enum MQTTClientState
 const char *const mqttClientStateName[] = {
     "MQTT_CLIENT_OFF",
     "MQTT_CLIENT_ON",
+    "MQTT_CLIENT_CHECK_CERTS",
     "MQTT_CLIENT_NETWORK_STARTED",
     "MQTT_CLIENT_CONNECTING_2_SERVER",
     "MQTT_CLIENT_SUBSCRIBE_KEY",
@@ -206,6 +208,7 @@ void mqttClientPrintStateSummary()
         break;
 
     case MQTT_CLIENT_ON:
+    case MQTT_CLIENT_CHECK_CERTS:
     case MQTT_CLIENT_NETWORK_STARTED:
         systemPrint("Disconnected");
         break;
@@ -529,6 +532,20 @@ void mqttClientUpdate()
         break;
     }
 
+    // Check for certs, wait for them to be available
+    case MQTT_CLIENT_CHECK_CERTS: {
+        // Determine if the network has failed
+        if (networkIsShuttingDown(NETWORK_USER_MQTT_CLIENT))
+            // Failed to connect to the network, attempt to restart the network
+            mqttClientStop(true); // Was mqttClientRestart(); - #StopVsRestart
+
+        // Determine if certs are available
+        else if (checkCertificates())
+            // The network is available for the MQTT client
+            mqttClientSetState(MQTT_CLIENT_NETWORK_STARTED);
+        break;
+    }
+
     // Wait for a network media connection
     case MQTT_CLIENT_NETWORK_STARTED: {
         // Determine if the network has failed

Firmware/RTK_Everywhere/States.ino

@@ -509,31 +509,29 @@ void stateUpdate()
             // We want an immediate change from this state
             forceSystemStateUpdate = true; // Immediately go to this new state
 
+            uint8_t networkType = networkGetActiveType();
+
             // If user has turned off PointPerfect, skip everything
             if (!settings.enablePointPerfectCorrections)
             {
                 changeState(settings.lastState); // Go to either rover or base
             }
 
-            // If there is no WiFi setup, and no keys, skip everything
-            else if (wifiNetworkCount() == 0 && strlen(settings.pointPerfectCurrentKey) == 0)
+            // If on WiFi and there are no WiFi SSIDs available, skip everything
+            // (Some duplication in pointPerfectProvisionOrUpdate)
+            else if ((networkType == NETWORK_TYPE_WIFI) && (wifiNetworkCount() == 0))
             {
                 displayNoSSIDs(2000);
                 changeState(settings.lastState); // Go to either rover or base
             }
 
-            // If we don't have keys, begin zero touch provisioning
-            else if (strlen(settings.pointPerfectCurrentKey) == 0 || strlen(settings.pointPerfectNextKey) == 0)
+            // If we don't have certs or keys, begin zero touch provisioning
+            else if (!checkCertificates() || strlen(settings.pointPerfectCurrentKey) == 0 || strlen(settings.pointPerfectNextKey) == 0)
             {
                 if (settings.debugPpCertificate)
-                    systemPrintln("PointPerfect Keys starting WiFi");
-
-                // Temporarily limit WiFi connection attempts
-                wifiOriginalMaxConnectionAttempts = wifiMaxConnectionAttempts;
-                wifiMaxConnectionAttempts = 0; // Override setting during key retrieval. Give up after single failure.
+                    systemPrintln("PointPerfect starting provisioning");
 
-                wifiStart();
-                changeState(STATE_KEYS_PROVISION_STARTED);
+                changeState(STATE_KEYS_NEEDED);
             }
 
             // Determine if we have valid date/time RTC from last boot
@@ -566,17 +564,14 @@ void stateUpdate()
         case (STATE_KEYS_NEEDED): {
             forceSystemStateUpdate = true; // Immediately go to this new state
 
+            uint8_t networkType = networkGetActiveType();
+
             if (online.rtc == false)
             {
                 if (settings.debugPpCertificate)
-                    systemPrintln("Keys Needed. RTC offline. Starting WiFi");
-
-                // Temporarily limit WiFi connection attempts
-                wifiOriginalMaxConnectionAttempts = wifiMaxConnectionAttempts;
-                wifiMaxConnectionAttempts = 0; // Override setting during key retrieval. Give up after single failure.
+                    systemPrintln("Keys Needed. RTC offline. Starting provisioning or update");
 
-                wifiStart();
-                changeState(STATE_KEYS_WIFI_STARTED); // If we can't check the RTC, continue
+                changeState(STATE_KEYS_PROVISION_STARTED); // If we can't check the RTC, continue
             }
 
             // When did we last try to get keys? Attempt every 24 hours
@@ -586,19 +581,14 @@ void stateUpdate()
                 recordSystemSettings();                   // Record these settings to unit
 
                 if (settings.debugPpCertificate)
-                    systemPrintln("Keys Needed. Starting WiFi");
+                    systemPrintln("Keys Needed. Starting provisioning or update");
 
-                // Temporarily limit WiFi connection attempts
-                wifiOriginalMaxConnectionAttempts = wifiMaxConnectionAttempts;
-                wifiMaxConnectionAttempts = 0; // Override setting during key retrieval. Give up after single failure.
-
-                wifiStart(); // Starts WiFi state machine
-                changeState(STATE_KEYS_WIFI_STARTED);
+                changeState(STATE_KEYS_PROVISION_STARTED);
             }
 
             // Added to display error if user selects GetKeys from the display
             // Normally, this would be caught during STATE_KEYS_STARTED
-            else if (wifiNetworkCount() == 0)
+            else if ((networkType == NETWORK_TYPE_WIFI) && (wifiNetworkCount() == 0))
             {
                 displayNoSSIDs(1000);
                 changeState(
@@ -614,13 +604,7 @@ void stateUpdate()
                 if (settings.debugPpCertificate)
                     systemPrintln("Force key update. Starting WiFi");
 
-                // Temporarily limit WiFi connection attempts
-                wifiOriginalMaxConnectionAttempts = wifiMaxConnectionAttempts;
-                wifiMaxConnectionAttempts = 0; // Override setting during key retrieval. Give up after single failure.
-
-                wifiStart(); // Starts WiFi state machine
-
-                changeState(STATE_KEYS_WIFI_STARTED);
+                changeState(STATE_KEYS_PROVISION_STARTED);
             }
 
             else
@@ -634,75 +618,6 @@ void stateUpdate()
         }
         break;
 
-        case (STATE_KEYS_WIFI_STARTED): {
-            wifiMaxConnectionAttempts = wifiOriginalMaxConnectionAttempts; // Revert setting
-
-            if (wifiIsConnected())
-                changeState(STATE_KEYS_WIFI_CONNECTED);
-            else
-            {
-                wifiShutdown(); // Turn off WiFi
-
-                changeState(STATE_KEYS_WIFI_TIMEOUT);
-            }
-        }
-        break;
-
-        case (STATE_KEYS_WIFI_CONNECTED): {
-
-            // Check that the certs are valid
-            if (checkCertificates() == true)
-            {
-                // Update the keys
-                if (pointperfectUpdateKeys() == true) // Connect to ThingStream MQTT and get PointPerfect key UBX packet
-                    displayKeysUpdated();
-            }
-            else
-            {
-                // Erase keys
-                erasePointperfectCredentials();
-
-                // Provision device
-                if (pointperfectProvisionDevice() == true) // Connect to ThingStream API and get keys
-                    displayKeysUpdated();
-            }
-
-            wifiShutdown();                // Turn off WiFi
-            forceSystemStateUpdate = true; // Imediately go to this new state
-            changeState(STATE_KEYS_DAYS_REMAINING);
-        }
-        break;
-
-        case (STATE_KEYS_WIFI_TIMEOUT): {
-            paintKeyWiFiFail(2000);
-
-            forceSystemStateUpdate = true; // Imediately go to this new state
-
-            if (online.rtc == true)
-            {
-                int daysRemaining =
-                    daysFromEpoch(settings.pointPerfectNextKeyStart + settings.pointPerfectNextKeyDuration + 1);
-
-                if (daysRemaining >= 0)
-                {
-                    changeState(STATE_KEYS_DAYS_REMAINING);
-                }
-                else
-                {
-                    paintKeysExpired();
-                    changeState(STATE_KEYS_LBAND_ENCRYPTED);
-                }
-            }
-            else
-            {
-                // No WiFi. No RTC. We don't know if the keys we have are expired. Attempt to use them.
-                changeState(STATE_KEYS_LBAND_CONFIGURE);
-            }
-        }
-        break;
-
-            // Note: STATE_KEYS_EXPIRED should be here, but isn't. TODO: check this
-
         case (STATE_KEYS_DAYS_REMAINING): {
             if (online.rtc == true)
             {
@@ -749,30 +664,44 @@ void stateUpdate()
         break;
 
         case (STATE_KEYS_PROVISION_STARTED): {
-            if (wifiIsConnected())
-                changeState(STATE_KEYS_PROVISION_CONNECTED);
+            if (pointPerfectProvisionOrUpdate(false))
+                changeState(STATE_KEYS_PROVISION_SUCCESS);
             else
-            {
-                wifiShutdown(); // Turn off WiFi
-                changeState(STATE_KEYS_WIFI_TIMEOUT);
-            }
+                changeState(STATE_KEYS_PROVISION_FAIL);
         }
         break;
 
-        case (STATE_KEYS_PROVISION_CONNECTED): {
+        case (STATE_KEYS_PROVISION_SUCCESS): {
             forceSystemStateUpdate = true; // Imediately go to this new state
 
-            if (pointperfectProvisionDevice() == true)
+            //displayKeysUpdated();
+            changeState(STATE_KEYS_DAYS_REMAINING);
+        }
+        break;
+
+        case (STATE_KEYS_PROVISION_FAIL): {
+            forceSystemStateUpdate = true; // Imediately go to this new state
+
+            if (online.rtc == true)
             {
-                displayKeysUpdated();
-                changeState(STATE_KEYS_DAYS_REMAINING);
+                int daysRemaining =
+                    daysFromEpoch(settings.pointPerfectNextKeyStart + settings.pointPerfectNextKeyDuration + 1);
+
+                if (daysRemaining >= 0)
+                {
+                    changeState(STATE_KEYS_DAYS_REMAINING);
+                }
+                else
+                {
+                    paintKeysExpired();
+                    changeState(STATE_KEYS_LBAND_ENCRYPTED);
+                }
             }
             else
             {
-                paintKeyProvisionFail(10000); // Device not whitelisted. Show device ID.
-                changeState(STATE_KEYS_LBAND_ENCRYPTED);
+                // No RTC. We don't know if the keys we have are expired. Attempt to use them.
+                changeState(STATE_KEYS_LBAND_CONFIGURE);
             }
-            wifiShutdown(); // Turn off WiFi
         }
         break;
 
@@ -1038,12 +967,6 @@ const char *getState(SystemState state, char *buffer)
         return "STATE_KEYS_STARTED";
     case (STATE_KEYS_NEEDED):
         return "STATE_KEYS_NEEDED";
-    case (STATE_KEYS_WIFI_STARTED):
-        return "STATE_KEYS_WIFI_STARTED";
-    case (STATE_KEYS_WIFI_CONNECTED):
-        return "STATE_KEYS_WIFI_CONNECTED";
-    case (STATE_KEYS_WIFI_TIMEOUT):
-        return "STATE_KEYS_WIFI_TIMEOUT";
     case (STATE_KEYS_EXPIRED):
         return "STATE_KEYS_EXPIRED";
     case (STATE_KEYS_DAYS_REMAINING):
@@ -1054,8 +977,10 @@ const char *getState(SystemState state, char *buffer)
         return "STATE_KEYS_LBAND_ENCRYPTED";
     case (STATE_KEYS_PROVISION_STARTED):
         return "STATE_KEYS_PROVISION_STARTED";
-    case (STATE_KEYS_PROVISION_CONNECTED):
-        return "STATE_KEYS_PROVISION_CONNECTED";
+    case (STATE_KEYS_PROVISION_SUCCESS):
+        return "STATE_KEYS_PROVISION_SUCCESS";
+    case (STATE_KEYS_PROVISION_FAIL):
+        return "STATE_KEYS_PROVISION_FAIL";
 #endif // COMPILE_L_BAND
 
     case (STATE_ESPNOW_PAIRING_NOT_STARTED):
@@ -1155,7 +1080,7 @@ const RTK_MODE_ENTRY stateModeTable[] = {
     {"Rover", STATE_ROVER_NOT_STARTED, STATE_ROVER_RTK_FIX},
     {"Base", STATE_BASE_NOT_STARTED, STATE_BASE_FIXED_TRANSMITTING},
     {"Setup", STATE_DISPLAY_SETUP, STATE_PROFILE},
-    {"Key Provisioning", STATE_KEYS_STARTED, STATE_KEYS_PROVISION_CONNECTED},
+    {"Key Provisioning", STATE_KEYS_STARTED, STATE_KEYS_PROVISION_FAIL},
     {"ESPNOW Pairing", STATE_ESPNOW_PAIRING_NOT_STARTED, STATE_ESPNOW_PAIRING},
     {"NTP", STATE_NTPSERVER_NOT_STARTED, STATE_NTPSERVER_SYNC},
     {"Ethernet Config", STATE_CONFIG_VIA_ETH_NOT_STARTED, STATE_CONFIG_VIA_ETH_RESTART_BASE},

Firmware/RTK_Everywhere/Tasks.ino

@@ -1568,15 +1568,13 @@ void buttonCheckTask(void *e)
                     /* These lines are commented to allow default to print the diagnostic.
                     case STATE_KEYS_STARTED:
                     case STATE_KEYS_NEEDED:
-                    case STATE_KEYS_WIFI_STARTED:
-                    case STATE_KEYS_WIFI_CONNECTED:
-                    case STATE_KEYS_WIFI_TIMEOUT:
                     case STATE_KEYS_EXPIRED:
                     case STATE_KEYS_DAYS_REMAINING:
                     case STATE_KEYS_LBAND_CONFIGURE:
                     case STATE_KEYS_LBAND_ENCRYPTED:
                     case STATE_KEYS_PROVISION_STARTED:
-                    case STATE_KEYS_PROVISION_CONNECTED:
+                    case STATE_KEYS_PROVISION_SUCCESS:
+                    case STATE_KEYS_PROVISION_FAIL:
                         // Abort key download?
                         // TODO: check this! I think we want to be able to terminate STATE_KEYS via the button?
                         break;

Firmware/RTK_Everywhere/WiFi.ino

@@ -631,9 +631,7 @@ bool wifiIsNeeded()
         return true;
     }
 
-    if (systemState == STATE_KEYS_WIFI_STARTED || systemState == STATE_KEYS_WIFI_CONNECTED)
-        return true;
-    if (systemState == STATE_KEYS_PROVISION_STARTED || systemState == STATE_KEYS_PROVISION_CONNECTED)
+    if (systemState == STATE_KEYS_PROVISION_STARTED)
         return true;
 
     return false;