Flutter Reactive BLE

https://pub.dev/packages/flutter_reactive_ble
Admin
A Flutter library for reactive Bluetooth Low Energy (BLE) operations, enabling communication with...
Tokens:12,800
Snippets:91
Trust Score:9.9
Update:1 day ago
Show doc for...
Tokens:
Raw
### Initialize FlutterReactiveBle

Source: https://pub.dev/packages/flutter_reactive_ble

Creates an instance of FlutterReactiveBle to start using the library.

```dart
final flutterReactiveBle = FlutterReactiveBle();
```

--------------------------------

### status

Source: https://pub.dev/packages/flutter_reactive_ble

Gets the current BLE status of the host device.

```APIDOC
## status

### Description
Gets the current BLE status of the host device. See BleStatus for more info about the meaning of the different statuses.

### Method
status

### Usage Example
```dart
_ble.status
```

```

--------------------------------

### Scan for BLE devices with scanForDevices

Source: https://pub.dev/packages/flutter_reactive_ble

Starts scanning for BLE devices. The withServices parameter filters by advertised service IDs; an empty list reports all devices. scanMode is Android-only and defaults to balanced if omitted.

```dart
flutterReactiveBle.scanForDevices(withServices: [serviceId], scanMode: ScanMode.lowLatency).listen((device) {
      //code for handling results
    }, onError: () {
      //code for handling error
    });
```

--------------------------------

### Scan for BLE devices with scanForDevices

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Starts a BLE scan for devices advertising the specified service IDs. If withServices is empty, all advertising devices are reported. scanMode is Android-only and defaults to balanced if omitted.

```dart
flutterReactiveBle.scanForDevices(withServices: [serviceId], scanMode: ScanMode.lowLatency).listen((device) {
      //code for handling results
    }, onError: () {
      //code for handling error
    });
  
```

--------------------------------

### connectToDevice

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Establishes a connection to a BLE device. Returns a stream of connection state updates.

```APIDOC
## connectToDevice

### Description
Establishes a connection to a BLE device. The device ID is required and can be obtained from device discovery. On iOS it is a UUID, on Android it is a MAC address. Supplying a map of services and characteristics to discover may speed up connection on iOS. A connectionTimeout can be specified to error if connection cannot be established within the time.

### Method
connectToDevice

### Parameters
- **id** (String) - Required - Device ID (UUID on iOS, MAC address on Android).
- **servicesWithCharacteristicsToDiscover** (Map<Uuid, List<Uuid>>) - Optional - Map of service IDs to characteristic IDs to discover.
- **connectionTimeout** (Duration) - Optional - Timeout for connection establishment.

### Example
```dart
flutterReactiveBle.connectToDevice(
  id: foundDeviceId,
  servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
  connectionTimeout: const Duration(seconds: 2),
).listen((connectionState) {
  // Handle connection state updates
}, onError: (Object error) {
  // Handle a possible error
});
```
```

--------------------------------

### Initialization

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Initializes the FlutterReactiveBle library by creating an instance of the FlutterReactiveBle class.

```APIDOC
## Initialization

### Description
Creates an instance of the FlutterReactiveBle class to interact with BLE devices.

### Method
Constructor

### Example
```dart
final flutterReactiveBle = FlutterReactiveBle();
```
```

--------------------------------

### Connect to advertising device with connectToAdvertisingDevice

Source: https://pub.dev/packages/flutter_reactive_ble

Scans for the device before connecting, to work around Android BLE hanging issues. Requires withServices and prescanDuration parameters.

```dart
flutterReactiveBle.connectToAdvertisingDevice(
    id: foundDeviceId,
    withServices: [serviceUuid],
    prescanDuration: const Duration(seconds: 5),
    servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
    connectionTimeout: const Duration(seconds:  2),
  ).listen((connectionState) {
    // Handle connection state updates
  }, onError: (dynamic error) {
    // Handle a possible error
  });
```

--------------------------------

### connectToDevice

Source: https://pub.dev/packages/flutter_reactive_ble

Establishes a connection to a BLE device using its device ID. Optionally specifies services and characteristics to discover and a connection timeout.

```APIDOC
## connectToDevice

### Description
Establishes a connection to a BLE device. The device ID is obtained from device discovery. On iOS it is a UUID, on Android a MAC address. Supplying a map of services and characteristics to discover may speed up connection on iOS. A connection timeout can be specified to error if connection cannot be established within the time.

### Method
connectToDevice

### Parameters
- **id** (String) - Required - Device ID from discovery.
- **servicesWithCharacteristicsToDiscover** (Map<Uuid, List<Uuid>>) - Optional - Map of service IDs to characteristic IDs to discover.
- **connectionTimeout** (Duration) - Optional - Timeout for connection establishment.

### Usage Example
```dart
flutterReactiveBle.connectToDevice(
  id: foundDeviceId,
  servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
  connectionTimeout: const Duration(seconds: 2),
).listen((connectionState) {
  // Handle connection state updates
}, onError: (Object error) {
  // Handle a possible error
});
```

```

--------------------------------

### FlutterReactiveBle()

Source: https://pub.dev/packages/flutter_reactive_ble

Initializes the FlutterReactiveBle instance for use in the application.

```APIDOC
## FlutterReactiveBle()

### Description
Initializes the FlutterReactiveBle library. This is the entry point for all BLE operations.

### Method
Constructor

### Usage Example
```dart
final flutterReactiveBle = FlutterReactiveBle();
```

```

--------------------------------

### requestMtu

Source: https://pub.dev/packages/flutter_reactive_ble

Requests a specific MTU size for the BLE connection. Returns the actual negotiated MTU size, which may differ from the requested size.

```APIDOC
## requestMtu

### Description
Requests a new MTU size for the connection. Returns the actual negotiated MTU size.

### Method
requestMtu

### Parameters
- **deviceId** (String) - Required - The ID of the BLE device.
- **mtu** (int) - Required - The desired MTU size.

### Request Example
```dart
final mtu = await flutterReactiveBle.requestMtu(deviceId: foundDeviceId, mtu: 250);
```

### Response
Returns a Future<int> that resolves to the actual negotiated MTU size.
```

--------------------------------

### scanForDevices

Source: https://pub.dev/packages/flutter_reactive_ble

Scans for BLE devices advertising the specified service IDs. Returns a stream of discovered devices.

```APIDOC
## scanForDevices

### Description
Scans for BLE devices that advertise the specified service IDs. If an empty list is provided, all advertising devices are reported. The scan mode is only used on Android and follows Android's ScanSettings conventions.

### Method
scanForDevices

### Parameters
- **withServices** (List<Uuid>) - Required - List of service IDs to filter by. Empty list means all devices.
- **scanMode** (ScanMode) - Optional - Android scan mode (e.g., lowLatency). Defaults to balanced if omitted.

### Usage Example
```dart
flutterReactiveBle.scanForDevices(withServices: [serviceId], scanMode: ScanMode.lowLatency).listen((device) {
  //code for handling results
}, onError: () {
  //code for handling error
});
```

```

--------------------------------

### scanForDevices

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Scans for BLE devices advertising the specified service IDs. Returns a stream of discovered devices.

```APIDOC
## scanForDevices

### Description
Scans for BLE devices that advertise the specified service IDs. If an empty list is provided, all advertising devices are reported. The scanMode parameter is only used on Android and follows the conventions described in the Android ScanSettings reference. If omitted, balanced scan mode is used.

### Method
scanForDevices

### Parameters
- **withServices** (List<Uuid>) - Required - List of service IDs to filter devices by.
- **scanMode** (ScanMode) - Optional - Scan mode (Android only). Defaults to balanced.

### Example
```dart
flutterReactiveBle.scanForDevices(withServices: [serviceId], scanMode: ScanMode.lowLatency).listen((device) {
  //code for handling results
}, onError: () {
  //code for handling error
});
```
```

--------------------------------

### connectToAdvertisingDevice

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Scans for a device and connects to it only if found. Useful to work around Android BLE stack issues when connecting to devices not in range.

```APIDOC
## connectToAdvertisingDevice

### Description
Scans for a device and connects to it only if found. This method is useful to work around Android BLE stack issues that leave it hanging when connecting to a device not in range. It requires additional parameters `withServices` and `prescanDuration`.

### Method
connectToAdvertisingDevice

### Parameters
- **id** (String) - Required - Device ID.
- **withServices** (List<Uuid>) - Required - Service IDs to scan for.
- **prescanDuration** (Duration) - Required - Duration to scan for the device before attempting to connect.
- **servicesWithCharacteristicsToDiscover** (Map<Uuid, List<Uuid>>) - Optional - Map of service IDs to characteristic IDs to discover.
- **connectionTimeout** (Duration) - Optional - Timeout for connection establishment.

### Example
```dart
flutterReactiveBle.connectToAdvertisingDevice(
  id: foundDeviceId,
  withServices: [serviceUuid],
  prescanDuration: const Duration(seconds: 5),
  servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
  connectionTimeout: const Duration(seconds: 2),
).listen((connectionState) {
  // Handle connection state updates
}, onError: (dynamic error) {
  // Handle a possible error
});
```
```

--------------------------------

### connectToAdvertisingDevice

Source: https://pub.dev/packages/flutter_reactive_ble

Scans for a device and connects to it only if found. Useful to work around Android BLE stack issues when connecting to out-of-range devices.

```APIDOC
## connectToAdvertisingDevice

### Description
Scans for a device and connects to it only if found. This method is recommended to avoid Android BLE stack hanging when connecting to devices not in range. It requires additional parameters `withServices` and `prescanDuration`.

### Method
connectToAdvertisingDevice

### Parameters
- **id** (String) - Required - Device ID from discovery.
- **withServices** (List<Uuid>) - Required - List of service IDs to scan for.
- **prescanDuration** (Duration) - Required - Duration to scan for the device before attempting to connect.
- **servicesWithCharacteristicsToDiscover** (Map<Uuid, List<Uuid>>) - Optional - Map of service IDs to characteristic IDs to discover.
- **connectionTimeout** (Duration) - Optional - Timeout for connection establishment.

### Usage Example
```dart
flutterReactiveBle.connectToAdvertisingDevice(
  id: foundDeviceId,
  withServices: [serviceUuid],
  prescanDuration: const Duration(seconds: 5),
  servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
  connectionTimeout: const Duration(seconds: 2),
).listen((connectionState) {
  // Handle connection state updates
}, onError: (dynamic error) {
  // Handle a possible error
});
```

```

--------------------------------

### Connect to a BLE device with connectToDevice

Source: https://pub.dev/packages/flutter_reactive_ble

Establishes a connection to a discovered device. The id is required (UUID on iOS, MAC address on Android). Optionally specify services/characteristics to discover and a connection timeout.

```dart
flutterReactiveBle.connectToDevice(
      id: foundDeviceId,
      servicesWithCharacteristicsToDiscover: {serviceId: [char1, char2]},
      connectionTimeout: const Duration(seconds: 2),
    ).listen((connectionState) {
      // Handle connection state updates
    }, onError: (Object error) {
      // Handle a possible error
    });
```

--------------------------------

### Observe host device BLE status with statusStream

Source: https://pub.dev/packages/flutter_reactive_ble

Listens to the statusStream to receive updates about the host device's BLE status, such as whether BLE is on or permissions are granted.

```dart
_ble.statusStream.listen((status) {
  //code for handling status update
});
```

--------------------------------

### requestMtu

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Requests a new MTU size for the connection. Returns the actual negotiated MTU size, which may differ from the requested size.

```APIDOC
## requestMtu

### Description
Requests a new MTU size for the connection. Returns the actual negotiated MTU size, which may differ from the requested size.

### Method
requestMtu

### Parameters
- **deviceId** (String) - Required - The ID of the device.
- **mtu** (int) - Required - The requested MTU size.

### Request Example
```dart
final mtu = await flutterReactiveBle.requestMtu(deviceId: foundDeviceId, mtu: 250);
```

### Response
Returns the actual negotiated MTU size (int).
```

--------------------------------

### Negotiate MTU size with requestMtu

Source: https://pub.dev/packages/flutter_reactive_ble

Requests a specific MTU size to increase throughput. Returns the actual negotiated size, which may differ. On iOS, MTU cannot be negotiated but the current size is returned.

```Dart
final mtu = await flutterReactiveBle.requestMtu(deviceId: foundDeviceId, mtu: 250);
```

--------------------------------

### statusStream

Source: https://pub.dev/packages/flutter_reactive_ble

Stream that emits updates about the BLE status of the host device (e.g., BLE on/off, permissions granted).

```APIDOC
## statusStream

### Description
Stream that provides updates about the BLE status of the host device. Use this to determine if BLE is turned on or if required permissions are granted.

### Method
statusStream

### Usage Example
```dart
_ble.statusStream.listen((status) {
  //code for handling status update
});
```

```

--------------------------------

### ProGuard rule for flutter_reactive_ble

Source: https://pub.dev/packages/flutter_reactive_ble

Add this rule to your proguard-rules.pro file when using ProGuard to prevent issues like #131.

```proguard
-keep class com.signify.hue.** { *; }
```

--------------------------------

### statusStream

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Stream that emits updates about the BLE status of the host device. Can be used to determine if BLE is turned on or if required permissions are granted.

```APIDOC
## statusStream

### Description
Stream that provides updates about the BLE status of the host device. Use this stream to determine if BLE is turned on or if required permissions are granted.

### Method
statusStream

### Example
```dart
_ble.statusStream.listen((status) {
  //code for handling status update
});
```

### Related
- Use `_ble.status` to get the current status of the host device.
- See BleStatus for more info about the meaning of the different statuses.
```

--------------------------------

### Request connection priority (Android)

Source: https://pub.dev/packages/flutter_reactive_ble

Sends a connection priority update on Android. Using highPerformance increases battery usage and speeds up GATT operations. Not supported on iOS (throws UnSupportedOperationException).

```Dart
await flutterReactiveBle.requestConnectionPriority(deviceId: foundDeviceId, priority:  ConnectionPriority.highPerformance);
```

--------------------------------

### writeCharacteristicWithResponse

Source: https://pub.dev/packages/flutter_reactive_ble

Writes a value to a characteristic and awaits the acknowledgement from the device. The write can either be acknowledged (success) or fail (exception thrown).

```APIDOC
## writeCharacteristicWithResponse

### Description
Writes a value to a characteristic and awaits the response (acknowledgement). The return type is void; success is indicated by no exception, failure by an exception.

### Method
writeCharacteristicWithResponse

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to write to.
- **value** (List<int>) - Required - The byte array to write.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
await flutterReactiveBle.writeCharacteristicWithResponse(characteristic, value: [0x00]);
```

### Response
Returns a Future that completes when the write is acknowledged. Throws an exception on failure.
```

--------------------------------

### requestConnectionPriority

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Requests a connection priority update on Android. The priority parameter uses the same spec as the BluetoothGatt Android spec.

```APIDOC
## requestConnectionPriority

### Description
Requests a connection priority update on Android. The priority parameter uses the same spec as the BluetoothGatt Android spec. Using highPerformance increases battery usage but speeds up GATT operations.

### Method
requestConnectionPriority

### Parameters
- **deviceId** (String) - Required - The ID of the device.
- **priority** (ConnectionPriority) - Required - The connection priority (e.g., ConnectionPriority.highPerformance).

### Request Example
```dart
await flutterReactiveBle.requestConnectionPriority(deviceId: foundDeviceId, priority: ConnectionPriority.highPerformance);
```

### Response
Returns void. Throws UnSupportedOperationException on iOS.
```

--------------------------------

### writeCharacteristicWithResponse

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Writes a value to a characteristic and awaits the acknowledgement. The write can either be acknowledged (success) or fail (exception thrown).

```APIDOC
## writeCharacteristicWithResponse

### Description
Writes a value to a characteristic and awaits the response (acknowledgement). The return type is void; success or failure is indicated by whether an exception is thrown.

### Method
writeCharacteristicWithResponse

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to write to.
- **value** (List<int>) - Required - The value to write.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
await flutterReactiveBle.writeCharacteristicWithResponse(characteristic, value: [0x00]);
```

### Response
Returns void. Throws an exception if the write fails.
```

--------------------------------

### AndroidManifest.xml Bluetooth and location permissions

Source: https://pub.dev/packages/flutter_reactive_ble

Add these permissions to your AndroidManifest.xml file to enable Bluetooth scanning and connection on Android. The BLUETOOTH_SCAN permission includes usesPermissionFlags="neverForLocation" and location permissions are limited to maxSdkVersion="30".

```xml
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" android:usesPermissionFlags="neverForLocation" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" android:maxSdkVersion="30" />
```

--------------------------------

### requestConnectionPriority

Source: https://pub.dev/packages/flutter_reactive_ble

Android-specific operation to request a connection priority update. The priority parameter uses the same spec as the Android BluetoothGatt. Throws UnSupportedOperationException on iOS.

```APIDOC
## requestConnectionPriority

### Description
Requests a connection priority update on Android. This can increase or decrease performance and battery usage.

### Method
requestConnectionPriority

### Parameters
- **deviceId** (String) - Required - The ID of the BLE device.
- **priority** (ConnectionPriority) - Required - The desired priority (e.g., highPerformance).

### Request Example
```dart
await flutterReactiveBle.requestConnectionPriority(deviceId: foundDeviceId, priority: ConnectionPriority.highPerformance);
```

### Response
Returns a Future that completes when the request is processed. Throws UnSupportedOperationException on iOS.
```

--------------------------------

### Set RxJava global error handler to ignore BLE undeliverable exceptions

Source: https://pub.dev/packages/flutter_reactive_ble

Place this Kotlin code in the Java/Kotlin part of your Flutter app (e.g., MainActivity) to ignore BleException instances wrapped in UndeliverableException. Requires the dependency 'implementation "com.polidea.rxandroidble2:rxandroidble:1.11.1"'.

```kotlin
RxJavaPlugins.setErrorHandler { throwable ->
  if (throwable is UndeliverableException && throwable.cause is BleException) {
    return@setErrorHandler // ignore BleExceptions since we do not have subscriber
  }
  else {
    throw throwable
  }
}
```

--------------------------------

### Write characteristic with response

Source: https://pub.dev/packages/flutter_reactive_ble

Writes a value to a characteristic and awaits an acknowledgement. The write can succeed or throw an exception. Use for request-response patterns where the device acknowledges reception.

```Dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId); 
await flutterReactiveBle.writeCharacteristicWithResponse(characteristic, value: [0x00]);
```

--------------------------------

### writeCharacteristicWithoutResponse

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Writes a value to a characteristic without waiting for a response. This is faster but may not be handled by the device if too many writes are sent consecutively.

```APIDOC
## writeCharacteristicWithoutResponse

### Description
Writes a value to a characteristic without waiting for a response. This is the fastest way to write but may overwhelm the device if used excessively.

### Method
writeCharacteristicWithoutResponse

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to write to.
- **value** (List<int>) - Required - The value to write.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
flutterReactiveBle.writeCharacteristicWithoutResponse(characteristic, value: [0x00]);
```

### Response
Returns void.
```

--------------------------------

### writeCharacteristicWithoutResponse

Source: https://pub.dev/packages/flutter_reactive_ble

Writes a value to a characteristic without waiting for an acknowledgement. This is faster but may not be handled by the device if too many writes are sent consecutively.

```APIDOC
## writeCharacteristicWithoutResponse

### Description
Writes a value to a characteristic without waiting for a response. Use for high-throughput operations like firmware uploads.

### Method
writeCharacteristicWithoutResponse

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to write to.
- **value** (List<int>) - Required - The byte array to write.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
flutterReactiveBle.writeCharacteristicWithoutResponse(characteristic, value: [0x00]);
```

### Response
Returns a Stream or Future? (The source does not specify a return type; it is likely a Future that completes immediately.)
```

--------------------------------

### AndroidManifest.xml BLUETOOTH_SCAN location override

Source: https://pub.dev/packages/flutter_reactive_ble

If you use BLUETOOTH_SCAN to determine location, modify your AndroidManifest.xml to include this entry, which removes the usesPermissionFlags attribute and sets targetApi to 's'.

```xml
 <uses-permission android:name="android.permission.BLUETOOTH_SCAN" 
                     tools:remove="android:usesPermissionFlags"
                     tools:targetApi="s" />
```

--------------------------------

### subscribeToCharacteristic

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Subscribes to notifications from a characteristic. The stream emits data whenever the characteristic value changes.

```APIDOC
## subscribeToCharacteristic

### Description
Subscribes to notifications from a characteristic. The stream emits data whenever the characteristic value changes.

### Method
subscribeToCharacteristic

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to subscribe to.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
flutterReactiveBle.subscribeToCharacteristic(characteristic).listen((data) {
  // code to handle incoming data
}, onError: (dynamic error) {
  // code to handle errors
});
```

### Response
Returns a Stream that emits the characteristic value (List<int>) when it changes.
```

--------------------------------

### subscribeToCharacteristic

Source: https://pub.dev/packages/flutter_reactive_ble

Subscribes to notifications or indications from a characteristic. The returned stream emits data whenever the characteristic value changes.

```APIDOC
## subscribeToCharacteristic

### Description
Subscribes to characteristic notifications/indications and returns a stream of data updates.

### Method
subscribeToCharacteristic

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to subscribe to.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
flutterReactiveBle.subscribeToCharacteristic(characteristic).listen((data) {
  // code to handle incoming data
}, onError: (dynamic error) {
  // code to handle errors
});
```

### Response
Returns a Stream<List<int>> that emits data when the characteristic value changes.
```

--------------------------------

### clearGattCache

Source: https://pub.dev/packages/flutter_reactive_ble

Android-specific operation to clear the GATT cache for a device. This is a hidden BLE operation and should be used with extreme caution.

```APIDOC
## clearGattCache

### Description
Clears the GATT cache for a device on Android. This is a hidden operation and should be used with caution.

### Method
clearGattCache

### Parameters
- **deviceId** (String) - Required - The ID of the BLE device.

### Request Example
```dart
await flutterReactiveBle.clearGattCache(foundDeviceId);
```

### Response
Returns a Future that completes when the cache is cleared. Throws UnSupportedOperationException on iOS.
```

--------------------------------

### clearGattCache

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Clears the GATT cache on Android. This is a hidden BLE operation and should be used with extreme caution.

```APIDOC
## clearGattCache

### Description
Clears the GATT cache on Android. This is a hidden BLE operation and should be used with extreme caution since it is on the Android greylist.

### Method
clearGattCache

### Parameters
- **deviceId** (String) - Required - The ID of the device.

### Request Example
```dart
await flutterReactiveBle.clearGattCache(foundDeviceId);
```

### Response
Returns void. Throws UnSupportedOperationException on iOS.
```

--------------------------------

### Write characteristic without response

Source: https://pub.dev/packages/flutter_reactive_ble

Writes a value without waiting for an acknowledgement. Fastest for consecutive writes (e.g., firmware upload) but may overwhelm the device; periodically use writeWithResponse.

```Dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
flutterReactiveBle.writeCharacteristicWithoutResponse(characteristic, value: [0x00]);
```

--------------------------------

### Subscribe to characteristic notifications

Source: https://pub.dev/packages/flutter_reactive_ble

Listens to notifications from a characteristic when its value changes. Requires the service to support notifications. Handles incoming data and errors via the stream.

```Dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
   flutterReactiveBle.subscribeToCharacteristic(characteristic).listen((data) {
      // code to handle incoming data
    }, onError: (dynamic error) {
      // code to handle errors
    });
```

--------------------------------

### readCharacteristic

Source: https://pub.dev/packages/flutter_reactive_ble/versions/5.6.0

Reads the value of a characteristic. The characteristic is identified by its service UUID, characteristic UUID, and device ID.

```APIDOC
## readCharacteristic

### Description
Reads the value of a characteristic.

### Method
readCharacteristic

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to read, containing serviceId, characteristicId, and deviceId.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
final response = await flutterReactiveBle.readCharacteristic(characteristic);
```

### Response
Returns the value of the characteristic as a List<int>.
```

--------------------------------

### readCharacteristic

Source: https://pub.dev/packages/flutter_reactive_ble

Reads the value of a characteristic from a BLE device. The characteristic is identified by its service UUID, characteristic UUID, and device ID.

```APIDOC
## readCharacteristic

### Description
Reads the value of a characteristic from a BLE device.

### Method
readCharacteristic

### Parameters
- **characteristic** (QualifiedCharacteristic) - Required - The characteristic to read, containing serviceId, characteristicId, and deviceId.

### Request Example
```dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
final response = await flutterReactiveBle.readCharacteristic(characteristic);
```

### Response
Returns a Future that resolves to the characteristic value (List<int>).
```

--------------------------------

### Read characteristic with readCharacteristic

Source: https://pub.dev/packages/flutter_reactive_ble

Reads a value from a BLE characteristic. Requires a QualifiedCharacteristic with service, characteristic, and device IDs. Returns the characteristic value as a List<int>.

```Dart
final characteristic = QualifiedCharacteristic(serviceId: serviceUuid, characteristicId: characteristicUuid, deviceId: foundDeviceId);
final response = await flutterReactiveBle.readCharacteristic(characteristic);
```

--------------------------------

### Clear GATT cache (Android)

Source: https://pub.dev/packages/flutter_reactive_ble

Invalidates the Android GATT cache to pick up new services after firmware updates. Hidden operation on the greylist; use with extreme caution.

```Dart
await flutterReactiveBle.clearGattCache(foundDeviceId);
```
Tokens:
Raw