less reliant on StatusFlags struct

Author: 2bndy5

RF24.cpp

@@ -21,35 +21,35 @@ int StatusFlags::toString(char* buf) const
 
 /****************************************************************************/
 
-bool StatusFlags::tx_full() const
+const bool StatusFlags::tx_full() const
 {
     return value & _BV(TX_FULL);
 }
 
 /****************************************************************************/
 
-uint8_t StatusFlags::rx_pipe() const
+const uint8_t StatusFlags::rx_pipe() const
 {
     return (value >> RX_P_NO) & 7;
 }
 
 /****************************************************************************/
 
-bool StatusFlags::tx_df() const
+const bool StatusFlags::tx_df() const
 {
     return value & _BV(MAX_RT);
 }
 
 /****************************************************************************/
 
-bool StatusFlags::tx_ds() const
+const bool StatusFlags::tx_ds() const
 {
     return value & _BV(TX_DS);
 }
 
 /****************************************************************************/
 
-bool StatusFlags::rx_dr() const
+const bool StatusFlags::rx_dr() const
 {
     return value & _BV(RX_DR);
 }
@@ -1603,43 +1603,33 @@ void RF24::whatHappened(bool& tx_ok, bool& tx_fail, bool& rx_ready)
 
 /****************************************************************************/
 
-StatusFlags RF24::clearStatusFlags()
+uint8_t RF24::clearStatusFlags(uint8_t flags)
 {
-    write_register(NRF_STATUS, RF24_IRQ_ALL);
-    StatusFlags flags(status);
-    return flags;
-}
-
-/****************************************************************************/
-
-void RF24::clearStatusFlags(StatusFlags& flags)
-{
-    write_register(NRF_STATUS, flags.value & RF24_IRQ_ALL);
-    flags.value = status;
+    write_register(NRF_STATUS, flags & RF24_IRQ_ALL);
+    return status;
 }
 
 /****************************************************************************/
 
-void RF24::setStatusFlags(StatusFlags flags)
+void RF24::setStatusFlags(uint8_t flags)
 {
     // flip the flags to translate from "human understanding"
-    write_register(NRF_CONFIG, ~flags.value & RF24_IRQ_ALL);
+    write_register(NRF_CONFIG, ~flags & RF24_IRQ_ALL);
 }
 
 /****************************************************************************/
 
-void RF24::getStatusFlags(StatusFlags& flags)
+uint8_t RF24::getStatusFlags()
 {
-    flags = StatusFlags(status);
+    return status;
 }
 
 /****************************************************************************/
 
-StatusFlags RF24::update()
+uint8_t RF24::update()
 {
     read_register(RF24_NOP, (uint8_t*)nullptr, 0);
-    StatusFlags flags(status);
-    return flags;
+    return status;
 }
 
 /****************************************************************************/

RF24.h

@@ -157,16 +157,16 @@ struct StatusFlags
 {
     // starting with bit 0 at the top...
     /// Signifies that the TX FIFO is fully occupied.
-    bool tx_full() const;
+    const bool tx_full() const;
     /// @brief Represents the pipe number that received the first available payload in the RX FIFO.
     /// @remark This data shall be considered invalid if the @ref StatusFlags::rx_dr flag is `false`.
-    uint8_t rx_pipe() const;
+    const uint8_t rx_pipe() const;
     /// Represents an event where TX Data Failed to send.
-    bool tx_df() const;
+    const bool tx_df() const;
     /// Represents an event where TX Data Sent successfully.
-    bool tx_ds() const;
+    const bool tx_ds() const;
     /// Represents an event where RX Data is Ready to `RF24::read()`.
-    bool rx_dr() const;
+    const bool rx_dr() const;
 
     /**
      * @brief Convert this struct to a human understandable string.
@@ -208,8 +208,7 @@ struct StatusFlags
     StatusFlags(uint8_t bits) : value(bits) {};
 
 private:
-    friend class RF24;
-    uint8_t value;
+    const uint8_t value;
 };
 
 /**
@@ -1263,51 +1262,36 @@ class RF24
     void whatHappened(bool& tx_ok, bool& tx_fail, bool& rx_ready);
 
     /**
-     * Clear all of the StatusFlags that caused an interrupt event.
+     * Clear the StatusFlags that caused an interrupt event.
      *
      * @remark This function is similar to `whatHappened()` because it also returns the
      * StatusFlags that caused the interrupt event. However, this function returns
-     * a 1-byte bit-field struct (@ref StatusFlags) instead of bit-banging 3 1-byte booleans
+     * a 1-byte struct (@ref StatusFlags) instead of bit-banging 3 1-byte booleans
      * passed by reference.
      *
      * @note When used in an ISR (Interrupt Service routine), there is a chance that the
-     * @ref StatusFlags::rx_pipe information is inaccurate. See available(uint8_t*) (or the
+     * @ref StatusFlags::rx_pipe() information is inaccurate. See available(uint8_t*) (or the
      * datasheet) for more detail.
      *
-     * @ingroup StatusFlags
-     */
-    StatusFlags clearStatusFlags();
-
-    /**
-     * Clear the specified flags.
-     *
-     * If any of the following flags are `true`, then the flag will be reset:
-     *
-     * - @ref StatusFlags::rx_dr
-     * - @ref StatusFlags::tx_ds
-     * - @ref StatusFlags::tx_df
+     * @param flags The IRQ flags to clear. Default value is all of them (@ref RF24_IRQ_ALL).
+     * Multiple flags can be cleared by OR-ing @ref rf24_irq_flags_e values together.
      *
      * @ingroup StatusFlags
      */
-    void clearStatusFlags(StatusFlags& flags);
+    uint8_t clearStatusFlags(uint8_t flags = RF24_IRQ_ALL);
 
     /**
      * Set which flags shall be reflected on the radio's IRQ pin.
      *
-     * This is similar to maskIRQ(), but with a more intuitive API.
-     *
-     * @param flags The configuration of the StatusFlags to influence the radio's IRQ pin.
-     *
-     * If any of the following `flags` are `true`, then the flag's corresponding event will
-     * trigger the IRQ pin active HIGH:
+     * This is similar to maskIRQ(), but with less confusing parameters.
      *
-     * - @ref StatusFlags::rx_dr
-     * - @ref StatusFlags::tx_ds
-     * - @ref StatusFlags::tx_df
+     * @param flags The value of @ref rf24_irq_flags_e to influence the radio's IRQ pin.
+     * The default value `0` will disable the radio's IRQ pin.
+     * Multiple events can be enabled by OR-ing @ref rf24_irq_flags_e values together.
      *
      * @ingroup StatusFlags
      */
-    void setStatusFlags(StatusFlags flags);
+    void setStatusFlags(uint8_t flags = 0);
 
     /**
      * Get the latest STATUS byte returned from the last SPI transaction.
@@ -1323,7 +1307,7 @@ class RF24
      *
      * @ingroup StatusFlags
      */
-    void getStatusFlags(StatusFlags& flags);
+    uint8_t getStatusFlags();
 
     /**
      * Get an updated STATUS byte from the radio.
@@ -1332,7 +1316,7 @@ class RF24
      *
      * @ingroup StatusFlags
      */
-    StatusFlags update();
+    uint8_t update();
 
     /**
      * Non-blocking write to the open writing pipe used for buffered writes

pyRF24/pyRF24.cpp

@@ -113,13 +113,6 @@ bp::tuple whatHappened_wrap(RF24& ref)
     return bp::make_tuple(tx_ok, tx_fail, tx_ready);
 }
 
-StatusFlags getStatusFlags_wrap(RF24& ref)
-{
-    StatusFlags flags;
-    ref.getStatusFlags(flags);
-    return flags;
-}
-
 std::string reprStatusFlags(StatusFlags& self)
 {
     char* buf = new char[69];
@@ -383,10 +376,11 @@ BOOST_PYTHON_MODULE(RF24)
         .def("setRadiation", &RF24::setRadiation)
         .def("txStandBy", (bool(::RF24::*)(::uint32_t, bool))(&RF24::txStandBy), txStandBy_wrap1(bp::args("timeout", "startTx")))
         .def("whatHappened", &whatHappened_wrap)
-        .def("setStatusFlags", &RF24::setStatusFlags, (bp::arg("flags")))
-        .def("clearStatusFlags", (StatusFlags(::RF24::*)(void))(&RF24::clearStatusFlags))
-        .def("clearStatusFlags", (void(::RF24::*)(StatusFlags&))(&RF24::clearStatusFlags), (bp::arg("flags")))
-        .def("getStatusFlags", &getStatusFlags_wrap)
+        .def("setStatusFlags", (uint8_t(::RF24::*)(void))(&RF24::setStatusFlags))
+        .def("setStatusFlags", (uint8_t(::RF24::*)(uint8_t&))(&RF24::setStatusFlags), (bp::arg("flags")))
+        .def("clearStatusFlags", (uint8_t(::RF24::*)(void))(&RF24::clearStatusFlags))
+        .def("clearStatusFlags", (uint8_t(::RF24::*)(uint8_t&))(&RF24::clearStatusFlags), (bp::arg("flags")))
+        .def("getStatusFlags", &RF24::getStatusFlags)
         .def("update", &RF24::update)
         .def("startConstCarrier", &RF24::startConstCarrier, (bp::arg("level"), bp::arg("channel")))
         .def("stopConstCarrier", &RF24::stopConstCarrier)