Skip to content

Commit ff86a7c

Browse files
committed
Improve docs of available_ble_devices
1 parent 5ecc935 commit ff86a7c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/utils_internal.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,23 +203,25 @@ pub async fn build_tcp_stream(
203203
Ok(StreamHandle::from_stream(stream))
204204
}
205205

206-
/// A helper method to list the names of all reachable Meshtstic Bluetooth radios. This method is
207-
/// intended to be used to select a valid Bluetooth radio, then to pass that device ID to the
208-
/// `build_ble_stream` method.
206+
/// A helper method to list the names of all reachable Meshtastic Bluetooth radios.
207+
///
208+
/// This method is intended to be used to select a valid Bluetooth radio, then to pass that device
209+
/// MAC address to the `build_ble_stream` method.
209210
///
210211
/// # Arguments
211212
///
212213
/// `scan_duration` - Duration of a Bluetooth LE scan for devices
213214
///
214215
/// # Returns
215216
///
216-
/// A vector of Bluetooth devices identified by BleId which contains a name and a MAC address.
217+
/// A vector of Bluetooth devices identified by a MAC address and optionally also a name.
217218
///
218219
/// # Examples
219220
///
220221
/// ```
221222
/// let ble_devices = utils::available_ble_devices().await.unwrap();
222223
/// println!("Available Meshtastic BLE devices: {:?}", ble_devices);
224+
/// let stream = build_ble_stream(&ble_devices[0].1.into(), Duration::from_secs(10)).await;
223225
/// ```
224226
///
225227
/// # Errors

0 commit comments

Comments
 (0)