//Text

Author: PaulZC

Firmware/RTK_Surveyor/Base.ino

@@ -15,7 +15,7 @@ bool configureUbloxModuleBase()
 
   theGNSS.checkUblox(); //Regularly poll to get latest data and any RTCM
 
-  theGNSS.setNMEAGPGGAcallbackPtr(nullptr); // Disable GPGGA call back that may have been set during Rover NTRIP Client mode
+  theGNSS.setNMEAGPGGAcallbackPtr(nullptr); //Disable GPGGA call back that may have been set during Rover NTRIP Client mode
 
   bool response = true;
 
@@ -27,13 +27,13 @@ bool configureUbloxModuleBase()
   //Since we are at 1Hz, allow GSV NMEA to be reported at whatever the user has chosen
   response &= theGNSS.addCfgValset(settings.ubxMessages[8].msgConfigKey, settings.ubxMessages[8].msgRate); //Update rate on module
 
-  response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_NMEA_ID_GGA_I2C, 0); // Disable NMEA message that may have been set during Rover NTRIP Client mode
+  response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_NMEA_ID_GGA_I2C, 0); //Disable NMEA message that may have been set during Rover NTRIP Client mode
 
   //Survey mode is only available on ZED-F9P modules
   if (zedModuleType == PLATFORM_F9P)
     response &= theGNSS.addCfgValset(UBLOX_CFG_TMODE_MODE, 0); //Disable survey-in mode
 
-  response &= theGNSS.addCfgValset(UBLOX_CFG_NAVSPG_DYNMODEL, (dynModel)settings.dynamicModel); // Set dynamic model
+  response &= theGNSS.addCfgValset(UBLOX_CFG_NAVSPG_DYNMODEL, (dynModel)settings.dynamicModel); //Set dynamic model
 
   //RTCM is only available on ZED-F9P modules
   //
@@ -69,7 +69,7 @@ bool configureUbloxModuleBase()
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1124_UART1, 1);
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1230_UART1, 10);
   }
-  else // SPI GNSS
+  else //SPI GNSS
   {
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1005_SPI, 1);
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1074_SPI, 1);
@@ -78,20 +78,20 @@ bool configureUbloxModuleBase()
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1124_SPI, 1);
     response &= theGNSS.addCfgValset(UBLOX_CFG_MSGOUT_RTCM_3X_TYPE1230_SPI, 10);  //Enable message every 10 cycles - note: this may conflict with settings and setMessages?
 
-    // Enable logging of these messages so the RTCM will be stored automatically in the logging buffer.
-    // This mimics the data arriving via UART1.
+    //Enable logging of these messages so the RTCM will be stored automatically in the logging buffer.
+    //This mimics the data arriving via UART1.
     uint32_t logRTCMMessages = theGNSS.getRTCMLoggingMask();
     logRTCMMessages |= ( SFE_UBLOX_FILTER_RTCM_TYPE1005 | SFE_UBLOX_FILTER_RTCM_TYPE1074 | SFE_UBLOX_FILTER_RTCM_TYPE1084
                        | SFE_UBLOX_FILTER_RTCM_TYPE1094 | SFE_UBLOX_FILTER_RTCM_TYPE1124 | SFE_UBLOX_FILTER_RTCM_TYPE1230 );
     theGNSS.setRTCMLoggingMask(logRTCMMessages);
     log_d("setRTCMLoggingMask 0x%X", logRTCMMessages);
 
-    // Update settings, otherwise setMessages could disable these again...
+    //Update settings, otherwise setMessages could disable these again...
     for (int x = 0; x < MAX_UBX_MSG; x++)
     {
-      if (settings.ubxMessages[x].msgClass == UBX_RTCM_MSB) // RTCM messages
+      if (settings.ubxMessages[x].msgClass == UBX_RTCM_MSB) //RTCM messages
       {
-        if (settings.ubxMessages[x].filterMask & // This is quicker than checking the msgID
+        if (settings.ubxMessages[x].filterMask & //This is quicker than checking the msgID
           ( SFE_UBLOX_FILTER_RTCM_TYPE1005 | SFE_UBLOX_FILTER_RTCM_TYPE1074 | SFE_UBLOX_FILTER_RTCM_TYPE1084
           | SFE_UBLOX_FILTER_RTCM_TYPE1094 | SFE_UBLOX_FILTER_RTCM_TYPE1124))
           settings.ubxMessages[x].msgRate = 1;

Firmware/RTK_Surveyor/Begin.ino

@@ -29,7 +29,7 @@ void identifyBoard()
   }
   else
   {
-    productVariant = RTK_UNKNOWN; // Need to wait until the GNSS and Accel have been initialized
+    productVariant = RTK_UNKNOWN; //Need to wait until the GNSS and Accel have been initialized
   }
 }
 
@@ -79,8 +79,8 @@ void initializePowerPins()
     pin_Ethernet_Interrupt = 33;
     pin_setupButton = 0;
 
-    pin_radio_rx = 17; // Radio RX In = ESP TX Out
-    pin_radio_tx = 16; // Radio TX Out = ESP RX In
+    pin_radio_rx = 17; //Radio RX In = ESP TX Out
+    pin_radio_tx = 16; //Radio TX Out = ESP RX In
 
     pinMode(pin_Ethernet_CS, OUTPUT);
     digitalWrite(pin_Ethernet_CS, HIGH);
@@ -219,9 +219,9 @@ void beginBoard()
 #ifdef COMPILE_SD_MMC
   else if (productVariant == REFERENCE_STATION)
   {
-    // No powerOnCheck
+    //No powerOnCheck
 
-    settings.enablePrintBatteryMessages = false; // No pesky battery messages
+    settings.enablePrintBatteryMessages = false; //No pesky battery messages
 
     strncpy(platformFilePrefix, "SFE_Reference_Station", sizeof(platformFilePrefix) - 1);
     strncpy(platformPrefix, "Reference Station", sizeof(platformPrefix) - 1);
@@ -388,7 +388,7 @@ void beginSD()
 
       //TODO: add Card Detect input and check hot insertion
 
-      // SDIO MMC
+      //SDIO MMC
       if (SD_MMC.begin() == false)
       {
         int tries = 0;
@@ -451,10 +451,6 @@ void endSD(bool alreadyHaveSemaphore, bool releaseSemaphore)
   {
     if (USE_SPI_MICROSD)
       sd->end();
-#ifdef COMPILE_SD_MMC
-//    else
-//      SD_MMC.end(); // NO!! DO NOT!!
-#endif
     online.microSD = false;
     systemPrintln("microSD: Offline");
   }
@@ -518,7 +514,7 @@ void beginUART2()
       "UARTStart", //Just for humans
       2000, //Stack Size
       nullptr, //Task input parameter
-      0, // Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
+      0, //Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
       &pinUART2TaskHandle, //Task handle
       0); //Core where task should run, 0=core, 1=Arduino
 
@@ -531,15 +527,15 @@ void pinUART2Task( void *pvParameters )
 {
 //Note: ESP32 2.0.6 does some strange auto-bauding thing here which takes 20s to complete if there is no data for it to auto-baud.
 //      That's fine for most RTK products, but causes the Ref Stn to stall for 20s. However, it doesn't stall with ESP32 2.0.2...
-//      Note to my future self: uncomment these lines to prevent the stall if/when we upgrade to ESP32 ~2.0.6.
+//      Uncomment these lines to prevent the stall if/when we upgrade to ESP32 ~2.0.6.
 //#if defined(ENABLE_DEVELOPER) && defined(REF_STN_GNSS_DEBUG)
 //  if (productVariant == REFERENCE_STATION)
 //#else
 //  if (USE_I2C_GNSS)
 //#endif
   {
-    serialGNSS.setRxBufferSize(settings.uartReceiveBufferSize); // TODO: work out if we can reduce or skip this when using SPI GNSS
-    serialGNSS.setTimeout(settings.serialTimeoutGNSS); // Requires serial traffic on the UART pins for detection
+    serialGNSS.setRxBufferSize(settings.uartReceiveBufferSize); //TODO: work out if we can reduce or skip this when using SPI GNSS
+    serialGNSS.setTimeout(settings.serialTimeoutGNSS); //Requires serial traffic on the UART pins for detection
     serialGNSS.begin(settings.dataPortBaud); //UART2 on pins 16/17 for SPP. The ZED-F9P will be configured to output NMEA over its UART1 at the same rate.
 
     //Reduce threshold value above which RX FIFO full interrupt is generated
@@ -575,11 +571,11 @@ void beginGNSS()
   //If we're using SPI, then increase the logging buffer
   if (USE_SPI_GNSS)
   {
-    SPI.begin(); // Begin SPI here - beginSD has not yet been called
+    SPI.begin(); //Begin SPI here - beginSD has not yet been called
 
-    // setFileBufferSize must be called _before_ .begin
-    // Use gnssHandlerBufferSize for now. TODO: work out if the SPI GNSS needs its own buffer size setting
-    // Also used by Tasks.ino
+    //setFileBufferSize must be called _before_ .begin
+    //Use gnssHandlerBufferSize for now. TODO: work out if the SPI GNSS needs its own buffer size setting
+    //Also used by Tasks.ino
     theGNSS.setFileBufferSize(settings.gnssHandlerBufferSize);
   }
 
@@ -614,7 +610,7 @@ void beginGNSS()
         return;
       }
     }
-    if (theGNSS.getFileBufferSize() != settings.gnssHandlerBufferSize) // Need to call getFileBufferSize after begin
+    if (theGNSS.getFileBufferSize() != settings.gnssHandlerBufferSize) //Need to call getFileBufferSize after begin
     {
       log_d("GNSS offline - no RAM for file buffer");
       displayGNSSFail(1000);
@@ -630,19 +626,19 @@ void beginGNSS()
   theGNSS.autoSendCfgValsetAtSpaceRemaining(16);
 
   //Check the firmware version of the ZED-F9P. Based on Example21_ModuleInfo.
-  if (theGNSS.getModuleInfo(1100) == true) // Try to get the module info
+  if (theGNSS.getModuleInfo(1100) == true) //Try to get the module info
   {
-    // Reconstruct the firmware version
+    //Reconstruct the firmware version
     snprintf(zedFirmwareVersion, sizeof(zedFirmwareVersion), "%s %d.%02d", theGNSS.getFirmwareType(), theGNSS.getFirmwareVersionHigh(), theGNSS.getFirmwareVersionLow());
 
-    // Construct the firmware version as uint8_t. Note: will fail above 2.55!
+    //Construct the firmware version as uint8_t. Note: will fail above 2.55!
     zedFirmwareVersionInt = (theGNSS.getFirmwareVersionHigh() * 100) + theGNSS.getFirmwareVersionLow();
 
-    // Check this is known firmware
-    // "1.20" - Mostly for F9R HPS 1.20, but also F9P HPG v1.20 Spartan future support
-    // "1.21" - Future F9R HPS v1.21
-    // "1.30" - ZED-F9P (HPG) released Dec, 2021. Also ZED-F9R (HPS) released Sept, 2022
-    // "1.32" - ZED-F9P released May, 2022
+    //Check this is known firmware
+    //"1.20" - Mostly for F9R HPS 1.20, but also F9P HPG v1.20 Spartan future support
+    //"1.21" - Future F9R HPS v1.21
+    //"1.30" - ZED-F9P (HPG) released Dec, 2021. Also ZED-F9R (HPS) released Sept, 2022
+    //"1.32" - ZED-F9P released May, 2022
 
     const uint8_t knownFirmwareVersions[] = { 100, 112, 113, 120, 121, 130, 132 };
     bool knownFirmware = false;
@@ -680,8 +676,8 @@ void configureGNSS()
 {
   if (online.gnss == false) return;
 
-  theGNSS.setAutoPVTcallbackPtr(&storePVTdata); // Enable automatic NAV PVT messages with callback to storePVTdata
-  theGNSS.setAutoHPPOSLLHcallbackPtr(&storeHPdata); // Enable automatic NAV HPPOSLLH messages with callback to storeHPdata
+  theGNSS.setAutoPVTcallbackPtr(&storePVTdata); //Enable automatic NAV PVT messages with callback to storePVTdata
+  theGNSS.setAutoHPPOSLLHcallbackPtr(&storeHPdata); //Enable automatic NAV HPPOSLLH messages with callback to storeHPdata
 
   //Configuring the ZED can take more than 2000ms. We save configuration to
   //ZED so there is no need to update settings unless user has modified
@@ -752,7 +748,7 @@ void beginLEDs()
 //Configure the on board MAX17048 fuel gauge
 void beginFuelGauge()
 {
-  // Set up the MAX17048 LiPo fuel gauge
+  //Set up the MAX17048 LiPo fuel gauge
   if (lipo.begin() == false)
   {
     systemPrintln("Fuel gauge not detected.");
@@ -908,11 +904,11 @@ bool beginExternalTriggers()
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_PULSE_LENGTH_DEF, 1); //Define timepulse by length (not ratio)
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_POL_TP1, settings.externalPulsePolarity); //0 = falling, 1 = raising edge
 
-  // While the module is _locking_ to GNSS time, turn off pulse
+  //While the module is _locking_ to GNSS time, turn off pulse
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_PERIOD_TP1, 1000000); //Set the period between pulses in us
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_LEN_TP1, 0); //Set the pulse length in us
 
-  // When the module is _locked_ to GNSS time, make it generate 1kHz
+  //When the module is _locked_ to GNSS time, make it generate 1kHz
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_PERIOD_LOCK_TP1, settings.externalPulseTimeBetweenPulse_us); //Set the period between pulses is us
   response &= theGNSS.addCfgValset(UBLOX_CFG_TP_LEN_LOCK_TP1, settings.externalPulseLength_us); //Set the pulse length in us
   response &= theGNSS.sendCfgValset();
@@ -945,7 +941,7 @@ void beginIdleTasks()
           taskName, //Just for humans
           2000, //Stack Size
           nullptr, //Task input parameter
-          0, // Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
+          0, //Priority, with 3 (configMAX_PRIORITIES - 1) being the highest, and 0 being the lowest
           &idleTaskHandle[index], //Task handle
           index); //Core where task should run, 0=core, 1=Arduino
     }

Firmware/RTK_Surveyor/Bluetooth.ino

@@ -20,19 +20,19 @@
   =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 
 //----------------------------------------
-// Constants
+//Constants
 //----------------------------------------
 
 //----------------------------------------
-// Locals - compiled out
+//Locals - compiled out
 //----------------------------------------
 
 #ifdef COMPILE_BT
 BTSerialInterface *bluetoothSerial;
 static volatile byte bluetoothState = BT_OFF;
 
 //----------------------------------------
-// Bluetooth Routines - compiled out
+//Bluetooth Routines - compiled out
 //----------------------------------------
 
 //Call back for when BT connection event happens (connected/disconnect)
@@ -61,7 +61,7 @@ void bluetoothCallback(esp_spp_cb_event_t event, esp_spp_cb_param_t *param) {
 #endif  //COMPILE_BT
 
 //----------------------------------------
-// Global Bluetooth Routines
+//Global Bluetooth Routines
 //----------------------------------------
 
 //Return the Bluetooth state
@@ -155,7 +155,7 @@ void bluetoothStart()
 
     snprintf(deviceName, sizeof(deviceName), "%s %s%02X%02X", platformPrefix, stateName, btMACAddress[4], btMACAddress[5]);
 
-    // Select Bluetooth setup
+    //Select Bluetooth setup
     if (settings.bluetoothRadioType == BLUETOOTH_RADIO_OFF)
       return;
     else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP)

Firmware/RTK_Surveyor/Display.ino

@@ -1,5 +1,5 @@
 //----------------------------------------
-// Constants
+//Constants
 //----------------------------------------
 
 //A bitfield is used to flag which icon needs to be illuminated
@@ -60,7 +60,7 @@
 #define ICON_LOGGING                     (1<<6) // right, bottom
 
 //----------------------------------------
-// Locals
+//Locals
 //----------------------------------------
 
 static QwiicMicroOLED oled;
@@ -71,16 +71,16 @@ static uint32_t iconsRadio;
 unsigned long ssidDisplayTimer = 0;
 bool ssidDisplayFirstHalf = false;
 
-// Fonts
+//Fonts
 #include <res/qw_fnt_5x7.h>
 #include <res/qw_fnt_8x16.h>
 #include <res/qw_fnt_largenum.h>
 
-// Icons
+//Icons
 #include "icons.h"
 
 //----------------------------------------
-// Routines
+//Routines
 //----------------------------------------
 
 void beginDisplay()
@@ -478,7 +478,7 @@ void displaySplash()
   {
     //Display SparkFun Logo for at least 1/10 of a second
     unsigned long minSplashFor = 100;
-    if (productVariant == REFERENCE_STATION) // Reference station starts up very quickly. Keep splash on for longer
+    if (productVariant == REFERENCE_STATION) //Reference station starts up very quickly. Keep splash on for longer
       minSplashFor = 1000;
     while ((millis() - splashStart) < minSplashFor)
       delay(10);
@@ -547,7 +547,7 @@ void displayError(const char * errorMessage)
 {
   if (online.display == true)
   {
-    oled.erase(); // Clear the display's internal buffer
+    oled.erase(); //Clear the display's internal buffer
 
     oled.setCursor(0, 0); //x, y
     oled.setFont(QW_FONT_5X7); //Set font to smallest
@@ -1588,7 +1588,7 @@ void displayRoverStart(uint16_t displayTime)
     uint8_t yPos = oled.getHeight() / 2 - fontHeight;
 
     printTextCenter("Rover", yPos, QW_FONT_8X16, 1, false);  //text, y, font type, kerning, inverted
-    //  printTextCenter("Started", yPos + fontHeight, QW_FONT_8X16, 1, false);  //text, y, font type, kerning, inverted
+    //printTextCenter("Started", yPos + fontHeight, QW_FONT_8X16, 1, false);  //text, y, font type, kerning, inverted
 
     oled.display();
 
@@ -1844,7 +1844,7 @@ void displayFirmwareUpdateProgress(int percentComplete)
   //Update the display if connected
   if (online.display == true)
   {
-    oled.erase(); // Clear the display's internal buffer
+    oled.erase(); //Clear the display's internal buffer
 
     int yPos = 3;
     int fontHeight = 8;