Merge pull request #661 from sparkfun/PointPerfectRTCM

Add support for additional PointPerfect services

Author: nseidle

.github/workflows/compile-rtk-everywhere.yml

@@ -150,7 +150,7 @@ jobs:
         run: arduino-cli compile --fqbn "esp32:esp32:esp32":DebugLevel=${{ env.DEBUG_LEVEL }},PSRAM=enabled ./Firmware/RTK_Everywhere/RTK_Everywhere.ino
           --build-property build.partitions=RTKEverywhere
           --build-property upload.maximum_size=4055040
-          --build-property "compiler.cpp.extra_flags=-MMD -c \"-DPOINTPERFECT_LBAND_TOKEN=$POINTPERFECT_LBAND_TOKEN\" \"-DPOINTPERFECT_IP_TOKEN=$POINTPERFECT_IP_TOKEN\" \"-DPOINTPERFECT_LBAND_IP_TOKEN=$POINTPERFECT_LBAND_IP_TOKEN\" \"-DFIRMWARE_VERSION_MAJOR=$FIRMWARE_VERSION_MAJOR\" \"-DFIRMWARE_VERSION_MINOR=$FIRMWARE_VERSION_MINOR\" \"-DENABLE_DEVELOPER=${{ env.ENABLE_DEVELOPER }}\""
+          --build-property "compiler.cpp.extra_flags=-MMD -c \"-DPOINTPERFECT_LBAND_TOKEN=$POINTPERFECT_LBAND_TOKEN\" \"-DPOINTPERFECT_IP_TOKEN=$POINTPERFECT_IP_TOKEN\" \"-DPOINTPERFECT_LBAND_IP_TOKEN=$POINTPERFECT_LBAND_IP_TOKEN\" \"-DPOINTPERFECT_RTCM_TOKEN=$POINTPERFECT_RTCM_TOKEN\"  \"-DFIRMWARE_VERSION_MAJOR=$FIRMWARE_VERSION_MAJOR\" \"-DFIRMWARE_VERSION_MINOR=$FIRMWARE_VERSION_MINOR\" \"-DENABLE_DEVELOPER=${{ env.ENABLE_DEVELOPER }}\""
           --export-binaries
 
       - name: Rename binary

Firmware/RTK_Everywhere/AP-Config/index.html

@@ -1190,36 +1190,50 @@
 
                     <div>
                         Device ID: <p id="hardwareID" style="display:inline;">N/A</p><br>
-                        Days until keys expire: <p id="daysRemaining" style="display:inline;">No Keys</p>
                     </div>
 
-                    <div class="form-check mt-3">
-                        <label class="form-check-label" for="enablePointPerfectCorrections">Enable PointPerfect
-                            Corrections </label>
-                        <input class="form-check-input" type="checkbox" value="" id="enablePointPerfectCorrections">
-                        <span class="tt" data-bs-placement="right"
-                            title="Use L-Band / IP PointPerfect corrections when available. Default: Disabled">
-                            <span class="icon-info-circle text-primary ms-2"></span>
-                        </span>
-                    </div>
-
-                    <div id="geographicRegionDropdown">
-                        <label for="geographicRegion">Geographic Region:</label>
-                        <select name="geographicRegion" id="geographicRegion" class="form-dropdown mb-2">
-                            <option value="0">US</option>
-                            <option value="1">EU</option>
-                            <option value="2">AU</option>
-                            <option value="3">KR</option>
-                            <option value="4">Japan</option>
+                    <div id="pointPerfectServiceDropdown">
+                        <label for="pointPerfectService">PointPerfect Service:</label>
+                        <select name="pointPerfectService" id="pointPerfectService" class="form-dropdown mb-2">
                         </select>
                         <span class="tt" data-bs-placement="right"
-                            title="Select your geographic region. This defines the L-Band frequency and Regional Correction topic. Default: US">
+                            title="The device will attempt to use PointPerfect for corrections. The device must be registered through SparkFun. NTRIP/RTCM service requires WiFi. Default: Disabled">
                             <span class="icon-info-circle text-primary ms-2"></span>
                         </span>
-                        <br>
+                        <p id="pointPerfectServiceError" class="inlineError"></p>
                     </div>
 
-                    <div id="ppSettingsConfig">
+                    <div id="ppSettingsLBandNAConfig">
+                        <div>
+                            Days until keys expire: <p id="daysRemaining" style="display:inline;">No Keys</p>
+                        </div>
+
+                        <div class="form-check mt-3">
+                            <label class="form-check-label" for="requestKeyUpdate"
+                                id="pointPerfectKeyUpdateLabel">Request Key Update</label>
+                            <input class="form-check-input" type="checkbox" value="" id="requestKeyUpdate">
+                            <span class="tt" data-bs-placement="right"
+                                title="When checked, the PointPerfect keys will be requested and updated at the next opportunity. Default: Disabled">
+                                <span class="icon-info-circle text-primary ms-2"></span>
+                            </span>
+                        </div>
+
+                        <div id="geographicRegionDropdown">
+                            <label for="geographicRegion">Geographic Region:</label>
+                            <select name="geographicRegion" id="geographicRegion" class="form-dropdown mb-2">
+                                <option value="0">US</option>
+                                <option value="1">EU</option>
+                                <option value="2">AU</option>
+                                <option value="3">KR</option>
+                                <option value="4">Japan</option>
+                            </select>
+                            <span class="tt" data-bs-placement="right"
+                                title="Select your geographic region. This defines the L-Band frequency and Regional Correction topic. Default: US">
+                                <span class="icon-info-circle text-primary ms-2"></span>
+                            </span>
+                            <br>
+                        </div>
+
                         <div class="form-check mt-3">
                             <label class="form-check-label" for="autoKeyRenewal">Auto Key Renewal </label>
                             <input class="form-check-input" type="checkbox" value="" id="autoKeyRenewal">
@@ -1243,15 +1257,6 @@
                             </div>
                         </div>
 
-                        <div class="form-check mt-3">
-                            <label class="form-check-label" for="requestKeyUpdate">Request Key Update </label>
-                            <input class="form-check-input" type="checkbox" value="" id="requestKeyUpdate">
-                            <span class="tt" data-bs-placement="right"
-                                title="When checked, the PointPerfect keys will be requested and updated at the next opportunity. Default: Disabled">
-                                <span class="icon-info-circle text-primary ms-2"></span>
-                            </span>
-                        </div>
-
                         <div id="useAssistNowCheckbox">
                             <div class="form-check mt-3">
                                 <label class="form-check-label" for="useAssistNow">AssistNow </label>
@@ -2202,8 +2207,10 @@
 
                 <div id="shutdownNoChargeTimeoutMinutesCheckboxDetail">
                     <div class="form-check mt-3">
-                        <label class="form-check-label" for="shutdownNoChargeTimeoutMinutes">Shutdown If Not Charging</label>
-                        <input class="form-check-input" type="checkbox" value="" id="shutdownNoChargeTimeoutMinutesCheckbox">
+                        <label class="form-check-label" for="shutdownNoChargeTimeoutMinutes">Shutdown If Not
+                            Charging</label>
+                        <input class="form-check-input" type="checkbox" value=""
+                            id="shutdownNoChargeTimeoutMinutesCheckbox">
                         <span class="tt" data-bs-placement="right"
                             title="If enabled, device will turn off if no external charger is present. This is helpful when deploying in machinery or where a user may forget to turn the device off. Default: Disabled">
                             <span class="icon-info-circle text-primary ms-2"></span>
@@ -2213,7 +2220,8 @@
 
                 <div id="shutdownNoChargeTimeoutMinutesDetails" class="collapse mb-2">
                     <div class="form-group row">
-                        <label for="shutdownNoChargeTimeoutMinutes" class="box-margin40 col-sm-3 col-7 col-form-label">Minutes before
+                        <label for="shutdownNoChargeTimeoutMinutes"
+                            class="box-margin40 col-sm-3 col-7 col-form-label">Minutes before
                             shutdown:
                             <span class="tt" data-bs-placement="right"
                                 title="If shutdown is enabled, the device will turn off after this many minutes if no external charger is detected. Limits: 0 (disabled) to 10,080.">

Firmware/RTK_Everywhere/AP-Config/src/main.js

@@ -124,6 +124,14 @@ function parseIncoming(msg) {
                 hide("shutdownNoChargeTimeoutMinutesCheckboxDetail");
 
                 hide("constellationNavic"); //Not supported on ZED
+
+                select = ge("pointPerfectService");
+                let newOption = new Option('Disabled', '0');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex NTRIP/RTCM', '1');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex L-Band North America', '2');
+                select.add(newOption, undefined);
             }
             else if ((platformPrefix == "Facet v2") || (platformPrefix == "Facet v2 LBand")) {
                 show("baseConfig");
@@ -186,6 +194,14 @@ function parseIncoming(msg) {
                 ge("messageRateInfoText").setAttribute('data-bs-original-title', 'The GNSS can output NMEA and RTCMv3 at different rates. For NMEA: select a stream for each message, and set an interval for each stream. For RTCMv3: set an interval for each message group, and enable individual messages.');
                 ge("rtcmRateInfoText").setAttribute('data-bs-original-title', 'RTCM is transmitted by the base at a default of 1Hz for messages 1005, MSM4, and 0.1Hz for 1033. This can be lowered for radios with low bandwidth or tailored to transmit any/all RTCM messages. Limits: 0.1 to 600.');
                 ge("enableExtCorrRadioInfoText").setAttribute('data-bs-original-title', 'Enable external radio corrections: RTCMv3 on mosaic COM2. Default: False');
+
+                select = ge("pointPerfectService");
+                newOption = new Option('Disabled', '0');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex NTRIP/RTCM', '1');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex L-Band North America', '2');
+                select.add(newOption, undefined);
             }
             else if (platformPrefix == "Torch") {
                 show("baseConfig");
@@ -215,6 +231,11 @@ function parseIncoming(msg) {
 
                 ge("rtcmRateInfoText").setAttribute('data-bs-original-title', 'RTCM is transmitted by the base at a default of 1Hz for messages 1005, 1074, 1084, 1094, 1124, and 0.1Hz for 1033. This can be lowered for radios with low bandwidth or tailored to transmit any/all RTCM messages. Limits: 0 to 20. Note: The measurement rate is overridden to 1Hz when in Base mode.');
 
+                select = ge("pointPerfectService");
+                newOption = new Option('Disabled', '0');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex NTRIP/RTCM', '1');
+                select.add(newOption, undefined);
             }
             else if (platformPrefix == "Postcard") {
                 show("baseConfig");
@@ -245,6 +266,12 @@ function parseIncoming(msg) {
                 hide("minCNOConfig"); //Not supported on LG290P
 
                 ge("rtcmRateInfoText").setAttribute('data-bs-original-title', 'RTCM is transmitted by the base at a default of 1Hz for messages 1005, 1074, 1084, 1094, 1114, 1124, 1134. This can be lowered for radios with low bandwidth or tailored to transmit any/all RTCM messages. Limits: 0 to 20. Note: The measurement rate is overridden to 1Hz when in Base mode.');
+
+                select = ge("pointPerfectService");
+                let newOption = new Option('Disabled', '0');
+                select.add(newOption, undefined);
+                newOption = new Option('Flex NTRIP/RTCM', '1');
+                select.add(newOption, undefined);
             }
         }
         else if (id.includes("gnssFirmwareVersionInt")) {
@@ -473,8 +500,9 @@ function parseIncoming(msg) {
                 correctionsSourceNames.push(correctionNameLabel);
                 correctionsSourcePriorities.push(correctionPriority);
             }
-            else
-                console.log("Too many corrections sources");
+            else {
+                console.log("Too many corrections sources: ", correctionsSourceNames.length);
+            }
         }
         else if (id.includes("checkingNewFirmware")) {
             checkingNewFirmware();
@@ -574,7 +602,7 @@ function parseIncoming(msg) {
         ge("enableNtripServer").dispatchEvent(new CustomEvent('change'));
         ge("enableNtripClient").dispatchEvent(new CustomEvent('change'));
         ge("dataPortChannel").dispatchEvent(new CustomEvent('change'));
-        ge("enablePointPerfectCorrections").dispatchEvent(new CustomEvent('change'));
+        ge("pointPerfectService").dispatchEvent(new CustomEvent('change'));
         ge("enableExternalPulse").dispatchEvent(new CustomEvent('change'));
         ge("enableExternalHardwareEventLogging").dispatchEvent(new CustomEvent('change'));
         ge("enableEspNow").dispatchEvent(new CustomEvent('change'));
@@ -893,15 +921,7 @@ function validateFields() {
     // }
 
     //PointPerfect Config
-    if (ge("enablePointPerfectCorrections").checked == true) {
-        value = ge("pointPerfectDeviceProfileToken").value;
-        if (value.length > 0)
-            checkElementString("pointPerfectDeviceProfileToken", 36, 36, "Must be 36 characters", "collapsePPConfig");
-    }
-    else {
-        clearElement("pointPerfectDeviceProfileToken", "");
-        ge("autoKeyRenewal").checked = true;
-    }
+    checkPointPerfectService();
 
     //Port Config
     if (ge("enableExternalPulse").checked == true) {
@@ -1062,8 +1082,8 @@ function saveConfig() {
         clearSuccess('saveBtn');
     }
     else {
-        sendData();
         clearError('saveBtn');
+        sendData();
         showSuccess('saveBtn', "Saving...");
     }
 
@@ -1082,6 +1102,30 @@ function checkConstellations() {
         clearError("gnssConstellations");
 }
 
+function checkPointPerfectService() {
+    if (ge("pointPerfectService").value > 0) {
+        value = ge("pointPerfectDeviceProfileToken").value;
+        if (value.length > 0)
+            checkElementString("pointPerfectDeviceProfileToken", 36, 36, "Must be 36 characters", "collapsePPConfig");
+
+        if (networkCount() == 0) {
+            showError('pointPerfectService', "This PointPerfect service requires at least one WiFi network");
+            ge("collapsePPConfig").classList.add('show');
+            ge("collapseWiFiConfig").classList.add('show');
+            errorCount++;
+        }
+        else {
+            clearError("pointPerfectService");
+        }
+
+    }
+    else {
+        clearElement("pointPerfectDeviceProfileToken", "");
+        ge("autoKeyRenewal").checked = true;
+        clearError("pointPerfectService");
+    }
+}
+
 function checkBitMapValue(id, min, max, bitMap, errorText, collapseID) {
     value = ge(id).value;
     mask = ge(bitMap).value;
@@ -1652,12 +1696,15 @@ document.addEventListener("DOMContentLoaded", (event) => {
         }
     });
 
-    ge("enablePointPerfectCorrections").addEventListener("change", function () {
-        if (ge("enablePointPerfectCorrections").checked) {
-            show("ppSettingsConfig");
+    ge("pointPerfectService").addEventListener("change", function () {
+        if (ge("pointPerfectService").value == 1) { //Flex RTCM 
+            hide("ppSettingsLBandNAConfig");
         }
-        else {
-            hide("ppSettingsConfig");
+        else if (ge("pointPerfectService").value == 2) { //Flex L-Band NA
+            show("ppSettingsLBandNAConfig");
+        }
+        else { //"pointPerfectService").value == 0 //Disabled
+            hide("ppSettingsLBandNAConfig");
         }
     });
 

Firmware/RTK_Everywhere/Developer.ino

@@ -155,6 +155,7 @@ void mqttClientValidateTables() {}
 void httpClientPrintStatus() {}
 void httpClientUpdate() {}
 void httpClientValidateTables() {}
+bool pointPerfectServiceUsesKeys() {return(false);}
 
 #endif   // COMPILE_HTTP_CLIENT
 
@@ -300,18 +301,6 @@ void lg290pReset()      {}
 
 #ifndef COMPILE_ZED
 
-// MON HW Antenna Status
-enum sfe_ublox_antenna_status_e
-{
-  SFE_UBLOX_ANTENNA_STATUS_INIT,
-  SFE_UBLOX_ANTENNA_STATUS_DONTKNOW,
-  SFE_UBLOX_ANTENNA_STATUS_OK,
-  SFE_UBLOX_ANTENNA_STATUS_SHORT,
-  SFE_UBLOX_ANTENNA_STATUS_OPEN
-};
-
-uint8_t aStatus = SFE_UBLOX_ANTENNA_STATUS_DONTKNOW;
-
 // void checkRXMCOR() {}
 // void pushRXMPMP() {}
 void convertGnssTimeToEpoch(uint32_t *epochSecs, uint32_t *epochMicros) {