Merge pull request #45 from matthias-bs/20251014-feat-ble-scan-abort-callback

Added callback to abort BLE scanning early

Author: matthias-bs

src/BleSensors/BleSensors.cpp

@@ -43,6 +43,8 @@
 // 20250926 Moved decoding from callback to getData() to prevent WDT reset
 //          Modified getData() to return number of known sensors found
 // 20251013 Added abort of scanning by touch sensor
+// 20251014 Added optional callback to abort scanning early
+//          Replaced TouchTriggered by callback function pointer
 //
 // ToDo:
 // -
@@ -53,8 +55,6 @@
 
 #include "BleSensors.h"
 
-extern bool TouchTriggered(void);
-
 namespace BleSensorsCallbacks
 {
   constexpr size_t JSON_SERIALIZATION_BUFFER_SIZE = 256; //!< Buffer size for JSON serialization
@@ -68,6 +68,7 @@ namespace BleSensorsCallbacks
     std::vector<std::string> m_knownBLEAddresses; //!< MAC addresses of known sensors
     std::vector<ble_sensors_t> *m_sensorData;     //!< Sensor data
     NimBLEScan *m_pBLEScan;                       //!< Pointer to the BLE scan object
+    bool (*m_stopScanCb)();                        //!< Pointer to optional callback function to stop scan early
 
     // Raw JSON payloads collected during scan for later decoding.
     std::vector<std::string> m_rawBLEJsons;
@@ -140,9 +141,10 @@ namespace BleSensorsCallbacks
         cb_log_v("Known BLE device queued for decoding at index %d", found_index);
       }
 
-      // Abort scanning by touch sensor
-      if (TouchTriggered()) {
-        log_i("Touch interrupt!");
+      // Abort scanning if requested by callback
+      if (m_stopScanCb && m_stopScanCb())
+      {
+        log_i("Scan aborted.");
         m_pBLEScan->stop();
       }
 
@@ -199,6 +201,7 @@ unsigned BleSensors::getData(uint32_t scanTime, bool activeScan)
   scanCallbacks.m_knownBLEAddresses = _known_sensors;
   scanCallbacks.m_sensorData = &data;
   scanCallbacks.m_pBLEScan = _pBLEScan;
+  scanCallbacks.m_stopScanCb = _stopScanCb;
 
   // Ensure previous scan data cleared
   scanCallbacks.m_rawBLEJsons.clear();

src/BleSensors/BleSensors.h

@@ -40,6 +40,7 @@
 // 20250121 Updated for NimBLE-Arduino v2.x
 // 20250808 Added specific logging macros in scan callback to avoid WDT reset
 // 20250926 Changed getData() to return number of known sensors found
+// 20251014 Added optional callback to abort scanning early
 //
 // ToDo:
 // -
@@ -102,15 +103,18 @@ class BleSensors {
          *
          * \param known_sensors    Vector of BLE MAC addresses of known sensors, e.g. {"11:22:33:44:55:66", "AA:BB:CC:DD:EE:FF"}
          */
-        BleSensors(std::vector<std::string> known_sensors) {
+        BleSensors(std::vector<std::string> known_sensors, bool (*stopScanCb)() = nullptr) {
             _known_sensors = known_sensors;
             data.resize(known_sensors.size());
+            _stopScanCb = stopScanCb;
         };
 
         /*!
          * \brief Constructor.
          */
-        BleSensors(void) {
+        BleSensors(bool (*stopScanCb)() = nullptr) {
+            data.resize(0);
+            _stopScanCb = stopScanCb;
         };
 
         /*!
@@ -155,7 +159,8 @@ class BleSensors {
         std::vector<ble_sensors_t> data;
 
     protected:
-        std::vector<std::string> _known_sensors; /// MAC addresses of known sensors
-        NimBLEScan*              _pBLEScan;      /// NimBLEScan object
+        std::vector<std::string> _known_sensors;  /// MAC addresses of known sensors
+        NimBLEScan*              _pBLEScan;       /// NimBLEScan object
+        bool                    (*_stopScanCb)(); /// Pointer to optional callback function to stop scan early
 };
 #endif

src/LocalInterface.cpp

@@ -36,6 +36,8 @@
 // 20250308 Updated NimBLE-Arduino to v2.2.3
 // 20250725 Replaced BLE code by src/BleSensors/BleSensors.h/.cpp
 // 20251013 Updated SCD4x driver
+// 20251014 Changed bleSensors to local variable
+//          Added TouchTriggered to CTOR as callback to abort BLE scanning
 //
 // ToDo:
 // -
@@ -61,11 +63,6 @@ static const int bleScanMode = 1;  //!< BLE scan mode: 0=passive, 1=active
 static std::vector<std::string> knownBLEAddresses = KNOWN_BLE_ADDRESSES;
 #endif
 
-#ifdef THEENGSDECODER_EN
-/// Bluetooth Low Energy sensors
-BleSensors bleSensors;
-#endif
-
 // Get local sensor data
 void LocalInterface::GetLocalData(void)
 {
@@ -142,7 +139,7 @@ void LocalInterface::GetLocalData(void)
 #endif
 
 #ifdef THEENGSDECODER_EN
-  bleSensors = BleSensors(KNOWN_BLE_ADDRESSES);
+  BleSensors bleSensors = BleSensors(KNOWN_BLE_ADDRESSES, &TouchTriggered);
   if (bleSensors.data.size() > 0)
   {
     bleSensors.getData(bleScanTime, bleScanMode);