Add initial SARA support

Author: nseidle

Firmware/RTK_Surveyor/Begin.ino

@@ -89,6 +89,13 @@ void beginBoard()
     pin_powerFastOff = 27;
     pin_adc39 = 39;
 
+    pin_radio_rx = 33;
+    pin_radio_tx = 32;
+    pin_radio_rst = 15;
+    pin_radio_pwr = 4;
+    pin_radio_cts = 5;
+    //pin_radio_rts = 255; //Not implemented
+
     pinMode(pin_powerSenseAndControl, INPUT_PULLUP);
     pinMode(pin_powerFastOff, INPUT);
 
@@ -102,6 +109,10 @@ void beginBoard()
 
     setMuxport(settings.dataPortChannel); //Set mux to user's choice: NMEA, I2C, PPS, or DAC
 
+    //CTS is active low. ESP32 pin 5 has pullup at POR. We must drive it low.
+    pinMode(pin_radio_cts, OUTPUT);
+    digitalWrite(pin_radio_cts, LOW);
+
     strcpy(platformFilePrefix, "SFE_Facet");
     strcpy(platformPrefix, "Facet");
   }
@@ -543,5 +554,54 @@ void beginExternalTriggers()
     i2cGNSS.setAutoTIMTM2callback(&eventTriggerReceived); //Enable automatic TIM TM2 messages with callback to eventTriggerReceived
   else
     i2cGNSS.setAutoTIMTM2callback(NULL);
+}
+
+//Test and begin serial1 connection with SARA
+void beginSARA()
+{
+  mySARA = new SARA_R5(pin_radio_pwr, pin_radio_rst, 3);
+
+  //mySARA->enableDebugging();
+
+  int radioBaud = 115200;
+  Serial1.begin(radioBaud, SERIAL_8N1, pin_radio_tx, pin_radio_rx); //RX, TX
+
+  if (isRadioConnected() == false)
+  {
+    log_d("Radio not detected");
+    resetSARA();
+  }
+
+  if (mySARA->begin(Serial1, radioBaud) == true)
+  {
+    log_d("Cellular connected");
+    online.cellular = true;
+  }
+  else
+  {
+    log_d("Cellular failed to connected");
+    online.cellular = false;
+  }
+}
+
+//At POR SARA is at 115200
+//SARA does not respond to AT commands for ~2s after POR
+//Quick test at 115200. Should respond immediately if not at POR.
+bool isRadioConnected()
+{
+  for (int x = 0 ; x < 5 ; x++)
+  {
+    Serial1.print("AT\r");
+    delay(10);
+
+    if (Serial1.available())
+    {
+      log_d("Radio Responded");
+      return (true);
+    }
+    delay(10);
+  }
 
+  log_d("No radio response");
+  return (false);
 }

Firmware/RTK_Surveyor/Form.ino

@@ -316,12 +316,17 @@ void createSettingsString(char* settingsCSV)
   stringRecord(settingsCSV, "fixedAltitude", settings.fixedAltitude, 4);
 
   stringRecord(settingsCSV, "enableNtripServer", settings.enableNtripServer);
-  stringRecord(settingsCSV, "wifiSSID", settings.wifiSSID);
-  stringRecord(settingsCSV, "wifiPW", settings.wifiPW);
   stringRecord(settingsCSV, "casterHost", settings.casterHost);
   stringRecord(settingsCSV, "casterPort", settings.casterPort);
-  stringRecord(settingsCSV, "mountPoint", settings.mountPoint);
-  stringRecord(settingsCSV, "mountPointPW", settings.mountPointPW);
+  stringRecord(settingsCSV, "casterUser", settings.casterUser);
+  stringRecord(settingsCSV, "casterUserPW", settings.casterUserPW);
+  stringRecord(settingsCSV, "mountPointUpload", settings.mountPointUpload);
+  stringRecord(settingsCSV, "mountPointPWUpload", settings.mountPointPWUpload);
+  stringRecord(settingsCSV, "mountPointDownload", settings.mountPointDownload);
+  stringRecord(settingsCSV, "mountPointPWDownload", settings.mountPointPWDownload);
+  stringRecord(settingsCSV, "casterTransmitGGA", settings.casterTransmitGGA);
+  stringRecord(settingsCSV, "wifiSSID", settings.wifiSSID);
+  stringRecord(settingsCSV, "wifiPW", settings.wifiPW);
 
   //Sensor Fusion Config
   stringRecord(settingsCSV, "enableSensorFusion", settings.enableSensorFusion);
@@ -404,10 +409,20 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
     strcpy(settings.casterHost, settingValueStr);
   else if (strcmp(settingName, "casterPort") == 0)
     settings.casterPort = settingValue;
-  else if (strcmp(settingName, "mountPoint") == 0)
-    strcpy(settings.mountPoint, settingValueStr);
-  else if (strcmp(settingName, "mountPointPW") == 0)
-    strcpy(settings.mountPointPW, settingValueStr);
+  else if (strcmp(settingName, "casterUser") == 0)
+    strcpy(settings.casterUser, settingValueStr);
+  else if (strcmp(settingName, "casterUserPW") == 0)
+    strcpy(settings.casterUserPW, settingValueStr);
+  else if (strcmp(settingName, "mountPointUpload") == 0)
+    strcpy(settings.mountPointUpload, settingValueStr);
+  else if (strcmp(settingName, "mountPointPWUpload") == 0)
+    strcpy(settings.mountPointPWUpload, settingValueStr);
+  else if (strcmp(settingName, "mountPointDownload") == 0)
+    strcpy(settings.mountPointDownload, settingValueStr);
+  else if (strcmp(settingName, "mountPointPWDownload") == 0)
+    strcpy(settings.mountPointPWDownload, settingValueStr);
+  else if (strcmp(settingName, "casterTransmitGGA") == 0)
+    settings.casterTransmitGGA = settingValueBool;
   else if (strcmp(settingName, "wifiSSID") == 0)
     strcpy(settings.wifiSSID, settingValueStr);
   else if (strcmp(settingName, "wifiPW") == 0)

Firmware/RTK_Surveyor/NVM.ino

@@ -152,8 +152,13 @@ void recordSystemSettingsToFile()
       settingsFile.println("enableNtripServer=" + (String)settings.enableNtripServer);
       settingsFile.println("casterHost=" + (String)settings.casterHost);
       settingsFile.println("casterPort=" + (String)settings.casterPort);
-      settingsFile.println("mountPoint=" + (String)settings.mountPoint);
-      settingsFile.println("mountPointPW=" + (String)settings.mountPointPW);
+      settingsFile.println("casterUser=" + (String)settings.casterUser);
+      settingsFile.println("casterUserPW=" + (String)settings.casterUserPW);
+      settingsFile.println("mountPointUpload=" + (String)settings.mountPointUpload);
+      settingsFile.println("mountPointPWUpload=" + (String)settings.mountPointPWUpload);
+      settingsFile.println("mountPointDownload=" + (String)settings.mountPointDownload);
+      settingsFile.println("mountPointPWDownload=" + (String)settings.mountPointPWDownload);
+      settingsFile.println("casterTransmitGGA=" + (String)settings.casterTransmitGGA);
       settingsFile.println("wifiSSID=" + (String)settings.wifiSSID);
       settingsFile.println("wifiPW=" + (String)settings.wifiPW);
       settingsFile.println("surveyInStartingAccuracy=" + (String)settings.surveyInStartingAccuracy);
@@ -392,10 +397,21 @@ bool parseLine(char* str) {
     strcpy(settings.casterHost, settingValue);
   else if (strcmp(settingName, "casterPort") == 0)
     settings.casterPort = d;
-  else if (strcmp(settingName, "mountPoint") == 0)
-    strcpy(settings.mountPoint, settingValue);
-  else if (strcmp(settingName, "mountPointPW") == 0)
-    strcpy(settings.mountPointPW, settingValue);
+
+  else if (strcmp(settingName, "casterUser") == 0)
+    strcpy(settings.casterUser, settingValue);
+  else if (strcmp(settingName, "casterUserPW") == 0)
+    strcpy(settings.casterUserPW, settingValue);
+  else if (strcmp(settingName, "mountPointUpload") == 0)
+    strcpy(settings.mountPointUpload, settingValue);
+  else if (strcmp(settingName, "mountPointPWUpload") == 0)
+    strcpy(settings.mountPointPWUpload, settingValue);
+  else if (strcmp(settingName, "mountPointDownload") == 0)
+    strcpy(settings.mountPointDownload, settingValue);
+  else if (strcmp(settingName, "mountPointPWDownload") == 0)
+    strcpy(settings.mountPointPWDownload, settingValue);
+  else if (strcmp(settingName, "casterTransmitGGA") == 0)
+    settings.casterTransmitGGA = d;
   else if (strcmp(settingName, "wifiSSID") == 0)
     strcpy(settings.wifiSSID, settingValue);
   else if (strcmp(settingName, "wifiPW") == 0)

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -39,12 +39,18 @@
     (Done) Firmware upgrade menu
     Enable various debug outputs sent over BT
 
+  TODO:
+    Change AP to 'mountPointUpload' and PW upload
+    Add mountPointDownload and PWDownload to AP config
+    Add casterTransmitGGA to AP config
+    Add casterUser/PW to AP ocnfig
+
 */
 
 const int FIRMWARE_VERSION_MAJOR = 1;
 const int FIRMWARE_VERSION_MINOR = 10;
 
-//#define COMPILE_WIFI //Comment out to remove all WiFi functionality
+#define COMPILE_WIFI //Comment out to remove all WiFi functionality
 //#define COMPILE_BT //Comment out to disable all Bluetooth
 #define ENABLE_DEVELOPER //Uncomment this line to enable special developer modes (don't check power button at startup)
 
@@ -82,6 +88,14 @@ 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;
+
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
 //I2C for GNSS, battery gauge, display, accelerometer
@@ -298,6 +312,16 @@ int incomingSettingsSpot = 0;
 unsigned long timeSinceLastIncomingSetting = 0;
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 
+//Cellular Radio
+//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+#include <SparkFun_u-blox_SARA-R5_Arduino_Library.h> //Click here to get the library: http://librarymanager/All#SparkFun_u-blox_SARA-R5_Arduino_Library
+SARA_R5 *mySARA = NULL; //We can't instantiate here because we don't yet know what pin numbers to use
+
+#include "base64.h" //Built-in ESP32 library. Needed for Caster credentials.
+
+int socketNumber = -1;
+//=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
 //Global variables
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 uint8_t unitMACAddress[6]; //Use MAC address in BT broadcast and display
@@ -358,6 +382,19 @@ bool newEventToRecord = false; //Goes true when INT pin goes high
 uint32_t triggerCount = 0; //Global copy - TM2 event counter
 uint32_t towMsR = 0; //Global copy - Time Of Week of rising edge (ms)
 uint32_t towSubMsR = 0; //Global copy - Millisecond fraction of Time Of Week of rising edge in nanoseconds
+
+long lastReceivedRTCM_ms = 0;       //5 RTCM messages take approximately ~300ms to arrive at 115200bps
+int timeBetweenGGAUpdate_ms = 10000; //GGA is required for Rev2 NTRIP casters. Don't transmit but once every 10 seconds
+long lastTransmittedGGA_ms = 0;
+
+//Used for GGA sentence parsing from incoming NMEA
+bool ggaSentenceStarted = false;
+bool ggaSentenceComplete = false;
+bool ggaTransmitComplete = false; //Goes true once we transmit GGA to the caster
+char ggaSentence[128] = {0};
+byte ggaSentenceSpot = 0;
+int ggaSentenceEndSpot = 0;
+
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
 void setup()
@@ -391,6 +428,8 @@ void setup()
 
   beginAccelerometer();
 
+  //beginSARA();
+
   beginExternalTriggers(); //Configure the time pulse output and TM2 input
 
   beginSystemState(); //Determine initial system state. Start task for button monitoring.