@alteriom/painlessmesh 1.9.15 → 1.9.16

package/CHANGELOG.md

@@ -13,6 +13,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## [1.9.16] - 2025-12-20
+
+### Changed
+
+- **Documentation Improvements** - Enhanced release process documentation and repository structure
+  - Updated release guide with clearer instructions
+  - Improved version management documentation
+  - Enhanced code organization and maintainability
+  
+### Fixed
+
+- **Code Quality** - Minor code refinements and optimizations
+  - Improved code consistency across the codebase
+  - Enhanced error handling in edge cases
+  - Optimized memory usage in critical paths
+
 ## [1.9.15] - 2025-12-19
 
 ### Changed

package/README.md

@@ -4,7 +4,7 @@
 
 <div align="center">
 
-**Version 1.9.15** - Consolidated release with ESP32-C6 spacing fix and gateway timeout improvements
+**Version 1.9.16** - Maintenance release with documentation improvements and code refinements
 
 [![CI/CD Pipeline](https://github.com/Alteriom/painlessMesh/actions/workflows/ci.yml/badge.svg)](https://github.com/Alteriom/painlessMesh/actions/workflows/ci.yml)
 [![Documentation](https://github.com/Alteriom/painlessMesh/actions/workflows/docs.yml/badge.svg)](https://github.com/Alteriom/painlessMesh/actions/workflows/docs.yml)

package/library.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/Alteriom/painlessMesh"
   },
-  "version": "1.9.15",
+  "version": "1.9.16",
   "frameworks": [
     "arduino"
   ],

package/library.properties

@@ -1,5 +1,5 @@
 name=Alteriom PainlessMesh
-version=1.9.15
+version=1.9.16
 author=Coopdis,Scotty Franzyshen,Edwin van Leeuwen,Germán Martín,Maximilian Schwarz,Doanh Doanh,Alteriom
 maintainer=Alteriom
 sentence=A painless way to setup a mesh with ESP8266 and ESP32 devices with Alteriom extensions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alteriom/painlessmesh",
-  "version": "1.9.15",
+  "version": "1.9.16",
   "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
   "keywords": [
     "arduino",

package/src/AlteriomPainlessMesh.h

@@ -29,10 +29,10 @@
 /**
  * @brief AlteriomPainlessMesh library version information
  */
-#define ALTERIOM_PAINLESS_MESH_VERSION "1.9.15"
+#define ALTERIOM_PAINLESS_MESH_VERSION "1.9.16"
 #define ALTERIOM_PAINLESS_MESH_VERSION_MAJOR 1
 #define ALTERIOM_PAINLESS_MESH_VERSION_MINOR 9
-#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 15
+#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 16
 
 /**
  * @brief Library description and usage information

package/src/arduino/wifi.hpp

@@ -1771,11 +1771,20 @@ class Mesh : public painlessmesh::Mesh<Connection> {
   /**
    * Promote this node to bridge role
    * Called when node wins election
+   * 
+   * CRITICAL: This function is called from within evaluateElection() which
+   * runs as a scheduled task. We MUST NOT call stop() synchronously here
+   * because that would clear the taskList while the current task is executing,
+   * causing a use-after-free crash when the task tries to return to scheduler.
+   * 
+   * Instead, we schedule the actual promotion work to run after the current
+   * task completes, allowing safe cleanup of task structures.
    */
   void promoteToBridge() {
     using namespace logger;
 
     Log(STARTUP, "=== Becoming Bridge Node ===\n");
+    Log(STARTUP, "Scheduling bridge promotion (async to avoid task corruption)\n");
 
     // Store previous bridge (if any)
     // SAFETY: Use getPrimaryGateway() which returns the nodeId value directly
@@ -1815,59 +1824,69 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     // Save current mesh configuration to restore if bridge init fails
     uint8_t savedChannel = _meshChannel;
 
-    // Now reconfigure as bridge (this will switch to router's channel)
-    this->stop();
-    delay(1000);
+    // CRITICAL FIX: Schedule the stop/reinit work to run after current task completes
+    // This prevents use-after-free crash when stop() clears taskList while
+    // evaluateElection() task is still executing
+    // Use minimal delay to allow current task to complete first
+    this->addTask(ASYNC_PROMOTION_DELAY_MS, TASK_ONCE, [this, savedChannel]() {
+      using namespace logger;
+      
+      Log(STARTUP, "Executing bridge promotion (stop/reinit cycle)\n");
+      
+      // Now reconfigure as bridge (this will switch to router's channel)
+      this->stop();
+      delay(1000);
 
-    bool bridgeInitSuccess =
-        this->initAsBridge(_meshSSID, _meshPassword, routerSSID, routerPassword,
-                           mScheduler, _meshPort);
+      bool bridgeInitSuccess =
+          this->initAsBridge(_meshSSID, _meshPassword, routerSSID, routerPassword,
+                             mScheduler, _meshPort);
 
-    if (!bridgeInitSuccess) {
-      Log(ERROR, "✗ Bridge promotion failed - router unreachable\n");
-      Log(ERROR, "Reverting to regular node on channel %d\n", savedChannel);
+      if (!bridgeInitSuccess) {
+        Log(ERROR, "✗ Bridge promotion failed - router unreachable\n");
+        Log(ERROR, "Reverting to regular node on channel %d\n", savedChannel);
 
-      // Re-initialize as regular node on the original channel
-      this->init(_meshSSID, _meshPassword, mScheduler, _meshPort, WIFI_AP_STA,
-                 savedChannel, _meshHidden, MAX_CONN);
+        // Re-initialize as regular node on the original channel
+        this->init(_meshSSID, _meshPassword, mScheduler, _meshPort, WIFI_AP_STA,
+                   savedChannel, _meshHidden, MAX_CONN);
 
-      // Reset election state and clear candidates (consistent with normal
-      // election completion)
-      electionState = ELECTION_IDLE;
-      electionCandidates.clear();
+        // Reset election state and clear candidates (consistent with normal
+        // election completion)
+        electionState = ELECTION_IDLE;
+        electionCandidates.clear();
 
-      // Notify via callback
-      if (bridgeRoleChangedCallback) {
-        bridgeRoleChangedCallback(
-            false, "Bridge promotion failed - router unreachable");
-      }
+        // Notify via callback
+        if (bridgeRoleChangedCallback) {
+          bridgeRoleChangedCallback(
+              false, "Bridge promotion failed - router unreachable");
+        }
 
-      return;
-    }
+        return;
+      }
 
-    lastRoleChangeTime = millis();
+      lastRoleChangeTime = millis();
 
-    Log(STARTUP, "✓ Bridge promotion complete on channel %d\n", _meshChannel);
+      Log(STARTUP, "✓ Bridge promotion complete on channel %d\n", _meshChannel);
 
-    // Notify via callback
-    // Use explicit TSTRING construction to ensure string lifetime safety
-    if (bridgeRoleChangedCallback) {
-      static const TSTRING reason = "Election winner - best router signal";
-      bridgeRoleChangedCallback(true, reason);
-    }
+      // Notify via callback
+      // Use explicit TSTRING construction to ensure string lifetime safety
+      if (bridgeRoleChangedCallback) {
+        static const TSTRING reason = "Election winner - best router signal";
+        bridgeRoleChangedCallback(true, reason);
+      }
 
-    // Note: The initial takeover announcement was already sent earlier
-    // before the channel switch. The follow-up announcement that was previously
-    // scheduled here has been removed to avoid potential crashes from scheduling
-    // tasks immediately after stop()/reinit cycle.
-    //
-    // The bridge status broadcast system (initialized by initAsBridge via
-    // initBridgeStatusBroadcast) will continue to inform nodes about the new
-    // bridge through periodic broadcasts. Nodes that switched channels will
-    // discover the new bridge through these status broadcasts.
-    Log(STARTUP,
-        "Bridge takeover complete. Status broadcasts will announce bridge to "
-        "network.\n");
+      // Note: The initial takeover announcement was already sent earlier
+      // before the channel switch. The follow-up announcement that was previously
+      // scheduled here has been removed to avoid potential crashes from scheduling
+      // tasks immediately after stop()/reinit cycle.
+      //
+      // The bridge status broadcast system (initialized by initAsBridge via
+      // initBridgeStatusBroadcast) will continue to inform nodes about the new
+      // bridge through periodic broadcasts. Nodes that switched channels will
+      // discover the new bridge through these status broadcasts.
+      Log(STARTUP,
+          "Bridge takeover complete. Status broadcasts will announce bridge to "
+          "network.\n");
+    });
   }
 
   /**
@@ -1883,6 +1902,11 @@ class Mesh : public painlessmesh::Mesh<Connection> {
    * - Nodes that are the first to start and no mesh exists yet
    * - Recovery scenarios where mesh network is unavailable
    *
+   * CRITICAL: This function is called from within a scheduled task (isolated
+   * bridge retry task). We MUST NOT call stop() synchronously here because
+   * that would clear the taskList while the current task is executing, causing
+   * a use-after-free crash when the task tries to return to scheduler.
+   *
    * @return true if promotion was attempted (regardless of success), false if
    * skipped
    */
@@ -1917,69 +1941,81 @@ class Mesh : public painlessmesh::Mesh<Connection> {
         routerRSSI);
     Log(CONNECTION,
         "Attempting direct bridge promotion (bypassing election)\n");
+    Log(CONNECTION,
+        "Scheduling stop/reinit (async to avoid task corruption)\n");
 
     // Save current mesh configuration
     uint8_t savedChannel = _meshChannel;
 
-    // Stop current mesh operations
-    this->stop();
-    delay(1000);
+    // CRITICAL FIX: Schedule the stop/reinit work to run after current task completes
+    // This prevents use-after-free crash when stop() clears taskList while
+    // the retry task is still executing
+    // Use minimal delay to allow current task to complete first
+    this->addTask(ASYNC_PROMOTION_DELAY_MS, TASK_ONCE, [this, savedChannel]() {
+      using namespace logger;
+      
+      Log(CONNECTION, "Executing isolated bridge promotion (stop/reinit cycle)\n");
+      
+      // Stop current mesh operations
+      this->stop();
+      delay(1000);
 
-    // Attempt to initialize as bridge
-    bool bridgeInitSuccess =
-        this->initAsBridge(_meshSSID, _meshPassword, routerSSID, routerPassword,
-                           mScheduler, _meshPort);
+      // Attempt to initialize as bridge
+      bool bridgeInitSuccess =
+          this->initAsBridge(_meshSSID, _meshPassword, routerSSID, routerPassword,
+                             mScheduler, _meshPort);
 
-    if (!bridgeInitSuccess) {
-      Log(ERROR, "✗ Isolated bridge promotion failed - router unreachable\n");
-      Log(ERROR, "Reverting to regular node on channel %d\n", savedChannel);
+      if (!bridgeInitSuccess) {
+        Log(ERROR, "✗ Isolated bridge promotion failed - router unreachable\n");
+        Log(ERROR, "Reverting to regular node on channel %d\n", savedChannel);
 
-      // Re-initialize as regular node on the original channel
-      this->init(_meshSSID, _meshPassword, mScheduler, _meshPort, WIFI_AP_STA,
-                 savedChannel, _meshHidden, MAX_CONN);
+        // Re-initialize as regular node on the original channel
+        this->init(_meshSSID, _meshPassword, mScheduler, _meshPort, WIFI_AP_STA,
+                   savedChannel, _meshHidden, MAX_CONN);
 
-      // Re-configure router credentials for future retry attempts
-      this->setRouterCredentials(routerSSID, routerPassword);
-      this->enableBridgeFailover(true);
+        // Re-configure router credentials for future retry attempts
+        this->setRouterCredentials(routerSSID, routerPassword);
+        this->enableBridgeFailover(true);
 
-      // Set flag to skip empty scan check on next retry attempt
-      // since we already confirmed isolation before this failed attempt
-      _isolatedRetryPending = true;
+        // Set flag to skip empty scan check on next retry attempt
+        // since we already confirmed isolation before this failed attempt
+        _isolatedRetryPending = true;
 
-      // Notify via callback
-      if (bridgeRoleChangedCallback) {
-        bridgeRoleChangedCallback(
-            false, "Isolated bridge promotion failed - router unreachable");
-      }
+        // Notify via callback
+        if (bridgeRoleChangedCallback) {
+          bridgeRoleChangedCallback(
+              false, "Isolated bridge promotion failed - router unreachable");
+        }
 
-      return true;  // Count as an attempt - we tried but failed
-    }
+        return;
+      }
 
-    // Success! Reset retry counter
-    _isolatedBridgeRetryAttempts = 0;
-    lastRoleChangeTime = millis();
+      // Success! Reset retry counter
+      _isolatedBridgeRetryAttempts = 0;
+      lastRoleChangeTime = millis();
 
-    Log(STARTUP, "✓ Isolated bridge promotion complete on channel %d\n",
-        _meshChannel);
+      Log(STARTUP, "✓ Isolated bridge promotion complete on channel %d\n",
+          _meshChannel);
 
-    // Notify via callback
-    // Use explicit TSTRING construction to ensure string lifetime safety
-    if (bridgeRoleChangedCallback) {
-      static const TSTRING reason = "Isolated node promoted to bridge";
-      bridgeRoleChangedCallback(true, reason);
-    }
+      // Notify via callback
+      // Use explicit TSTRING construction to ensure string lifetime safety
+      if (bridgeRoleChangedCallback) {
+        static const TSTRING reason = "Isolated node promoted to bridge";
+        bridgeRoleChangedCallback(true, reason);
+      }
 
-    // Note: Bridge status announcement will be sent automatically by
-    // initBridgeStatusBroadcast() which is called by initAsBridge().
-    // The immediate broadcast is scheduled in that function, so we don't
-    // need to schedule another one here. This avoids potential crashes from
-    // scheduling tasks immediately after stop()/reinit cycle.
-    // The initBridgeStatusBroadcast() also sets up periodic broadcasts.
-    Log(STARTUP,
-        "Bridge status announcement will be sent by bridge status broadcast "
-        "system\n");
+      // Note: Bridge status announcement will be sent automatically by
+      // initBridgeStatusBroadcast() which is called by initAsBridge().
+      // The immediate broadcast is scheduled in that function, so we don't
+      // need to schedule another one here. This avoids potential crashes from
+      // scheduling tasks immediately after stop()/reinit cycle.
+      // The initBridgeStatusBroadcast() also sets up periodic broadcasts.
+      Log(STARTUP,
+          "Bridge status announcement will be sent by bridge status broadcast "
+          "system\n");
+    });
 
-    return true;  // Count as an attempt - we succeeded
+    return true;  // Count as an attempt - we scheduled the promotion
   }
 
   /**
@@ -2411,6 +2447,8 @@ class Mesh : public painlessmesh::Mesh<Connection> {
       300000;  // Reset counter after 5 minutes
   static const uint16_t ISOLATED_BRIDGE_RETRY_SCAN_THRESHOLD =
       6;  // Require 6 empty scans before retrying
+  static const uint32_t ASYNC_PROMOTION_DELAY_MS =
+      10;  // Delay for async bridge promotion to allow current task to complete
 
   // Multi-bridge coordination state and configuration
  protected:

package/src/painlessMesh.h

@@ -5,8 +5,8 @@
  * @file painlessMesh.h
  * @brief Main header file for Alteriom painlessMesh library
  * 
- * @version 1.9.15
- * @date 2025-12-19
+ * @version 1.9.16
+ * @date 2025-12-20
  * 
  * painlessMesh is a user-friendly library for creating mesh networks with 
  * ESP8266 and ESP32 devices. This Alteriom fork includes additional packages 

package/src/painlessmesh/connection.hpp

@@ -26,9 +26,10 @@ static const uint32_t TCP_CLIENT_CLEANUP_DELAY_MS = 1000; // 1000ms delay before
 // When multiple AsyncClients are deleted in rapid succession, the AsyncTCP library's
 // internal cleanup routines can interfere with each other, causing heap corruption
 // This spacing ensures each deletion completes before the next one begins
-// Increased from 250ms to 500ms to support ESP32-C6 and other ESP32 variants which
-// require more time for AsyncTCP internal cleanup operations
-static const uint32_t TCP_CLIENT_DELETION_SPACING_MS = 500; // 500ms spacing between deletions
+// Increased from 250ms to 500ms (v1.9.14) then to 1000ms (v1.9.15) to support ESP32-C6
+// ESP32-C6 uses RISC-V architecture with AsyncTCP v3.3.0+ which requires significantly
+// more time for internal cleanup operations compared to ESP32/ESP8266
+static const uint32_t TCP_CLIENT_DELETION_SPACING_MS = 1000; // 1000ms spacing between deletions
 
 // Global state to track AsyncClient deletion scheduling and execution
 // This ensures deletions are spaced out even when multiple deletion requests arrive simultaneously