Expose BT SPP Queue size in debug menu.

Author: nseidle

Firmware/RTK_Surveyor/NVM.ino

@@ -131,7 +131,8 @@ void recordSystemSettingsToFile()
       settingsFile.println("enableHeapReport=" + (String)settings.enableHeapReport);
       settingsFile.println("dataPortChannel=" + (String)settings.dataPortChannel);
       settingsFile.println("spiFrequency=" + (String)settings.spiFrequency);
-      settingsFile.println("enableLogging=" + (String)settings.enableLogging);
+      settingsFile.println("sppRxQueueSize=" + (String)settings.sppRxQueueSize);
+      settingsFile.println("sppTxQueueSize=" + (String)settings.sppTxQueueSize);
 
       //NMEA
       settingsFile.println("message.nmea_dtm.msgRate=" + (String)settings.message.nmea_dtm.msgRate);
@@ -386,6 +387,8 @@ bool parseLine(char* str) {
   }
   else if (strcmp(settingName, "rtkIdentifier") == 0)
     settings.rtkIdentifier = d;
+  else if (strcmp(settingName, "rtkFirmwareVersion") == 0)
+  {} //Do nothing. Just read it to avoid 'Unknown setting' error
 
   else if (strcmp(settingName, "printDebugMessages") == 0)
     settings.printDebugMessages = d;
@@ -451,6 +454,10 @@ bool parseLine(char* str) {
     settings.spiFrequency = d;
   else if (strcmp(settingName, "enableLogging") == 0)
     settings.enableLogging = d;
+  else if (strcmp(settingName, "sppRxQueueSize") == 0)
+    settings.sppRxQueueSize = d;
+  else if (strcmp(settingName, "sppTxQueueSize") == 0)
+    settings.sppTxQueueSize = d;
 
   //NMEA
   else if (strcmp(settingName, "message.nmea_dtm.msgRate") == 0)

Firmware/RTK_Surveyor/System.ino

@@ -15,7 +15,7 @@ bool startBluetooth()
 
   sprintf(deviceName, "%s %s-%02X%02X", platformPrefix, stateName, unitMACAddress[4], unitMACAddress[5]); //Base mode
 
-  if (SerialBT.begin(deviceName) == false)
+  if (SerialBT.begin(deviceName, false, settings.sppRxQueueSize, settings.sppTxQueueSize) == false) //localName, isMaster, rxBufferSize, txBufferSize
   {
     Serial.println(F("An error occurred initializing Bluetooth"));
     radioState = RADIO_OFF;

Firmware/RTK_Surveyor/Tasks.ino

@@ -92,6 +92,10 @@ void F9PSerialReadTask(void *e)
 
             xSemaphoreGive(xFATSemaphore);
           } //End xFATSemaphore
+          else
+          {
+            log_d("F9SerialRead: Semaphore failed to yield");
+          }
         } //End maxLogTime
       } //End logging
     } //End serial available from GNSS

Firmware/RTK_Surveyor/menuDebug.ino

@@ -27,6 +27,12 @@ void menuDebug()
     Serial.print(settings.spiFrequency);
     Serial.println(" MHz");
 
+    Serial.print(F("4) Set SPP RX Buffer Size: "));
+    Serial.println(settings.sppRxQueueSize);
+
+    Serial.print(F("5) Set SPP TX Buffer Size: "));
+    Serial.println(settings.sppTxQueueSize);
+
     Serial.println(F("x) Exit"));
 
     byte incoming = getByteChoice(menuTimeout); //Timeout after x seconds
@@ -50,13 +56,39 @@ void menuDebug()
       int freq = getNumber(menuTimeout); //Timeout after x seconds
       if (freq < 1 || freq > 48) //Arbitrary 48 hour limit
       {
-        Serial.println(F("Error: max minutes out of range"));
+        Serial.println(F("Error: SPI frequency out of range"));
       }
       else
       {
         settings.spiFrequency = freq; //Recorded to NVM and file at main menu exit
       }
     }
+    else if (incoming == '4')
+    {
+      Serial.print(F("Enter SPP RX Queue Size in Bytes (32 to 16384): "));
+      uint16_t queSize = getNumber(menuTimeout); //Timeout after x seconds
+      if (queSize < 32 || queSize > 16384) //Arbitrary 16k limit
+      {
+        Serial.println(F("Error: Queue size out of range"));
+      }
+      else
+      {
+        settings.sppRxQueueSize = queSize; //Recorded to NVM and file at main menu exit
+      }
+    }
+    else if (incoming == '5')
+    {
+      Serial.print(F("Enter SPP TX Queue Size in Bytes (32 to 16384): "));
+      uint16_t queSize = getNumber(menuTimeout); //Timeout after x seconds
+      if (queSize < 32 || queSize > 16384) //Arbitrary 16k limit
+      {
+        Serial.println(F("Error: Queue size out of range"));
+      }
+      else
+      {
+        settings.sppTxQueueSize = queSize; //Recorded to NVM and file at main menu exit
+      }
+    }
     else if (incoming == 'x')
       break;
     else if (incoming == STATUS_GETBYTE_TIMEOUT)

Firmware/RTK_Surveyor/settings.h

@@ -278,6 +278,8 @@ struct struct_settings {
   muxConnectionType_e dataPortChannel = MUX_UBLOX_NMEA; //Mux default to ublox UART1
   uint16_t spiFrequency = 8; //By default, use 8MHz SPI
   bool enableLogging = true; //If an SD card is present, log default sentences
+  uint16_t sppRxQueueSize = 2048;
+  uint16_t sppTxQueueSize = 512;
 } settings;
 
 //These are the devices on board RTK Surveyor that may be on or offline.

Firmware/RTK_Surveyor/src/BluetoothSerial/BluetoothSerial.cpp

@@ -40,9 +40,11 @@
 
 const char * _spp_server_name = "ESP32SPP";
 
-#define RX_QUEUE_SIZE (512 * 4) //Increase to facilitate larger NTRIP transfers
+//Now passed in during begin()
+//#define RX_QUEUE_SIZE (512 * 4) //Increase to facilitate larger NTRIP transfers
 //#define RX_QUEUE_SIZE 512
-#define TX_QUEUE_SIZE 32
+//#define TX_QUEUE_SIZE 512 //Increase to facilitate high transmission rates
+//#define TX_QUEUE_SIZE 32
 #define SPP_TX_QUEUE_TIMEOUT 1000
 #define SPP_TX_DONE_TIMEOUT 1000
 #define SPP_CONGESTED_TIMEOUT 1000
@@ -485,7 +487,7 @@ static void esp_bt_gap_cb(esp_bt_gap_cb_event_t event, esp_bt_gap_cb_param_t *pa
     }
 }
 
-static bool _init_bt(const char *deviceName)
+static bool _init_bt(const char *deviceName, uint16_t rxQueueSize, uint16_t txQueueSize)
 {
     if(!_spp_event_group){
         _spp_event_group = xEventGroupCreate();
@@ -498,14 +500,14 @@ static bool _init_bt(const char *deviceName)
         xEventGroupSetBits(_spp_event_group, SPP_DISCONNECTED);
     }
     if (_spp_rx_queue == NULL){
-        _spp_rx_queue = xQueueCreate(RX_QUEUE_SIZE, sizeof(uint8_t)); //initialize the queue
+        _spp_rx_queue = xQueueCreate(rxQueueSize, sizeof(uint8_t)); //initialize the queue
         if (_spp_rx_queue == NULL){
             log_e("RX Queue Create Failed");
             return false;
         }
     }
     if (_spp_tx_queue == NULL){
-        _spp_tx_queue = xQueueCreate(TX_QUEUE_SIZE, sizeof(spp_packet_t*)); //initialize the queue
+        _spp_tx_queue = xQueueCreate(txQueueSize, sizeof(spp_packet_t *)); //initialize the queue
         if (_spp_tx_queue == NULL){
             log_e("TX Queue Create Failed");
             return false;
@@ -654,13 +656,13 @@ BluetoothSerial::~BluetoothSerial(void)
     _stop_bt();
 }
 
-bool BluetoothSerial::begin(String localName, bool isMaster)
+bool BluetoothSerial::begin(String localName, bool isMaster, uint16_t rxQueueSize, uint16_t txQueueSize)
 {
     _isMaster = isMaster;
     if (localName.length()){
         local_name = localName;
     }
-    return _init_bt(local_name.c_str());
+    return _init_bt(local_name.c_str(), rxQueueSize, txQueueSize);
 }
 
 int BluetoothSerial::available(void)

Firmware/RTK_Surveyor/src/BluetoothSerial/BluetoothSerial.h

@@ -35,7 +35,7 @@ class BluetoothSerial: public Stream
         BluetoothSerial(void);
         ~BluetoothSerial(void);
 
-        bool begin(String localName=String(), bool isMaster=false);
+        bool begin(String localName=String(), bool isMaster=false, uint16_t rxQueueSize = 512, uint16_t txQueueSize = 512);
         int available(void);
         int peek(void);
         bool hasClient(void);

Issue_Template.md

@@ -3,6 +3,7 @@ Describe your issue here. If you reference a datasheet please specify which one
 
 ### Your workbench
 * What version of RTK Surveyor firmware are you running? This can be found when the serial menu is opened (also in the settings.txt file, and in the serial output at power up).
+* Are you connected to the device over Bluetooth? What app? Are you transmitting NTRIP back to the device?
 * How is everything being powered?
 * Are there any additional details that may help us help you?