feat(all): support to pass manufacturerData to the scan filters (#752)

steinerjakob · Jakob Steiner · web-flow · commit c56b6709c421 · 2025-05-07T20:20:15.000+10:00
feat(all): support to pass manufacturerData to the scan filters

---------

Co-authored-by: Jakob Steiner &lt;jakob.steiner@microtronics.com&gt;
diff --git a/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/BluetoothLe.kt b/android/src/main/java/com/capacitorjs/community/plugins/bluetoothle/BluetoothLe.kt
@@ -368,7 +368,8 @@ class BluetoothLe : Plugin() {
             displayStrings = displayStrings!!,
             showDialog = false,
         )
-        deviceScanner?.startScanning(scanFilters,
+        deviceScanner?.startScanning(
+            scanFilters,
             scanSettings,
             allowDuplicates,
             namePrefix,
@@ -808,8 +809,11 @@ class BluetoothLe : Plugin() {
         val filters: ArrayList<ScanFilter> = ArrayList()
 
         val services = (call.getArray("services", JSArray()) as JSArray).toList<String>()
+        val manufacturerDataArray = call.getArray("manufacturerData", JSArray())
         val name = call.getString("name", null)
+
         try {
+            // Create filters based on services
             for (service in services) {
                 val filter = ScanFilter.Builder()
                 filter.setServiceUuid(ParcelUuid.fromString(service))
@@ -818,18 +822,66 @@ class BluetoothLe : Plugin() {
                 }
                 filters.add(filter.build())
             }
+
+            // Manufacturer Data Handling (with optional parameters)
+            manufacturerDataArray?.let {
+                for (i in 0 until it.length()) {
+                    val manufacturerDataObject = it.getJSONObject(i)
+
+                    val companyIdentifier = manufacturerDataObject.getInt("companyIdentifier")
+
+                    val dataPrefix = if (manufacturerDataObject.has("dataPrefix")) {
+                        val dataPrefixObject = manufacturerDataObject.getJSONObject("dataPrefix")
+                        val byteLength = dataPrefixObject.length()
+
+                        ByteArray(byteLength).apply {
+                            for (idx in 0 until byteLength) {
+                                val key = idx.toString()
+                                this[idx] = (dataPrefixObject.getInt(key) and 0xFF).toByte()
+                            }
+                        }
+                    } else null
+
+
+                    val mask = if (manufacturerDataObject.has("mask")) {
+                        val maskObject = manufacturerDataObject.getJSONObject("mask")
+                        val byteLength = maskObject.length()
+
+                        ByteArray(byteLength).apply {
+                            for (idx in 0 until byteLength) {
+                                val key = idx.toString()
+                                this[idx] = (maskObject.getInt(key) and 0xFF).toByte()
+                            }
+                        }
+                    } else null
+
+                    val filterBuilder = ScanFilter.Builder()
+
+                    if (dataPrefix != null && mask != null) {
+                        filterBuilder.setManufacturerData(companyIdentifier, dataPrefix, mask)
+                    } else if (dataPrefix != null) {
+                        filterBuilder.setManufacturerData(companyIdentifier, dataPrefix)
+                    } else {
+                        // Android requires at least dataPrefix for manufacturer filters.
+                        call.reject("dataPrefix is required when specifying manufacturerData.")
+                        return null
+                    }
+
+                    if (name != null) {
+                        filterBuilder.setDeviceName(name)
+                    }
+
+                    filters.add(filterBuilder.build())
+                }
+            }
+            return filters;
         } catch (e: IllegalArgumentException) {
-            call.reject("Invalid service UUID.")
+            call.reject("Invalid UUID or Manufacturer data provided.")
+            return null
+        } catch (e: Exception) {
+            call.reject("Invalid or malformed filter data provided.")
             return null
         }
-
-        if (name != null && filters.isEmpty()) {
-            val filter = ScanFilter.Builder()
-            filter.setDeviceName(name)
-            filters.add(filter.build())
-        }
-
-        return filters
     }
 
     private fun getScanSettings(call: PluginCall): ScanSettings? {
diff --git a/ios/Plugin/DeviceManager.swift b/ios/Plugin/DeviceManager.swift
@@ -20,6 +20,7 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
     private var deviceNamePrefixFilter: String?
     private var shouldShowDeviceList = false
     private var allowDuplicates = false
+    private var manufacturerDataFilters: [ManufacturerDataFilter]?
 
     init(_ viewController: UIViewController?, _ displayStrings: [String: String], _ callback: @escaping Callback) {
         super.init()
@@ -79,6 +80,7 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
         _ serviceUUIDs: [CBUUID],
         _ name: String?,
         _ namePrefix: String?,
+        _ manufacturerDataFilters: [ManufacturerDataFilter]?,
         _ allowDuplicates: Bool,
         _ shouldShowDeviceList: Bool,
         _ scanDuration: Double?,
@@ -94,6 +96,7 @@ class DeviceManager: NSObject, CBCentralManagerDelegate {
             self.allowDuplicates = allowDuplicates
             self.deviceNameFilter = name
             self.deviceNamePrefixFilter = namePrefix
+            self.manufacturerDataFilters = manufacturerDataFilters
 
             if shouldShowDeviceList {
                 self.showDeviceList()
@@ -152,6 +155,7 @@ 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 }
 
         let device: Device
         if self.allowDuplicates, let knownDevice = discoveredDevices.first(where: { $0.key == peripheral.identifier.uuidString })?.value {
@@ -296,6 +300,54 @@ 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]
         if callback != nil {
diff --git a/ios/Plugin/Plugin.swift b/ios/Plugin/Plugin.swift
@@ -7,6 +7,12 @@ 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]
@@ -110,15 +116,17 @@ public class BluetoothLe: CAPPlugin {
         let serviceUUIDs = self.getServiceUUIDs(call)
         let name = call.getString("name")
         let namePrefix = call.getString("namePrefix")
+        let manufacturerDataFilters = self.getManufacturerDataFilters(call)
 
         deviceManager.startScanning(
             serviceUUIDs,
             name,
             namePrefix,
+            manufacturerDataFilters,
             false,
             true,
-            30, {(success, message) in
-                // selected a device
+            30,
+            {(success, message) in
                 if success {
                     guard let device = deviceManager.getDevice(message) else {
                         call.reject("Device not found.")
@@ -130,9 +138,8 @@ public class BluetoothLe: CAPPlugin {
                 } else {
                     call.reject(message)
                 }
-            }, {(_, _, _) in
-
-            }
+            },
+            { (_, _, _) in }
         )
     }
 
@@ -143,20 +150,23 @@ public class BluetoothLe: CAPPlugin {
         let name = call.getString("name")
         let namePrefix = call.getString("namePrefix")
         let allowDuplicates = call.getBool("allowDuplicates", false)
+        let manufacturerDataFilters = self.getManufacturerDataFilters(call)
 
         deviceManager.startScanning(
             serviceUUIDs,
             name,
             namePrefix,
+            manufacturerDataFilters,
             allowDuplicates,
             false,
-            nil, {(success, message) in
+            nil,
+            { (success, message) in
                 if success {
                     call.resolve()
                 } else {
                     call.reject(message)
                 }
-            }, {(device, advertisementData, rssi) in
+            }, { (device, advertisementData, rssi) in
                 self.deviceMap[device.getId()] = device
                 let data = self.getScanResult(device, advertisementData, rssi)
                 self.notifyListeners("onScanResult", data: data)
@@ -521,6 +531,42 @@ public class BluetoothLe: CAPPlugin {
         return serviceUUIDs
     }
 
+    private func getManufacturerDataFilters(_ call: CAPPluginCall) -> [ManufacturerDataFilter]? {
+        guard let manufacturerDataArray = call.getArray("manufacturerData") else {
+            return nil
+        }
+
+        var manufacturerDataFilters: [ManufacturerDataFilter] = []
+
+        for index in 0..<manufacturerDataArray.count {
+            guard let dataObject = manufacturerDataArray[index] as? JSObject,
+                  let companyIdentifier = dataObject["companyIdentifier"] as? UInt16 else {
+                // Invalid or missing company identifier
+                return nil
+            }
+
+            let dataPrefix: Data? = {
+                guard let prefixArray = dataObject["dataPrefix"] as? [Int] else { return nil }
+                return Data(prefixArray.map { UInt8($0 & 0xFF) })
+            }()
+
+            let mask: Data? = {
+                guard let maskArray = dataObject["mask"] as? [Int] else { return nil }
+                return Data(maskArray.map { UInt8($0 & 0xFF) })
+            }()
+
+            let manufacturerFilter = ManufacturerDataFilter(
+                companyIdentifier: companyIdentifier,
+                dataPrefix: dataPrefix,
+                mask: mask
+            )
+
+            manufacturerDataFilters.append(manufacturerFilter)
+        }
+
+        return manufacturerDataFilters
+    }
+
     private func getDevice(_ call: CAPPluginCall, checkConnection: Bool = true) -> Device? {
         guard let deviceId = call.getString("deviceId") else {
             call.reject("deviceId required.")
diff --git a/src/definitions.ts b/src/definitions.ts
@@ -46,6 +46,11 @@ export interface RequestBleDeviceOptions {
    * Android scan mode (default: ScanMode.SCAN_MODE_BALANCED)
    */
   scanMode?: ScanMode;
+  /**
+   * Allow scanning for devices with a specific manufacturer data
+   * https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata
+   */
+  manufacturerData?: { companyIdentifier: number; dataPrefix?: Uint8Array; mask?: Uint8Array }[];
 }
 
 /**
diff --git a/src/web.ts b/src/web.ts
@@ -376,6 +376,11 @@ export class BluetoothLeWeb extends WebPlugin implements BluetoothLePlugin {
         namePrefix: options.namePrefix,
       });
     }
+    for (const manufacturerData of options?.manufacturerData ?? []) {
+      filters.push({
+        manufacturerData: [manufacturerData],
+      });
+    }
     return filters;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -376,6 +376,11 @@ export class BluetoothLeWeb extends WebPlugin implements BluetoothLePlugin {`
`376`	`376`	`namePrefix: options.namePrefix,`
`377`	`377`	`});`
`378`	`378`	`}`
	`379`	`+ for (const manufacturerData of options?.manufacturerData ?? []) {`
	`380`	`+ filters.push({`
	`381`	`+ manufacturerData: [manufacturerData],`
	`382`	`+ });`
	`383`	`+ }`
`379`	`384`	`return filters;`
`380`	`385`	`}`
`381`	`386`