Flutter Blue 插件是一个跨平台的 Flutter 包,可在 Android、iOS、macOS 和 Windows 上实现与蓝牙低功耗(BLE)设备的通信。它提供了一个统一的 API,用于发现、连接和与 BLE 外设交换数据。该插件支持扫描设备、读取和写入特征值、订阅通知以及管理连接。基于原生 BLE 栈构建,确保了跨平台的可靠性能。非常适合开发与可穿戴设备、传感器、信标及其他 BLE 设备交互的应用程序。
FlutterBlue is a bluetooth plugin for Flutter, a new app SDK to help developers build modern multi-platform apps.
Alpha version
This library is actively developed alongside production apps, and the API will evolve as we continue our way to version 1.0.
Please be fully prepared to deal with breaking changes.This package must be tested on a real device.
Having trouble adapting to the latest API? I'd love to hear your use-case, please contact me.
Cross-Platform Bluetooth LE
FlutterBlue aims to offer the most from both platforms (iOS and Android and Desktop).
Using the FlutterBlue instance, you can scan for and connect to nearby devices (BluetoothDevice).
Once connected to a device, the BluetoothDevice object can discover services (BluetoothService), characteristics (BluetoothCharacteristic), and descriptors (BluetoothDescriptor).
The BluetoothDevice object is then used to directly interact with characteristics and descriptors.
Usage
Obtain an instance
FlutterBlue flutterBlue = FlutterBlue.instance;
Scan for devices
// Start scanning
flutterBlue.startScan(timeout: Duration(seconds: 4));
// Listen to scan resultsvar subscription = flutterBlue.scanResults.listen((results) {
// do something with scan resultsfor (ScanResult r in results) {
print('${r.device.name} found! rssi: ${r.rssi}');
}
});
// Stop scanning
flutterBlue.stopScan();
Connect to a device
// Connect to the deviceawait device.connect();
// Disconnect from device
device.disconnect();
Discover services
List<BluetoothService> services = await device.discoverServices();
services.forEach((service) {
// do something with service
});
Read and write characteristics
// Reads all characteristicsvar characteristics = service.characteristics;
for(BluetoothCharacteristic c in characteristics) {
List<int> value = await c.read();
print(value);
}
// Writes to a characteristicawait c.write([0x12, 0x34])
Read and write descriptors
// Reads all descriptorsvar descriptors = characteristic.descriptors;
for(BluetoothDescriptor d in descriptors) {
List<int> value = await d.read();
print(value);
}
// Writes to a descriptorawait d.write([0x12, 0x34])
Set notifications and listen to changes
await characteristic.setNotifyValue(true);
characteristic.value.listen((value) {
// do something with new value
});
Read the MTU and request larger size
final mtu = await device.mtu.first;
await device.requestMtu(512);
Note that iOS will not allow requests of MTU size, and will always try to negotiate the highest possible MTU (iOS supports up to MTU size 185)
Getting Started
Change the minSdkVersion for Android
flutter_blue_plugin is compatible only from version 21 of Android SDK so you should change this in android/app/build.gradle:
Android {
defaultConfig {
minSdkVersion: 21
Add permissions for Bluetooth
We need to add the permission to use Bluetooth and access location:
Android
In the android/app/src/main/AndroidManifest.xml let’s add:
Stream of state changes for the Bluetooth Adapter.
isAvailable
:white_check_mark:
:white_check_mark:
Checks whether the device supports Bluetooth.
isOn
:white_check_mark:
:white_check_mark:
Checks if Bluetooth functionality is turned on.
BluetoothDevice API
Android
iOS
Description
connect
:white_check_mark:
:white_check_mark:
Establishes a connection to the device.
disconnect
:white_check_mark:
:white_check_mark:
Cancels an active or pending connection to the device.
discoverServices
:white_check_mark:
:white_check_mark:
Discovers services offered by the remote device as well as their characteristics and descriptors.
services
:white_check_mark:
:white_check_mark:
Gets a list of services. Requires that discoverServices() has completed.
state
:white_check_mark:
:white_check_mark:
Stream of state changes for the Bluetooth Device.
mtu
:white_check_mark:
:white_check_mark:
Stream of mtu size changes.
requestMtu
:white_check_mark:
Request to change the MTU for the device.
BluetoothCharacteristic API
Android
iOS
Description
read
:white_check_mark:
:white_check_mark:
Retrieves the value of the characteristic.
write
:white_check_mark:
:white_check_mark:
Writes the value of the characteristic.
setNotifyValue
:white_check_mark:
:white_check_mark:
Sets notifications or indications on the characteristic.
value
:white_check_mark:
:white_check_mark:
Stream of characteristic's value when changed.
BluetoothDescriptor API
Android
iOS
Description
read
:white_check_mark:
:white_check_mark:
Retrieves the value of the descriptor.
write
:white_check_mark:
:white_check_mark:
Writes the value of the descriptor.
Troubleshooting
When I scan using a service UUID filter, it doesn't find any devices.
Make sure the device is advertising which service UUID's it supports. This is found in the advertisement
packet as UUID 16 bit complete list or UUID 128 bit complete list.