Add firmware update from SD example

nseidle · nseidle · commit 8e7b7ad42182 · 2020-12-18T21:03:08.000-07:00
diff --git a/Firmware/Test Sketches/SD_Update/SD_Update.ino b/Firmware/Test Sketches/SD_Update/SD_Update.ino
@@ -0,0 +1,66 @@
+/*
+  Demonstrates reading a binary file from SD and reprogramming ESP32.
+
+  To work, we must the use a partition scheme that includes OTA.
+  For RTK Surveyor, 'Minimal SPIFFS (1.9MB with OTA/190KB SPIFFS)' works well.
+*/
+
+#include <Update.h>
+
+#include "settings.h"
+
+const byte PIN_MICROSD_CHIP_SELECT = 25;
+
+//microSD Interface
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+#include <SPI.h>
+#include <SdFat.h> //SdFat (FAT32) by Bill Greiman: http://librarymanager/All#SdFat
+SdFat sd;
+SdFile gnssDataFile; //File that all gnss data is written to
+
+char settingsFileName[40] = "SFE_Surveyor_Settings.txt"; //File to read/write system settings to
+
+unsigned long lastDataLogSyncTime = 0; //Used to record to SD every half second
+long startLogTime_minutes = 0; //Mark when we start logging so we can stop logging after maxLogTime_minutes
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
+const byte menuTimeout = 15; //Menus will exit/timeout after this number of seconds
+
+int binCount = 0;
+char binFileNames[10][50];
+const char* forceFirmwareFileName = "RTK_Surveyor_Firmware_Force.bin";
+
+void setup() {
+  Serial.begin(115200);
+  delay(100);
+  Serial.println("SD Update");
+
+  beginSD(); //Test if SD is present
+
+  if (online.microSD == true)
+  {
+    Serial.println("SD online");
+    scanForFirmware();
+  }
+}
+
+
+void loop() {
+  if (Serial.available())
+  {
+    byte incoming = Serial.read();
+
+    if (incoming == '1')
+    {
+      menuFirmware();
+    }
+    else
+    {
+      Serial.println("Unknown command");
+    }
+
+    delay(10);
+    while (Serial.available()) Serial.read(); //Remote extra chars
+  }
+
+}
diff --git a/Firmware/Test Sketches/SD_Update/begin.ino b/Firmware/Test Sketches/SD_Update/begin.ino
@@ -0,0 +1,40 @@
+void beginSD()
+{
+  pinMode(PIN_MICROSD_CHIP_SELECT, OUTPUT);
+  digitalWrite(PIN_MICROSD_CHIP_SELECT, HIGH); //Be sure SD is deselected
+
+  if (settings.enableSD == true)
+  {
+    //Max power up time is 250ms: https://www.kingston.com/datasheets/SDCIT-specsheet-64gb_en.pdf
+    //Max current is 200mA average across 1s, peak 300mA
+    delay(10);
+
+    if (sd.begin(PIN_MICROSD_CHIP_SELECT, SD_SCK_MHZ(24)) == false) //Standard SdFat
+    {
+      Serial.println("SD init failed (first attempt). Trying again...\r\n");
+      //Give SD more time to power up, then try again
+      delay(250);
+      if (sd.begin(PIN_MICROSD_CHIP_SELECT, SD_SCK_MHZ(24)) == false) //Standard SdFat
+      {
+        Serial.println(F("SD init failed (second attempt). Is card present? Formatted?"));
+        digitalWrite(PIN_MICROSD_CHIP_SELECT, HIGH); //Be sure SD is deselected
+        online.microSD = false;
+        return;
+      }
+    }
+
+    //Change to root directory. All new file creation will be in root.
+    if (sd.chdir() == false)
+    {
+      Serial.println(F("SD change directory failed"));
+      online.microSD = false;
+      return;
+    }
+
+    online.microSD = true;
+  }
+  else
+  {
+    online.microSD = false;
+  }
+}
diff --git a/Firmware/Test Sketches/SD_Update/menuFirmware.ino b/Firmware/Test Sketches/SD_Update/menuFirmware.ino
@@ -0,0 +1,158 @@
+//Update firmware if bin files found
+void menuFirmware()
+{
+  if (online.microSD == false)
+  {
+    Serial.println(F("No SD card detected"));
+  }
+
+  if (binCount == 0)
+  {
+    Serial.println("No valid binary files found.");
+    delay(2000);
+    return;
+  }
+
+  while (1)
+  {
+    Serial.println();
+    Serial.println(F("Menu: Update Firmware Menu"));
+
+    for (int x = 0 ; x < binCount ; x++)
+    {
+      Serial.printf("%d) Load %s\n", x + 1, binFileNames[x]);
+    }
+
+    Serial.println(F("x) Exit"));
+
+    int incoming = getNumber(menuTimeout); //Timeout after x seconds
+
+    if (incoming > 0 && incoming < (binCount + 1))
+    {
+      //Adjust incoming to match array
+      incoming--;
+      Serial.printf("Loading %s\n", binFileNames[incoming]);
+      updateFromSD(binFileNames[incoming]);
+    }
+    else if (incoming == STATUS_PRESSED_X)
+      break;
+    else if (incoming == STATUS_GETNUMBER_TIMEOUT)
+      break;
+    else
+      Serial.printf("Bad value: %d\n", incoming);
+  }
+
+  while (Serial.available()) Serial.read(); //Empty buffer of any newline chars
+}
+
+//Looks for matching binary files in root
+//Loads a global called binCount
+void scanForFirmware()
+{
+  if (online.microSD == true)
+  {
+    //Count available binaries
+    SdFile tempFile;
+    SdFile dir;
+    const char* BIN_EXT = "bin";
+    const char* BIN_HEADER = "RTK_Surveyor_Firmware";
+    char fname[50]; //Handle long file names
+
+    dir.open("/"); //Open root
+
+    while (tempFile.openNext(&dir, O_READ))
+    {
+      if (tempFile.isFile())
+      {
+        tempFile.getName(fname, sizeof(fname));
+
+        if (strcmp(forceFirmwareFileName, fname) == 0)
+          updateFromSD((char *)forceFirmwareFileName);
+
+        //Check for 'sfe_rtk' and 'bin' extension
+        if (strcmp(BIN_EXT, &fname[strlen(fname) - strlen(BIN_EXT)]) == 0)
+        {
+          if (strstr(fname, BIN_HEADER) != NULL)
+          {
+            strcpy(binFileNames[binCount++], fname); //Add this to the array
+          }
+          else
+            Serial.printf("Unknown: %s\n", fname);
+        }
+      }
+      tempFile.close();
+    }
+  }
+}
+
+//Look for firmware file on SD card and update as needed
+void updateFromSD(char *firmwareFileName)
+{
+  Serial.printf("Loading %s\n", firmwareFileName);
+  if (sd.exists(firmwareFileName))
+  {
+    SdFile firmwareFile;
+    firmwareFile.open(firmwareFileName, O_READ);
+
+    size_t updateSize = firmwareFile.fileSize();
+    if (updateSize == 0)
+    {
+      Serial.println(F("Error: Binary is empty"));
+      firmwareFile.close();
+      return;
+    }
+
+    if (Update.begin(updateSize) == false)
+    {
+      Serial.println(F("Update begin failed. Not enough partition space available."));
+      firmwareFile.close();
+      return;
+    }
+
+    Serial.print(F("Moving file to OTA section"));
+
+    const int pageSize = 512;
+    byte dataArray[pageSize];
+    int bytesWritten = 0;
+
+    //Bulk write from the SD file to the EEPROM
+    while (firmwareFile.available())
+    {
+      int bytesToWrite = pageSize; //Max number of bytes to read
+      if (firmwareFile.available() < bytesToWrite) bytesToWrite = firmwareFile.available(); //Trim this read size as needed
+
+      firmwareFile.read(dataArray, bytesToWrite); //Read the next set of bytes from file into our temp array
+
+      if (Update.write(dataArray, bytesToWrite) != bytesToWrite)
+        Serial.println(F("Write failed"));
+      else
+        bytesWritten += bytesToWrite;
+
+      if (bytesWritten % (512 * 32) == 0) Serial.print("."); //Indicate progress
+    }
+    Serial.println(F("\nFile move complete"));
+
+    if (Update.end())
+    {
+      if (Update.isFinished())
+      {
+        Serial.println(F("Firmware updated successfully. Rebooting. Good bye!"));
+        delay(1000);
+        ESP.restart();
+      }
+      else
+        Serial.println(F("Update not finished? Something went wrong!"));
+    }
+    else
+    {
+      Serial.print(F("Error Occurred. Error #: "));
+      Serial.println(String(Update.getError()));
+    }
+
+    firmwareFile.close();
+  }
+  else
+  {
+    Serial.println(F("No firmware file found"));
+  }
+}
diff --git a/Firmware/Test Sketches/SD_Update/settings.h b/Firmware/Test Sketches/SD_Update/settings.h
@@ -0,0 +1,54 @@
+//Return values for getByteChoice()
+enum returnStatus {
+  STATUS_GETBYTE_TIMEOUT = 255,
+  STATUS_GETNUMBER_TIMEOUT = -123455555,
+  STATUS_PRESSED_X,
+};
+
+//This is all the settings that can be set on RTK Surveyor. It's recorded to NVM and the config file.
+struct struct_settings {
+  int sizeOfSettings = 0; //sizeOfSettings **must** be the first entry and must be int
+  //int rtkIdentifier = RTK_IDENTIFIER; // rtkIdentifier **must** be the second entry
+  uint8_t gnssMeasurementFrequency = 4; //Number of fixes per second
+  bool printDebugMessages = false;
+  bool enableSD = true;
+  bool enableDisplay = true;
+  bool zedOutputLogging = false;
+  bool gnssRAWOutput = false;
+  bool frequentFileAccessTimestamps = false;
+  int maxLogTime_minutes = 60*10; //Default to 10 hours
+  int observationSeconds = 60; //Default survey in time of 60 seconds
+  float observationPositionAccuracy = 5.0; //Default survey in pos accy of 5m
+  bool fixedBase = false; //Use survey-in by default
+  //bool fixedBaseCoordinateType = COORD_TYPE_ECEF;
+  double fixedEcefX = 0.0;
+  double fixedEcefY = 0.0;
+  double fixedEcefZ = 0.0;
+  double fixedLat = 0.0;
+  double fixedLong = 0.0;
+  double fixedAltitude = 0.0;
+  uint32_t dataPortBaud = 115200; //Default to 115200bps
+  uint32_t radioPortBaud = 57600; //Default to 57600bps to support connection to SiK1000 radios
+  bool outputSentenceGGA = true;
+  bool outputSentenceGSA = true;
+  bool outputSentenceGSV = true;
+  bool outputSentenceRMC = true;
+  bool outputSentenceGST = true;
+  bool enableSBAS = false; //Bug in ZED-F9P v1.13 firmware causes RTK LED to not light when RTK Floating with SBAS on.
+  bool enableNtripServer = false;
+  char casterHost[50] = "rtk2go.com"; //It's free...
+  uint16_t casterPort = 2101;
+  char mountPoint[50] = "bldr_dwntwn2";
+  char mountPointPW[50] = "WR5wRo4H";
+  char wifiSSID[50] = "TRex";
+  char wifiPW[50] = "parachutes";  
+} settings;
+
+//These are the devices on board RTK Surveyor that may be on or offline.
+struct struct_online {
+  bool microSD = false;
+  bool display = false;
+  bool dataLogging = false;
+  bool serialOutput = false;
+  bool eeprom = false;
+} online;
diff --git a/Firmware/Test Sketches/SD_Update/support.ino b/Firmware/Test Sketches/SD_Update/support.ino
