Merge pull request #740 from sparkfun/pcUpdates

Updates for MFi (BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)

Author: nseidle

.github/workflows/compile-rtk-everywhere.yml

@@ -97,7 +97,7 @@ jobs:
           "SparkFun UM980 Triband RTK GNSS Arduino Library"@1.0.5
           "SparkFun LG290P Quadband RTK GNSS Arduino Library"@1.0.8
           "SparkFun I2C Expander Arduino Library"@1.0.1
-          "SparkFun Apple Accessory Arduino Library"@3.0.8
+          "SparkFun Apple Accessory Arduino Library"@3.0.9
           "SparkFun Authentication Coprocessor Arduino Library"@1.0.0
           "SparkFun Toolkit"@1.0.6
 

.github/workflows/non-release-build.yml

@@ -97,7 +97,7 @@ jobs:
           "SparkFun UM980 Triband RTK GNSS Arduino Library"@1.0.5
           "SparkFun LG290P Quadband RTK GNSS Arduino Library"@1.0.8
           "SparkFun I2C Expander Arduino Library"@1.0.1
-          "SparkFun Apple Accessory Arduino Library"@3.0.8
+          "SparkFun Apple Accessory Arduino Library"@3.0.9
           "SparkFun Authentication Coprocessor Arduino Library"@1.0.0
           "SparkFun Toolkit"@1.0.6
 

Firmware/RTK_Everywhere/AuthCoPro.ino

@@ -3,7 +3,8 @@
 const char *manufacturer = "SparkFun Electronics";
 const char *hardwareVersion = "1.0.0";
 const char *EAProtocol = "com.sparkfun.rtk";
-const char *BTTransportName = "com.sparkfun.bt";
+//const char *BTTransportName = "com.sparkfun.bt";
+const char *BTTransportName = "Bluetooth";
 const char *LIComponentName = "com.sparkfun.li";
 const char *productPlanUID =
     "0123456789ABCDEF"; // This comes from the MFi Portal, when you register the product with Apple
@@ -70,17 +71,7 @@ void beginAuthCoPro(TwoWire *i2cBus)
     systemPrintln("Authentication coprocessor online");
 }
 
-static char *bda2str(esp_bd_addr_t bda, char *str, size_t size)
-{
-    if (bda == NULL || str == NULL || size < 18)
-    {
-        return NULL;
-    }
-
-    uint8_t *p = bda;
-    snprintf(str, size, "%02x:%02x:%02x:%02x:%02x:%02x", p[0], p[1], p[2], p[3], p[4], p[5]);
-    return str;
-}
+extern char *bda2str(esp_bd_addr_t bda, char *str, size_t size);
 
 void updateAuthCoPro()
 {
@@ -98,31 +89,36 @@ void updateAuthCoPro()
             //       The internal flag is automatically cleared when aclConnected returns true
             if (bluetoothSerialSpp->aclConnected() == true)
             {
-                // //
-                // https://github.com/espressif/arduino-esp32/blob/master/libraries/BluetoothSerial/examples/DiscoverConnect/DiscoverConnect.ino
-                // std::map<int, std::string> channels =
-                // bluetoothSerialSpp->getChannels(bluetoothSerialSpp->aclGetAddress());
+                char bda_str[18];
+                systemPrintf("Apple Device %s found\r\n", bda2str(bluetoothSerialSpp->aclGetAddress(), bda_str, 18));
 
-                // int channel = 0; // Channel 0 for auto-detect
-                // if (channels.size() > 0)
-                //     channel = channels.begin()->first;
+                // We need to connect _almost_ immediately for a successful pairing
+                // This is really brittle.
+                // Having core debug enabled adds enough delay to make this work.
+                // With debug set to none, we need to insert a _small_ delay...
+                // Too much delay and we get Connection Unsuccessful.
+                delay(2);
 
                 int channel = 1;
+                if (settings.debugNetworkLayer)
+                    systemPrintf("Connecting on channel %d\r\n", channel);
 
-                char bda_str[18];
-                bda2str(bluetoothSerialSpp->aclGetAddress(), bda_str, 18);
-
-                systemPrintf("Apple Device %s found, connecting on channel %d\r\n", bda_str, channel);
-
-                bluetoothSerialSpp->connect(bluetoothSerialSpp->aclGetAddress(), channel);
+                bluetoothSerialSpp->connect(bluetoothSerialSpp->aclGetAddress(), channel); // Blocking for READY_TIMEOUT
 
                 if (bluetoothSerialSpp->connected())
                 {
+                    systemPrintln("Connected. Sending handshake...");
                     appleAccessory->startHandshake((Stream *)bluetoothSerialSpp);
                 }
+                else
+                {
+                    systemPrintln("Connection failed / timed out! Handshake will be sent if device connects...");
+                    sendAccessoryHandshakeOnBtConnect = true;
+                }
             }
 
             // That's all folks!
+            // If a timeout occurred, Handshake is sent by bluetoothUpdate()
             // Everything else is handled by the Apple Accessory Library
         }
     }

Firmware/RTK_Everywhere/Bluetooth.ino

@@ -72,6 +72,14 @@ void bluetoothUpdate()
             // LED is controlled by tickerBluetoothLedUpdate()
 
             btPrintEchoExit = false; // Reset the exiting of config menus and/or command modes
+
+#ifdef COMPILE_AUTHENTICATION
+            if (sendAccessoryHandshakeOnBtConnect)
+            {
+                appleAccessory->startHandshake((Stream *)bluetoothSerialSpp);
+                sendAccessoryHandshakeOnBtConnect = false; // One-shot
+            }
+#endif
         }
 
         else if ((bluetoothState == BT_CONNECTED) && (!bluetoothIsConnected()))
@@ -411,6 +419,12 @@ void bluetoothFlush()
 #endif                               // COMPILE_BT
 }
 
+void BTConfirmRequestCallback(uint32_t numVal) {
+    systemPrintf("Device sent PIN: %06lu. Sending confirmation\r\n", numVal);
+    bluetoothSerialSpp->confirmReply(true); // AUTO_PAIR - equivalent to enableSSP(false, true);
+    // TODO: if the RTK device has an OLED, we should display the PIN so user can confirm
+}
+
 // Get MAC, start radio
 // Tack device's MAC address to end of friendly broadcast name
 // This allows multiple units to be on at same time
@@ -533,10 +547,23 @@ void bluetoothStart()
         }
         else if (settings.bluetoothRadioType == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)
         {
-            // Support Apple Accessory
-
-            bluetoothSerialSpp->enableSSP(false,
-                                          false); // Enable secure pairing, authenticate without displaying anything
+            // Uncomment the next line to force deletion of all paired (bonded) devices
+            // (This should only be necessary if you have changed the SSP pairing type)
+            //settings.clearBtPairings = true;
+            
+            // Enable secure pairing without PIN :
+            // iPhone displays Connection Unsuccessful - but then connects anyway...
+            bluetoothSerialSpp->enableSSP(false, false);
+
+            // Enable secure pairing with PIN :
+            //bluetoothSerialSpp->enableSSP(false, true);
+
+            // Accessory Protocol recommends using a PIN
+            // Support Apple Accessory: Device to Accessory
+            // 1. Search for an accessory from the device and initiate pairing.
+            // 2. Verify pairing is successful after exchanging a pin code.
+            //bluetoothSerialSpp->enableSSP(true, true); // Enable secure pairing with PIN
+            //bluetoothSerialSpp->onConfirmRequest(&BTConfirmRequestCallback); // Callback to verify the PIN
 
             beginSuccess &= bluetoothSerialSpp->begin(
                 deviceName, true, true, settings.sppRxQueueSize, settings.sppTxQueueSize, 0, 0,
@@ -546,16 +573,32 @@ void bluetoothStart()
             {
                 // bluetoothSerialSpp.getBtAddress(btMACAddress); // Read the ESP32 BT MAC Address
 
+                if (settings.clearBtPairings)
+                {
+                    // Paired / bonded devices are stored in flash. Only a full flash erase
+                    // or deleteAllBondedDevices() will clear them all. They can be deleted
+                    // individually, but that would need a menu and more functions added to
+                    // the BT classes.
+                    // Deleting all bonded devices after a factory reset seems sensible.
+                    // TODO: test all the possibilities / overlap of this and "Forget Device"
+                    if (settings.debugNetworkLayer)
+                        systemPrintln("Deleting all bonded devices");
+                    bluetoothSerialSpp->deleteAllBondedDevices(); // Must be called after begin
+                    settings.clearBtPairings = false;
+                    recordSystemSettings();
+                }
+
                 esp_sdp_init();
 
                 esp_bluetooth_sdp_hdr_overlay_t record = {(esp_bluetooth_sdp_types_t)0};
                 record.type = ESP_SDP_TYPE_RAW;
                 record.uuid.len = sizeof(UUID_IAP2);
                 memcpy(record.uuid.uuid.uuid128, UUID_IAP2, sizeof(UUID_IAP2));
-                record.service_name_length = strlen(sdp_service_name) + 1;
-                record.service_name = (char *)sdp_service_name;
-                // record.service_name_length = strlen(deviceName) + 1; // Doesn't seem to help the failed connects
-                // record.service_name = (char *)deviceName;
+                //record.service_name_length = strlen(sdp_service_name) + 1;
+                //record.service_name = (char *)sdp_service_name;
+                // Use the same EIR Local Name parameter as the Name in the IdentificationInformation
+                record.service_name_length = strlen(deviceName) + 1;
+                record.service_name = (char *)deviceName;
                 // record.rfcomm_channel_number = 1; // Doesn't seem to help the failed connects
                 esp_sdp_create_record((esp_bluetooth_sdp_record_t *)&record);
             }

Firmware/RTK_Everywhere/Patch/libbt.a

@@ -812,10 +812,10 @@ SparkFunAppleAccessoryDriver *appleAccessory; // Instantiated by beginAuthCoPro
 
 const char *sdp_service_name = "iAP2";
 
-// UUID: Big-Endian
-static const uint8_t  UUID_IAP2[] = {0x00, 0x00, 0x00, 0x00, 0xDE, 0xCA, 0xFA, 0xDE, 0xDE, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xCA, 0xFF};
-// UUID: Little-Endian
-//static const uint8_t  UUID_IAP2[] = {0xFF, 0xCA, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xDE, 0xDE, 0xFA, 0xCA, 0xDE, 0x00, 0x00, 0x00, 0x00};
+// UUID : Big-Endian
+//static const uint8_t  UUID_IAP2[] = {0x00, 0x00, 0x00, 0x00, 0xDE, 0xCA, 0xFA, 0xDE, 0xDE, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xCA, 0xFF};
+// UUID : Little-Endian
+static const uint8_t  UUID_IAP2[] = {0xFF, 0xCA, 0xCA, 0xDE, 0xAF, 0xDE, 0xCA, 0xDE, 0xDE, 0xFA, 0xCA, 0xDE, 0x00, 0x00, 0x00, 0x00};
 
 #endif
 
@@ -845,6 +845,7 @@ uint32_t powerPressedStartTime;       // Times how long the user has been holdin
 bool inMainMenu;                      // Set true when in the serial config menu system.
 bool btPrintEcho;                     // Set true when in the serial config menu system via Bluetooth.
 bool btPrintEchoExit;                 // When true, exit all config menus.
+bool sendAccessoryHandshakeOnBtConnect = false; // Send accessory handshake on BT connect
 
 bool forceDisplayUpdate = true; // Goes true when setup is pressed, causes the display to refresh in real-time
 uint32_t lastSystemStateUpdate;

Firmware/RTK_Everywhere/RTK_Everywhere.ino

@@ -37,6 +37,12 @@ class BTSerialInterface : public virtual Stream
     virtual bool aclConnected() = 0;
     virtual uint8_t *aclGetAddress() = 0;
     virtual std::map<int, std::string> getChannels(const BTAddress &remoteAddress) = 0;
+
+    virtual void onConfirmRequest(void (*cbPtr)(uint32_t)) = 0;
+    virtual void confirmReply(bool confirm) = 0;
+    virtual void respondPasskey(uint32_t passkey) = 0;
+
+    virtual void deleteAllBondedDevices() = 0;
 };
 
 class BTClassicSerial : public virtual BTSerialInterface, public BluetoothSerial
@@ -119,7 +125,7 @@ class BTClassicSerial : public virtual BTSerialInterface, public BluetoothSerial
 
     void enableSSP(bool inputCapability, bool outputCapability)
     {
-        return (BluetoothSerial::enableSSP(inputCapability, outputCapability));
+        BluetoothSerial::enableSSP(inputCapability, outputCapability);
     }
 
     bool aclConnected()
@@ -136,6 +142,26 @@ class BTClassicSerial : public virtual BTSerialInterface, public BluetoothSerial
     {
         return (BluetoothSerial::getChannels(remoteAddress));
     }
+
+    void onConfirmRequest(void (*cbPtr)(uint32_t))
+    {
+        BluetoothSerial::onConfirmRequest(cbPtr);
+    }
+
+    void confirmReply(bool confirm)
+    {
+        BluetoothSerial::confirmReply((boolean)confirm);
+    }
+
+    void respondPasskey(uint32_t passkey)
+    {
+        BluetoothSerial::respondPasskey(passkey);
+    }
+
+    void deleteAllBondedDevices()
+    {
+        BluetoothSerial::deleteAllBondedDevices();
+    }
 };
 
 class BTLESerial : public virtual BTSerialInterface, public BleSerial
@@ -234,6 +260,14 @@ class BTLESerial : public virtual BTSerialInterface, public BleSerial
         return empty;
     }
 
+    void onConfirmRequest(void (*cbPtr)(uint32_t)) {}
+
+    void confirmReply(bool confirm) {}
+
+    void respondPasskey(uint32_t passkey) {}
+
+    void deleteAllBondedDevices() {}
+
     // Callbacks removed in v2 of BleSerial. Using polled connected() in bluetoothUpdate()
     // override BLEServerCallbacks
     // void Server->onConnect(BLEServer *pServer)

Firmware/RTK_Everywhere/bluetoothSelect.h

@@ -580,12 +580,14 @@ BluetoothRadioType_e mmChangeBluetoothProtocol(BluetoothRadioType_e bluetoothUse
 }
 
 // Restart Bluetooth radio if settings have changed
-void mmSetBluetoothProtocol(BluetoothRadioType_e bluetoothUserChoice)
+void mmSetBluetoothProtocol(BluetoothRadioType_e bluetoothUserChoice, bool clearBtPairings)
 {
-    if (bluetoothUserChoice != settings.bluetoothRadioType)
+    if ((bluetoothUserChoice != settings.bluetoothRadioType) 
+        || (clearBtPairings != settings.clearBtPairings))
     {
         bluetoothStop();
         settings.bluetoothRadioType = bluetoothUserChoice;
+        settings.clearBtPairings = clearBtPairings;
         bluetoothStart();
     }
 }
@@ -594,6 +596,7 @@ void mmSetBluetoothProtocol(BluetoothRadioType_e bluetoothUserChoice)
 void menuRadio()
 {
     BluetoothRadioType_e bluetoothUserChoice = settings.bluetoothRadioType;
+    bool clearBtPairings = settings.clearBtPairings;
 
     while (1)
     {
@@ -668,6 +671,12 @@ void menuRadio()
         // Display Bluetooth menu
         mmDisplayBluetoothRadioMenu('b', bluetoothUserChoice);
 
+        // If in BLUETOOTH_RADIO_SPP_ACCESSORY_MODE, allow user to delete all pairings
+        if (bluetoothUserChoice == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE)
+        {
+            systemPrintf("c) Clear BT pairings: %s\r\n", clearBtPairings ? "Yes" : "No");
+        }
+
         systemPrintln("x) Exit");
 
         byte incoming = getUserInputCharacterNumber();
@@ -676,6 +685,10 @@ void menuRadio()
         if (incoming == 'b')
             bluetoothUserChoice = mmChangeBluetoothProtocol(bluetoothUserChoice);
 
+        // Allow user to clear BT pairings - when BTClassicSerial is next begun
+        else if ((incoming == 'c') && (bluetoothUserChoice == BLUETOOTH_RADIO_SPP_ACCESSORY_MODE))
+            clearBtPairings ^= 1;
+
         else if (incoming == 1)
         {
             settings.enableEspNow ^= 1;
@@ -808,7 +821,7 @@ void menuRadio()
     wifiEspNowOn(__FILE__, __LINE__);
 
     // Restart Bluetooth radio if settings have changed
-    mmSetBluetoothProtocol(bluetoothUserChoice);
+    mmSetBluetoothProtocol(bluetoothUserChoice, clearBtPairings);
 
     // LoRa radio state machine will start/stop radio upon next updateLora in loop()
 

Firmware/RTK_Everywhere/menuMain.ino

@@ -417,8 +417,8 @@ void menuSystem()
             printUnknown(incoming);
     }
 
-    // Restart Bluetooth radio if settings have changed
-    mmSetBluetoothProtocol(bluetoothUserChoice);
+    // Restart Bluetooth radio if settings have changed (ignore clearBtPairings)
+    mmSetBluetoothProtocol(bluetoothUserChoice, settings.clearBtPairings);
 
     clearBuffer(); // Empty buffer of any newline chars
 }

Firmware/RTK_Everywhere/menuSystem.ino

@@ -699,6 +699,7 @@ struct Settings
     BluetoothRadioType_e bluetoothRadioType = BLUETOOTH_RADIO_SPP_AND_BLE;
     uint16_t sppRxQueueSize = 512 * 4;
     uint16_t sppTxQueueSize = 32;
+    bool clearBtPairings = true; // Clear MFi Accessory SSP pairings
 
     // Corrections
     int correctionsSourcesLifetime_s = 30; // Expire a corrections source if no data is seen for this many seconds
@@ -1341,6 +1342,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
     { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, tBtRadio,  0, & settings.bluetoothRadioType, "bluetoothRadioType",  },
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _uint16_t, 0, & settings.sppRxQueueSize, "sppRxQueueSize",  },
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _uint16_t, 0, & settings.sppTxQueueSize, "sppTxQueueSize",  },
+    { 0, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _bool,     0, & settings.clearBtPairings, "clearBtPairings",  },
 
     // Corrections
     { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, 1, _int,      0, & settings.correctionsSourcesLifetime_s, "correctionsSourcesLifetime",  },