@alteriom/painlessmesh 1.8.14 → 1.9.0

package/examples/queued_alarms/queued_alarms.ino

@@ -1,265 +0,0 @@
-//************************************************************
-// Queued Alarms Example - Message Queueing for Offline Mode
-//
-// Demonstrates priority-based message queueing for critical alarms
-// when Internet connection is unavailable. Perfect for IoT systems
-// that cannot afford to lose critical data.
-//
-// Use Case: Fish farm dissolved oxygen monitoring
-// - CRITICAL alarms (low O2) must never be lost
-// - Queue messages during Internet outages
-// - Automatic delivery when connection restored
-//
-// Hardware: ESP32 or ESP8266
-//************************************************************
-
-#include "painlessMesh.h"
-
-// Mesh configuration
-#define   MESH_PREFIX     "FishFarmMesh"
-#define   MESH_PASSWORD   "somethingSneaky"
-#define   MESH_PORT       5555
-
-// Router credentials for bridge node
-#define   ROUTER_SSID     "YourWiFiSSID"
-#define   ROUTER_PASSWORD "YourWiFiPassword"
-
-// Sensor thresholds (mg/L for dissolved oxygen)
-#define   CRITICAL_O2_THRESHOLD  3.0
-#define   WARNING_O2_THRESHOLD   5.0
-
-// Queue configuration
-#define   MAX_QUEUE_SIZE  500
-#define   QUEUE_PRUNE_AGE (24 * 60 * 60 * 1000)  // 24 hours in ms
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-bool offlineMode = false;
-uint32_t lastO2Check = 0;
-uint32_t lastQueuePrune = 0;
-
-// Simulated sensor reading (replace with actual sensor code)
-float readDissolvedOxygenSensor() {
-  // In real application, read from actual sensor
-  // For demo, simulate varying O2 levels
-  static float o2Level = 7.0;
-  o2Level += random(-20, 20) / 10.0;  // +/- 2.0 mg/L variation
-  o2Level = constrain(o2Level, 2.0, 10.0);
-  return o2Level;
-}
-
-// Send critical O2 alarm
-void sendCriticalAlarm(float o2Level) {
-  // Create alarm message (in real app, use JSON)
-  String payload = String("{\"type\":\"CRITICAL_ALARM\",\"sensor\":\"O2\",\"value\":") 
-                   + String(o2Level, 2) + ",\"threshold\":" 
-                   + String(CRITICAL_O2_THRESHOLD, 2) + ",\"tankId\":\"TANK_A\",\"nodeId\":" 
-                   + mesh.getNodeId() + ",\"timestamp\":" + mesh.getNodeTime() + "}";
-  
-  if (offlineMode || !mesh.hasInternetConnection()) {
-    // CRITICAL: Queue for guaranteed delivery
-    uint32_t msgId = mesh.queueMessage(
-      payload,
-      "mqtt://cloud.farm.com/alarms/critical",
-      PRIORITY_CRITICAL
-    );
-    
-    if (msgId) {
-      Serial.printf("🚨 CRITICAL O2 ALARM: %.2f mg/L - QUEUED #%u\n", o2Level, msgId);
-    } else {
-      Serial.printf("🚨 CRITICAL O2 ALARM: %.2f mg/L - QUEUE FAILED!\n", o2Level);
-    }
-  } else {
-    // Send immediately via bridge (in real app, use MQTT client)
-    Serial.printf("🚨 CRITICAL O2 ALARM: %.2f mg/L - SENT IMMEDIATELY\n", o2Level);
-    // mqttClient.publish("alarms/critical", payload.c_str());
-  }
-}
-
-// Send warning alarm
-void sendWarningAlarm(float o2Level) {
-  String payload = String("{\"type\":\"WARNING\",\"sensor\":\"O2\",\"value\":") 
-                   + String(o2Level, 2) + ",\"threshold\":" 
-                   + String(WARNING_O2_THRESHOLD, 2) + ",\"nodeId\":" 
-                   + mesh.getNodeId() + "}";
-  
-  if (offlineMode) {
-    uint32_t msgId = mesh.queueMessage(
-      payload,
-      "mqtt://cloud.farm.com/alarms/warning",
-      PRIORITY_HIGH
-    );
-    
-    if (msgId) {
-      Serial.printf("⚠️  WARNING O2: %.2f mg/L - QUEUED #%u\n", o2Level, msgId);
-    } else {
-      Serial.printf("⚠️  WARNING O2: %.2f mg/L - QUEUE FULL\n", o2Level);
-    }
-  } else {
-    Serial.printf("⚠️  WARNING O2: %.2f mg/L - SENT\n", o2Level);
-  }
-}
-
-// Send normal telemetry
-void sendNormalTelemetry(float o2Level) {
-  String payload = String("{\"sensor\":\"O2\",\"value\":") + String(o2Level, 2) 
-                   + ",\"nodeId\":" + mesh.getNodeId() + "}";
-  
-  if (offlineMode) {
-    // Low priority - queue only if space available
-    uint32_t msgId = mesh.queueMessage(
-      payload,
-      "mqtt://cloud.farm.com/telemetry",
-      PRIORITY_LOW
-    );
-    
-    if (msgId) {
-      Serial.printf("📊 Telemetry: %.2f mg/L - queued #%u\n", o2Level, msgId);
-    } else {
-      Serial.printf("📊 Telemetry: %.2f mg/L - dropped (queue full)\n", o2Level);
-    }
-  } else {
-    Serial.printf("📊 Telemetry: %.2f mg/L\n", o2Level);
-  }
-}
-
-// Check O2 sensor and send appropriate message
-void checkO2Sensor() {
-  float o2Level = readDissolvedOxygenSensor();
-  
-  if (o2Level < CRITICAL_O2_THRESHOLD) {
-    sendCriticalAlarm(o2Level);
-  } else if (o2Level < WARNING_O2_THRESHOLD) {
-    sendWarningAlarm(o2Level);
-  } else {
-    sendNormalTelemetry(o2Level);
-  }
-}
-
-// Bridge status callback - Internet connectivity changed
-void bridgeStatusCallback(uint32_t bridgeNodeId, bool hasInternet) {
-  if (!hasInternet) {
-    offlineMode = true;
-    Serial.println("\n⚠️  OFFLINE MODE ACTIVATED");
-    Serial.printf("  Bridge node %u lost Internet\n", bridgeNodeId);
-    Serial.printf("  Queue size: %u messages\n", mesh.getQueuedMessageCount());
-    
-    uint32_t critical = mesh.getQueuedMessageCount(PRIORITY_CRITICAL);
-    if (critical > 0) {
-      Serial.printf("  ⚠️  %u CRITICAL messages queued!\n", critical);
-    }
-  } else {
-    offlineMode = false;
-    Serial.println("\n✅ ONLINE MODE - Internet restored");
-    Serial.printf("  Bridge node %u has Internet\n", bridgeNodeId);
-    
-    // Flush queued messages
-    uint32_t queuedCount = mesh.getQueuedMessageCount();
-    if (queuedCount > 0) {
-      Serial.printf("  Flushing %u queued messages...\n", queuedCount);
-      
-      auto messages = mesh.flushMessageQueue();
-      for (auto& msg : messages) {
-        // In real application, send via MQTT or HTTP
-        Serial.printf("  Sending queued message #%u (priority=%d, attempts=%u)\n",
-                     msg.id, msg.priority, msg.attempts);
-        
-        // Simulate sending (in real app, check if send succeeded)
-        bool sent = true;  // Replace with: mqttClient.publish(...)
-        
-        if (sent) {
-          mesh.removeQueuedMessage(msg.id);
-        } else {
-          // Increment attempt counter
-          mesh.incrementQueuedMessageAttempts(msg.id);
-          
-          // Remove if too many attempts
-          if (msg.attempts >= 3) {
-            Serial.printf("  ❌ Message #%u failed after 3 attempts, removing\n", msg.id);
-            mesh.removeQueuedMessage(msg.id);
-          }
-        }
-      }
-      
-      Serial.printf("  ✅ Queue flushed (%u messages sent)\n", queuedCount);
-    }
-  }
-}
-
-// Queue state callback - Monitor queue health
-void queueStateCallback(QueueState state, uint32_t messageCount) {
-  switch (state) {
-    case QUEUE_EMPTY:
-      Serial.println("ℹ️  Queue empty");
-      break;
-    case QUEUE_NORMAL:
-      Serial.printf("ℹ️  Queue normal (%u messages)\n", messageCount);
-      break;
-    case QUEUE_75_PERCENT:
-      Serial.printf("⚠️  Queue 75%% full (%u messages)\n", messageCount);
-      break;
-    case QUEUE_FULL:
-      Serial.printf("🚨 Queue FULL (%u messages) - dropping LOW priority\n", messageCount);
-      break;
-  }
-}
-
-void setup() {
-  Serial.begin(115200);
-  Serial.println("\n\n=== Fish Farm O2 Monitoring with Message Queue ===\n");
-  
-  // Initialize mesh
-  mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  
-  // For bridge node: set router credentials
-  // Uncomment if this is the bridge node
-  // mesh.stationManual(ROUTER_SSID, ROUTER_PASSWORD);
-  // mesh.setHostname("FishFarmBridge");
-  
-  // Enable message queue
-  mesh.enableMessageQueue(true, MAX_QUEUE_SIZE);
-  Serial.printf("Message queue enabled (capacity: %u)\n", MAX_QUEUE_SIZE);
-  
-  // Set callbacks
-  mesh.onBridgeStatusChanged(&bridgeStatusCallback);
-  mesh.onQueueStateChanged(&queueStateCallback);
-  
-  Serial.println("Setup complete. Monitoring O2 levels...\n");
-  
-  // Initialize random for sensor simulation
-  randomSeed(analogRead(0));
-}
-
-void loop() {
-  mesh.update();
-  
-  // Check O2 sensor every 10 seconds
-  if (millis() - lastO2Check > 10000) {
-    lastO2Check = millis();
-    checkO2Sensor();
-    
-    // Print queue status
-    uint32_t queueSize = mesh.getQueuedMessageCount();
-    if (queueSize > 0) {
-      Serial.printf("  [Queue: %u messages", queueSize);
-      
-      uint32_t critical = mesh.getQueuedMessageCount(PRIORITY_CRITICAL);
-      if (critical > 0) {
-        Serial.printf(" (%u CRITICAL)", critical);
-      }
-      
-      Serial.println("]");
-    }
-  }
-  
-  // Prune old messages every hour
-  if (millis() - lastQueuePrune > 3600000) {
-    lastQueuePrune = millis();
-    uint32_t pruned = mesh.pruneQueue(QUEUE_PRUNE_AGE);
-    if (pruned > 0) {
-      Serial.printf("ℹ️  Pruned %u old messages from queue\n", pruned);
-    }
-  }
-}

package/examples/routing_demo/README.md

@@ -1,172 +0,0 @@
-# Multi-Hop Routing Demo
-
-This example demonstrates the new multi-hop routing capabilities implemented in painlessMesh.
-
-## Features Demonstrated
-
-### 1. Hop Count Calculation (`getHopCount()`)
-- Calculates the actual number of hops to reach any node in the mesh
-- Returns 0 for self, 1 for direct connections, actual count for multi-hop paths
-- Returns -1 if the node is unreachable
-
-### 2. Routing Table (`getRoutingTable()`)
-- Returns a complete routing table mapping each destination to its next hop
-- For direct connections, destination equals next hop
-- For multi-hop paths, shows which neighbor to route through
-
-### 3. Path Discovery (`getPathToNode()`)
-- Finds the complete path from this node to any target node
-- Returns a vector of node IDs representing the shortest path
-- Useful for visualizing mesh topology and debugging connectivity
-
-## How It Works
-
-The implementation uses **Breadth-First Search (BFS)** to:
-- Find shortest paths in the mesh topology
-- Build accurate routing tables
-- Calculate hop counts efficiently
-
-### Algorithm Complexity
-- **Time**: O(V + E) where V = nodes, E = edges
-- **Space**: O(V) for visited set and queue
-- **Suitable for**: ESP8266 (80KB RAM) and ESP32 (320KB RAM)
-
-## Running the Example
-
-### Hardware Requirements
-- 2 or more ESP32 or ESP8266 boards
-- No additional hardware needed
-
-### Software Requirements
-- painlessMesh library (with multi-hop routing support)
-- TaskScheduler library
-- ArduinoJson library
-
-### Setup Instructions
-
-1. Upload this sketch to multiple ESP devices
-2. Each device will automatically join the mesh
-3. Open Serial Monitor (115200 baud) on any device
-4. Observe routing information every 10 seconds
-
-### Expected Output
-
-```
-Routing Demo Started
-Node ID: 123456789
-
-=== Routing Information ===
-Mesh contains 3 nodes (plus this node)
-
-Hop Counts:
-  Node 234567890: 1 hop
-  Node 345678901: 2 hops
-  Node 456789012: 3 hops
-
-Routing Table (Destination -> Next Hop):
-  To 234567890 -> via 234567890 (direct connection)
-  To 345678901 -> via 234567890
-  To 456789012 -> via 234567890
-
-Path to node 456789012:
-  123456789 -> 234567890 -> 345678901 -> 456789012
-  (Total: 3 hops)
-========================
-```
-
-## Use Cases
-
-### Network Diagnostics
-- Monitor mesh topology changes in real-time
-- Identify connectivity issues
-- Measure network depth
-
-### Load Balancing
-- Choose optimal paths for data transmission
-- Distribute traffic across multiple routes
-- Avoid overloading single-hop nodes
-
-### Network Visualization
-- Build visual representations of mesh topology
-- Display on OLED/LCD screens
-- Create web-based network maps
-
-## Performance Considerations
-
-### Memory Usage
-- Routing table size: ~8 bytes per node
-- BFS temporary storage: ~16 bytes per node
-- Example mesh of 50 nodes: ~1.2KB total
-
-### CPU Usage
-- Routing calculation: ~1-5ms for typical meshes
-- Triggered only on topology changes
-- No continuous overhead
-
-## Advanced Usage
-
-### Custom Routing Logic
-
-```cpp
-// Find nodes within N hops
-std::vector<uint32_t> findNodesWithinRange(int maxHops) {
-  std::vector<uint32_t> nearby;
-  auto nodeList = mesh.getNodeList(false);
-  
-  for (auto nodeId : nodeList) {
-    int hops = mesh.getHopCount(nodeId);
-    if (hops > 0 && hops <= maxHops) {
-      nearby.push_back(nodeId);
-    }
-  }
-  
-  return nearby;
-}
-```
-
-### Route Optimization
-
-```cpp
-// Select best route based on hop count
-uint32_t selectBestRoute(std::vector<uint32_t> candidates) {
-  uint32_t best = 0;
-  int minHops = 999;
-  
-  for (auto candidate : candidates) {
-    int hops = mesh.getHopCount(candidate);
-    if (hops > 0 && hops < minHops) {
-      minHops = hops;
-      best = candidate;
-    }
-  }
-  
-  return best;
-}
-```
-
-## Troubleshooting
-
-### "All nodes show 2 hops"
-- Old firmware without multi-hop support
-- Update to latest painlessMesh version
-
-### "Routing table is empty"
-- No other nodes in the mesh
-- Check mesh credentials (SSID/password)
-- Verify mesh is initialized
-
-### "Path discovery returns empty vector"
-- Target node is unreachable or left the mesh
-- Check connectivity with `getHopCount()` first
-
-## Related Examples
-
-- `namedMesh.ino` - Basic mesh setup
-- `diagnosticsExample.ino` - Advanced diagnostics
-- `bridge_failover.ino` - Multi-bridge routing
-
-## References
-
-- [painlessMesh Documentation](https://alteriom.github.io/painlessMesh/)
-- [Multi-Hop Routing Issue #XXX](https://github.com/Alteriom/painlessMesh/issues/XXX)
-- BFS Algorithm: [Wikipedia](https://en.wikipedia.org/wiki/Breadth-first_search)

package/examples/routing_demo/routing_demo.ino

@@ -1,102 +0,0 @@
-/**
- * Multi-Hop Routing Demo
- * 
- * This example demonstrates the new multi-hop routing capabilities of painlessMesh.
- * It shows how to:
- * - Calculate hop count to any node in the mesh
- * - Get the complete routing table
- * - Find the path from this node to any other node
- * 
- * The functions work automatically with any mesh topology - linear chains,
- * star configurations, or complex multi-hop meshes.
- */
-
-#include "painlessMesh.h"
-
-#define MESH_PREFIX     "routingDemo"
-#define MESH_PASSWORD   "meshPassword"
-#define MESH_PORT       5555
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-// Task to periodically display routing information
-Task taskShowRouting(10000, TASK_FOREVER, []() {
-  Serial.println("\n=== Routing Information ===");
-  
-  // Get list of all nodes in the mesh
-  auto nodeList = mesh.getNodeList(false);  // false = don't include self
-  Serial.printf("Mesh contains %d nodes (plus this node)\n", nodeList.size());
-  
-  // Display hop count to each node
-  Serial.println("\nHop Counts:");
-  for (auto nodeId : nodeList) {
-    int hops = mesh.getHopCount(nodeId);
-    Serial.printf("  Node %u: %d hop%s\n", nodeId, hops, hops == 1 ? "" : "s");
-  }
-  
-  // Display complete routing table
-  Serial.println("\nRouting Table (Destination -> Next Hop):");
-  auto routingTable = mesh.getRoutingTable();
-  for (auto& entry : routingTable) {
-    Serial.printf("  To %u -> via %u", entry.first, entry.second);
-    if (entry.first == entry.second) {
-      Serial.print(" (direct connection)");
-    }
-    Serial.println();
-  }
-  
-  // Example: Show path to first node in list
-  if (!nodeList.empty()) {
-    uint32_t targetNode = nodeList.front();
-    auto path = mesh.getPathToNode(targetNode);
-    
-    if (!path.empty()) {
-      Serial.printf("\nPath to node %u:\n  ", targetNode);
-      for (size_t i = 0; i < path.size(); i++) {
-        Serial.printf("%u", path[i]);
-        if (i < path.size() - 1) {
-          Serial.print(" -> ");
-        }
-      }
-      Serial.printf("\n  (Total: %d hop%s)\n", path.size() - 1, 
-                    path.size() - 1 == 1 ? "" : "s");
-    } else {
-      Serial.printf("\nNode %u is unreachable\n", targetNode);
-    }
-  }
-  
-  Serial.println("========================\n");
-});
-
-void setup() {
-  Serial.begin(115200);
-  
-  // Initialize mesh
-  mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  
-  // Setup callbacks
-  mesh.onNewConnection([](uint32_t nodeId) {
-    Serial.printf("\nNew connection: Node %u joined the mesh\n", nodeId);
-  });
-  
-  mesh.onDroppedConnection([](uint32_t nodeId) {
-    Serial.printf("\nConnection dropped: Node %u left the mesh\n", nodeId);
-  });
-  
-  mesh.onChangedConnections([]() {
-    Serial.println("\nMesh topology changed - routing tables updated");
-  });
-  
-  // Add routing display task
-  userScheduler.addTask(taskShowRouting);
-  taskShowRouting.enable();
-  
-  Serial.println("\nRouting Demo Started");
-  Serial.printf("Node ID: %u\n", mesh.getNodeId());
-}
-
-void loop() {
-  mesh.update();
-}