more review

Author: 2bndy5

bindings/node/src/fake_ble/radio.rs

@@ -14,6 +14,20 @@ use super::services::BlePayload;
 /// !!! note "See also"
 ///     This implementation is subject to
 ///     [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
+///
+///     Use {@link bleConfig} to properly configure the radio for
+///     BLE compatibility.
+///
+///     ```ts
+///     import { bleConfig, FakeBle, RF24 } from "@rf24/rf24";
+///
+///     const radio = new RF24(22, 0);
+///     radio.begin();
+///     radio.withConfig(bleConfig());
+///     const ble = new FakeBle(radio);
+///
+///     radio.printDetails();
+///     ```
 #[napi]
 pub struct FakeBle {
     radio: Reference<RF24>,

bindings/python/src/fake_ble/radio.rs

@@ -13,6 +13,20 @@ use super::services::BlePayload;
 /// See also:
 ///     This implementation is subject to
 ///     [Limitations](https://docs.rs/rf24ble-rs/latest/rf24ble/index.html#limitations).
+///
+///     Use [`ble_config()`][rf24_py.ble_config] to properly configure the radio for
+///     BLE compatibility.
+///
+///     ```py
+///     from rf24_py import RF24, FakeBle, ble_config
+///
+///     radio = RF24(22, 0)
+///     radio.begin()
+///     radio.with_config(ble_config())
+///     ble = FakeBle(radio)
+///
+///     radio.print_details()
+///     ```
 #[pyclass(module = "rf24_py")]
 pub struct FakeBle {
     radio: Py<RF24>,

crates/rf24ble-rs/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rf24ble-rs"
 description = "A fake BLE implementation for the nRF24L01"
-version = "0.1.0"
+version = "0.0.0"
 repository.workspace = true
 homepage.workspace = true
 edition.workspace = true

crates/rf24ble-rs/README.md

@@ -24,3 +24,9 @@ Original research was done by [Dmitry Grinberg and his write-up (including C
 source code) can be found here][fake-ble-research].
 As this technique can prove invaluable in certain project designs, the code
 here has been adapted to work with Rust.
+
+## Example
+
+See the [example located in the nRF24/rf24-rs repository][ble-example].
+
+[ble-example]: https://github.com/nRF24/rf24-rs/blob/main/examples/rust/src/bin/fake_ble.rs

crates/rf24ble-rs/src/radio.rs

@@ -66,6 +66,20 @@ pub fn ble_config() -> RadioConfig {
 /// A struct that implements BLE functionality.
 ///
 /// This implementation is subject to [Limitations](index.html#limitations).
+///
+/// Use [`ble_config()`] to properly configure the radio for BLE compatibility.
+///
+/// ```ignore
+/// use rf24::radio::{prelude::*, RF24};
+/// use rf24ble::{ble_config, radio::FakeBle};
+///
+/// let mut radio = RF24::new(ce_pin, spi_device, delay_impl);
+/// radio.init()?;
+/// radio.withConfig(&ble_config())?;
+/// let mut ble = FakeBle::new();
+///
+/// radio.print_details()?;
+/// ```
 pub struct FakeBle {
     pub(crate) name: [u8; 12],
     /// Enable or disable the inclusion of the radio's PA level in advertisements.
@@ -142,7 +156,7 @@ impl FakeBle {
 
     /// How many bytes are available in an advertisement payload?
     ///
-    /// The `hypothetical` parameter shall be the same value passed to [`FakeBle::send()`].
+    /// The `hypothetical` parameter shall be the same `buf` value passed to [`FakeBle::send()`].
     ///
     /// In addition to the given `hypothetical` payload length, this function also
     /// accounts for the current state of [`FakeBle::get_name()`] and

crates/rf24ble-rs/src/services.rs

@@ -18,7 +18,7 @@ const EDDYSTONE_UUID: u16 = 0xFEAA;
 /// Some common traits related to BLE service data structs.
 pub mod prelude {
     /// A trait to define the factory method of constructing BLE service data from a buffer.
-    pub trait FromBuffer {
+    pub(super) trait FromBuffer {
         fn from_buffer(buf: &[u8]) -> Self;
     }
 

cspell.config.yml

@@ -55,6 +55,7 @@ words:
   - mkdocs
   - mkdocstrings
   - mosi
+  - MSRV
   - msvc
   - multiceiver
   - musleabihf