use enum constants for setters

Author: 2bndy5

RF24.cpp

@@ -56,36 +56,6 @@ bool StatusFlags::rx_dr() const
 
 /****************************************************************************/
 
-void StatusFlags::set_tx_df(bool enable)
-{
-    if (enable)
-        value |= _BV(MAX_RT);
-    else
-        value &= ~_BV(MAX_RT);
-}
-
-/****************************************************************************/
-
-void StatusFlags::set_tx_ds(bool enable)
-{
-    if (enable)
-        value |= _BV(TX_DS);
-    else
-        value &= ~_BV(TX_DS);
-}
-
-/****************************************************************************/
-
-void StatusFlags::set_rx_dr(bool enable)
-{
-    if (enable)
-        value |= _BV(RX_DR);
-    else
-        value &= ~_BV(RX_DR);
-}
-
-/****************************************************************************/
-
 void RF24::csn(bool mode)
 {
 #if defined(RF24_TINY)
@@ -1635,26 +1605,25 @@ void RF24::whatHappened(bool& tx_ok, bool& tx_fail, bool& rx_ready)
 
 StatusFlags RF24::clearStatusFlags()
 {
-    write_register(NRF_STATUS, 0x70);
-    StatusFlags flags;
-    memcpy((void*)(&flags), &status, 1);
+    write_register(NRF_STATUS, RF24_IRQ_ALL);
+    StatusFlags flags(status);
     return flags;
 }
 
 /****************************************************************************/
 
 void RF24::clearStatusFlags(StatusFlags& flags)
 {
-    write_register(NRF_STATUS, flags.value & 0x70);
-    flags = StatusFlags(status);
+    write_register(NRF_STATUS, flags.value & RF24_IRQ_ALL);
+    flags.value = status;
 }
 
 /****************************************************************************/
 
 void RF24::setStatusFlags(StatusFlags flags)
 {
     // flip the flags to translate from "human understanding"
-    write_register(NRF_CONFIG, ~flags.value & 0x70);
+    write_register(NRF_CONFIG, ~flags.value & RF24_IRQ_ALL);
 }
 
 /****************************************************************************/

RF24.h

@@ -134,6 +134,22 @@ typedef enum
  * @{
  */
 
+/**
+ * @brief An enumeration of constants used to configure @ref StatusFlags
+ */
+typedef enum
+{
+#include "nRF24L01.h"
+    /// Represents an event where TX Data Failed to send.
+    RF24_TX_DF = 1 << MASK_MAX_RT,
+    /// Represents an event where TX Data Sent successfully.
+    RF24_TX_DS = 1 << TX_DS,
+    /// Represents an event where RX Data is Ready to `RF24::read()`.
+    RF24_RX_DR = 1 << RX_DR,
+    /// Equivalent to `RF24_RX_DR | RF24_TX_DS | RF24_TX_DF`.
+    RF24_IRQ_ALL = (1 << MASK_MAX_RT) | (1 << TX_DS) | (1 << RX_DR),
+} rf24_irq_flags_e;
+
 /**
  * @brief A bit-field struct to represent the radio's STATUS byte.
  */
@@ -152,13 +168,6 @@ struct StatusFlags
     /// Represents an event where RX Data is Ready to `RF24::read()`.
     bool rx_dr() const;
 
-    /// Configure the event where TX Data Failed to send.
-    void set_tx_df(bool enable);
-    /// Configure the event where TX Data Sent successfully.
-    void set_tx_ds(bool enable);
-    /// Configure the event where RX Data is Ready to `RF24::read()`.
-    void set_rx_dr(bool enable);
-
     /**
      * @brief Convert this struct to a human understandable string.
      *
@@ -181,6 +190,21 @@ struct StatusFlags
     /// The default initializer constructor.
     /// @see Details about `StatusFlags::toString()` show an example output of default values.
     StatusFlags() : value(0x0E) {};
+
+    /**
+     * @brief Set the StatusFlags using constants defined by @ref rf24_irq_flags_e
+     *
+     * @param bits This value shall be a value of @ref rf24_irq_flags_e.
+     * Enabling multiple flags can be done with bitwise OR operator (`|`).
+     *
+     * ```cpp
+     * // only enable the "RX Data Ready" event
+     * StatusFlags flags(RF24_RX_DR);
+     *
+     * // only enable the "TX Data Sent" and "TX Data Fail" events
+     * flags = StatusFlags(RF24_TX_DF | RF24_TX_DS);
+     * ```
+     */
     StatusFlags(uint8_t bits) : value(bits) {};
 
 private:

pyRF24/pyRF24.cpp

@@ -305,10 +305,18 @@ BOOST_PYTHON_MODULE(RF24)
         .value("RF24_FIFO_INVALID", RF24_FIFO_INVALID)
         .export_values();
 
+    bp::enum_<rf24_irq_flags_e>("rf24_irq_flags_e")
+        .value("RF24_TX_DF", RF24_TX_DF)
+        .value("RF24_TX_DS", RF24_TX_DS)
+        .value("RF24_RX_DR", RF24_RX_DR)
+        .value("RF24_IRQ_ALL", RF24_IRQ_ALL)
+        .export_values();
+
     bp::class_<StatusFlags>("StatusFlags", bp::init<>())
-        .add_property("rx_dr", &StatusFlags::rx_dr, &StatusFlags::set_rx_dr)
-        .add_property("tx_ds", &StatusFlags::tx_ds, &StatusFlags::set_tx_ds)
-        .add_property("tx_df", &StatusFlags::tx_df, &StatusFlags::set_tx_df)
+        .def(bp::init<uint8_t>((bp::arg("bits"))))
+        .add_property("rx_dr", &StatusFlags::rx_dr)
+        .add_property("tx_ds", &StatusFlags::tx_ds)
+        .add_property("tx_df", &StatusFlags::tx_df)
         .add_property("tx_full", &StatusFlags::tx_full)
         .add_property("rx_pipe", &StatusFlags::rx_pipe)
         .def("__repr__", &reprStatusFlags);