Merge pull request #502 from sparkfun/release_candidate

Merge v3.5
sparkfun · Jun 21, 2023 · b59d2d6 · b59d2d6
2 parents 2021f64 + def8ca5
commit b59d2d6
Show file tree

Hide file tree

Showing 31 changed files with 720 additions and 243 deletions.
diff --git a/.github/workflows/compile-rtk-firmware.yml b/.github/workflows/compile-rtk-firmware.yml
@@ -126,7 +126,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           directory: ./Firmware/RTK_Surveyor
           branch: ${{ env.BRANCH }}
-          message: 'Update form.h via Python ${date}'
+          message: 'Update form.h via Python'
 
       - name: Copy custom app3M_fat9M_16MB.csv
         run:

diff --git a/Firmware/RTK_Surveyor/Begin.ino b/Firmware/RTK_Surveyor/Begin.ino
@@ -445,13 +445,13 @@ void beginSD()
                 }
             }
         }
-#else
+#else   // COMPILE_SD_MMC
         else
         {
             log_d("SD_MMC not compiled");
             break; // No SD available.
         }
-#endif
+#endif  // COMPILE_SD_MMC
 
         if (createTestFile() == false)
         {
@@ -490,7 +490,7 @@ void endSD(bool alreadyHaveSemaphore, bool releaseSemaphore)
 #ifdef COMPILE_SD_MMC
         else
             SD_MMC.end();
-#endif
+#endif  // COMPILE_SD_MMC
 
         online.microSD = false;
         systemPrintln("microSD: Offline");
@@ -574,9 +574,9 @@ void pinUART2Task(void *pvParameters)
     //       ESP32 2.0.2... Uncomment these lines to prevent the stall if/when we upgrade to ESP32 ~2.0.6.
     // #if defined(REF_STN_GNSS_DEBUG)
     //   if (ENABLE_DEVELOPER && productVariant == REFERENCE_STATION)
-    // #else
+    // #else   // REF_STN_GNSS_DEBUG
     //   if (USE_I2C_GNSS)
-    // #endif
+    // #endif  // REF_STN_GNSS_DEBUG
     {
         serialGNSS.setRxBufferSize(
             settings.uartReceiveBufferSize); // TODO: work out if we can reduce or skip this when using SPI GNSS
@@ -876,7 +876,7 @@ void beginInterrupts()
         pinMode(pin_Ethernet_Interrupt, INPUT_PULLUP);                 // Prepare the interrupt pin
         attachInterrupt(pin_Ethernet_Interrupt, ethernetISR, FALLING); // Attach the interrupt
     }
-#endif
+#endif  // COMPILE_ETHERNET
 }
 
 // Set LEDs for output and configure PWM

diff --git a/Firmware/RTK_Surveyor/Bluetooth.ino b/Firmware/RTK_Surveyor/Bluetooth.ino
@@ -234,6 +234,7 @@ void bluetoothStart()
 // https://github.com/espressif/arduino-esp32/issues/3386
 void pinBluetoothTask(void *pvParameters)
 {
+#ifdef COMPILE_BT
     if (bluetoothSerial->begin(deviceName) == false)
     {
         systemPrintln("An error occurred initializing Bluetooth");
@@ -245,6 +246,7 @@ void pinBluetoothTask(void *pvParameters)
     bluetoothPinned = true;
 
     vTaskDelete(nullptr); // Delete task once it has run once
+#endif // COMPILE_BT
 }
 
 // This function stops BT so that it can be restarted later

diff --git a/Firmware/RTK_Surveyor/Display.ino b/Firmware/RTK_Surveyor/Display.ino
@@ -1016,9 +1016,9 @@ uint32_t setWiFiIcon_TwoRadios()
         {
 #ifdef COMPILE_WIFI
             int wifiRSSI = WiFi.RSSI();
-#else
+#else   // COMPILE_WIFI
             int wifiRSSI = -40;     // Dummy
-#endif
+#endif  // COMPILE_WIFI
             // Based on RSSI, select icon
             if (wifiRSSI >= -40)
                 icons |= ICON_WIFI_SYMBOL_3_LEFT;
@@ -1046,9 +1046,9 @@ uint32_t setWiFiIcon_TwoRadios()
             {
 #ifdef COMPILE_WIFI
                 int wifiRSSI = WiFi.RSSI();
-#else
+#else   // COMPILE_WIFI
                 int wifiRSSI = -40; // Dummy
-#endif
+#endif  // COMPILE_WIFI
                 // Based on RSSI, select icon
                 if (wifiRSSI >= -40)
                     icons |= ICON_WIFI_SYMBOL_3_LEFT;
@@ -1103,9 +1103,9 @@ uint32_t setWiFiIcon_ThreeRadios()
         {
 #ifdef COMPILE_WIFI
             int wifiRSSI = WiFi.RSSI();
-#else
+#else   // COMPILE_WIFI
             int wifiRSSI = -40;     // Dummy
-#endif
+#endif  // COMPILE_WIFI
             // Based on RSSI, select icon
             if (wifiRSSI >= -40)
                 icons |= ICON_WIFI_SYMBOL_3_RIGHT;
@@ -1133,9 +1133,9 @@ uint32_t setWiFiIcon_ThreeRadios()
             {
 #ifdef COMPILE_WIFI
                 int wifiRSSI = WiFi.RSSI();
-#else
+#else   // COMPILE_WIFI
                 int wifiRSSI = -40; // Dummy
-#endif
+#endif  // COMPILE_WIFI
                 // Based on RSSI, select icon
                 if (wifiRSSI >= -40)
                     icons |= ICON_WIFI_SYMBOL_3_RIGHT;
@@ -1583,9 +1583,9 @@ void paintLogging()
     loggingIconDisplayed %= 4; // Wrap
 #ifdef COMPILE_ETHERNET
     if ((online.logging == true) && (logIncreasing || ntpLogIncreasing))
-#else
+#else   // COMPILE_ETHERNET
     if ((online.logging == true) && (logIncreasing))
-#endif
+#endif  // COMPILE_ETHERNET
     {
         if (loggingType == LOGGING_STANDARD)
         {
@@ -1656,9 +1656,9 @@ void paintLoggingNTP(bool noPulse)
     loggingIconDisplayed %= 4; // Wrap
 #ifdef COMPILE_ETHERNET        // Some redundancy here. paintLoggingNTP should only be called if Ethernet is present
     if ((online.logging == true) && (logIncreasing || ntpLogIncreasing))
-#else
+#else   // COMPILE_ETHERNET
     if ((online.logging == true) && (logIncreasing))
-#endif
+#endif  // COMPILE_ETHERNET
     {
         if (loggingIconDisplayed == 0)
             displayBitmap(64 - Logging_0_Width, 48 - Logging_0_Height, Logging_0_Width, Logging_0_Height, Logging_0);
@@ -1825,9 +1825,9 @@ void paintIPAddress()
     snprintf(ipAddress, sizeof(ipAddress), "       %d.%d.%d.%d       ",
 #ifdef COMPILE_ETHERNET
              Ethernet.localIP()[0], Ethernet.localIP()[1], Ethernet.localIP()[2], Ethernet.localIP()[3]);
-#else
+#else   // COMPILE_ETHERNET
              0, 0, 0, 0);
-#endif
+#endif  // COMPILE_ETHERNET
 
     static uint8_t ipAddressPosition = 0;
 
@@ -2037,9 +2037,9 @@ void displayWiFiConfig()
         snprintf(mySSID, sizeof(mySSID), "%s", "RTK Config");
     else
         snprintf(mySSID, sizeof(mySSID), "%s", WiFi.SSID().c_str());
-#else
+#else   // COMPILE_WIFI
     snprintf(mySSID, sizeof(mySSID), "%s", "!Compiled");
-#endif
+#endif  // COMPILE_WIFI
 
     char mySSIDFront[displayMaxCharacters + 1]; // 1 for null terminator
     char mySSIDBack[displayMaxCharacters + 1];  // 1 for null terminator
@@ -2094,9 +2094,9 @@ void displayWiFiConfig()
     else
         printTextCenter(myIPBack, yPos, QW_FONT_5X7, 1, false);
 
-#else
+#else   // COMPILE_AP
     printTextCenter("!Compiled", yPos, QW_FONT_5X7, 1, false);
-#endif
+#endif  // COMPILE_AP
 }
 
 // When user does a factory reset, let us know
@@ -3307,11 +3307,11 @@ void displayConfigViaEthernet()
         oled.display();
     }
 
-#else
+#else   // COMPILE_ETHERNET
     uint8_t fontHeight = 15;
     uint8_t yPos = oled.getHeight() / 2 - fontHeight;
     printTextCenter("!Compiled", yPos, QW_FONT_5X7, 1, false);
-#endif
+#endif  // COMPILE_ETHERNET
 }
 
 const uint8_t *getMacAddress()
@@ -3321,14 +3321,14 @@ const uint8_t *getMacAddress()
 #ifdef COMPILE_BT
     if (bluetoothState != BT_OFF)
         return btMACAddress;
-#endif
+#endif  // COMPILE_BT
 #ifdef COMPILE_WIFI
     if (wifiState != WIFI_OFF)
         return wifiMACAddress;
-#endif
+#endif  // COMPILE_WIFI
 #ifdef COMPILE_ETHERNET
     if ((online.ethernetStatus >= ETH_STARTED_CHECK_CABLE) && (online.ethernetStatus <= ETH_CONNECTED))
         return ethernetMACAddress;
-#endif
+#endif  // COMPILE_ETHERNET
     return zero;
 }
diff --git a/Firmware/RTK_Surveyor/ESPNOW.ino b/Firmware/RTK_Surveyor/ESPNOW.ino
@@ -32,7 +32,7 @@ void espnowOnDataSent(const uint8_t *mac_addr, esp_now_send_status_t status)
     //  else
     //    systemPrintln("Delivery Fail");
 }
-#endif
+#endif  // COMPILE_ESPNOW
 
 // Callback when data is received
 void espnowOnDataReceived(const uint8_t *mac, const uint8_t *incomingData, int len)
@@ -73,7 +73,7 @@ void espnowOnDataReceived(const uint8_t *mac, const uint8_t *incomingData, int l
         espnowIncomingRTCM = true;
         lastEspnowRssiUpdate = millis();
     }
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // Callback for all RX Packets
@@ -88,7 +88,7 @@ void promiscuous_rx_cb(void *buf, wifi_promiscuous_pkt_type_t type)
     const wifi_promiscuous_pkt_t *ppkt = (wifi_promiscuous_pkt_t *)buf;
     packetRSSI = ppkt->rx_ctrl.rssi;
 }
-#endif
+#endif  // COMPILE_ESPNOW
 
 // If WiFi is already enabled, simply add the LR protocol
 // If the radio is off entirely, start the radio, turn on only the LR protocol
@@ -188,7 +188,7 @@ void espnowStart()
     }
 
     systemPrintln("ESP-Now Started");
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // If WiFi is already enabled, simply remove the LR protocol
@@ -247,7 +247,7 @@ void espnowStop()
         wifiStart(); // Force WiFi to restart
     }
 
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // Start ESP-Now if needed, put ESP-Now into broadcast state
@@ -300,7 +300,7 @@ bool espnowIsPaired()
         espnowSetState(ESPNOW_PAIRED);
         return (true);
     }
-#endif
+#endif  // COMPILE_ESPNOW
     return (false);
 }
 
@@ -321,9 +321,9 @@ esp_err_t espnowSendPairMessage(uint8_t *sendToMac)
         pairMessage.crc += wifiMACAddress[x];
 
     return (esp_now_send(sendToMac, (uint8_t *)&pairMessage, sizeof(pairMessage))); // Send packet to given MAC
-#else
+#else   // COMPILE_ESPNOW
     return (ESP_OK);
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // Add a given MAC address to the peer list
@@ -349,9 +349,9 @@ esp_err_t espnowAddPeer(uint8_t *peerMac, bool encrypt)
         log_d("Failed to add peer: 0x%02X%02X%02X%02X%02X%02X", peerMac[0], peerMac[1], peerMac[2], peerMac[3],
               peerMac[4], peerMac[5]);
     return (result);
-#else
+#else   // COMPILE_ESPNOW
     return (ESP_OK);
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // Remove a given MAC address from the peer list
@@ -363,9 +363,9 @@ esp_err_t espnowRemovePeer(uint8_t *peerMac)
         log_d("Failed to remove peer: %s", esp_err_to_name(response));
 
     return (response);
-#else
+#else   // COMPILE_ESPNOW
     return (ESP_OK);
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // Update the state of the ESP Now state machine
@@ -428,7 +428,7 @@ void espnowProcessRTCM(byte incoming)
             espnowOutgoingRTCM = true;
         }
     }
-#endif
+#endif  // COMPILE_ESPNOW
 }
 
 // A blocking function that is used to pair two devices