@capacitor-community/bluetooth-le 7.2.0 → 7.3.1

package/ios/Plugin/DeviceManager.swift

@@ -1,6 +1,12 @@
 import Foundation
 import CoreBluetooth
 
+enum DeviceListMode {
+    case none
+    case alert
+    case list
+}
+
 class DeviceManager: NSObject, CBCentralManagerDelegate {
     typealias Callback = (_ success: Bool, _ message: String) -> Void
     typealias StateReceiver = (_ enabled: Bool) -> Void
@@ -15,12 +21,15 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
     private var timeoutMap = [String: DispatchWorkItem]()
     private var stopScanWorkItem: DispatchWorkItem?
     private var alertController: UIAlertController?
+    private var deviceListView: DeviceListView?
+    private var popoverController: UIPopoverPresentationController?
     private var discoveredDevices = [String: Device]()
     private var deviceNameFilter: String?
     private var deviceNamePrefixFilter: String?
-    private var shouldShowDeviceList = false
+    private var deviceListMode: DeviceListMode = .none
     private var allowDuplicates = false
     private var manufacturerDataFilters: [ManufacturerDataFilter]?
+    private var serviceDataFilters: [ServiceDataFilter]?
 
     init(_ viewController: UIViewController?, _ displayStrings: [String: String], _ callback: @escaping Callback) {
         super.init()
@@ -81,8 +90,9 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         _ name: String?,
         _ namePrefix: String?,
         _ manufacturerDataFilters: [ManufacturerDataFilter]?,
+        _ serviceDataFilters: [ServiceDataFilter]?,
         _ allowDuplicates: Bool,
-        _ shouldShowDeviceList: Bool,
+        _ deviceListMode: DeviceListMode,
         _ scanDuration: Double?,
         _ callback: @escaping Callback,
         _ scanResultCallback: @escaping ScanResultCallback
@@ -92,13 +102,14 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
 
         if self.centralManager.isScanning == false {
             self.discoveredDevices = [String: Device]()
-            self.shouldShowDeviceList = shouldShowDeviceList
+            self.deviceListMode = deviceListMode
             self.allowDuplicates = allowDuplicates
             self.deviceNameFilter = name
             self.deviceNamePrefixFilter = namePrefix
             self.manufacturerDataFilters = manufacturerDataFilters
+            self.serviceDataFilters = serviceDataFilters
 
-            if shouldShowDeviceList {
+            if deviceListMode != .none {
                 self.showDeviceList()
             }
 
@@ -113,7 +124,7 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
                 options: [CBCentralManagerScanOptionAllowDuplicatesKey: allowDuplicates]
             )
 
-            if shouldShowDeviceList == false {
+            if deviceListMode == .none {
                 self.resolve("startScanning", "Scan started.")
             }
         } else {
@@ -128,10 +139,22 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         self.stopScanWorkItem?.cancel()
         self.stopScanWorkItem = nil
         DispatchQueue.main.async { [weak self] in
-            if self?.discoveredDevices.count == 0 {
-                self?.alertController?.title = self?.displayStrings["noDeviceFound"]
-            } else {
-                self?.alertController?.title = self?.displayStrings["availableDevices"]
+            guard let self = self else { return }
+            switch self.deviceListMode {
+            case .alert:
+                if self.discoveredDevices.count == 0 {
+                    self.alertController?.title = self.displayStrings["noDeviceFound"]
+                } else {
+                    self.alertController?.title = self.displayStrings["availableDevices"]
+                }
+            case .list:
+                if self.discoveredDevices.count == 0 {
+                    self.deviceListView?.setTitle(self.displayStrings["noDeviceFound"])
+                } else {
+                    self.deviceListView?.setTitle(self.displayStrings["availableDevices"])
+                }
+            case .none:
+                break
             }
         }
     }
@@ -155,7 +178,8 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
 
         guard self.passesNameFilter(peripheralName: peripheral.name) else { return }
         guard self.passesNamePrefixFilter(peripheralName: peripheral.name) else { return }
-        guard self.passesManufacturerDataFilter(advertisementData) else { return }
+        guard ScanFilterUtils.passesManufacturerDataFilter(advertisementData, filters: self.manufacturerDataFilters) else { return }
+        guard ScanFilterUtils.passesServiceDataFilter(advertisementData, filters: self.serviceDataFilters) else { return }
 
         let device: Device
         if self.allowDuplicates, let knownDevice = discoveredDevices.first(where: { $0.key == peripheral.identifier.uuidString })?.value {
@@ -166,7 +190,12 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         }
         log("New device found: ", device.getName() ?? "Unknown")
 
-        if shouldShowDeviceList {
+        switch deviceListMode {
+        case .none:
+            if self.scanResultCallback != nil {
+                self.scanResultCallback!(device, advertisementData, RSSI)
+            }
+        case .alert:
             DispatchQueue.main.async { [weak self] in
                 self?.alertController?.addAction(UIAlertAction(title: device.getName() ?? "Unknown", style: UIAlertAction.Style.default, handler: { (_) in
                     log("Selected device")
@@ -174,14 +203,29 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
                     self?.resolve("startScanning", device.getId())
                 }))
             }
-        } else {
-            if self.scanResultCallback != nil {
-                self.scanResultCallback!(device, advertisementData, RSSI)
+        case .list:
+            DispatchQueue.main.async { [weak self] in
+                self?.deviceListView?.addItem(device.getName() ?? "Unknown", action: {
+                    log("Selected device")
+                    self?.stopScan()
+                    self?.resolve("startScanning", device.getId())
+                })
             }
         }
     }
 
     func showDeviceList() {
+        switch deviceListMode {
+        case .none:
+            break
+        case .alert:
+            showDeviceListAlert()
+        case .list:
+            showDeviceListView()
+        }
+    }
+
+    func showDeviceListAlert() {
         DispatchQueue.main.async { [weak self] in
             self?.alertController = UIAlertController(title: self?.displayStrings["scanning"], message: nil, preferredStyle: UIAlertController.Style.alert)
             self?.alertController?.addAction(UIAlertAction(title: self?.displayStrings["cancel"], style: UIAlertAction.Style.cancel, handler: { (_) in
@@ -193,6 +237,22 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         }
     }
 
+    func showDeviceListView() {
+        DispatchQueue.main.async { [weak self] in
+            self?.deviceListView = DeviceListView()
+            if #available(macCatalyst 15.0, iOS 15.0, *) {
+                self?.deviceListView?.sheetPresentationController?.detents = [.medium()]
+            }
+            self?.viewController?.present((self?.deviceListView)!, animated: true, completion: nil)
+            self?.deviceListView?.setTitle(self?.displayStrings["scanning"])
+            self?.deviceListView?.setCancelButton(self?.displayStrings["cancel"], action: {
+                log("Cancelled request device.")
+                self?.stopScan()
+                self?.reject("startScanning", "requestDevice cancelled.")
+            })
+        }
+    }
+
     func getDevices(
         _ deviceUUIDs: [UUID]
     ) -> [CBPeripheral] {
@@ -300,53 +360,6 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         return name.hasPrefix(prefix)
     }
 
-    private func passesManufacturerDataFilter(_ advertisementData: [String: Any]) -> Bool {
-        guard let filters = self.manufacturerDataFilters, !filters.isEmpty else {
-            return true  // No filters means everything passes
-        }
-
-        guard let manufacturerData = advertisementData[CBAdvertisementDataManufacturerDataKey] as? Data,
-              manufacturerData.count >= 2 else {
-            return false  // If there's no valid manufacturer data, fail
-        }
-
-        let companyIdentifier = manufacturerData.prefix(2).withUnsafeBytes {
-            $0.load(as: UInt16.self).littleEndian // Manufacturer ID is little-endian
-        }
-
-        let payload = manufacturerData.dropFirst(2)
-
-        for filter in filters {
-            if filter.companyIdentifier != companyIdentifier {
-                continue  // Skip if company ID does not match
-            }
-
-            if let dataPrefix = filter.dataPrefix {
-                if payload.count < dataPrefix.count {
-                    continue // Payload too short, does not match
-                }
-
-                if let mask = filter.mask {
-                    var matches = true
-                    for i in 0..<dataPrefix.count {
-                        if (payload[i] & mask[i]) != (dataPrefix[i] & mask[i]) {
-                            matches = false
-                            break
-                        }
-                    }
-                    if matches {
-                        return true
-                    }
-                } else if payload.starts(with: dataPrefix) {
-                    return true
-                }
-            } else {
-                return true // Company ID matched, and no dataPrefix required
-            }
-        }
-
-        return false  // If none matched, return false
-    }
 
     private func resolve(_ key: String, _ value: String) {
         let callback = self.callbackMap[key]

package/ios/Plugin/Plugin.swift

@@ -7,12 +7,6 @@ import CoreBluetooth
 let CONNECTION_TIMEOUT: Double = 10
 let DEFAULT_TIMEOUT: Double = 5
 
-struct ManufacturerDataFilter {
-    let companyIdentifier: UInt16
-    let dataPrefix: Data?
-    let mask: Data?
-}
-
 @objc(BluetoothLe)
 public class BluetoothLe: CAPPlugin {
     typealias BleDevice = [String: Any]
@@ -117,14 +111,23 @@ public class BluetoothLe: CAPPlugin {
         let name = call.getString("name")
         let namePrefix = call.getString("namePrefix")
         let manufacturerDataFilters = self.getManufacturerDataFilters(call)
+        let serviceDataFilters = self.getServiceDataFilters(call)
+
+        let displayModeString = (call.getString("displayMode") ?? "alert").lowercased()
+        guard ["alert", "list"].contains(displayModeString) else {
+            call.reject("Invalid displayMode '\(call.getString("displayMode") ?? "")'. Use 'alert' or 'list'.")
+            return
+        }
+        let deviceListMode: DeviceListMode = displayModeString == "list" ? .list : .alert
 
         deviceManager.startScanning(
             serviceUUIDs,
             name,
             namePrefix,
             manufacturerDataFilters,
+            serviceDataFilters,
             false,
-            true,
+            deviceListMode,
             30,
             {(success, message) in
                 if success {
@@ -151,14 +154,16 @@ public class BluetoothLe: CAPPlugin {
         let namePrefix = call.getString("namePrefix")
         let allowDuplicates = call.getBool("allowDuplicates", false)
         let manufacturerDataFilters = self.getManufacturerDataFilters(call)
+        let serviceDataFilters = self.getServiceDataFilters(call)
 
         deviceManager.startScanning(
             serviceUUIDs,
             name,
             namePrefix,
             manufacturerDataFilters,
+            serviceDataFilters,
             allowDuplicates,
-            false,
+            .none,
             nil,
             { (success, message) in
                 if success {
@@ -546,13 +551,13 @@ public class BluetoothLe: CAPPlugin {
             }
 
             let dataPrefix: Data? = {
-                guard let prefixArray = dataObject["dataPrefix"] as? [Int] else { return nil }
-                return Data(prefixArray.map { UInt8($0 & 0xFF) })
+                guard let prefixString = dataObject["dataPrefix"] as? String else { return nil }
+                return stringToData(prefixString)
             }()
 
             let mask: Data? = {
-                guard let maskArray = dataObject["mask"] as? [Int] else { return nil }
-                return Data(maskArray.map { UInt8($0 & 0xFF) })
+                guard let maskString = dataObject["mask"] as? String else { return nil }
+                return stringToData(maskString)
             }()
 
             let manufacturerFilter = ManufacturerDataFilter(
@@ -567,6 +572,44 @@ public class BluetoothLe: CAPPlugin {
         return manufacturerDataFilters
     }
 
+    private func getServiceDataFilters(_ call: CAPPluginCall) -> [ServiceDataFilter]? {
+        guard let serviceDataArray = call.getArray("serviceData") else {
+            return nil
+        }
+
+        var serviceDataFilters: [ServiceDataFilter] = []
+
+        for index in 0..<serviceDataArray.count {
+            guard let dataObject = serviceDataArray[index] as? JSObject,
+                  let serviceUuidString = dataObject["serviceUuid"] as? String else {
+                // Invalid or missing service UUID
+                return nil
+            }
+
+            let serviceUuid = CBUUID(string: serviceUuidString)
+
+            let dataPrefix: Data? = {
+                guard let prefixString = dataObject["dataPrefix"] as? String else { return nil }
+                return stringToData(prefixString)
+            }()
+
+            let mask: Data? = {
+                guard let maskString = dataObject["mask"] as? String else { return nil }
+                return stringToData(maskString)
+            }()
+
+            let serviceDataFilter = ServiceDataFilter(
+                serviceUuid: serviceUuid,
+                dataPrefix: dataPrefix,
+                mask: mask
+            )
+
+            serviceDataFilters.append(serviceDataFilter)
+        }
+
+        return serviceDataFilters
+    }
+
     private func getDevice(_ call: CAPPluginCall, checkConnection: Bool = true) -> Device? {
         guard let deviceId = call.getString("deviceId") else {
             call.reject("deviceId required.")

package/ios/Plugin/ScanFilters.swift

@@ -0,0 +1,114 @@
+import Foundation
+import CoreBluetooth
+
+struct ManufacturerDataFilter {
+    let companyIdentifier: UInt16
+    let dataPrefix: Data?
+    let mask: Data?
+}
+
+struct ServiceDataFilter {
+    let serviceUuid: CBUUID
+    let dataPrefix: Data?
+    let mask: Data?
+}
+
+class ScanFilterUtils {
+
+    static func passesManufacturerDataFilter(_ advertisementData: [String: Any], filters: [ManufacturerDataFilter]?) -> Bool {
+        guard let filters = filters, !filters.isEmpty else {
+            return true  // No filters means everything passes
+        }
+
+        guard let manufacturerData = advertisementData[CBAdvertisementDataManufacturerDataKey] as? Data,
+              manufacturerData.count >= 2 else {
+            return false  // If there's no valid manufacturer data, fail
+        }
+
+        let companyIdentifier = manufacturerData.prefix(2).withUnsafeBytes {
+            $0.load(as: UInt16.self).littleEndian // Manufacturer ID is little-endian
+        }
+
+        let payload = Data(manufacturerData.dropFirst(2))
+
+        for filter in filters {
+            if filter.companyIdentifier != companyIdentifier {
+                continue  // Skip if company ID does not match
+            }
+
+            if let dataPrefix = filter.dataPrefix {
+                if payload.count < dataPrefix.count {
+                    continue // Payload too short, does not match
+                }
+
+                if let mask = filter.mask {
+                    // Validate that mask length matches dataPrefix length
+                    if mask.count != dataPrefix.count {
+                        continue // Skip this filter if mask length is invalid
+                    }
+                    var matches = true
+                    for i in 0..<dataPrefix.count {
+                        if (payload[i] & mask[i]) != (dataPrefix[i] & mask[i]) {
+                            matches = false
+                            break
+                        }
+                    }
+                    if matches {
+                        return true
+                    }
+                } else if payload.starts(with: dataPrefix) {
+                    return true
+                }
+            } else {
+                return true // Company ID matched, and no dataPrefix required
+            }
+        }
+
+        return false  // If none matched, return false
+    }
+
+    static func passesServiceDataFilter(_ advertisementData: [String: Any], filters: [ServiceDataFilter]?) -> Bool {
+        guard let filters = filters, !filters.isEmpty else {
+            return true  // No filters means everything passes
+        }
+
+        guard let serviceDataDict = advertisementData[CBAdvertisementDataServiceDataKey] as? [CBUUID: Data] else {
+            return false  // If there's no service data, fail
+        }
+
+        for filter in filters {
+            guard let serviceData = serviceDataDict[filter.serviceUuid] else {
+                continue  // Skip if service UUID does not match
+            }
+
+            if let dataPrefix = filter.dataPrefix {
+                if serviceData.count < dataPrefix.count {
+                    continue // Service data too short, does not match
+                }
+
+                if let mask = filter.mask {
+                    // Validate that mask length matches dataPrefix length
+                    if mask.count != dataPrefix.count {
+                        continue // Skip this filter if mask length is invalid
+                    }
+                    var matches = true
+                    for i in 0..<dataPrefix.count {
+                        if (serviceData[i] & mask[i]) != (dataPrefix[i] & mask[i]) {
+                            matches = false
+                            break
+                        }
+                    }
+                    if matches {
+                        return true
+                    }
+                } else if serviceData.starts(with: dataPrefix) {
+                    return true
+                }
+            } else {
+                return true // Service UUID matched, and no dataPrefix required
+            }
+        }
+
+        return false  // If none matched, return false
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/bluetooth-le",
-  "version": "7.2.0",
+  "version": "7.3.1",
   "description": "Capacitor plugin for Bluetooth Low Energy ",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -19,7 +19,7 @@
     "prettier": "prettier \"**/*.{css,html,ts,js}\"",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api BleClientInterface --output-readme README.md --output-json dist/docs.json",
-    "postdocgen": "prettier README.md --write",
+    "postdocgen": "node scripts/fix-docgen-types.js && prettier README.md --write",
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
@@ -85,7 +85,17 @@
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",
   "eslintConfig": {
-    "extends": "@ionic/eslint-config/recommended"
+    "extends": "@ionic/eslint-config/recommended",
+    "rules": {
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          "argsIgnorePattern": "^_",
+          "varsIgnorePattern": "^_",
+          "caughtErrorsIgnorePattern": "^_"
+        }
+      ]
+    }
   },
   "repository": {
     "type": "git",