feat: add skipDescriptorDiscovery option to ConnectOptions

Author: vincent.gillot

README.md

@@ -628,16 +628,16 @@ and [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getD
 ### connect(...)
 
 ```typescript
-connect(deviceId: string, onDisconnect?: ((deviceId: string) => void) | undefined, options?: TimeoutOptions | undefined) => Promise<void>
+connect(deviceId: string, onDisconnect?: ((deviceId: string) => void) | undefined, options?: ConnectClientOptions | undefined) => Promise<void>
 ```
 
 Connect to a peripheral BLE device. For an example, see [usage](#usage).
 
-| Param              | Type                                                      | Description                                                                                                    |
-| ------------------ | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| **`deviceId`**     | <code>string</code>                                       | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |
-| **`onDisconnect`** | <code>((deviceId: string) =&gt; void)</code>              | Optional disconnect callback function that will be used when the device disconnects                            |
-| **`options`**      | <code><a href="#timeoutoptions">TimeoutOptions</a></code> | Options for plugin call                                                                                        |
+| Param              | Type                                                                  | Description                                                                                                    |
+| ------------------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| **`deviceId`**     | <code>string</code>                                                   | The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan)) |
+| **`onDisconnect`** | <code>((deviceId: string) =&gt; void)</code>                          | Optional disconnect callback function that will be used when the device disconnects                            |
+| **`options`**      | <code><a href="#connectclientoptions">ConnectClientOptions</a></code> | Options for plugin call                                                                                        |
 
 ---
 
@@ -970,6 +970,12 @@ Stop listening to the changes of the value of a characteristic. For an example,
 | **`uuids`**            | <code>string[]</code>                                                                                                            | Advertised services.                                                                                                                                                                                                                                                                                  |
 | **`rawAdvertisement`** | <code>[DataView](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView)</code>                     | Raw advertisement data (**Android** only).                                                                                                                                                                                                                                                            |
 
+#### ConnectClientOptions
+
+| Prop                          | Type                 | Description                                                                                                                                         | Default            |
+| ----------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
+| **`skipDescriptorDiscovery`** | <code>boolean</code> | Skip descriptor discovery during connection to improve connection speed. When enabled, descriptors will not be available in the services structure. | <code>false</code> |
+
 #### TimeoutOptions
 
 | Prop          | Type                | Description                                                                                                |

android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/BluetoothLe.kt

@@ -463,7 +463,8 @@ class BluetoothLe : Plugin() {
     fun connect(call: PluginCall) {
         val device = getOrCreateDevice(call) ?: return
         val timeout = call.getFloat("timeout", CONNECTION_TIMEOUT)!!.toLong()
-        device.connect(timeout) { response ->
+        val skipDescriptorDiscovery = call.getBoolean("skipDescriptorDiscovery", false)!!
+        device.connect(timeout, skipDescriptorDiscovery) { response ->
             run {
                 if (response.success) {
                     call.resolve()
@@ -527,6 +528,7 @@ class BluetoothLe : Plugin() {
     fun getServices(call: PluginCall) {
         val device = getDevice(call) ?: return
         val services = device.getServices()
+        val skipDescriptorDiscovery = device.getSkipDescriptorDiscovery()
         val bleServices = JSArray()
         services.forEach { service ->
             val bleCharacteristics = JSArray()
@@ -535,10 +537,12 @@ class BluetoothLe : Plugin() {
                 bleCharacteristic.put("uuid", characteristic.uuid)
                 bleCharacteristic.put("properties", getProperties(characteristic))
                 val bleDescriptors = JSArray()
-                characteristic.descriptors.forEach { descriptor ->
-                    val bleDescriptor = JSObject()
-                    bleDescriptor.put("uuid", descriptor.uuid)
-                    bleDescriptors.put(bleDescriptor)
+                if (!skipDescriptorDiscovery) {
+                    characteristic.descriptors.forEach { descriptor ->
+                        val bleDescriptor = JSObject()
+                        bleDescriptor.put("uuid", descriptor.uuid)
+                        bleDescriptors.put(bleDescriptor)
+                    }
                 }
                 bleCharacteristic.put("descriptors", bleDescriptors)
                 bleCharacteristics.put(bleCharacteristic)

android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/Device.kt

@@ -74,6 +74,7 @@ class Device(
     private var bondStateReceiver: BroadcastReceiver? = null
     private val pendingBondKeys = Collections.newSetFromMap(ConcurrentHashMap<String, Boolean>())
     private var currentMtu = -1
+    private var skipDescriptorDiscovery = false
 
     private lateinit var callbacksHandlerThread: HandlerThread
     private lateinit var callbacksHandler: Handler
@@ -318,9 +319,10 @@ class Device(
      * - request MTU
      */
     fun connect(
-        timeout: Long, callback: (CallbackResponse) -> Unit
+        timeout: Long, skipDescriptorDiscovery: Boolean, callback: (CallbackResponse) -> Unit
     ) {
         val key = "connect"
+        this.skipDescriptorDiscovery = skipDescriptorDiscovery
         callbackMap[key] = callback
         if (isConnected()) {
             resolve(key, "Already connected.")
@@ -478,6 +480,10 @@ class Device(
         return bluetoothGatt?.services ?: mutableListOf()
     }
 
+    fun getSkipDescriptorDiscovery(): Boolean {
+        return skipDescriptorDiscovery
+    }
+
     fun discoverServices(
         timeout: Long, callback: (CallbackResponse) -> Unit
     ) {

ios/Sources/BluetoothLe/Device.swift

@@ -12,6 +12,7 @@ class Device: NSObject, CBPeripheralDelegate {
     private var servicesDiscovered = 0
     private var characteristicsCount = 0
     private var characteristicsDiscovered = 0
+    private var skipDescriptorDiscovery = false
 
     init(
         _ peripheral: CBPeripheral
@@ -48,9 +49,11 @@ class Device: NSObject, CBPeripheralDelegate {
 
     func setOnConnected(
         _ connectionTimeout: Double,
+        _ skipDescriptorDiscovery: Bool,
         _ callback: @escaping Callback
     ) {
         let key = "connect"
+        self.skipDescriptorDiscovery = skipDescriptorDiscovery
         self.callbackMap[key] = callback
         self.setTimeout(key, "Connection timeout", connectionTimeout)
     }
@@ -81,11 +84,19 @@ class Device: NSObject, CBPeripheralDelegate {
         self.servicesDiscovered += 1
         log("didDiscoverCharacteristicsFor", self.servicesDiscovered, self.servicesCount)
         self.characteristicsCount += service.characteristics?.count ?? 0
-        for characteristic in service.characteristics ?? [] {
-            peripheral.discoverDescriptors(for: characteristic)
+        
+        if !self.skipDescriptorDiscovery {
+            for characteristic in service.characteristics ?? [] {
+                peripheral.discoverDescriptors(for: characteristic)
+            }
         }
-        // if the last service does not have characteristics, resolve the connect call now
-        if self.servicesDiscovered >= self.servicesCount && self.characteristicsDiscovered >= self.characteristicsCount {
+        
+        // Resolve immediately if skipping descriptor discovery or if all characteristics are discovered
+        let shouldResolve = self.skipDescriptorDiscovery
+            ? self.servicesDiscovered >= self.servicesCount
+            : self.servicesDiscovered >= self.servicesCount && self.characteristicsDiscovered >= self.characteristicsCount
+        
+        if shouldResolve {
             self.resolve("connect", "Connection successful.")
             self.resolve("discoverServices", "Services discovered.")
         }

ios/Sources/BluetoothLe/Plugin.swift

@@ -279,7 +279,8 @@ public class BluetoothLe: CAPPlugin, CAPBridgedPlugin {
         guard self.getDeviceManager(call) != nil else { return }
         guard let device = self.getDevice(call, checkConnection: false) else { return }
         let timeout = self.getTimeout(call, defaultTimeout: CONNECTION_TIMEOUT)
-        device.setOnConnected(timeout, {(success, message) in
+        let skipDescriptorDiscovery = call.getBool("skipDescriptorDiscovery") ?? false
+        device.setOnConnected(timeout, skipDescriptorDiscovery, {(success, message) in
             if success {
                 // only resolve after service discovery
                 call.resolve()

src/bleClient.ts

@@ -7,6 +7,7 @@ import type {
   BleDevice,
   BleService,
   ConnectionPriority,
+  ConnectClientOptions,
   Data,
   InitializeOptions,
   ReadResult,
@@ -151,7 +152,7 @@ export interface BleClientInterface {
    * @param onDisconnect Optional disconnect callback function that will be used when the device disconnects
    * @param options Options for plugin call
    */
-  connect(deviceId: string, onDisconnect?: (deviceId: string) => void, options?: TimeoutOptions): Promise<void>;
+  connect(deviceId: string, onDisconnect?: (deviceId: string) => void, options?: ConnectClientOptions): Promise<void>;
 
   /**
    * Create a bond with a peripheral BLE device.
@@ -476,7 +477,11 @@ class BleClientClass implements BleClientInterface {
     });
   }
 
-  async connect(deviceId: string, onDisconnect?: (deviceId: string) => void, options?: TimeoutOptions): Promise<void> {
+  async connect(
+    deviceId: string,
+    onDisconnect?: (deviceId: string) => void,
+    options?: ConnectClientOptions,
+  ): Promise<void> {
     await this.queue(async () => {
       if (onDisconnect) {
         const key = `disconnected|${deviceId}`;

src/definitions.ts

@@ -181,6 +181,17 @@ export interface TimeoutOptions {
   timeout?: number;
 }
 
+export interface ConnectClientOptions extends TimeoutOptions {
+  /**
+   * Skip descriptor discovery during connection to improve connection speed.
+   * When enabled, descriptors will not be available in the services structure.
+   * @default false
+   */
+  skipDescriptorDiscovery?: boolean;
+}
+
+export interface ConnectOptions extends DeviceIdOptions, ConnectClientOptions {}
+
 export interface RequestConnectionPriorityOptions extends DeviceIdOptions {
   connectionPriority: ConnectionPriority;
 }
@@ -365,7 +376,7 @@ export interface BluetoothLePlugin {
     eventName: 'onScanResult',
     listenerFunc: (result: ScanResultInternal) => void,
   ): Promise<PluginListenerHandle>;
-  connect(options: DeviceIdOptions & TimeoutOptions): Promise<void>;
+  connect(options: ConnectOptions): Promise<void>;
   createBond(options: DeviceIdOptions & TimeoutOptions): Promise<void>;
   isBonded(options: DeviceIdOptions): Promise<BooleanResult>;
   disconnect(options: DeviceIdOptions): Promise<void>;

src/web.ts

@@ -6,7 +6,7 @@ import type {
   BleCharacteristicProperties,
   BleDescriptor,
   BleService,
-  TimeoutOptions,
+  ConnectOptions,
   BleDevice,
   BleServices,
   BluetoothLePlugin,
@@ -184,7 +184,7 @@ export class BluetoothLeWeb extends WebPlugin implements BluetoothLePlugin {
     return {} as Promise<GetDevicesResult>;
   }
 
-  async connect(options: DeviceIdOptions & TimeoutOptions): Promise<void> {
+  async connect(options: ConnectOptions): Promise<void> {
     const device = this.getDeviceFromMap(options.deviceId);
     device.removeEventListener('gattserverdisconnected', this.onDisconnectedCallback);
     device.addEventListener('gattserverdisconnected', this.onDisconnectedCallback);