@alteriom/painlessmesh 1.8.14 → 1.9.0

package/examples/bridgeAwareSensorNode/bridgeAwareSensorNode.ino

@@ -1,342 +0,0 @@
-//************************************************************
-// Bridge-Aware Sensor Node Example
-//
-// This example demonstrates how to use the bridge status
-// callback feature to implement intelligent message queueing.
-//
-// Features:
-// - Monitors bridge Internet connectivity status
-// - Queues critical messages when Internet is unavailable
-// - Automatically sends queued messages when Internet returns
-// - Implements failover logic for multiple bridges
-//
-// Use case: Fish farm monitoring system that needs to ensure
-// critical alarms are delivered even during Internet outages
-//************************************************************
-
-#include "painlessTaskOptions.h"  // Must be first to configure TaskScheduler
-#include <TaskScheduler.h>  // Required for LDF to find TaskScheduler dependency
-#include "alteriom_sensor_package.hpp"
-#include "painlessMesh.h"
-
-#define MESH_PREFIX "AlteriomMesh"
-#define MESH_PASSWORD "somethingSneaky"
-#define MESH_PORT 5555
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-// Alteriom package handlers
-using namespace alteriom;
-
-// Message queue for offline mode
-struct QueuedMessage {
-  uint32_t timestamp;
-  bool isCritical;
-  SensorPackage data;
-};
-
-std::vector<QueuedMessage> messageQueue;
-const size_t MAX_QUEUE_SIZE = 100;  // Prevent memory overflow
-
-// Bridge connectivity tracking
-bool internetAvailable = false;
-uint32_t primaryBridgeId = 0;
-
-// Simulation variables
-float currentTemperature = 25.0;
-float currentOxygenLevel = 7.5;  // mg/L - critical threshold is 5.0
-
-// Function prototypes
-void sendSensorData();
-void handleIncomingPackage(uint32_t from, String& msg);
-void bridgeStatusCallback(uint32_t bridgeNodeId, bool hasInternet);
-void checkCriticalConditions();
-void flushMessageQueue();
-void queueMessage(const SensorPackage& data, bool isCritical);
-
-Task taskSendSensorData(30000, TASK_FOREVER, &sendSensorData);
-Task taskCheckCritical(5000, TASK_FOREVER, &checkCriticalConditions);
-
-void setup() {
-  Serial.begin(115200);
-
-  // Initialize mesh
-  mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  
-  // Setup callbacks
-  mesh.onReceive(&handleIncomingPackage);
-  mesh.onBridgeStatusChanged(&bridgeStatusCallback);
-  
-  mesh.onNewConnection([](uint32_t nodeId) {
-    Serial.printf("✓ New connection: %u\n", nodeId);
-  });
-  
-  mesh.onChangedConnections([]() {
-    Serial.println("ℹ Mesh connections changed");
-    
-    // Check if we have a primary bridge
-    auto primaryBridge = mesh.getPrimaryBridge();
-    if (primaryBridge) {
-      Serial.printf("  Primary bridge: %u (RSSI: %d dBm, Internet: %s)\n",
-                    primaryBridge->nodeId,
-                    primaryBridge->routerRSSI,
-                    primaryBridge->internetConnected ? "Yes" : "No");
-    } else {
-      Serial.println("  ⚠ No healthy bridges available");
-    }
-  });
-
-  // Add tasks
-  userScheduler.addTask(taskSendSensorData);
-  taskSendSensorData.enable();
-
-  userScheduler.addTask(taskCheckCritical);
-  taskCheckCritical.enable();
-
-  Serial.println("═══════════════════════════════════════════");
-  Serial.println("  Bridge-Aware Sensor Node");
-  Serial.println("  Fish Farm Monitoring System");
-  Serial.println("═══════════════════════════════════════════");
-  Serial.printf("  Node ID: %u\n", mesh.getNodeId());
-  Serial.println("  Monitoring: Temperature, Dissolved Oxygen");
-  Serial.println("  Critical O₂ threshold: 5.0 mg/L");
-  Serial.println("═══════════════════════════════════════════\n");
-}
-
-void loop() { 
-  mesh.update();
-  
-  // Simulate sensor drift
-  static uint32_t lastSimUpdate = 0;
-  if (millis() - lastSimUpdate > 10000) {
-    // Randomly vary oxygen level (can go critical)
-    currentOxygenLevel += random(-20, 15) / 10.0;
-    currentOxygenLevel = constrain(currentOxygenLevel, 3.0, 9.0);
-    
-    currentTemperature += random(-10, 10) / 10.0;
-    currentTemperature = constrain(currentTemperature, 20.0, 30.0);
-    
-    lastSimUpdate = millis();
-  }
-}
-
-void sendSensorData() {
-  // Create sensor package
-  SensorPackage sensorData;
-  sensorData.from = mesh.getNodeId();
-  sensorData.sensorId = mesh.getNodeId();
-  sensorData.timestamp = mesh.getNodeTime();
-  sensorData.temperature = currentTemperature;
-  sensorData.humidity = 65.0 + random(-50, 50) / 10.0;  // Not critical for fish farm
-  sensorData.pressure = currentOxygenLevel;  // Abuse pressure field for O₂ level
-  sensorData.batteryLevel = 85 + random(-10, 5);
-
-  // Determine if this is critical data (low oxygen)
-  bool isCritical = (currentOxygenLevel < 5.5);  // Early warning threshold
-
-  if (internetAvailable) {
-    // Internet available - send immediately
-    JsonDocument doc;
-    JsonObject obj = doc.to<JsonObject>();
-    sensorData.addTo(std::move(obj));
-
-    String msg;
-    serializeJson(doc, msg);
-    mesh.sendBroadcast(msg);
-
-    Serial.printf("📤 Sent: T=%.1f°C, O₂=%.1f mg/L, Bat=%d%% %s\n",
-                  sensorData.temperature,
-                  currentOxygenLevel,
-                  sensorData.batteryLevel,
-                  isCritical ? "⚠ CRITICAL" : "");
-  } else {
-    // Internet offline - queue message
-    queueMessage(sensorData, isCritical);
-    
-    Serial.printf("💾 Queued: T=%.1f°C, O₂=%.1f mg/L %s [Queue: %d/%d]\n",
-                  sensorData.temperature,
-                  currentOxygenLevel,
-                  isCritical ? "⚠ CRITICAL" : "",
-                  messageQueue.size(),
-                  MAX_QUEUE_SIZE);
-  }
-}
-
-void checkCriticalConditions() {
-  // Check for critical low oxygen
-  if (currentOxygenLevel < 5.0) {
-    Serial.printf("🚨 CRITICAL ALARM: Low Oxygen = %.1f mg/L!\n", currentOxygenLevel);
-    
-    // Create critical alarm package
-    SensorPackage alarm;
-    alarm.from = mesh.getNodeId();
-    alarm.sensorId = mesh.getNodeId();
-    alarm.timestamp = mesh.getNodeTime();
-    alarm.temperature = currentTemperature;
-    alarm.pressure = currentOxygenLevel;
-    alarm.batteryLevel = 85;
-
-    if (internetAvailable) {
-      // Send immediately
-      JsonDocument doc;
-      JsonObject obj = doc.to<JsonObject>();
-      alarm.addTo(std::move(obj));
-
-      String msg;
-      serializeJson(doc, msg);
-      mesh.sendBroadcast(msg);
-      Serial.println("  ↪ Critical alarm sent immediately");
-    } else {
-      // Queue with high priority
-      queueMessage(alarm, true);
-      Serial.printf("  ↪ Critical alarm queued [Queue: %d/%d]\n",
-                    messageQueue.size(), MAX_QUEUE_SIZE);
-    }
-  }
-}
-
-void queueMessage(const SensorPackage& data, bool isCritical) {
-  if (messageQueue.size() >= MAX_QUEUE_SIZE) {
-    Serial.println("⚠ Queue full - dropping oldest message");
-    messageQueue.erase(messageQueue.begin());
-  }
-
-  QueuedMessage qMsg;
-  qMsg.timestamp = millis();
-  qMsg.isCritical = isCritical;
-  qMsg.data = data;
-  
-  messageQueue.push_back(qMsg);
-}
-
-void flushMessageQueue() {
-  if (messageQueue.empty()) {
-    return;
-  }
-
-  Serial.printf("\n📤 Flushing message queue (%d messages)...\n", messageQueue.size());
-  
-  size_t sentCount = 0;
-  size_t criticalCount = 0;
-  
-  for (const auto& qMsg : messageQueue) {
-    JsonDocument doc;
-    JsonObject obj = doc.to<JsonObject>();
-    qMsg.data.addTo(std::move(obj));
-
-    String msg;
-    serializeJson(doc, msg);
-    mesh.sendBroadcast(msg);
-    
-    sentCount++;
-    if (qMsg.isCritical) criticalCount++;
-    
-    delay(100);  // Small delay to avoid flooding
-  }
-  
-  messageQueue.clear();
-  
-  Serial.printf("✓ Queue flushed: %d messages (%d critical)\n\n",
-                sentCount, criticalCount);
-}
-
-void bridgeStatusCallback(uint32_t bridgeNodeId, bool hasInternet) {
-  bool wasAvailable = internetAvailable;
-  internetAvailable = hasInternet;
-  primaryBridgeId = bridgeNodeId;
-  
-  Serial.println("\n════════════════════════════════════════════");
-  if (hasInternet) {
-    Serial.printf("✓ Bridge %u: Internet CONNECTED\n", bridgeNodeId);
-    
-    // Get bridge details
-    auto bridges = mesh.getBridges();
-    for (const auto& bridge : bridges) {
-      if (bridge.nodeId == bridgeNodeId) {
-        Serial.printf("  Router: %s (RSSI: %d dBm, Ch: %d)\n",
-                      bridge.gatewayIP.c_str(),
-                      bridge.routerRSSI,
-                      bridge.routerChannel);
-        Serial.printf("  Bridge uptime: %u seconds\n", bridge.uptime / 1000);
-      }
-    }
-    
-    // If Internet was restored, flush queued messages
-    if (!wasAvailable) {
-      Serial.println("  → Internet restored - processing queue");
-      flushMessageQueue();
-    }
-  } else {
-    Serial.printf("⚠ Bridge %u: Internet OFFLINE\n", bridgeNodeId);
-    Serial.println("  → Entering offline mode");
-    Serial.println("  → Critical alarms will be queued");
-  }
-  Serial.println("════════════════════════════════════════════\n");
-  
-  // Show overall mesh status
-  if (mesh.hasInternetConnection()) {
-    Serial.println("✓ Mesh has Internet connectivity");
-  } else {
-    Serial.println("⚠ No Internet connectivity in mesh");
-  }
-  
-  // Show all known bridges
-  auto bridges = mesh.getBridges();
-  if (!bridges.empty()) {
-    Serial.printf("Known bridges: %d\n", bridges.size());
-    for (const auto& bridge : bridges) {
-      Serial.printf("  - Bridge %u: %s (RSSI: %d dBm)\n",
-                    bridge.nodeId,
-                    bridge.internetConnected ? "Online" : "Offline",
-                    bridge.routerRSSI);
-    }
-  }
-  Serial.println();
-}
-
-void handleIncomingPackage(uint32_t from, String& msg) {
-  // Parse the JSON message
-  JsonDocument doc;
-  deserializeJson(doc, msg);
-  JsonObject obj = doc.as<JsonObject>();
-
-  // Check message type
-  uint8_t msgType = obj["type"];
-
-  switch (msgType) {
-    case 200:  // SensorPackage
-    {
-      SensorPackage receivedSensor(obj);
-      Serial.printf("📥 Sensor from %u: T=%.1f°C, O₂=%.1f mg/L\n",
-                    receivedSensor.from,
-                    receivedSensor.temperature,
-                    receivedSensor.pressure);  // Using pressure for O₂
-    } break;
-
-    case 400:  // CommandPackage
-    {
-      CommandPackage receivedCmd(obj);
-      if (receivedCmd.dest == mesh.getNodeId()) {
-        Serial.printf("📥 Command %d received\n", receivedCmd.command);
-        
-        // Handle commands (e.g., request status, change thresholds)
-        if (receivedCmd.command == 3) {
-          // Data request - send immediately even if offline
-          sendSensorData();
-        }
-      }
-    } break;
-
-    case 610:  // BridgeStatusPackage
-      // Handled automatically by mesh's internal callback
-      // But we can log that we received it
-      Serial.printf("📡 Bridge status update from %u\n", from);
-      break;
-
-    default:
-      // Unknown message type
-      break;
-  }
-}

package/examples/bridgeAwareSensorNode/platformio.ini

@@ -1,26 +0,0 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_ldf_mode = deep+
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP@^2.0.0  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP

package/examples/diagnosticsExample/diagnosticsExample.ino

@@ -1,171 +0,0 @@
-/**
- * painlessMesh Diagnostics API Example
- * 
- * This example demonstrates the enhanced diagnostics API for bridge operations.
- * It shows how to:
- * - Enable diagnostics tracking
- * - Get bridge status information
- * - Monitor election history
- * - Test bridge connectivity
- * - Generate diagnostic reports
- * - Export topology for visualization
- * 
- * Hardware: ESP32 or ESP8266
- * 
- * Usage:
- * 1. Upload to multiple devices
- * 2. Configure one device as a bridge (see bridgeExample)
- * 3. Regular nodes will use this diagnostics API to monitor mesh health
- * 4. Open Serial Monitor to see diagnostic information
- */
-
-#include "painlessMesh.h"
-
-#define   MESH_PREFIX     "DiagnosticsMesh"
-#define   MESH_PASSWORD   "diagnostic123"
-#define   MESH_PORT       5555
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-// Task to periodically print diagnostics
-Task taskPrintDiagnostics(30000, TASK_FOREVER, []() {
-  Serial.println("\n" + mesh.getDiagnosticReport());
-});
-
-// Task to test bridge connectivity
-Task taskTestBridge(60000, TASK_FOREVER, []() {
-  Serial.println("\n=== Testing Bridge Connectivity ===");
-  auto result = mesh.testBridgeConnectivity();
-  
-  if (result.success) {
-    Serial.printf("✓ Bridge test PASSED: %s\n", result.message.c_str());
-    Serial.printf("  Latency: %u ms\n", result.latencyMs);
-    Serial.printf("  Internet available: %s\n", result.internetReachable ? "Yes" : "No");
-  } else {
-    Serial.printf("✗ Bridge test FAILED: %s\n", result.message.c_str());
-  }
-});
-
-// Task to monitor bridge status
-Task taskMonitorBridge(15000, TASK_FOREVER, []() {
-  auto status = mesh.getBridgeStatus();
-  
-  Serial.println("\n=== Bridge Status ===");
-  Serial.printf("Node ID: %u\n", mesh.getNodeId());
-  Serial.printf("Role: %s\n", status.role.c_str());
-  Serial.printf("Is Bridge: %s\n", status.isBridge ? "Yes" : "No");
-  Serial.printf("Internet Connected: %s\n", status.internetConnected ? "Yes" : "No");
-  
-  if (status.bridgeNodeId != 0) {
-    Serial.printf("Bridge Node: %u (RSSI: %d dBm)\n", 
-                  status.bridgeNodeId, status.bridgeRSSI);
-    Serial.printf("Time since bridge change: %u seconds\n", 
-                  status.timeSinceBridgeChange / 1000);
-  } else {
-    Serial.println("No bridge available");
-  }
-});
-
-// Task to show election history
-Task taskShowElections(120000, TASK_FOREVER, []() {
-  auto history = mesh.getElectionHistory();
-  
-  if (history.size() > 0) {
-    Serial.println("\n=== Election History ===");
-    for (const auto& election : history) {
-      Serial.printf("Winner: %u (RSSI: %d dBm, %u candidates) - %s\n",
-                    election.winnerNodeId, election.winnerRSSI,
-                    election.candidateCount, election.reason.c_str());
-    }
-  }
-});
-
-// Task to export topology for visualization
-Task taskExportTopology(300000, TASK_FOREVER, []() {
-  Serial.println("\n=== Mesh Topology (GraphViz DOT format) ===");
-  Serial.println(mesh.exportTopologyDOT());
-  Serial.println("Copy above to http://www.webgraphviz.com/ to visualize");
-});
-
-void receivedCallback(uint32_t from, String &msg) {
-  Serial.printf("Received from %u: %s\n", from, msg.c_str());
-}
-
-void newConnectionCallback(uint32_t nodeId) {
-  Serial.printf("New Connection: %u\n", nodeId);
-  
-  // Get last bridge change when new node connects
-  auto event = mesh.getLastBridgeChange();
-  if (event.timestamp > 0) {
-    Serial.printf("Last bridge change: %u -> %u (%s)\n",
-                  event.oldBridgeId, event.newBridgeId, event.reason.c_str());
-  }
-}
-
-void changedConnectionCallback() {
-  Serial.println("Connections changed");
-  Serial.printf("Mesh nodes: %d\n", mesh.getNodeList().size());
-  
-  // Show Internet path for this node
-  auto path = mesh.getInternetPath(mesh.getNodeId());
-  if (path.size() > 0) {
-    Serial.print("Path to Internet: ");
-    for (auto nodeId : path) {
-      Serial.printf("%u -> ", nodeId);
-    }
-    Serial.println("Internet");
-  }
-}
-
-void bridgeStatusChangedCallback(uint32_t bridgeNodeId, bool hasInternet) {
-  Serial.printf("\n!!! Bridge Status Changed !!!\n");
-  Serial.printf("Bridge %u Internet: %s\n", 
-                bridgeNodeId, hasInternet ? "Connected" : "Disconnected");
-  
-  // Run immediate connectivity test
-  auto result = mesh.testBridgeConnectivity();
-  Serial.printf("Connectivity test: %s\n", result.message.c_str());
-}
-
-void setup() {
-  Serial.begin(115200);
-  
-  Serial.println("\n\n=== painlessMesh Diagnostics Example ===");
-  Serial.println("Initializing mesh network...");
-  
-  // Initialize mesh
-  mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  
-  // Enable diagnostics tracking
-  Serial.println("Enabling diagnostics...");
-  mesh.enableDiagnostics(true);
-  
-  // Setup callbacks
-  mesh.onReceive(&receivedCallback);
-  mesh.onNewConnection(&newConnectionCallback);
-  mesh.onChangedConnections(&changedConnectionCallback);
-  mesh.onBridgeStatusChanged(&bridgeStatusChangedCallback);
-  
-  // Add diagnostic tasks
-  userScheduler.addTask(taskPrintDiagnostics);
-  userScheduler.addTask(taskTestBridge);
-  userScheduler.addTask(taskMonitorBridge);
-  userScheduler.addTask(taskShowElections);
-  userScheduler.addTask(taskExportTopology);
-  
-  // Enable tasks
-  taskPrintDiagnostics.enable();
-  taskTestBridge.enable();
-  taskMonitorBridge.enable();
-  taskShowElections.enable();
-  taskExportTopology.enable();
-  
-  Serial.println("Setup complete!");
-  Serial.printf("Node ID: %u\n", mesh.getNodeId());
-}
-
-void loop() {
-  mesh.update();
-}

package/examples/diagnosticsExample/platformio.ini

@@ -1,26 +0,0 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-lib_ldf_mode = deep+
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP@^2.0.0  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP

package/examples/echoNode/echoNode.ino

@@ -1,33 +0,0 @@
-//************************************************************
-// this is a simple example that uses the painlessMesh library and echos any
-// messages it receives
-//
-//************************************************************
-#include "painlessMesh.h"
-
-#define   MESH_PREFIX     "whateverYouLike"
-#define   MESH_PASSWORD   "somethingSneaky"
-#define   MESH_PORT       5555
-
-// Prototypes
-void receivedCallback( uint32_t from, String &msg );
-
-painlessMesh  mesh;
-
-void setup() {
-  Serial.begin(115200);
-    
-  mesh.setDebugMsgTypes( ERROR | STARTUP | CONNECTION );  // set before init() so that you can see startup messages
-
-  mesh.init( MESH_PREFIX, MESH_PASSWORD, MESH_PORT );
-  mesh.onReceive(&receivedCallback);
-}
-
-void loop() {
-  mesh.update();
-}
-
-void receivedCallback( uint32_t from, String &msg ) {
-  Serial.printf("echoNode: Received from %u msg=%s\n", from, msg.c_str());
-  mesh.sendSingle(from, msg);
-}

package/examples/echoNode/platformio.ini

@@ -1,26 +0,0 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-lib_ldf_mode = deep+
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP@^2.0.0  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP