Add back custom version of BluetoothSerial

This originally comes from RTK Firmware ~v2.0. This change exposes the TX/RX buffer sizes so that we can dynamically set them (from settings) at run time. The BluetoothSerial library defaults to 512 bytes in the RX buffer. Because RTCM is ~530 to 600 bytes, there are times when the btReadTask cannot keep up and an RTCM sentence is corrupted. This change reduces the number of RTCM bytes dropped during SPP from the phone. By default, this will increase the overall RAM usage by 512 bytes.

Author: nseidle

Firmware/RTK_Surveyor/Bluetooth.ino

@@ -180,7 +180,8 @@ void bluetoothStart()
         // while (bluetoothPinned == false) // Wait for task to run once
         //     delay(1);
 
-        if (bluetoothSerial->begin(deviceName) == false)
+        if (bluetoothSerial->begin(deviceName, false, settings.sppRxQueueSize, settings.sppTxQueueSize) ==
+            false) // localName, isMaster, rxBufferSize, txBufferSize
         {
             systemPrintln("An error occurred initializing Bluetooth");
 
@@ -235,7 +236,8 @@ void bluetoothStart()
 void pinBluetoothTask(void *pvParameters)
 {
 #ifdef COMPILE_BT
-    if (bluetoothSerial->begin(deviceName) == false)
+    if (bluetoothSerial->begin(deviceName, false, settings.sppRxQueueSize, settings.sppTxQueueSize) ==
+        false) // localName, isMaster, rxBufferSize,
     {
         systemPrintln("An error occurred initializing Bluetooth");
 
@@ -246,7 +248,7 @@ void pinBluetoothTask(void *pvParameters)
     bluetoothPinned = true;
 
     vTaskDelete(nullptr); // Delete task once it has run once
-#endif // COMPILE_BT
+#endif                    // COMPILE_BT
 }
 
 // This function stops BT so that it can be restarted later

Firmware/RTK_Surveyor/bluetoothSelect.h

@@ -1,12 +1,16 @@
 #ifdef COMPILE_BT
 
-#include "BluetoothSerial.h"
+//We use a local copy of the BluetoothSerial library so that we can increase the RX buffer. See issues: 
+//https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/23
+//https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/469
+#include "src/BluetoothSerial/BluetoothSerial.h"
+
 #include <BleSerial.h> //Click here to get the library: http://librarymanager/All#ESP32_BleSerial v1.0.4 by Avinab Malla
 
 class BTSerialInterface
 {
   public:
-    virtual bool begin(String deviceName) = 0;
+    virtual bool begin(String deviceName, bool isMaster, uint16_t rxQueueSize, uint16_t txQueueSize) = 0;
     virtual void disconnect() = 0;
     virtual void end() = 0;
     virtual esp_err_t register_callback(esp_spp_cb_t *callback) = 0;
@@ -27,9 +31,9 @@ class BTClassicSerial : public virtual BTSerialInterface, public BluetoothSerial
     // Everything is already implemented in BluetoothSerial since the code was
     // originally written using that class
   public:
-    bool begin(String deviceName)
+    bool begin(String deviceName, bool isMaster, uint16_t rxQueueSize, uint16_t txQueueSize)
     {
-        return BluetoothSerial::begin(deviceName);
+        return BluetoothSerial::begin(deviceName, isMaster, rxQueueSize, txQueueSize);
     }
 
     void disconnect()
@@ -87,7 +91,7 @@ class BTLESerial : public virtual BTSerialInterface, public BleSerial
 {
   public:
     // Missing from BleSerial
-    bool begin(String deviceName)
+    bool begin(String deviceName, bool isMaster, uint16_t rxQueueSize, uint16_t txQueueSize)
     {
         BleSerial::begin(deviceName.c_str());
         return true;

Firmware/RTK_Surveyor/settings.h

@@ -753,8 +753,8 @@ typedef struct
     bool enableLogging = true;                            // If an SD card is present, log default sentences
     bool enableARPLogging = false;      // Log the Antenna Reference Position from RTCM 1005/1006 - if available
     uint16_t ARPLoggingInterval_s = 10; // Log the ARP every 10 seconds - if available
-    uint16_t sppRxQueueSize = 2048;
-    uint16_t sppTxQueueSize = 512;
+    uint16_t sppRxQueueSize = 512 * 2;
+    uint16_t sppTxQueueSize = 32;
     uint8_t dynamicModel = DYN_MODEL_PORTABLE;
     SystemState lastState = STATE_NOT_SET; // Start unit in last known state
     bool enableSensorFusion = false; // If IMU is available, avoid using it unless user specifically selects automotive

Firmware/RTK_Surveyor/src/BluetoothSerial/BTAddress.cpp

@@ -0,0 +1,96 @@
+/*
+ * BTAddress.cpp
+ *
+ *  Created on: Jul 2, 2017
+ *      Author: kolban
+ *  Ported  on: Feb 5, 2021
+ *      Author: Thomas M. (ArcticSnowSky)
+ */
+#include "sdkconfig.h"
+#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BLUEDROID_ENABLED)
+
+#include "BTAddress.h"
+#include <string>
+#include <sstream>
+#include <iomanip>
+#include <string.h>
+#include <stdio.h>
+#include <malloc.h>
+#ifdef ARDUINO_ARCH_ESP32
+#include "esp32-hal-log.h"
+#endif
+
+
+/**
+ * @brief Create an address from the native ESP32 representation.
+ * @param [in] address The native representation.
+ */
+BTAddress::BTAddress(esp_bd_addr_t address) {
+	memcpy(m_address, address, ESP_BD_ADDR_LEN);
+} // BTAddress
+
+
+/**
+ * @brief Create an address from a hex string
+ *
+ * A hex string is of the format:
+ * ```
+ * 00:00:00:00:00:00
+ * ```
+ * which is 17 characters in length.
+ *
+ * @param [in] stringAddress The hex representation of the address.
+ */
+BTAddress::BTAddress(std::string stringAddress) {
+	if (stringAddress.length() != 17) return;
+
+	int data[6];
+	sscanf(stringAddress.c_str(), "%x:%x:%x:%x:%x:%x", &data[0], &data[1], &data[2], &data[3], &data[4], &data[5]);
+	m_address[0] = (uint8_t) data[0];
+	m_address[1] = (uint8_t) data[1];
+	m_address[2] = (uint8_t) data[2];
+	m_address[3] = (uint8_t) data[3];
+	m_address[4] = (uint8_t) data[4];
+	m_address[5] = (uint8_t) data[5];
+} // BTAddress
+
+
+/**
+ * @brief Determine if this address equals another.
+ * @param [in] otherAddress The other address to compare against.
+ * @return True if the addresses are equal.
+ */
+bool BTAddress::equals(BTAddress otherAddress) {
+	return memcmp(otherAddress.getNative(), m_address, 6) == 0;
+} // equals
+
+
+/**
+ * @brief Return the native representation of the address.
+ * @return The native representation of the address.
+ */
+esp_bd_addr_t *BTAddress::getNative() {
+	return &m_address;
+} // getNative
+
+
+/**
+ * @brief Convert a BT address to a string.
+ *
+ * A string representation of an address is in the format:
+ *
+ * ```
+ * xx:xx:xx:xx:xx:xx
+ * ```
+ *
+ * @return The string representation of the address.
+ */
+std::string BTAddress::toString() {
+	auto size = 18;
+	char *res = (char*)malloc(size);
+	snprintf(res, size, "%02x:%02x:%02x:%02x:%02x:%02x", m_address[0], m_address[1], m_address[2], m_address[3], m_address[4], m_address[5]);
+	std::string ret(res);
+	free(res);
+	return ret;
+} // toString
+#endif

Firmware/RTK_Surveyor/src/BluetoothSerial/BTAddress.h

@@ -0,0 +1,36 @@
+/*
+ * BTAddress.h
+ *
+ *  Created on: Jul 2, 2017
+ *      Author: kolban
+ *  Ported  on: Feb 5, 2021
+ *      Author: Thomas M. (ArcticSnowSky)
+ */
+
+#ifndef COMPONENTS_CPP_UTILS_BTADDRESS_H_
+#define COMPONENTS_CPP_UTILS_BTADDRESS_H_
+#include "sdkconfig.h"
+#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BLUEDROID_ENABLED)
+#include <esp_gap_bt_api.h> // ESP32 BT
+#include <string>
+
+
+/**
+ * @brief A %BT device address.
+ *
+ * Every %BT device has a unique address which can be used to identify it and form connections.
+ */
+class BTAddress {
+public:
+	BTAddress(esp_bd_addr_t address);
+	BTAddress(std::string stringAddress);
+	bool           equals(BTAddress otherAddress);
+	esp_bd_addr_t* getNative();
+	std::string    toString();
+
+private:
+	esp_bd_addr_t m_address;
+};
+
+#endif /* CONFIG_BT_ENABLED */
+#endif /* COMPONENTS_CPP_UTILS_BTADDRESS_H_ */

Firmware/RTK_Surveyor/src/BluetoothSerial/BTAdvertisedDevice.h

@@ -0,0 +1,65 @@
+/*
+ * BTAdvertisedDevice.h
+ *
+ *  Created on: Feb 5, 2021
+ *      Author: Thomas M. (ArcticSnowSky)
+ */
+
+#ifndef __BTADVERTISEDDEVICE_H__
+#define __BTADVERTISEDDEVICE_H__
+
+#include "BTAddress.h"
+
+
+class BTAdvertisedDevice {
+public:
+    virtual ~BTAdvertisedDevice() = default;
+
+    virtual BTAddress   getAddress();
+    virtual uint32_t    getCOD();
+    virtual std::string getName();
+    virtual int8_t      getRSSI();
+
+
+    virtual bool        haveCOD();
+    virtual bool        haveName();
+    virtual bool        haveRSSI();
+
+    virtual std::string toString();
+};
+
+class BTAdvertisedDeviceSet : public virtual BTAdvertisedDevice {
+public:
+    BTAdvertisedDeviceSet();
+    //~BTAdvertisedDeviceSet() = default;
+    
+
+    BTAddress   getAddress();
+    uint32_t    getCOD();
+    std::string getName();
+    int8_t      getRSSI();
+
+
+    bool        haveCOD();
+    bool        haveName();
+    bool        haveRSSI();
+
+    std::string toString();
+
+    void setAddress(BTAddress address);
+    void setCOD(uint32_t cod);
+    void setName(std::string name);
+    void setRSSI(int8_t rssi);
+
+    bool m_haveCOD;
+    bool m_haveName;
+    bool m_haveRSSI;
+
+
+    BTAddress   m_address = BTAddress((uint8_t*)"\0\0\0\0\0\0");
+    uint32_t    m_cod;
+    std::string m_name;
+    int8_t      m_rssi;
+};
+
+#endif

Firmware/RTK_Surveyor/src/BluetoothSerial/BTAdvertisedDeviceSet.cpp

@@ -0,0 +1,78 @@
+/*
+ * BTAdvertisedDeviceSet.cpp
+ *
+ *  Created on: Feb 5, 2021
+ *      Author: Thomas M. (ArcticSnowSky)
+ */
+
+#include "sdkconfig.h"
+#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BLUEDROID_ENABLED)
+
+//#include <map>
+
+#include "BTAdvertisedDevice.h"
+//#include "BTScan.h"
+
+
+BTAdvertisedDeviceSet::BTAdvertisedDeviceSet() {
+	m_cod		       = 0;
+	m_name             = "";
+	m_rssi             = 0;
+
+	m_haveCOD	       = false;
+	m_haveName         = false;
+	m_haveRSSI         = false;
+} // BTAdvertisedDeviceSet
+
+BTAddress   BTAdvertisedDeviceSet::getAddress()    { return m_address; }
+uint32_t    BTAdvertisedDeviceSet::getCOD()        { return m_cod; }
+std::string BTAdvertisedDeviceSet::getName()       { return m_name; }
+int8_t      BTAdvertisedDeviceSet::getRSSI()	    { return m_rssi; }
+
+
+bool        BTAdvertisedDeviceSet::haveCOD()   { return m_haveCOD; }
+bool        BTAdvertisedDeviceSet::haveName()  { return m_haveName; }
+bool        BTAdvertisedDeviceSet::haveRSSI()  { return m_haveRSSI; }
+
+/**
+ * @brief Create a string representation of this device.
+ * @return A string representation of this device.
+ */
+std::string BTAdvertisedDeviceSet::toString() {
+	std::string res = "Name: " + getName() + ", Address: " + getAddress().toString();
+	if (haveCOD()) {
+		char val[6];
+		snprintf(val, sizeof(val), "%d", getCOD());
+		res += ", cod: ";
+		res += val;
+	}
+	if (haveRSSI()) {
+		char val[6];
+		snprintf(val, sizeof(val), "%d", (int8_t)getRSSI());
+		res += ", rssi: ";
+		res += val;
+	}
+	return res;
+} // toString
+
+
+void BTAdvertisedDeviceSet::setAddress(BTAddress address) {
+    m_address = address;
+}
+
+void BTAdvertisedDeviceSet::setCOD(uint32_t cod) {
+    m_cod     = cod;
+	m_haveCOD = true;
+}
+
+void BTAdvertisedDeviceSet::setName(std::string name) {
+    m_name     = name;
+	m_haveName = true;
+}
+
+void BTAdvertisedDeviceSet::setRSSI(int8_t rssi) {
+    m_rssi     = rssi;
+	m_haveRSSI = true;
+}
+
+#endif /* CONFIG_BT_ENABLED */