implicitly cast to bool in bindings

Only the node binding's `StatusFlags` interface must use explicit boolean values.
To implicitly cast that interface's values to boolean would
- incur much more overhead
- lose precise typing information

See napi-rs docs about Env and Context.

README.md

@@ -22,12 +22,13 @@ This includes but is not limited to Linux on RPi. Other points of interest:
 
 Here is the intended roadmap:
 
-- [x] implement driver for the nRF24L01 (OTA compatible with other RF24 library)
+- [x] implement driver for the nRF24L01 (OTA compatible with RF24 library)
 
     This should be HAL-agnostic in terms of MCU. It would also be nice to
     reimplement the same API (using [rust's `trait` feature][rust-traits])
     for use on nRF5x radios.
 
+- [ ] implement a fake BLE API for the nRF24L01 (see [#4](https://github.com/nRF24/rf24-rs/issues/4))
 - [ ] implement network layers (OTA compatible with RF24Network and RF24Mesh libraries)
 - [ ] implement ESB support for nRF5x MCUs. This might be guarded under [cargo features][cargo-feat].
 

bindings/node/src/radio.rs

@@ -1,15 +1,15 @@
 #![cfg(target_os = "linux")]
 
 use crate::types::{
-    AvailablePipe, CrcLength, DataRate, FifoState, HardwareConfig, PaLevel, StatusFlags,
-    WriteConfig,
+    coerce_to_bool, AvailablePipe, CrcLength, DataRate, FifoState, HardwareConfig, PaLevel,
+    StatusFlags, WriteConfig,
 };
 use linux_embedded_hal::{
     gpio_cdev::{chips, LineRequestFlags},
     spidev::{SpiModeFlags, SpidevOptions},
     CdevPin, Delay, SpidevDevice,
 };
-use napi::{bindgen_prelude::Buffer, Error, Result, Status};
+use napi::{bindgen_prelude::Buffer, Error, JsNumber, Result, Status};
 
 use rf24::radio::prelude::*;
 
@@ -168,10 +168,15 @@ impl RF24 {
     ///
     /// @group Basic
     #[napi]
-    pub fn send(&mut self, buf: Buffer, ask_no_ack: Option<bool>) -> Result<bool> {
+    pub fn send(
+        &mut self,
+        buf: Buffer,
+        #[napi(ts_arg_type = "boolean | number")] ask_no_ack: Option<JsNumber>,
+    ) -> Result<bool> {
         let buf = buf.to_vec();
+        let ask_no_ack = coerce_to_bool(ask_no_ack, false)?;
         self.inner
-            .send(&buf, ask_no_ack.unwrap_or_default())
+            .send(&buf, ask_no_ack)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
@@ -330,9 +335,12 @@ impl RF24 {
     ///
     /// @group Configuration
     #[napi]
-    pub fn set_lna(&mut self, enable: bool) -> Result<()> {
+    pub fn set_lna(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] enable: JsNumber,
+    ) -> Result<()> {
         self.inner
-            .set_lna(enable)
+            .set_lna(coerce_to_bool(Some(enable), true)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
@@ -345,9 +353,12 @@ impl RF24 {
     ///
     /// @group Configuration
     #[napi]
-    pub fn allow_ack_payloads(&mut self, enable: bool) -> Result<()> {
+    pub fn allow_ack_payloads(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] enable: JsNumber,
+    ) -> Result<()> {
         self.inner
-            .allow_ack_payloads(enable)
+            .allow_ack_payloads(coerce_to_bool(Some(enable), false)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
@@ -359,19 +370,22 @@ impl RF24 {
     ///
     /// @group Configuration
     #[napi]
-    pub fn set_auto_ack(&mut self, enable: bool) -> Result<()> {
+    pub fn set_auto_ack(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] enable: JsNumber,
+    ) -> Result<()> {
         self.inner
-            .set_auto_ack(enable)
+            .set_auto_ack(coerce_to_bool(Some(enable), false)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
     /// Enable or disable the auto-ack feature for a specified `pipe`.
     ///
     /// @group Configuration
     #[napi]
-    pub fn set_auto_ack_pipe(&mut self, enable: bool, pipe: u8) -> Result<()> {
+    pub fn set_auto_ack_pipe(&mut self, enable: JsNumber, pipe: u8) -> Result<()> {
         self.inner
-            .set_auto_ack_pipe(enable, pipe)
+            .set_auto_ack_pipe(coerce_to_bool(Some(enable), false)?, pipe)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
@@ -383,9 +397,12 @@ impl RF24 {
     ///
     /// @group Configuration
     #[napi]
-    pub fn allow_ask_no_ack(&mut self, enable: bool) -> Result<()> {
+    pub fn allow_ask_no_ack(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] enable: JsNumber,
+    ) -> Result<()> {
         self.inner
-            .allow_ask_no_ack(enable)
+            .allow_ask_no_ack(coerce_to_bool(Some(enable), false)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 
@@ -567,9 +584,12 @@ impl RF24 {
     ///
     /// @group Advanced
     #[napi]
-    pub fn get_fifo_state(&mut self, about_tx: bool) -> Result<FifoState> {
+    pub fn get_fifo_state(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] about_tx: JsNumber,
+    ) -> Result<FifoState> {
         self.inner
-            .get_fifo_state(about_tx)
+            .get_fifo_state(coerce_to_bool(Some(about_tx), false)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
             .map(|e| FifoState::from_inner(e))
     }
@@ -631,9 +651,12 @@ impl RF24 {
     ///
     /// @group Configuration
     #[napi]
-    pub fn set_dynamic_payloads(&mut self, enable: bool) -> Result<()> {
+    pub fn set_dynamic_payloads(
+        &mut self,
+        #[napi(ts_arg_type = "boolean | number")] enable: JsNumber,
+    ) -> Result<()> {
         self.inner
-            .set_dynamic_payloads(enable)
+            .set_dynamic_payloads(coerce_to_bool(Some(enable), false)?)
             .map_err(|e| Error::new(Status::GenericFailure, format!("{e:?}")))
     }
 

bindings/node/src/types.rs

@@ -1,5 +1,15 @@
 //! This module defines thin wrappers around rust native types to be exposed in node.js
 
+use napi::{JsNumber, Result};
+
+/// A private helper to implicitly convert JS numbers to boolean values (falling back to a `default` value)
+pub fn coerce_to_bool(napi_instance: Option<JsNumber>, default: bool) -> Result<bool> {
+    if let Some(napi_value) = napi_instance {
+        return napi_value.coerce_to_bool()?.get_value();
+    }
+    return Ok(default);
+}
+
 /// Optional configuration parameters to fine tune instantiating the {@link RF24} object.
 /// Pass this object as third parameter to {@link RF24} constructor.
 #[napi(object)]

bindings/python/src/radio.rs

@@ -150,12 +150,12 @@ impl RF24 {
     ///         This has no effect if auto-ack is disabled or
     ///         [RF24.allow_ask_no_ack] is not enabled.
     #[pyo3(
-        signature = (buf, ask_no_ack = false),
-        text_signature = "(buf: bytes | bytearray, ask_no_ack = False) -> bool",
+        signature = (buf, ask_no_ack = 0i32),
+        text_signature = "(buf: bytes | bytearray, ask_no_ack: bool | int = False) -> bool",
     )]
-    pub fn send(&mut self, buf: &[u8], ask_no_ack: bool) -> PyResult<bool> {
+    pub fn send(&mut self, buf: &[u8], ask_no_ack: i32) -> PyResult<bool> {
         self.inner
-            .send(buf, ask_no_ack)
+            .send(buf, ask_no_ack != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -180,12 +180,12 @@ impl RF24 {
     /// Returns:
     ///     A Boolean that describes if the given `buf` was successfully loaded into the TX FIFO.
     #[pyo3(
-        signature = (buf, ask_no_ack = false, start_tx = true),
-        text_signature = "(buf: bytes | bytearray, ask_no_ack = False, start_tx = True) -> bool",
+        signature = (buf, ask_no_ack = 0i32, start_tx = 1i32),
+        text_signature = "(buf: bytes | bytearray, ask_no_ack: bool | int = False, start_tx: bool | int = True) -> bool",
     )]
-    pub fn write(&mut self, buf: &[u8], ask_no_ack: bool, start_tx: bool) -> PyResult<bool> {
+    pub fn write(&mut self, buf: &[u8], ask_no_ack: i32, start_tx: i32) -> PyResult<bool> {
         self.inner
-            .write(buf, ask_no_ack, start_tx)
+            .write(buf, ask_no_ack != 0, start_tx != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -299,9 +299,9 @@ impl RF24 {
     /// For clone's and module's with a separate PA/LNA circuit (external antenna),
     /// this function may not behave exactly as expected. Consult the radio module's
     /// manufacturer.
-    pub fn set_lna(&mut self, enable: bool) -> PyResult<()> {
+    pub fn set_lna(&mut self, enable: i32) -> PyResult<()> {
         self.inner
-            .set_lna(enable)
+            .set_lna(enable != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -311,9 +311,9 @@ impl RF24 {
     /// > This feature requires dynamically sized payloads.
     /// > Use [`RF24.set_dynamic_payloads(True)`][rf24_py.RF24.set_dynamic_payloads]
     /// > to enable dynamically sized payloads.
-    pub fn allow_ack_payloads(&mut self, enable: bool) -> PyResult<()> {
+    pub fn allow_ack_payloads(&mut self, enable: i32) -> PyResult<()> {
         self.inner
-            .allow_ack_payloads(enable)
+            .allow_ack_payloads(enable != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -325,9 +325,9 @@ impl RF24 {
     ///
     /// Parameters:
     ///     enable: Pass true to enable the auto-ack feature for all pipes.
-    pub fn set_auto_ack(&mut self, enable: bool) -> PyResult<()> {
+    pub fn set_auto_ack(&mut self, enable: i32) -> PyResult<()> {
         self.inner
-            .set_auto_ack(enable)
+            .set_auto_ack(enable != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -340,9 +340,9 @@ impl RF24 {
     /// Parameters:
     ///     enable: Pass true to enable the auto-ack feature for the specified `pipe`.
     ///     pipe: The pipe about which to control the auto-ack feature.
-    pub fn set_auto_ack_pipe(&mut self, enable: bool, pipe: u8) -> PyResult<()> {
+    pub fn set_auto_ack_pipe(&mut self, enable: i32, pipe: u8) -> PyResult<()> {
         self.inner
-            .set_auto_ack_pipe(enable, pipe)
+            .set_auto_ack_pipe(enable != 0, pipe)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -352,9 +352,9 @@ impl RF24 {
     ///     enable: Setting this to `true` will allow the `ask_no_ack` parameter to
     ///         take effect. See [`RF24.send()`][rf24_py.RF24.send] and
     ///         [`RF24.write()`][rf24_py.RF24.write] for more detail.
-    pub fn allow_ask_no_ack(&mut self, enable: bool) -> PyResult<()> {
+    pub fn allow_ask_no_ack(&mut self, enable: i32) -> PyResult<()> {
         self.inner
-            .allow_ask_no_ack(enable)
+            .allow_ask_no_ack(enable != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -494,9 +494,9 @@ impl RF24 {
     /// Parameters:
     ///     about_tx: True returns data about the TX FIFO.
     ///         False returns data about the RX FIFO.
-    pub fn get_fifo_state(&mut self, about_tx: bool) -> PyResult<FifoState> {
+    pub fn get_fifo_state(&mut self, about_tx: i32) -> PyResult<FifoState> {
         self.inner
-            .get_fifo_state(about_tx)
+            .get_fifo_state(about_tx != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
             .map(|e| FifoState::from_inner(e))
     }
@@ -544,9 +544,9 @@ impl RF24 {
     ///     enable: If set to `true`, the statically sized payload length (set via
     ///         [`RF24.payload_length`][rf24_py.RF24.payload_length]) are not
     ///         used.
-    pub fn set_dynamic_payloads(&mut self, enable: bool) -> PyResult<()> {
+    pub fn set_dynamic_payloads(&mut self, enable: i32) -> PyResult<()> {
         self.inner
-            .set_dynamic_payloads(enable)
+            .set_dynamic_payloads(enable != 0)
             .map_err(|e| PyRuntimeError::new_err(format!("{e:?}")))
     }
 
@@ -633,8 +633,8 @@ impl RF24 {
     ///     Setting this attribute to `True` is equivalent to calling
     ///     [`power_up()`][rf24_py.RF24.power_up] (using default delay).
     #[setter]
-    pub fn set_power(&mut self, enable: bool) -> PyResult<()> {
-        if enable {
+    pub fn set_power(&mut self, enable: i32) -> PyResult<()> {
+        if enable != 0 {
             self.power_up(None)
         } else {
             self.power_down()

bindings/python/src/types.rs

@@ -21,12 +21,15 @@ pub struct StatusFlags {
 #[pymethods]
 impl StatusFlags {
     #[new]
-    #[pyo3(signature = (rx_dr = false, tx_ds = false, tx_df = false))]
-    fn new(rx_dr: bool, tx_ds: bool, tx_df: bool) -> Self {
+    #[pyo3(
+        signature = (rx_dr = 0i32, tx_ds = 0i32, tx_df = 0i32),
+        text_signature = "(rx_dr: bool = False, tx_ds: bool = False, tx_df: bool = False) -> StatusFlags",
+    )]
+    fn new(rx_dr: i32, tx_ds: i32, tx_df: i32) -> Self {
         Self {
-            rx_dr,
-            tx_ds,
-            tx_df,
+            rx_dr: rx_dr != 0,
+            tx_ds: tx_ds != 0,
+            tx_df: tx_df != 0,
         }
     }
 

crates/rf24-rs/README.md

@@ -1,6 +1,6 @@
 # rf24-rs
 
-This is a rust driver library for the nRF24L01 wireless transceivers.
+This crate is a rust driver library for the nRF24L01 wireless transceivers.
 
 See the examples in the repository's [examples/rust](https://github.com/nRF24/rf24-rs/blob/main/examples/rust) folder.
 

crates/rf24-rs/src/radio/rf24/details.rs

@@ -8,7 +8,7 @@ use super::{mnemonics, registers};
 use crate::{
     radio::prelude::{
         EsbChannel, EsbCrcLength, EsbDataRate, EsbFifo, EsbPaLevel, EsbPayloadLength, EsbPipe,
-        EsbStatus,
+        EsbPower, EsbStatus,
     },
     StatusFlags,
 };
@@ -124,10 +124,7 @@ where
             "Primary Mode______________{=istr}X",
             if self._config_reg & 1 > 0 { rx } else { tx }
         );
-        defmt::println!(
-            "Powered Up________________{=bool}",
-            self._config_reg & 2 > 0
-        );
+        defmt::println!("Powered Up________________{=bool}", self.is_powered());
 
         // print pipe addresses
         self.spi_read(5, registers::TX_ADDR)?;
@@ -259,7 +256,7 @@ where
             "Primary Mode______________{}X",
             if self._config_reg & 1 > 0 { "R" } else { "T" }
         );
-        std::println!("Powered Up________________{}", self._config_reg & 2 > 0);
+        std::println!("Powered Up________________{}", self.is_powered());
 
         // print pipe addresses
         self.spi_read(5, registers::TX_ADDR)?;

crates/rf24-rs/src/radio/rf24/mod.rs

@@ -65,8 +65,8 @@ where
     /// `spi` bus with the given `ce_pin`.
     ///
     /// The radio's CSN pin (aka Chip Select pin) shall be defined
-    /// when instantiating the [`SpiDevice`] object (passed to the
-    /// `spi` parameter).
+    /// when instantiating the [`SpiDevice`](trait@embedded-hal::spi::SpiDevice)
+    /// object (passed to the `spi` parameter).
     pub fn new(ce_pin: DO, spi: SPI, delay_impl: DELAY) -> RF24<SPI, DO, DELAY> {
         RF24 {
             _status: 0,