Add flush. Add sizeof to createNMEASentence. Add button. Add base LED

Author: PaulZC

Firmware/RTK_Surveyor/Begin.ino

@@ -77,6 +77,7 @@ void initializePowerPins()
     pin_zed_tx_ready = 34;
     pin_microSD_CardDetect = 36;
     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
@@ -894,6 +895,8 @@ void beginSystemState()
     firstRoverStart = true; //Allow user to enter test screen during first rover start
     if (systemState == STATE_BASE_NOT_STARTED)
       firstRoverStart = false;
+
+    setupBtn = new Button(pin_setupButton); //Create the button in memory
   }
 
   //Starts task for monitoring button presses

Firmware/RTK_Surveyor/Buttons.ino

@@ -4,12 +4,14 @@
 void powerOnCheck()
 {
   powerPressedStartTime = millis();
-  if (digitalRead(pin_powerSenseAndControl) == LOW)
-    delay(500);
+  if (pin_powerSenseAndControl >= 0)
+    if (digitalRead(pin_powerSenseAndControl) == LOW)
+      delay(500);
 
 #ifndef ENABLE_DEVELOPER
-  if (digitalRead(pin_powerSenseAndControl) != LOW)
-    powerDown(false); //Power button tap. Returning to off state.
+  if (pin_powerSenseAndControl >= 0)
+    if (digitalRead(pin_powerSenseAndControl) != LOW)
+      powerDown(false); //Power button tap. Returning to off state.
 #endif
 
   powerPressedStartTime = 0; //Reset var to return to normal 'on' state
@@ -31,11 +33,20 @@ void powerDown(bool displayInfo)
     delay(2000);
   }
 
-  pinMode(pin_powerSenseAndControl, OUTPUT);
-  digitalWrite(pin_powerSenseAndControl, LOW);
+  if (pin_powerSenseAndControl >= 0)
+  {
+    pinMode(pin_powerSenseAndControl, OUTPUT);
+    digitalWrite(pin_powerSenseAndControl, LOW);
+  }
+
+  if (pin_powerFastOff >= 0)
+  {
+    pinMode(pin_powerFastOff, OUTPUT);
+    digitalWrite(pin_powerFastOff, LOW);
+  }
 
-  pinMode(pin_powerFastOff, OUTPUT);
-  digitalWrite(pin_powerFastOff, LOW);
+  if ((productVariant == RTK_FACET) || (productVariant == RTK_FACET_LBAND) || (productVariant == REFERENCE_STATION))
+    digitalWrite(pin_peripheralPowerControl, LOW);
 
   while (1)
     delay(1);

Firmware/RTK_Surveyor/FileSdFatMMC.h

@@ -166,6 +166,16 @@ class FileSdFatMMC : public SdFile
 #endif
   };
 
+  void flush()
+  {
+    if (USE_SPI_MICROSD)
+      _sdFile->flush();
+#ifdef COMPILE_SD_MMC
+    else
+      _file->flush();
+#endif
+  };
+
   void updateFileAccessTimestamp()
   {
     if (USE_SPI_MICROSD)

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -60,39 +60,39 @@
 //Hardware connections
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 //These pins are set in beginBoard()
-int pin_batteryLevelLED_Red;
-int pin_batteryLevelLED_Green;
-int pin_positionAccuracyLED_1cm;
-int pin_positionAccuracyLED_10cm;
-int pin_positionAccuracyLED_100cm;
-int pin_baseStatusLED;
-int pin_bluetoothStatusLED;
-int pin_microSD_CS;
-int pin_zed_tx_ready;
-int pin_zed_reset;
-int pin_batteryLevel_alert;
-
-int pin_muxA;
-int pin_muxB;
-int pin_powerSenseAndControl;
-int pin_setupButton;
-int pin_powerFastOff;
-int pin_dac26;
-int pin_adc39;
-int pin_peripheralPowerControl;
-
-int pin_radio_rx;
-int pin_radio_tx;
-int pin_radio_rst;
-int pin_radio_pwr;
-int pin_radio_cts;
-int pin_radio_rts;
-
-int pin_Ethernet_CS;
-int pin_Ethernet_Interrupt;
-int pin_GNSS_CS;
-int pin_GNSS_TimePulse;
-int pin_microSD_CardDetect;
+int pin_batteryLevelLED_Red = -1;
+int pin_batteryLevelLED_Green = -1;
+int pin_positionAccuracyLED_1cm = -1;
+int pin_positionAccuracyLED_10cm = -1;
+int pin_positionAccuracyLED_100cm = -1;
+int pin_baseStatusLED = -1;
+int pin_bluetoothStatusLED = -1;
+int pin_microSD_CS = -1;
+int pin_zed_tx_ready = -1;
+int pin_zed_reset = -1;
+int pin_batteryLevel_alert = -1;
+
+int pin_muxA = -1;
+int pin_muxB = -1;
+int pin_powerSenseAndControl = -1;
+int pin_setupButton = -1;
+int pin_powerFastOff = -1;
+int pin_dac26 = -1;
+int pin_adc39 = -1;
+int pin_peripheralPowerControl = -1;
+
+int pin_radio_rx = -1;
+int pin_radio_tx = -1;
+int pin_radio_rst = -1;
+int pin_radio_pwr = -1;
+int pin_radio_cts = -1;
+int pin_radio_rts = -1;
+
+int pin_Ethernet_CS = -1;
+int pin_Ethernet_Interrupt = -1;
+int pin_GNSS_CS = -1;
+int pin_GNSS_TimePulse = -1;
+int pin_microSD_CardDetect = -1;
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
 #include "esp_ota_ops.h" //Needed for partition counting and updateFromSD
@@ -308,7 +308,6 @@ volatile bool uart2pinned = false; //This variable is touched by core 0 but chec
 
 volatile static int combinedSpaceRemaining = 0; //Overrun indicator
 volatile static long fileSize = 0; //Updated with each write
-volatile static long filePosition = 0; //Updated with each write
 int bufferOverruns = 0; //Running count of possible data losses since power-on
 
 bool zedUartPassed = false; //Goes true during testing if ESP can communicate with ZED over UART
@@ -454,7 +453,6 @@ uint8_t loggingIconDisplayed = 0; //Increases every 500ms while logging
 uint8_t espnowIconDisplayed = 0; //Increases every 500ms while transmitting
 
 uint64_t lastLogSize = 0;
-uint64_t lastLogPosition = 0;
 bool logIncreasing = false; //Goes true when log file is greater than lastLogSize or logPosition changes
 bool reuseLastLog = false; //Goes true if we have a reset due to software (rather than POR)
 
@@ -792,7 +790,7 @@ void updateLogs()
       snprintf(eventData, sizeof(eventData), "%d,%d,%d,%d", triggerCount, triggerTowMsR, triggerTowSubMsR, triggerAccEst);
 
       char nmeaMessage[82]; //Max NMEA sentence length is 82
-      createNMEASentence(CUSTOM_NMEA_TYPE_EVENT, nmeaMessage, eventData); //textID, buffer, text
+      createNMEASentence(CUSTOM_NMEA_TYPE_EVENT, nmeaMessage, sizeof(nmeaMessage), eventData); //textID, buffer, sizeOfBuffer, text
 
       if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_shortWait_ms) == pdPASS)
       {
@@ -844,11 +842,6 @@ void updateLogs()
           lastLogSize = fileSize;
           logIncreasing = true;
         }
-        else if (filePosition != lastLogPosition)
-        {
-          lastLogPosition = filePosition;
-          logIncreasing = true;
-        }        
         else
         {
           log_d("No increase in file size");

Firmware/RTK_Surveyor/States.ino

@@ -101,6 +101,9 @@ void updateSystemState()
             ledcWrite(ledBTChannel, 0); //Turn off BT LED
           }
 
+          if (productVariant == REFERENCE_STATION)
+            digitalWrite(pin_baseStatusLED, LOW);
+
           //Configure for rover mode
           displayRoverStart(0);
 
@@ -232,6 +235,9 @@ void updateSystemState()
             ledcWrite(ledBTChannel, 0); //Turn off BT LED
           }
 
+          if (productVariant == REFERENCE_STATION)
+            digitalWrite(pin_baseStatusLED, LOW);
+
           displayBaseStart(0); //Show 'Base'
 
           //Allow WiFi to continue running if NTRIP Client is needed for assisted survey in
@@ -271,7 +277,7 @@ void updateSystemState()
           {
             lastBaseLEDupdate = millis();
 
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED));
           }
 
@@ -300,7 +306,7 @@ void updateSystemState()
           {
             lastBaseLEDupdate = millis();
 
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED));
           }
 
@@ -313,7 +319,7 @@ void updateSystemState()
             systemPrintf("Observation Time: %d\r\n", svinObservationTime);
             systemPrintln("Base survey complete! RTCM now broadcasting.");
 
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, HIGH); //Indicate survey complete
 
             //Start the NTRIP server if requested
@@ -378,7 +384,7 @@ void updateSystemState()
           bool response = startFixedBase();
           if (response == true)
           {
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, HIGH); //Turn on base LED
 
             //Start the NTRIP server if requested
@@ -431,7 +437,7 @@ void updateSystemState()
             if (online.logging == true)
             {
               char nmeaMessage[82]; //Max NMEA sentence length is 82
-              createNMEASentence(CUSTOM_NMEA_TYPE_WAYPOINT, nmeaMessage, (char*)"CustomEvent"); //textID, buffer, text
+              createNMEASentence(CUSTOM_NMEA_TYPE_WAYPOINT, nmeaMessage, sizeof(nmeaMessage), (char*)"CustomEvent"); //textID, buffer, sizeOfBuffer, text
               ubxFile->println(nmeaMessage);
               logged = true;
             }
@@ -597,16 +603,19 @@ void updateSystemState()
 
       case (STATE_WIFI_CONFIG_NOT_STARTED):
         {
-          if (productVariant == RTK_SURVEYOR)
+          if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
           {
             //Start BT LED Fade to indicate start of WiFi
             btLEDTask.detach(); //Increase BT LED blinker task rate
             btLEDTask.attach(btLEDTaskPace33Hz, updateBTled); //Rate in seconds, callback
 
             digitalWrite(pin_baseStatusLED, LOW);
-            digitalWrite(pin_positionAccuracyLED_1cm, LOW);
-            digitalWrite(pin_positionAccuracyLED_10cm, LOW);
-            digitalWrite(pin_positionAccuracyLED_100cm, LOW);
+            if (productVariant == RTK_SURVEYOR)
+            {
+              digitalWrite(pin_positionAccuracyLED_1cm, LOW);
+              digitalWrite(pin_positionAccuracyLED_10cm, LOW);
+              digitalWrite(pin_positionAccuracyLED_100cm, LOW);
+            }
           }
 
           displayWiFiConfigNotStarted(); //Display immediately during SD cluster pause

Firmware/RTK_Surveyor/System.ino

@@ -489,7 +489,7 @@ void setMuxport(int channelNumber)
 //Create $GNTXT, type message complete with CRC
 //https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf
 //Used for recording system events (boot reason, event triggers, etc) inside the log
-void createNMEASentence(customNmeaType_e textID, char *nmeaMessage, char *textMessage)
+void createNMEASentence(customNmeaType_e textID, char *nmeaMessage, size_t sizeOfNmeaMessage, char *textMessage)
 {
   //Currently we don't have messages longer than 82 char max so we hardcode the sentence numbers
   const uint8_t totalNumberOfSentences = 1;
@@ -503,7 +503,7 @@ void createNMEASentence(customNmeaType_e textID, char *nmeaMessage, char *textMe
   for (byte x = 1 ; x < strlen(nmeaTxt) - 1; x++)
     CRC = CRC ^ nmeaTxt[x];
 
-  snprintf(nmeaMessage, sizeof(nmeaMessage), "%s%02X", nmeaTxt, CRC);
+  snprintf(nmeaMessage, sizeOfNmeaMessage, "%s%02X", nmeaTxt, CRC);
 }
 
 //Reset settings struct to default initializers

Firmware/RTK_Surveyor/Tasks.ino

@@ -408,21 +408,22 @@ void handleGNSSDataTask(void *e)
           long startTime = millis();
 
           sdBytesToRecord = ubxFile->write(&ringBuffer[sdTail], sliceToRecord);
+          if (USE_MMC_MICROSD)
+            ubxFile->flush();
           fileSize = ubxFile->fileSize(); //Update file size
-          filePosition = ubxFile->position(); //Update file position
 
           sdFreeSpace -= sliceToRecord; //Update remaining space on SD
 
           //Force file sync every 60s
           if (millis() - lastUBXLogSyncTime > 60000)
           {
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED)); //Blink LED to indicate logging activity
 
             ubxFile->sync();
             ubxFile->updateFileAccessTimestamp(); // Update the file access time & date
 
-            if (productVariant == RTK_SURVEYOR)
+            if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
               digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED)); //Return LED to previous state
 
             lastUBXLogSyncTime = millis();

Firmware/RTK_Surveyor/menuFirmware.ino

@@ -374,7 +374,7 @@ void updateFromSD(const char *firmwareFileName)
   //Bulk write from the SD file to flash
   while (firmwareFile.available())
   {
-    if (productVariant == RTK_SURVEYOR)
+    if ((productVariant == RTK_SURVEYOR) || (productVariant == REFERENCE_STATION))
       digitalWrite(pin_baseStatusLED, !digitalRead(pin_baseStatusLED)); //Toggle LED to indcate activity
 
     int bytesToWrite = pageSize; //Max number of bytes to read

Firmware/RTK_Surveyor/menuMessages.ino

@@ -374,7 +374,6 @@ void beginLogging(const char *customFileName)
 
         fileSize = 0;
         lastLogSize = 0; //Reset counter - used for displaying active logging icon
-        lastLogPosition = 0;
 
         bufferOverruns = 0; //Reset counter
 
@@ -404,25 +403,25 @@ void beginLogging(const char *customFileName)
 
         //Mark top of log with system information
         char nmeaMessage[82]; //Max NMEA sentence length is 82
-        createNMEASentence(CUSTOM_NMEA_TYPE_RESET_REASON, nmeaMessage, rstReason); //textID, buffer, text
+        createNMEASentence(CUSTOM_NMEA_TYPE_RESET_REASON, nmeaMessage, sizeof(nmeaMessage), rstReason); //textID, buffer, sizeOfBuffer, text
         ubxFile->println(nmeaMessage);
 
         //Record system firmware versions and info to log
 
         //SparkFun RTK Express v1.10-Feb 11 2022
         char firmwareVersion[30]; //v1.3 December 31 2021
         snprintf(firmwareVersion, sizeof(firmwareVersion), "v%d.%d-%s", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, __DATE__);
-        createNMEASentence(CUSTOM_NMEA_TYPE_SYSTEM_VERSION, nmeaMessage, firmwareVersion); //textID, buffer, text
+        createNMEASentence(CUSTOM_NMEA_TYPE_SYSTEM_VERSION, nmeaMessage, sizeof(nmeaMessage), firmwareVersion); //textID, buffer, sizeOfBuffer, text
         ubxFile->println(nmeaMessage);
 
         //ZED-F9P firmware: HPG 1.30
-        createNMEASentence(CUSTOM_NMEA_TYPE_ZED_VERSION, nmeaMessage, zedFirmwareVersion); //textID, buffer, text
+        createNMEASentence(CUSTOM_NMEA_TYPE_ZED_VERSION, nmeaMessage, sizeof(nmeaMessage), zedFirmwareVersion); //textID, buffer, sizeOfBuffer, text
         ubxFile->println(nmeaMessage);
 
         //Device BT MAC. See issue: https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/346
         char macAddress[5];
         snprintf(macAddress, sizeof(macAddress), "%02X%02X", btMACAddress[4], btMACAddress[5]);
-        createNMEASentence(CUSTOM_NMEA_TYPE_DEVICE_BT_ID, nmeaMessage, macAddress); //textID, buffer, text
+        createNMEASentence(CUSTOM_NMEA_TYPE_DEVICE_BT_ID, nmeaMessage, sizeof(nmeaMessage), macAddress); //textID, buffer, sizeOfBuffer, text
         ubxFile->println(nmeaMessage);
 
         if (reuseLastLog == true)
@@ -467,7 +466,7 @@ void endLogging(bool gotSemaphore, bool releaseSemaphore)
               failedParserMessages_UBX);
 
       char nmeaMessage[82]; //Max NMEA sentence length is 82
-      createNMEASentence(CUSTOM_NMEA_TYPE_PARSER_STATS, nmeaMessage, parserStats); //textID, buffer, text
+      createNMEASentence(CUSTOM_NMEA_TYPE_PARSER_STATS, nmeaMessage, sizeof(nmeaMessage), parserStats); //textID, buffer, sizeOfBuffer, text
       ubxFile->println(nmeaMessage);
       ubxFile->sync();
 
@@ -842,7 +841,7 @@ void updateLogTest()
     snprintf(logMessage, sizeof(logMessage), "Start log test: %dHz, %dMsg, %dMS", rate, messages, semaphoreWait);
 
     char nmeaMessage[100]; //Max NMEA sentence length is 82
-    createNMEASentence(CUSTOM_NMEA_TYPE_LOGTEST_STATUS, nmeaMessage, logMessage); //textID, buffer, text
+    createNMEASentence(CUSTOM_NMEA_TYPE_LOGTEST_STATUS, nmeaMessage, sizeof(nmeaMessage), logMessage); //textID, buffer, sizeOfBuffer, text
 
     if (xSemaphoreTake(sdCardSemaphore, fatSemaphore_longWait_ms) == pdPASS)
     {