flutter/universal_ble
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README and BLE API documentation for MTU handling (#202)

Browse Source 
- Clarified MTU request behavior and platform limitations in README.md.
- Added best practices for MTU management in cross-platform BLE applications.
- Enhanced documentation for `requestMtu` method in UniversalBle and BleDeviceExtension to reflect best-effort nature of MTU requests and platform-specific behaviors.

Co-authored-by: Foti Dim <foti@navideck.com>
This commit is contained in:
Navideck Labs
2025-12-15 11:38:01 +05:30
committed by GitHub
parent 01b4511704
commit d26e752e73
3 changed files with 123 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/src/extensions/ble_device_extension.dart
+7 -1
View File
@@ -22,7 +22,13 @@ extension BleDeviceExtension on BleDevice {
/// Disconnects from the device.
Future<void> disconnect() => UniversalBle.disconnect(deviceId);
/// Requests a specific MTU (Maximum Transmission Unit) size for the connection.
/// Requests an MTU (Maximum Transmission Unit) value for the connection.
///
/// **⚠️ Note:** Requesting an MTU is a *best-effort* operation. The final MTU is
/// often controlled by the OS and remote device. Returns the negotiated MTU value,
/// which may differ from `expectedMtu`.
///
/// See [UniversalBle.requestMtu] for platform limitations and best practices.
Future<int> requestMtu(int expectedMtu) =>
UniversalBle.requestMtu(deviceId, expectedMtu);
lib/src/universal_ble.dart
+15 -3
View File
@@ -313,9 +313,21 @@ class UniversalBle {
);
}
/// Request MTU value.
/// It will **attempt** to set the MTU (Maximum Transmission Unit) but it is not guaranteed to succeed due to platform limitations.
/// It will always return the current MTU.
/// Requests an MTU (Maximum Transmission Unit) value for the connection.
///
/// **⚠️ Note:** Requesting an MTU is a *best-effort* operation. On many platforms
/// the final MTU is fully controlled by the OS and remote device. This method
/// returns the current/negotiated MTU value, which may differ from `expectedMtu`.
///
/// **Platform Limitations:**
/// * **iOS/macOS**: MTU is OS-managed; apps cannot request it (~185-517 bytes auto-negotiated)
/// * **Android ≤13**: May request once per connection (up to 517), default is 23
/// * **Android 14+**: First GATT client drives MTU to 517; subsequent requests ignored
/// * **Windows/Linux**: MTU is automatically negotiated; apps can only query it
/// * **Web**: Not supported (no API available)
///
/// **Best Practices:** Design for default ATT MTU (23 bytes), treat requests as
/// opportunistic, and implement fragmentation for larger payloads.
static Future<int> requestMtu(
String deviceId,
int expectedMtu, {