@capacitor-community/bluetooth-le 7.1.1 → 7.2.0

package/README.md

@@ -868,7 +868,7 @@ Write a value to a descriptor.
 ### startNotifications(...)
 
 ```typescript
-startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void) => Promise<void>
+startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void, options?: TimeoutOptions | undefined) => Promise<void>
 ```
 
 Start listening to changes of the value of a characteristic.
@@ -882,6 +882,7 @@ For an example, see [usage](#usage).
 | **`service`**        | <code>string</code>                                               | UUID of the service (see [UUID format](#uuid-format))                                                          |
 | **`characteristic`** | <code>string</code>                                               | UUID of the characteristic (see [UUID format](#uuid-format))                                                   |
 | **`callback`**       | <code>(value: <a href="#dataview">DataView</a>) =&gt; void</code> | Callback function to use when the value of the characteristic changes                                          |
+| **`options`**        | <code><a href="#timeoutoptions">TimeoutOptions</a></code>         | Options for plugin call. Timeout not supported on **web**.                                                     |
 
 ---
 

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

@@ -757,6 +757,7 @@ class BluetoothLe : Plugin() {
     fun startNotifications(call: PluginCall) {
         val device = getDevice(call) ?: return
         val characteristic = getCharacteristic(call) ?: return
+        val timeout = call.getFloat("timeout", DEFAULT_TIMEOUT)!!.toLong()
         device.setNotifications(characteristic.first, characteristic.second, true, { response ->
             run {
                 val key =
@@ -769,7 +770,7 @@ class BluetoothLe : Plugin() {
                     Logger.error(TAG, "Error in notifyListeners: ${e.localizedMessage}", e)
                 }
             }
-        }, { response ->
+        }, timeout, { response ->
             run {
                 if (response.success) {
                     call.resolve()
@@ -784,8 +785,9 @@ class BluetoothLe : Plugin() {
     fun stopNotifications(call: PluginCall) {
         val device = getDevice(call) ?: return
         val characteristic = getCharacteristic(call) ?: return
+        val timeout = call.getFloat("timeout", DEFAULT_TIMEOUT)!!.toLong()
         device.setNotifications(
-            characteristic.first, characteristic.second, false, null
+            characteristic.first, characteristic.second, false, null, timeout
         ) { response ->
             run {
                 if (response.success) {

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

@@ -68,6 +68,7 @@ class Device(
     private var device: BluetoothDevice = bluetoothAdapter.getRemoteDevice(address)
     private var bluetoothGatt: BluetoothGatt? = null
     private var callbackMap = HashMap<String, ((CallbackResponse) -> Unit)>()
+    private val bondReceiverMap = HashMap<String, BroadcastReceiver>()
     private val timeoutQueue = ConcurrentLinkedQueue<TimeoutHandler>()
     private var bondStateReceiver: BroadcastReceiver? = null
     private var currentMtu = -1
@@ -280,6 +281,9 @@ class Device(
             super.onDescriptorWrite(gatt, descriptor, status)
             val key =
                 "writeDescriptor|${descriptor.characteristic.service.uuid}|${descriptor.characteristic.uuid}|${descriptor.uuid}"
+            bondReceiverMap.remove(key)?.let {
+                context.unregisterReceiver(it)
+            }
             if (status == BluetoothGatt.GATT_SUCCESS) {
                 resolve(key, "Descriptor successfully written.")
             } else {
@@ -546,6 +550,7 @@ class Device(
         characteristicUUID: UUID,
         enable: Boolean,
         notifyCallback: ((CallbackResponse) -> Unit)?,
+        timeout: Long,
         callback: (CallbackResponse) -> Unit,
     ) {
         val key = "writeDescriptor|$serviceUUID|$characteristicUUID|$CLIENT_CHARACTERISTIC_CONFIG"
@@ -585,9 +590,47 @@ class Device(
             BluetoothGattDescriptor.DISABLE_NOTIFICATION_VALUE
         }
 
+        val bondReceiver = object : BroadcastReceiver() {
+            override fun onReceive(ctx: Context, intent: Intent) {
+                if (intent.action == BluetoothDevice.ACTION_BOND_STATE_CHANGED) {
+                    val updatedDevice =
+                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+                            intent.getParcelableExtra(
+                                BluetoothDevice.EXTRA_DEVICE,
+                                BluetoothDevice::class.java
+                            )
+                        } else {
+                            intent.getParcelableExtra<BluetoothDevice>(BluetoothDevice.EXTRA_DEVICE)
+                        }
+
+                    // BroadcastReceiver receives bond state updates from all devices, need to filter by device
+                    if (device.address == updatedDevice?.address) {
+                        val prev = intent.getIntExtra(BluetoothDevice.EXTRA_PREVIOUS_BOND_STATE, -1)
+                        val state = intent.getIntExtra(BluetoothDevice.EXTRA_BOND_STATE, -1)
+                        if (state == BluetoothDevice.BOND_BONDED) {
+                            ctx.unregisterReceiver(this)
+                        } else if (prev == BluetoothDevice.BOND_BONDING && state == BluetoothDevice.BOND_NONE) {
+                            ctx.unregisterReceiver(this)
+                            reject(key, "Pairing request was cancelled by the user.")
+                        } else if (state == -1) {
+                            ctx.unregisterReceiver(this)
+                        }
+                    }
+                }
+            }
+        }
+        bondReceiverMap[key] = bondReceiver
+        context.registerReceiver(
+            bondReceiver,
+            IntentFilter(BluetoothDevice.ACTION_BOND_STATE_CHANGED)
+        )
+
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
             val statusCode = bluetoothGatt?.writeDescriptor(descriptor, value)
             if (statusCode != BluetoothStatusCodes.SUCCESS) {
+                bondReceiverMap.remove(key)?.let {
+                    context.unregisterReceiver(it)
+                }
                 reject(key, "Setting notification failed with status code $statusCode.")
                 return
             }
@@ -595,11 +638,15 @@ class Device(
             descriptor.value = value
             val resultDesc = bluetoothGatt?.writeDescriptor(descriptor)
             if (resultDesc != true) {
+                bondReceiverMap.remove(key)?.let {
+                    context.unregisterReceiver(it)
+                }
                 reject(key, "Setting notification failed.")
                 return
             }
 
         }
+        setTimeout(key, "Setting notification timeout.", timeout)
         // wait for onDescriptorWrite
     }
 

package/dist/docs.json

@@ -17,7 +17,7 @@
         ],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Initialize Bluetooth Low Energy (BLE). If it fails, BLE might be unavailable on this device.\r\nOn **Android** it will ask for the location permission. On **iOS** it will ask for the Bluetooth permission.\r\nFor an example, see [usage](#usage).",
+        "docs": "Initialize Bluetooth Low Energy (BLE). If it fails, BLE might be unavailable on this device.\nOn **Android** it will ask for the location permission. On **iOS** it will ask for the Bluetooth permission.\nFor an example, see [usage](#usage).",
         "complexTypes": [
           "InitializeOptions"
         ],
@@ -29,7 +29,7 @@
         "parameters": [],
         "returns": "Promise<boolean>",
         "tags": [],
-        "docs": "Reports whether Bluetooth is enabled on this device.\r\nAlways returns `true` on **web**.",
+        "docs": "Reports whether Bluetooth is enabled on this device.\nAlways returns `true` on **web**.",
         "complexTypes": [],
         "slug": "isenabled"
       },
@@ -39,7 +39,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Request enabling Bluetooth. Show a system activity that allows the user to turn on Bluetooth. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#ACTION_REQUEST_ENABLE\r\nOnly available on **Android**.",
+        "docs": "Request enabling Bluetooth. Show a system activity that allows the user to turn on Bluetooth. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#ACTION_REQUEST_ENABLE\nOnly available on **Android**.",
         "complexTypes": [],
         "slug": "requestenable"
       },
@@ -54,7 +54,7 @@
             "text": "Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()"
           }
         ],
-        "docs": "Enable Bluetooth.\r\nOnly available on **Android**.\r\n**Deprecated** Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()",
+        "docs": "Enable Bluetooth.\nOnly available on **Android**.\n**Deprecated** Will fail on Android SDK >= 33. Use `requestEnable` instead. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#enable()",
         "complexTypes": [],
         "slug": "enable"
       },
@@ -69,7 +69,7 @@
             "text": "Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()"
           }
         ],
-        "docs": "Disable Bluetooth.\r\nOnly available on **Android**.\r\n**Deprecated** Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()",
+        "docs": "Disable Bluetooth.\nOnly available on **Android**.\n**Deprecated** Will fail on Android SDK >= 33. See https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#disable()",
         "complexTypes": [],
         "slug": "disable"
       },
@@ -90,7 +90,7 @@
             "text": "callback Callback function to use when the Bluetooth state changes."
           }
         ],
-        "docs": "Register a callback function that will be invoked when Bluetooth is enabled (true) or disabled (false) on this device.\r\nNot available on **web** (the callback will never be invoked).",
+        "docs": "Register a callback function that will be invoked when Bluetooth is enabled (true) or disabled (false) on this device.\nNot available on **web** (the callback will never be invoked).",
         "complexTypes": [],
         "slug": "startenablednotifications"
       },
@@ -110,7 +110,7 @@
         "parameters": [],
         "returns": "Promise<boolean>",
         "tags": [],
-        "docs": "Reports whether Location Services are enabled on this device.\r\nOnly available on **Android**.",
+        "docs": "Reports whether Location Services are enabled on this device.\nOnly available on **Android**.",
         "complexTypes": [],
         "slug": "islocationenabled"
       },
@@ -120,7 +120,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Open Location settings.\r\nOnly available on **Android**.",
+        "docs": "Open Location settings.\nOnly available on **Android**.",
         "complexTypes": [],
         "slug": "openlocationsettings"
       },
@@ -130,7 +130,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Open Bluetooth settings.\r\nOnly available on **Android**.",
+        "docs": "Open Bluetooth settings.\nOnly available on **Android**.",
         "complexTypes": [],
         "slug": "openbluetoothsettings"
       },
@@ -140,7 +140,7 @@
         "parameters": [],
         "returns": "Promise<void>",
         "tags": [],
-        "docs": "Open App settings.\r\nNot available on **web**.\r\nOn **iOS** when a user declines the request to use Bluetooth on the first call of `initialize`, it is not possible\r\nto request for Bluetooth again from within the app. In this case Bluetooth has to be enabled in the app settings\r\nfor the app to be able use it.",
+        "docs": "Open App settings.\nNot available on **web**.\nOn **iOS** when a user declines the request to use Bluetooth on the first call of `initialize`, it is not possible\nto request for Bluetooth again from within the app. In this case Bluetooth has to be enabled in the app settings\nfor the app to be able use it.",
         "complexTypes": [],
         "slug": "openappsettings"
       },
@@ -184,7 +184,7 @@
             "text": "options Device filters, see [RequestBleDeviceOptions](#RequestBleDeviceOptions)"
           }
         ],
-        "docs": "Request a peripheral BLE device to interact with. This will scan for available devices according to the filters in the options and show a dialog to pick a device.\r\nFor an example, see [usage](#usage).",
+        "docs": "Request a peripheral BLE device to interact with. This will scan for available devices according to the filters in the options and show a dialog to pick a device.\nFor an example, see [usage](#usage).",
         "complexTypes": [
           "BleDevice",
           "RequestBleDeviceOptions"
@@ -217,7 +217,7 @@
             "text": "callback"
           }
         ],
-        "docs": "Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.\r\nScanning will continue until `stopLEScan` is called. For an example, see [usage](#usage).\r\n**Note**: Use with care on **web** platform, the required API is still behind a flag in most browsers.",
+        "docs": "Start scanning for BLE devices to interact with according to the filters in the options. The callback will be invoked on each device that is found.\nScanning will continue until `stopLEScan` is called. For an example, see [usage](#usage).\n**Note**: Use with care on **web** platform, the required API is still behind a flag in most browsers.",
         "complexTypes": [
           "RequestBleDeviceOptions",
           "ScanResult"
@@ -251,7 +251,7 @@
             "text": "deviceIds List of device IDs, e.g. saved from a previous app run."
           }
         ],
-        "docs": "On iOS and web, if you want to connect to a previously connected device without scanning first, you can use `getDevice`.\r\nUses [retrievePeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1519127-retrieveperipherals) on iOS and\r\n[getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.\r\nOn Android, you can directly connect to the device with the deviceId.",
+        "docs": "On iOS and web, if you want to connect to a previously connected device without scanning first, you can use `getDevice`.\nUses [retrievePeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1519127-retrieveperipherals) on iOS and\n[getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.\nOn Android, you can directly connect to the device with the deviceId.",
         "complexTypes": [
           "BleDevice"
         ],
@@ -263,7 +263,7 @@
         "parameters": [],
         "returns": "Promise<BleDevice[]>",
         "tags": [],
-        "docs": "Get a list of currently bonded devices.\r\nOnly available on **Android**.\r\nUses [getBondedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getBondedDevices()) on Android",
+        "docs": "Get a list of currently bonded devices.\nOnly available on **Android**.\nUses [getBondedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothAdapter#getBondedDevices()) on Android",
         "complexTypes": [
           "BleDevice"
         ],
@@ -286,7 +286,7 @@
             "text": "services List of services to filter the devices by. If no service is specified, no devices will be returned. Only applies to iOS."
           }
         ],
-        "docs": "Get a list of currently connected devices.\r\nUses [retrieveConnectedPeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1518924-retrieveconnectedperipherals) on iOS,\r\n[getConnectedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothManager#getConnectedDevices(int)) on Android\r\nand [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.",
+        "docs": "Get a list of currently connected devices.\nUses [retrieveConnectedPeripherals](https://developer.apple.com/documentation/corebluetooth/cbcentralmanager/1518924-retrieveconnectedperipherals) on iOS,\n[getConnectedDevices](https://developer.android.com/reference/android/bluetooth/BluetoothManager#getConnectedDevices(int)) on Android\nand [getDevices](https://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/getDevices) on web.",
         "complexTypes": [
           "BleDevice"
         ],
@@ -359,7 +359,7 @@
             "text": "options Options for plugin call"
           }
         ],
-        "docs": "Create a bond with a peripheral BLE device.\r\nOnly available on **Android**. On iOS bonding is handled by the OS.",
+        "docs": "Create a bond with a peripheral BLE device.\nOnly available on **Android**. On iOS bonding is handled by the OS.",
         "complexTypes": [
           "TimeoutOptions"
         ],
@@ -382,7 +382,7 @@
             "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
           }
         ],
-        "docs": "Report whether a peripheral BLE device is bonded.\r\nOnly available on **Android**. On iOS bonding is handled by the OS.",
+        "docs": "Report whether a peripheral BLE device is bonded.\nOnly available on **Android**. On iOS bonding is handled by the OS.",
         "complexTypes": [],
         "slug": "isbonded"
       },
@@ -447,7 +447,7 @@
             "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
           }
         ],
-        "docs": "Discover services, characteristics and descriptors of a device.\r\nYou only need this method if your peripheral device changes its services and characteristics at runtime.\r\nIf the discovery was successful, the remote services can be retrieved using the getServices function.\r\nNot available on **web**.",
+        "docs": "Discover services, characteristics and descriptors of a device.\nYou only need this method if your peripheral device changes its services and characteristics at runtime.\nIf the discovery was successful, the remote services can be retrieved using the getServices function.\nNot available on **web**.",
         "complexTypes": [],
         "slug": "discoverservices"
       },
@@ -468,7 +468,7 @@
             "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
           }
         ],
-        "docs": "Get the MTU of a connected device. Note that the maximum write value length is 3 bytes less than the MTU.\r\nNot available on **web**.",
+        "docs": "Get the MTU of a connected device. Note that the maximum write value length is 3 bytes less than the MTU.\nNot available on **web**.",
         "complexTypes": [],
         "slug": "getmtu"
       },
@@ -498,7 +498,7 @@
             "text": "connectionPriority Request a specific connection priority. See [ConnectionPriority](#connectionpriority)"
           }
         ],
-        "docs": "Request a connection parameter update.\r\nOnly available on **Android**. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#requestConnectionPriority(int)",
+        "docs": "Request a connection parameter update.\nOnly available on **Android**. https://developer.android.com/reference/android/bluetooth/BluetoothGatt#requestConnectionPriority(int)",
         "complexTypes": [
           "ConnectionPriority"
         ],
@@ -521,7 +521,7 @@
             "text": "deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))"
           }
         ],
-        "docs": "Read the RSSI value of a connected device.\r\nNot available on **web**.",
+        "docs": "Read the RSSI value of a connected device.\nNot available on **web**.",
         "complexTypes": [],
         "slug": "readrssi"
       },
@@ -827,7 +827,7 @@
       },
       {
         "name": "startNotifications",
-        "signature": "(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void) => Promise<void>",
+        "signature": "(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void, options?: TimeoutOptions | undefined) => Promise<void>",
         "parameters": [
           {
             "name": "deviceId",
@@ -848,6 +848,11 @@
             "name": "callback",
             "docs": "Callback function to use when the value of the characteristic changes",
             "type": "(value: DataView) => void"
+          },
+          {
+            "name": "options",
+            "docs": "Options for plugin call. Timeout not supported on **web**.",
+            "type": "TimeoutOptions | undefined"
           }
         ],
         "returns": "Promise<void>",
@@ -867,11 +872,16 @@
           {
             "name": "param",
             "text": "callback Callback function to use when the value of the characteristic changes"
+          },
+          {
+            "name": "param",
+            "text": "options Options for plugin call. Timeout not supported on **web**."
           }
         ],
-        "docs": "Start listening to changes of the value of a characteristic.\r\nNote that you should only start the notifications once per characteristic in your app and share the data and\r\nnot call `startNotifications` in every component that needs the data.\r\nFor an example, see [usage](#usage).",
+        "docs": "Start listening to changes of the value of a characteristic.\nNote that you should only start the notifications once per characteristic in your app and share the data and\nnot call `startNotifications` in every component that needs the data.\nFor an example, see [usage](#usage).",
         "complexTypes": [
-          "DataView"
+          "DataView",
+          "TimeoutOptions"
         ],
         "slug": "startnotifications"
       },
@@ -933,7 +943,7 @@
               "name": "default"
             }
           ],
-          "docs": "If your app doesn't use Bluetooth scan results to derive physical\r\nlocation information, you can strongly assert that your app\r\ndoesn't derive physical location. (Android only)\r\nRequires adding 'neverForLocation' to AndroidManifest.xml\r\nhttps://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location",
+          "docs": "If your app doesn't use Bluetooth scan results to derive physical\nlocation information, you can strongly assert that your app\ndoesn't derive physical location. (Android only)\nRequires adding 'neverForLocation' to AndroidManifest.xml\nhttps://developer.android.com/guide/topics/connectivity/bluetooth/permissions#assert-never-for-location",
           "complexTypes": [],
           "type": "boolean | undefined"
         }
@@ -1038,7 +1048,7 @@
         {
           "name": "deviceId",
           "tags": [],
-          "docs": "ID of the device, which will be needed for further calls.\r\nOn **Android** this is the BLE MAC address.\r\nOn **iOS** and **web** it is an identifier.",
+          "docs": "ID of the device, which will be needed for further calls.\nOn **Android** this is the BLE MAC address.\nOn **iOS** and **web** it is an identifier.",
           "complexTypes": [],
           "type": "string"
         },
@@ -1068,7 +1078,7 @@
         {
           "name": "services",
           "tags": [],
-          "docs": "Filter devices by service UUIDs.\r\nUUIDs have to be specified as 128 bit UUID strings,\r\ne.g. ['0000180d-0000-1000-8000-00805f9b34fb']\r\nThere is a helper function to convert numbers to UUIDs.\r\ne.g. [numberToUUID(0x180f)]. (see [UUID format](#uuid-format))",
+          "docs": "Filter devices by service UUIDs.\nUUIDs have to be specified as 128 bit UUID strings,\ne.g. ['0000180d-0000-1000-8000-00805f9b34fb']\nThere is a helper function to convert numbers to UUIDs.\ne.g. [numberToUUID(0x180f)]. (see [UUID format](#uuid-format))",
           "complexTypes": [],
           "type": "string[] | undefined"
         },
@@ -1089,14 +1099,14 @@
         {
           "name": "optionalServices",
           "tags": [],
-          "docs": "For **web**, all services that will be used have to be listed under services or optionalServices,\r\ne.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format))",
+          "docs": "For **web**, all services that will be used have to be listed under services or optionalServices,\ne.g. [numberToUUID(0x180f)] (see [UUID format](#uuid-format))",
           "complexTypes": [],
           "type": "string[] | undefined"
         },
         {
           "name": "allowDuplicates",
           "tags": [],
-          "docs": "Normally scans will discard the second and subsequent advertisements from a single device.\r\nIf you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`).\r\n(default: false)",
+          "docs": "Normally scans will discard the second and subsequent advertisements from a single device.\nIf you need to receive them, set allowDuplicates to true (only applicable in `requestLEScan`).\n(default: false)",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
@@ -1112,7 +1122,7 @@
         {
           "name": "manufacturerData",
           "tags": [],
-          "docs": "Allow scanning for devices with a specific manufacturer data\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata",
+          "docs": "Allow scanning for devices with a specific manufacturer data\nhttps://developer.mozilla.org/en-US/docs/Web/API/Bluetooth/requestDevice#manufacturerdata",
           "complexTypes": [
             "ManufacturerDataFilter"
           ],
@@ -1137,7 +1147,7 @@
         {
           "name": "dataPrefix",
           "tags": [],
-          "docs": "Prefix to match in the manufacturer data field.\r\nOn **Android** this field is mandatory.",
+          "docs": "Prefix to match in the manufacturer data field.\nOn **Android** this field is mandatory.",
           "complexTypes": [
             "Uint8Array"
           ],
@@ -1146,7 +1156,7 @@
         {
           "name": "mask",
           "tags": [],
-          "docs": "Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.\r\nThe `mask` must have the same length of dataPrefix.",
+          "docs": "Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.\nThe `mask` must have the same length of dataPrefix.",
           "complexTypes": [
             "Uint8Array"
           ],
@@ -1995,7 +2005,7 @@
         {
           "name": "device",
           "tags": [],
-          "docs": "The peripheral device that was found in the scan.\r\n**Android** and **web**: `device.name` is always identical to `localName`.\r\n**iOS**: `device.name` is identical to `localName` the first time a device is discovered, but after connecting `device.name` is the cached GAP name in subsequent scans.",
+          "docs": "The peripheral device that was found in the scan.\n**Android** and **web**: `device.name` is always identical to `localName`.\n**iOS**: `device.name` is identical to `localName` the first time a device is discovered, but after connecting `device.name` is the cached GAP name in subsequent scans.",
           "complexTypes": [
             "BleDevice"
           ],
@@ -2593,7 +2603,7 @@
         {
           "name": "timeout",
           "tags": [],
-          "docs": "Timeout in milliseconds for plugin call.\r\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
+          "docs": "Timeout in milliseconds for plugin call.\nDefault is 10000 for `connect` and 5000 for other plugin methods.",
           "complexTypes": [],
           "type": "number | undefined"
         }
@@ -2777,19 +2787,19 @@
           "name": "SCAN_MODE_LOW_POWER",
           "value": "0",
           "tags": [],
-          "docs": "Perform Bluetooth LE scan in low power mode. This mode is enforced if the scanning application is not in foreground.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_POWER"
+          "docs": "Perform Bluetooth LE scan in low power mode. This mode is enforced if the scanning application is not in foreground.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_POWER"
         },
         {
           "name": "SCAN_MODE_BALANCED",
           "value": "1",
           "tags": [],
-          "docs": "Perform Bluetooth LE scan in balanced power mode. (default) Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_BALANCED"
+          "docs": "Perform Bluetooth LE scan in balanced power mode. (default) Scan results are returned at a rate that provides a good trade-off between scan frequency and power consumption.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_BALANCED"
         },
         {
           "name": "SCAN_MODE_LOW_LATENCY",
           "value": "2",
           "tags": [],
-          "docs": "Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.\r\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_LATENCY"
+          "docs": "Scan using highest duty cycle. It's recommended to only use this mode when the application is running in the foreground.\nhttps://developer.android.com/reference/android/bluetooth/le/ScanSettings#SCAN_MODE_LOW_LATENCY"
         }
       ]
     },
@@ -2801,19 +2811,19 @@
           "name": "CONNECTION_PRIORITY_BALANCED",
           "value": "0",
           "tags": [],
-          "docs": "Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_BALANCED"
+          "docs": "Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_BALANCED"
         },
         {
           "name": "CONNECTION_PRIORITY_HIGH",
           "value": "1",
           "tags": [],
-          "docs": "Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_HIGH"
+          "docs": "Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_BALANCED connection parameters to reduce energy use.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_HIGH"
         },
         {
           "name": "CONNECTION_PRIORITY_LOW_POWER",
           "value": "2",
           "tags": [],
-          "docs": "Request low power, reduced data rate connection parameters.\r\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
+          "docs": "Request low power, reduced data rate connection parameters.\nhttps://developer.android.com/reference/android/bluetooth/BluetoothGatt#CONNECTION_PRIORITY_LOW_POWER"
         }
       ]
     }
@@ -2846,11 +2856,11 @@
               "name": "since"
             },
             {
-              "text": "{\r\n\"scanning\": \"Scanning...\",\r\n\"cancel\": \"Cancel\",\r\n\"availableDevices\": \"Available devices\",\r\n\"noDeviceFound\": \"No device found\"\r\n}",
+              "text": "{\n\"scanning\": \"Scanning...\",\n\"cancel\": \"Cancel\",\n\"availableDevices\": \"Available devices\",\n\"noDeviceFound\": \"No device found\"\n}",
               "name": "default"
             },
             {
-              "text": "{\r\nscanning: \"Am Scannen...\",\r\ncancel: \"Abbrechen\",\r\navailableDevices: \"Verfügbare Geräte\",\r\nnoDeviceFound: \"Kein Gerät gefunden\",\r\n}",
+              "text": "{\nscanning: \"Am Scannen...\",\ncancel: \"Abbrechen\",\navailableDevices: \"Verfügbare Geräte\",\nnoDeviceFound: \"Kein Gerät gefunden\",\n}",
               "name": "example"
             }
           ],

package/dist/esm/bleClient.d.ts

@@ -219,8 +219,9 @@ export interface BleClientInterface {
      * @param service UUID of the service (see [UUID format](#uuid-format))
      * @param characteristic UUID of the characteristic (see [UUID format](#uuid-format))
      * @param callback Callback function to use when the value of the characteristic changes
+     * @param options Options for plugin call. Timeout not supported on **web**.
      */
-    startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void): Promise<void>;
+    startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void, options?: TimeoutOptions): Promise<void>;
     /**
      * Stop listening to the changes of the value of a characteristic. For an example, see [usage](#usage).
      * @param deviceId The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))
@@ -267,7 +268,7 @@ declare class BleClientClass implements BleClientInterface {
     writeWithoutResponse(deviceId: string, service: string, characteristic: string, value: DataView, options?: TimeoutOptions): Promise<void>;
     readDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, options?: TimeoutOptions): Promise<DataView>;
     writeDescriptor(deviceId: string, service: string, characteristic: string, descriptor: string, value: DataView, options?: TimeoutOptions): Promise<void>;
-    startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void): Promise<void>;
+    startNotifications(deviceId: string, service: string, characteristic: string, callback: (value: DataView) => void, options?: TimeoutOptions): Promise<void>;
     stopNotifications(deviceId: string, service: string, characteristic: string): Promise<void>;
     private validateRequestBleDeviceOptions;
     private convertValue;

package/dist/esm/bleClient.js

@@ -284,7 +284,7 @@ class BleClientClass {
                 descriptor, value: writeValue }, options));
         });
     }
-    async startNotifications(deviceId, service, characteristic, callback) {
+    async startNotifications(deviceId, service, characteristic, callback, options) {
         service = parseUUID(service);
         characteristic = parseUUID(characteristic);
         await this.queue(async () => {
@@ -295,11 +295,9 @@ class BleClientClass {
                 callback(this.convertValue(event === null || event === void 0 ? void 0 : event.value));
             });
             this.eventListeners.set(key, listener);
-            await BluetoothLe.startNotifications({
-                deviceId,
+            await BluetoothLe.startNotifications(Object.assign({ deviceId,
                 service,
-                characteristic,
-            });
+                characteristic }, options));
         });
     }
     async stopNotifications(deviceId, service, characteristic) {