mirror/Meshtastic-Android
1
0
Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-06-26 06:25:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(ble): update MeshtasticBleDevice KDoc for post-#5912 reconnect flow (#5913)

Browse Source 
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
James Rich
2026-06-23 10:18:57 -05:00
committed by GitHub
parent 31c2c2b504
commit 9f472cebad
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
core/ble/src/commonMain/kotlin/org/meshtastic/core/ble/MeshtasticBleDevice.kt
View File

@@ -26,8 +26,11 @@ import kotlinx.coroutines.flow.asStateFlow
* Unified [BleDevice] implementation for all BLE devices — scanned, bonded, or both.
*
* When created from a live BLE scan, [advertisement] is populated and used for optimal peripheral construction via
* `Peripheral(advertisement)`. When created from the OS bonded device list (address only), [advertisement] is `null`
* and the peripheral is constructed via `createPeripheral(address)` with `autoConnect = true`.
* `Peripheral(advertisement)` with a direct (non-autoConnect) connection attempt.
*
* Bonded-only devices (address only, [advertisement] null) can still be constructed — e.g. for display in the device
* list — but [BleRadioTransport.findDevice] requires a fresh advertisement before connecting and will throw
* [RadioNotConnectedException] rather than returning a stale handle.
*
* @param address The device's MAC address (or platform identifier string).
* @param name The device's display name, if known.