Merge branch 'main' into release_candidate

Author: nseidle

Firmware/RTK_Everywhere/MQTT_Client.ino

@@ -458,9 +458,8 @@ void mqttClientReceiveMessage(int messageSize)
 
                 settings.pointPerfectNextKeyDuration = (1000LL * 60 * 60 * 24 * 28) - 1; // Assume next key duration is 28 days
 
-                if (online.rtc)
-                    settings.lastKeyAttempt = rtc.getEpoch(); // Mark it - but only if RTC is online
-
+                settings.lastKeyAttempt = rtc.getEpoch(); // Mark it
+                
                 recordSystemSettings();                   // Record these settings to unit
 
                 if (settings.debugCorrections == true)

Firmware/RTK_Everywhere/menuPP.ino

@@ -1207,8 +1207,8 @@ void provisioningSetState(uint8_t newState)
     }
 }
 
-unsigned long provisioningStartTime_millis;
-const unsigned long provisioningTimeout_ms = 120000;
+unsigned long provisioningStartTime;
+const unsigned long provisioningTimeout = 120000;
 
 void updateProvisioning()
 {
@@ -1227,15 +1227,14 @@ void updateProvisioning()
         default:
         case PROVISIONING_OFF:
         {
-            provisioningStartTime_millis = millis(); // Record the start time so we can timeout
+            provisioningStartTime = millis(); // Record the start time so we can timeout
             provisioningSetState(PROVISIONING_WAIT_RTC);
         }
         break;
         case PROVISIONING_WAIT_RTC:
         {
             if  ((online.rtc)
-                // If RTC is not online after provisioningTimeout_ms, try to provision anyway
-                || (millis() > (provisioningStartTime_millis + provisioningTimeout_ms))
+                || (millis() > (provisioningStartTime + provisioningTimeout))
                 || (settings.requestKeyUpdate))
                 provisioningSetState(PROVISIONING_NOT_STARTED);
         }
@@ -1273,21 +1272,21 @@ void updateProvisioning()
             }
             else
             {
-                // RTC is online. Determine days until next key expires
+                // Determine days until next key expires
                 int daysRemaining =
                     daysFromEpoch(settings.pointPerfectNextKeyStart + settings.pointPerfectNextKeyDuration + 1);
 
                 if (settings.debugPpCertificate)
                     systemPrintf("Days until keys expire: %d\r\n", daysRemaining);
 
                 if (daysRemaining > 28)
-                    provisioningSetState(PROVISIONING_KEYS_REMAINING); // Don't need new keys
+                    provisioningSetState(PROVISIONING_KEYS_REMAINING);
                 else
-                    provisioningSetState(PROVISIONING_CHECK_ATTEMPT); // Do need new keys
+                    provisioningSetState(PROVISIONING_CHECK_ATTEMPT);
             }
         }
         break;
-        case PROVISIONING_CHECK_ATTEMPT: // Requires RTC to be online
+        case PROVISIONING_CHECK_ATTEMPT:
         {
             // When did we last try to get keys? Attempt every 24 hours - or always for DEVELOPER
             //if (rtc.getEpoch() - settings.lastKeyAttempt > ( ENABLE_DEVELOPER ? 0 : (60 * 60 * 24)))
@@ -1322,7 +1321,7 @@ void updateProvisioning()
         {
             ztpResponse = ZTP_NOT_STARTED; // HTTP_Client will update this
             httpClientModeNeeded = true; // This will start the HTTP_Client
-            provisioningStartTime_millis = millis(); // Record the start time so we can timeout
+            provisioningStartTime = millis(); // Record the start time so we can timeout
             paintGettingKeys();
             provisioningSetState(PROVISIONING_STARTED);
         }
@@ -1337,8 +1336,8 @@ void updateProvisioning()
             }
             else if (ztpResponse == ZTP_SUCCESS)
             {
-                httpClientModeNeeded = false; // Tell HTTP_Client to give up
-                recordSystemSettings(); // Make sure the new cert and keys are recorded
+                httpClientModeNeeded = false; // Tell HTTP_Client to give up. (But it probably already has...)
+                recordSystemSettings();
                 provisioningSetState(PROVISIONING_KEYS_REMAINING);
             }
             else if (ztpResponse == ZTP_DEACTIVATED)
@@ -1362,7 +1361,7 @@ void updateProvisioning()
                                 "subscription. Please reference device ID: %s\r\n",
                                 landingPageUrl, hardwareID);
 
-                httpClientModeNeeded = false; // Tell HTTP_Client to give up
+                httpClientModeNeeded = false; // Tell HTTP_Client to give up. (But it probably already has...)
                 displayAccountExpired(5000);
 
                 provisioningSetState(PROVISIONING_KEYS_REMAINING);
@@ -1388,7 +1387,7 @@ void updateProvisioning()
                                 "activated. Please reference device ID: %s\r\n",
                                 landingPageUrl, hardwareID);
 
-                httpClientModeNeeded = false; // Tell HTTP_Client to give up
+                httpClientModeNeeded = false; // Tell HTTP_Client to give up. (But it probably already has...)
                 displayNotListed(5000);
 
                 provisioningSetState(PROVISIONING_KEYS_REMAINING);
@@ -1404,7 +1403,7 @@ void updateProvisioning()
                                 "[email protected] for more assistance. Please reference device ID: %s\r\n",
                                 hardwareID);
 
-                httpClientModeNeeded = false; // Tell HTTP_Client to give up
+                httpClientModeNeeded = false; // Tell HTTP_Client to give up. (But it probably already has...)
                 displayAlreadyRegistered(5000);
 
                 provisioningSetState(PROVISIONING_KEYS_REMAINING);
@@ -1413,7 +1412,7 @@ void updateProvisioning()
             {
                 systemPrintln("updateProvisioning: ZTP_UNKNOWN_ERROR");
 
-                httpClientModeNeeded = false; // Tell HTTP_Client to give up
+                httpClientModeNeeded = false; // Tell HTTP_Client to give up. (But it probably already has...)
 
                 provisioningSetState(PROVISIONING_KEYS_REMAINING);
             }
@@ -1452,17 +1451,21 @@ void updateProvisioning()
             provisioningSetState(PROVISIONING_WAIT_ATTEMPT);
         }
         break;
-        case PROVISIONING_WAIT_ATTEMPT: // We may still not have RTC... Or RTC may come online _during_ this state.
+        case PROVISIONING_WAIT_ATTEMPT:
         {
             if (settings.requestKeyUpdate) // requestKeyUpdate can be set via the menu, mode button or web config
                 provisioningSetState(PROVISIONING_CHECK_REMAINING);
             else if (!settings.enablePointPerfectCorrections || !settings.autoKeyRenewal)
                 provisioningSetState(PROVISIONING_OFF);
             // When did we last try to get keys? Attempt every 24 hours - or every 15 mins for DEVELOPER
-            //else if (millis() > (provisioningStartTime_millis + ( ENABLE_DEVELOPER ? (1000 * 60 * 15) : (1000 * 60 * 60 * 24))))
+            //else if (online.rtc && (rtc.getEpoch() - settings.lastKeyAttempt > ( ENABLE_DEVELOPER ? (15 * 60) : (60 * 60 * 24))))
             // When did we last try to get keys? Attempt every 24 hours
-            else if (millis() > (provisioningStartTime_millis + (1000 * 60 * 60 * 24))) // Don't use settings.lastKeyAttempt (#419)
-                provisioningSetState(PROVISIONING_CHECK_REMAINING);
+            else if (online.rtc && (rtc.getEpoch() - settings.lastKeyAttempt > (60 * 60 * 24)))
+            {
+                settings.lastKeyAttempt = rtc.getEpoch(); // Mark it
+                recordSystemSettings();                   // Record these settings to unit
+                provisioningSetState(PROVISIONING_STARTING);
+            }
         }
         break;
     }

README.md

@@ -5,21 +5,27 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa
 
 <table class="table table-hover table-striped table-bordered">
   <tr align="center">
-   <td><a href="https://www.sparkfun.com/products/24672"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
+   <td><a href="https://www.sparkfun.com/products/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
+   <td><a href="https://www.sparkfun.com/products/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
      </tr>
   <tr align="center">
-    <td><a href="https://www.sparkfun.com/products/24672">SparkFun RTK Torch (GPS-24672)</a></td>
+    <td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
+    <td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
   </tr>
   <tr align="center">
-    <td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>
+    <td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
+    <td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
   </tr>
 </table>
 
-The [SparkFun RTK Torch](https://www.sparkfun.com/products/24672) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz!
+The [SparkFun RTK Torch](https://www.sparkfun.com/products/25662) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz. It supports Galileo E6 HAS and has built-in tilt compensation too!
+
+The [SparkFun RTK EVK](https://www.sparkfun.com/products/24342) is the perfect development platform for your fixed or mobile high-precision positioning and navigation needs. We called it the EVK (Evaluation Kit) as it truly covers all the options: L1 + L2 RTK GNSS, with L-Band correction built-in. Regarding connectivity, the SparkFun RTK EVK has it all: WiFi / Bluetooth®, Ethernet and LTE cellular!
 
 This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware) and the firmware that runs on the SparkFun RTK product line including:
 
-* [SparkFun RTK Torch](https://www.sparkfun.com/products/24672)
+* [SparkFun RTK Torch](https://www.sparkfun.com/products/25662)
+* [SparkFun RTK EVK](https://www.sparkfun.com/products/24342)
 
 For compiled binaries of the firmware, please see [SparkFun RTK Everywhere Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries).
 

docs/accuracy_verification.md

@@ -1,6 +1,6 @@
 # Accuracy Verification
 
-Torch: ![Feature Supported](img/Icons/GreenDot.png)
+Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 ![Facet in the field](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2016%20Facet%20in%20the%20Field.jpg)
 

docs/configure_with_bluetooth.md

@@ -1,6 +1,6 @@
 # Configure with Bluetooth
 
-Torch: ![Feature Supported](img/Icons/GreenDot.png)
+Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 ![Configuration menu open over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
 

docs/configure_with_ethernet.md

@@ -0,0 +1,49 @@
+# Configure with Ethernet
+
+Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
+
+During Ethernet configuration, the RTK device will present a webpage that is viewable from a desktop/laptop connected to the local network.
+
+![SparkFun RTK Ethernet Configuration Interface](<img/WiFi Config/SparkFun RTK Ethernet Config - Crop.png>)
+
+*SparkFun RTK Ethernet Configuration Interface*
+
+## RTK EVK
+
+To get into Ethernet configuration follow these steps:
+
+1. Power on the RTK EVK and connect it to your Ethernet network using the supplied cable
+2. Once the device has started, put the RTK EVK into Ethernet config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg Eth** is highlighted, then do a quick double-click to select it. Note that it is only possible to put the EVK into this mode via the Mode button, requiring physical access to the EVK. Remote configuration is only possible after putting the EVK into this mode.
+
+    ![SparkFun RTK EVK Mode Menu](<img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
+
+    *SparkFun RTK EVK Mode Menu*
+
+3. The RTK EVK will reboot into a dedicated Configure-Via-Ethernet mode
+4. By default, the RTK EVK uses DHCP, obtaining its IP address from your DHCP server. The IP address is displayed on the OLED display. You can use a fixed IP address if desired. See [Ethernet Menu](menu_ethernet.md) for more details.
+
+    ![SparkFun RTK EVK Config Ethernet](<img/Displays/SparkFun RTK EVK Ethernet Config.png>)
+
+    *SparkFun RTK EVK Config Ethernet*
+
+5. Open a browser (Chrome is preferred) on your computer and type the EVK's IP address into the address bar. The web config page will open.
+
+![SparkFun RTK Ethernet Configuration Interface](<img/WiFi Config/SparkFun RTK Ethernet Config - Main Interface.png>)
+
+*SparkFun RTK Ethernet Configuration Interface*
+
+## File Manager
+
+![List of files in file manager](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png>)
+
+On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. Files may be uploaded to the SD card if needed.
+
+Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
+
+## Saving and Exit
+
+![Save and Exit buttons](<img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png>)
+
+Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit and Reset’ at which point the unit will exit Ethernet configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).
+
+It is also possible to exit Configure-Via-Ethernet mode by: clicking the Mode button on the front panel; or by opening the serial menu and selecting 'r'.

docs/configure_with_serial.md

@@ -1,6 +1,6 @@
 # Configure with Serial
 
-Torch: ![Feature Supported](img/Icons/GreenDot.png) 
+Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 **Note:** Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
 

docs/configure_with_settings_file.md

@@ -1,6 +1,6 @@
 # Configure with Settings File
 
-Torch: ![Feature Not Supported](img/Icons/RedDot.png) 
+Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 ![SparkFun RTK Facet Settings File](img/SparkFun_RTK_Express_-_Settings_File.jpg)
 

docs/configure_with_ucenter.md

@@ -1,6 +1,6 @@
 # Configure with u-center
 
-Torch: ![Feature Not Supported](img/Icons/RedDot.png) 
+Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 On devices that have a u-blox GNSS receiver, the ZED-F9P GNSS module can be configured independently using the u-center software from u-blox by connecting a USB cable to the *Config u-blox* USB connector. Settings can be saved to the module between power cycles. For more information please see SparkFun’s [Getting Started with u-center by u-blox](https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox/all).
 

docs/configure_with_wifi.md

@@ -1,6 +1,6 @@
 # Configure with WiFi
 
-Torch: ![Feature Supported](img/Icons/GreenDot.png)
+Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
 
 ![SparkFun RTK WiFi Configuration Interface](<img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png>)
 
@@ -26,6 +26,27 @@ To get into WiFi configuration follow these steps:
 
 *Browser with rtk.local*
 
+Continue with [Connecting to WiFi network](#connecting-to-wifi-network).
+
+## RTK EVK
+
+To get into WiFi configuration follow these steps:
+
+1. Ensure the WiFi / Bluetooth antenna is attached, then connect the RTK EVK to a power source.
+2. Once the device has started, put the RTK EVK into WiFi config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg WiFi** is highlighted, then do a quick double-click to select it.
+
+    ![SparkFun RTK EVK Mode Menu](<img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
+
+    *SparkFun RTK EVK Mode Menu*
+
+3. The display will change, showing that the EVK is in WiFi configuration mode.
+4. Connect to WiFi network named ‘RTK Config’.
+5. You should be automatically re-directed to the config page but if you are not, open a browser (Chrome is preferred) and type **rtk.local** into the address bar.
+
+![Browser with rtk.local address](<img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png>)
+
+*Browser with rtk.local*
+
 ## Connecting to WiFi Network
 
 ![Discovered WiFi networks](<img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Networks.jpg>)
@@ -38,7 +59,7 @@ Note: Upon connecting, your phone may warn you that this WiFi network has no int
 
 *Connected to the RTK WiFi Setup Page*
 
-Clicking on the category 'carrot' will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
+Clicking on the category tab will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
 
 ![Firmware highlighted](<img/WiFi Config/SparkFun RTK WiFi Config - Header Firmware Version.png>)
 
@@ -50,12 +71,12 @@ Please note that the firmware for the RTK device and the firmware for the GNSS r
 
 ![List of files in file manager](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png>)
 
-On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. And files may be uploaded to the SD card if needed.
+On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. Files may be uploaded to the SD card if needed.
 
 Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
 
 ## Saving and Exit
 
 ![Save and Exit buttons](<img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png>)
 
-Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit to Rover Mode’ at which point the unit will exit WiFi configuration and return to standard Rover mode.
+Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit and Reset’ at which point the unit will exit WiFi configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).