moved the ISR for new data logic into the underlying interface comm object - in prep for enabling SPI - which needs the same logic as I2C; Also added logic for ESP32 and RP2* boards so the IRS callback takes a paramter -- which will enable the use of multiple devices - if needed

Author: gigapod

src/sfTk/sfDevFPC2534I2C.cpp

@@ -28,22 +28,6 @@ static sfDevFPC2534I2C_IRead *__readHelper = nullptr;
 
 #endif
 
-// When in I2C comm mode, an interrupt pin from the FPC2534 is used to signal when
-// data is available to read. We manage this here.
-//
-// For the ISR interrupt handler
-// static volatile bool data_available = false;
-static volatile bool data_available = false;
-
-static void the_isr_cb()
-{
-    // This is the interrupt callback function
-    // It will be called when the IRQ pin goes high
-    // We can use this to signal that data is available
-
-    data_available = true;
-}
-
 // --------------------------------------------------------------------------------------------
 // CTOR
 sfDevFPC2534I2C::sfDevFPC2534I2C() : _i2cAddress{0}, _i2cPort{nullptr}, _i2cBusNumber{0}
@@ -63,9 +47,8 @@ bool sfDevFPC2534I2C::initialize(uint8_t address, TwoWire &wirePort, uint8_t i2c
     _i2cPort = &wirePort;
     _i2cBusNumber = i2cBusNumber;
 
-    // Setup the interrupt handler
-    pinMode(interruptPin, INPUT);
-    attachInterrupt(interruptPin, the_isr_cb, RISING);
+    // Call our super to init the ISR handler
+    sfDevFPC2534IComm::initISRHandler(interruptPin);
 
     // clear out our data buffer
     clearData();
@@ -82,7 +65,7 @@ bool sfDevFPC2534I2C::dataAvailable()
         return false;
 
     // the data available flag is set, or we have data in the buffer
-    return data_available || _dataCount > 0;
+    return isISRDataAvailable() || _dataCount > 0;
 }
 
 //--------------------------------------------------------------------------------------------
@@ -93,7 +76,8 @@ void sfDevFPC2534I2C::clearData()
     _dataCount = 0;
     _dataHead = 0;
     _dataTail = 0;
-    data_available = false;
+    // clear any data signaled by the ISR
+    clearISRDataAvailable();
 }
 
 //--------------------------------------------------------------------------------------------
@@ -173,10 +157,10 @@ uint16_t sfDevFPC2534I2C::read(uint8_t *data, size_t len)
         return FPC_RESULT_IO_RUNTIME_FAILURE;
 
     // is new data available from the sensor - always grab new data if we have room
-    if (data_available)
+    if (isISRDataAvailable())
     {
         // clear flag
-        data_available = false;
+        clearISRDataAvailable();
 
         // how much data is available?
         uint16_t dataAvailable = __readHelper->readTransferSize(_i2cAddress);

src/sfTk/sfDevFPC2534IComm.cpp

@@ -0,0 +1,102 @@
+/*
+ *---------------------------------------------------------------------------------
+ *
+ * Copyright (c) 2025, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ *---------------------------------------------------------------------------------
+ */
+
+#include <Arduino.h>
+// Implementation file for the I2C communication class of the library.
+#include "sfDevFPC2534IComm.h"
+
+// When in I2C comm mode, an interrupt pin from the FPC2534 is used to signal when
+// data is available to read. We manage this here.
+//
+// For the ISR interrupt handler
+// static volatile bool data_available = false;
+static volatile bool data_available = false;
+
+static bool isISRInitialized = false;
+
+//--------------------------------------------------------------------------------------------
+// standard ISR handler - no param version
+static void the_isr_cb()
+{
+    // This is the interrupt callback function
+    // It will be called when the IRQ pin goes high
+    // We can use this to signal that data is available
+
+    data_available = true;
+}
+
+//--------------------------------------------------------------------------------------------
+// ISR handler with param version ()
+static void the_isr_cb_arg(void *arg)
+{
+    // set the data available flag in the instance
+    if (arg != nullptr)
+        static_cast<sfDevFPC2534IComm *>(arg)->setISRDataAvailable();
+}
+
+//--------------------------------------------------------------------------------------------
+// method used to set the IRS Handler by a sub-class
+void sfDevFPC2534IComm::initISRHandler(uint32_t interruptPin)
+{
+    // Some platforms (ESP32 , RP2040) support passing an argument to the ISR handler.
+    // If so, use that method to pass in "this" pointer to the handler. Which allows
+    // us to set the data_available flag in the instance, rather than a static/global flag
+    // and possibly support multiple sensors at the same time.
+
+    pinMode(interruptPin, INPUT);
+#if defined(ESP32)
+
+    attachInterruptArg(interruptPin, the_isr_cb_arg, (void *)this, RISING);
+    _usingISRParam = true;
+
+#elif defined(ARDUINO_ARCH_RP2040)
+
+    attachInterruptParam(interruptPin, the_isr_cb_arg, RISING, (void *)this);
+    _usingISRParam = true;
+
+#else
+
+    // Setup the interrupt handler for non-parameter version (older arduino impls)
+    attachInterrupt(interruptPin, the_isr_cb, RISING);
+
+    isISRInitialized = true;
+    _usingISRParam = false;
+#endif
+}
+//--------------------------------------------------------------------------------------------
+void sfDevFPC2534IComm::setISRDataAvailable(void)
+{
+    _dataAvailable = true;
+}
+//--------------------------------------------------------------------------------------------
+// method used to clear the data available flag
+void sfDevFPC2534IComm::clearISRDataAvailable(void)
+{
+    // Are we using the ISR param method?
+    if (_usingISRParam)
+        _dataAvailable = false;
+    else if (isISRInitialized)
+        data_available = false;
+}
+
+//--------------------------------------------------------------------------------------------
+// Data available ?
+bool sfDevFPC2534IComm::isISRDataAvailable(void)
+{
+    // Are we using the ISR param method?
+    if (_usingISRParam)
+        return _dataAvailable;
+
+    // Nope, using the static ISR and static flag in this file (this only supports one instance)
+    if (!isISRInitialized)
+        return false;
+
+    return data_available;
+}