@alteriom/painlessmesh 1.6.1 → 1.7.3

package/examples/basic/basic.ino

@@ -1,66 +1,66 @@
-//************************************************************
-// this is a simple example that uses the painlessMesh library
-//
-// 1. sends a silly message to every node on the mesh at a random time between 1 and 5 seconds
-// 2. prints anything it receives to Serial.print
-//
-//
-//************************************************************
-#include "painlessMesh.h"
-
-#define   MESH_PREFIX     "whateverYouLike"
-#define   MESH_PASSWORD   "somethingSneaky"
-#define   MESH_PORT       5555
-
-Scheduler userScheduler; // to control your personal task
-painlessMesh  mesh;
-
-// User stub
-void sendMessage() ; // Prototype so PlatformIO doesn't complain
-
-Task taskSendMessage( TASK_SECOND * 1 , TASK_FOREVER, &sendMessage );
-
-void sendMessage() {
-  String msg = "Hello from node ";
-  msg += mesh.getNodeId();
-  mesh.sendBroadcast( msg );
-  taskSendMessage.setInterval( random( TASK_SECOND * 1, TASK_SECOND * 5 ));
-}
-
-// Needed for painless library
-void receivedCallback( uint32_t from, String &msg ) {
-  Serial.printf("startHere: Received from %u msg=%s\n", from, msg.c_str());
-}
-
-void newConnectionCallback(uint32_t nodeId) {
-    Serial.printf("--> startHere: New Connection, nodeId = %u\n", nodeId);
-}
-
-void changedConnectionCallback() {
-  Serial.printf("Changed connections\n");
-}
-
-void nodeTimeAdjustedCallback(int32_t offset) {
-    Serial.printf("Adjusted time %u. Offset = %d\n", mesh.getNodeTime(),offset);
-}
-
-void setup() {
-  Serial.begin(115200);
-
-//mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | GENERAL | MSG_TYPES | REMOTE ); // all types on
-  mesh.setDebugMsgTypes( ERROR | STARTUP );  // set before init() so that you can see startup messages
-
-  mesh.init( MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT );
-  mesh.onReceive(&receivedCallback);
-  mesh.onNewConnection(&newConnectionCallback);
-  mesh.onChangedConnections(&changedConnectionCallback);
-  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);
-
-  userScheduler.addTask( taskSendMessage );
-  taskSendMessage.enable();
-}
-
-void loop() {
-  // it will run the user scheduler as well
-  mesh.update();
-}
+//************************************************************
+// this is a simple example that uses the painlessMesh library
+//
+// 1. sends a silly message to every node on the mesh at a random time between 1 and 5 seconds
+// 2. prints anything it receives to Serial.print
+//
+//
+//************************************************************
+#include "painlessMesh.h"
+
+#define   MESH_PREFIX     "whateverYouLike"
+#define   MESH_PASSWORD   "somethingSneaky"
+#define   MESH_PORT       5555
+
+Scheduler userScheduler; // to control your personal task
+painlessMesh  mesh;
+
+// User stub
+void sendMessage() ; // Prototype so PlatformIO doesn't complain
+
+Task taskSendMessage( TASK_SECOND * 1 , TASK_FOREVER, &sendMessage );
+
+void sendMessage() {
+  String msg = "Hello from node ";
+  msg += mesh.getNodeId();
+  mesh.sendBroadcast( msg );
+  taskSendMessage.setInterval( random( TASK_SECOND * 1, TASK_SECOND * 5 ));
+}
+
+// Needed for painless library
+void receivedCallback( uint32_t from, String &msg ) {
+  Serial.printf("startHere: Received from %u msg=%s\n", from, msg.c_str());
+}
+
+void newConnectionCallback(uint32_t nodeId) {
+    Serial.printf("--> startHere: New Connection, nodeId = %u\n", nodeId);
+}
+
+void changedConnectionCallback() {
+  Serial.printf("Changed connections\n");
+}
+
+void nodeTimeAdjustedCallback(int32_t offset) {
+    Serial.printf("Adjusted time %u. Offset = %d\n", mesh.getNodeTime(),offset);
+}
+
+void setup() {
+  Serial.begin(115200);
+
+//mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | GENERAL | MSG_TYPES | REMOTE ); // all types on
+  mesh.setDebugMsgTypes( ERROR | STARTUP );  // set before init() so that you can see startup messages
+
+  mesh.init( MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT );
+  mesh.onReceive(&receivedCallback);
+  mesh.onNewConnection(&newConnectionCallback);
+  mesh.onChangedConnections(&changedConnectionCallback);
+  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);
+
+  userScheduler.addTask( taskSendMessage );
+  taskSendMessage.enable();
+}
+
+void loop() {
+  // it will run the user scheduler as well
+  mesh.update();
+}

package/examples/basic/platformio.ini

@@ -1,25 +1,25 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP
+[platformio]
+src_dir = .
+
+[env]
+lib_deps =
+    bblanchon/ArduinoJson
+    arkhipenko/TaskScheduler
+
+[env:esp8266]
+platform = espressif8266
+board = nodemcuv2
+framework = arduino
+lib_extra_dirs = ../../
+lib_deps =
+    ${env.lib_deps}  ; Inherit common dependencies
+    esp32async/ESPAsyncTCP  ; 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/bridge/bridge.ino

@@ -1,51 +1,51 @@
-//************************************************************
-// this is a simple example that uses the painlessMesh library to
-// connect to a node on another network. Please see the WIKI on gitlab
-// for more details
-// https://gitlab.com/painlessMesh/painlessMesh/wikis/bridge-between-mesh-and-another-network
-//************************************************************
-#include "painlessMesh.h"
-
-#define MESH_PREFIX "whateverYouLike"
-#define MESH_PASSWORD "somethingSneaky"
-#define MESH_PORT 5555
-
-#define STATION_SSID "MSYSSID"
-#define STATION_PASSWORD "SSIDPASSWORD"
-#define STATION_PORT 5555
-uint8_t station_ip[4] = {192, 168, 1, 3};  // IP of the server
-
-// 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
-
-  // Channel set to 6. Make sure to use the same channel for your mesh and for
-  // you other network (STATION_SSID)
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, MESH_PORT, WIFI_AP_STA, 1);
-  // Setup over the air update support
-  mesh.initOTAReceive("bridge");
-
-  mesh.stationManual(STATION_SSID, STATION_PASSWORD, STATION_PORT, station_ip);
-  // Bridge node, should (in most cases) be a root node. See [the
-  // wiki](https://gitlab.com/painlessMesh/painlessMesh/wikis/Possible-challenges-in-mesh-formation)
-  // for some background
-  mesh.setRoot(true);
-  // This node and all other nodes should ideally know the mesh contains a root,
-  // so call this on all nodes
-  mesh.setContainsRoot(true);
-
-  mesh.onReceive(&receivedCallback);
-}
-
-void loop() { mesh.update(); }
-
-void receivedCallback(uint32_t from, String &msg) {
-  Serial.printf("bridge: Received from %u msg=%s\n", from, msg.c_str());
-}
+//************************************************************
+// this is a simple example that uses the painlessMesh library to
+// connect to a node on another network. Please see the WIKI on gitlab
+// for more details
+// https://gitlab.com/painlessMesh/painlessMesh/wikis/bridge-between-mesh-and-another-network
+//************************************************************
+#include "painlessMesh.h"
+
+#define MESH_PREFIX "whateverYouLike"
+#define MESH_PASSWORD "somethingSneaky"
+#define MESH_PORT 5555
+
+#define STATION_SSID "MSYSSID"
+#define STATION_PASSWORD "SSIDPASSWORD"
+#define STATION_PORT 5555
+uint8_t station_ip[4] = {192, 168, 1, 3};  // IP of the server
+
+// 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
+
+  // Channel set to 6. Make sure to use the same channel for your mesh and for
+  // you other network (STATION_SSID)
+  mesh.init(MESH_PREFIX, MESH_PASSWORD, MESH_PORT, WIFI_AP_STA, 1);
+  // Setup over the air update support
+  mesh.initOTAReceive("bridge");
+
+  mesh.stationManual(STATION_SSID, STATION_PASSWORD, STATION_PORT, station_ip);
+  // Bridge node, should (in most cases) be a root node. See [the
+  // wiki](https://gitlab.com/painlessMesh/painlessMesh/wikis/Possible-challenges-in-mesh-formation)
+  // for some background
+  mesh.setRoot(true);
+  // This node and all other nodes should ideally know the mesh contains a root,
+  // so call this on all nodes
+  mesh.setContainsRoot(true);
+
+  mesh.onReceive(&receivedCallback);
+}
+
+void loop() { mesh.update(); }
+
+void receivedCallback(uint32_t from, String &msg) {
+  Serial.printf("bridge: Received from %u msg=%s\n", from, msg.c_str());
+}

package/examples/bridge/mesh_event_publisher.hpp

@@ -0,0 +1,253 @@
+#ifndef MESH_EVENT_PUBLISHER_HPP
+#define MESH_EVENT_PUBLISHER_HPP
+
+#include "painlessMesh.h"
+#include <PubSubClient.h>
+#include <ArduinoJson.h>
+
+/**
+ * MeshEventPublisher - Publish real-time mesh events
+ * 
+ * Publishes mesh state change events conforming to @alteriom/mqtt-schema v0.5.0
+ * mesh_event.schema.json specification.
+ * 
+ * Event Types:
+ * - node_join: New node entered mesh
+ * - node_leave: Node left mesh (clean disconnect)
+ * - connection_lost: Direct connection failed
+ * - connection_restored: Connection recovered
+ * 
+ * @author Alteriom Development Team
+ * @date October 12, 2025
+ */
+class MeshEventPublisher {
+private:
+  painlessMesh& mesh;
+  PubSubClient& mqttClient;
+  String meshId;
+  String eventTopic;
+  String firmwareVersion;
+  
+public:
+  MeshEventPublisher(painlessMesh& mesh, PubSubClient& mqttClient, 
+                     const String& meshId, const String& topic = "alteriom/mesh/events",
+                     const String& fwVersion = "GW 2.3.4")
+    : mesh(mesh), mqttClient(mqttClient), meshId(meshId), 
+      eventTopic(topic), firmwareVersion(fwVersion) {}
+  
+  /**
+   * Publish node join event
+   * Called when a new node connects to the mesh
+   */
+  void publishNodeJoin(uint32_t nodeId) {
+    DynamicJsonDocument doc(1024);
+    
+    // Envelope
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    // Event
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "node_join";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    affected.add(generateDeviceId(nodeId));
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["total_nodes"] = mesh.getNodeList().size() + 1;
+    details["timestamp"] = getISO8601Timestamp();
+    
+    publishEvent(doc, "Node Join");
+  }
+  
+  /**
+   * Publish node leave event
+   * Called when a node disconnects from the mesh
+   */
+  void publishNodeLeave(uint32_t nodeId) {
+    DynamicJsonDocument doc(1024);
+    
+    // Envelope
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    // Event
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "node_leave";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    affected.add(generateDeviceId(nodeId));
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["reason"] = "connection_lost";
+    details["last_seen"] = getISO8601Timestamp();
+    details["total_nodes"] = mesh.getNodeList().size() + 1;
+    
+    publishEvent(doc, "Node Leave");
+  }
+  
+  /**
+   * Publish connection lost event
+   * Called when a direct connection fails
+   */
+  void publishConnectionLost(uint32_t nodeId) {
+    DynamicJsonDocument doc(1024);
+    
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "connection_lost";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    affected.add(generateDeviceId(nodeId));
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["reason"] = "timeout";
+    details["timestamp"] = getISO8601Timestamp();
+    
+    publishEvent(doc, "Connection Lost");
+  }
+  
+  /**
+   * Publish connection restored event
+   * Called when a connection is re-established
+   */
+  void publishConnectionRestored(uint32_t nodeId) {
+    DynamicJsonDocument doc(1024);
+    
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "connection_restored";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    affected.add(generateDeviceId(nodeId));
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["timestamp"] = getISO8601Timestamp();
+    
+    publishEvent(doc, "Connection Restored");
+  }
+  
+  /**
+   * Publish network split event
+   * Called when mesh partitions into separate segments
+   */
+  void publishNetworkSplit() {
+    DynamicJsonDocument doc(1024);
+    
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "network_split";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    // TODO: Detect which nodes are in different partitions
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["timestamp"] = getISO8601Timestamp();
+    details["partition_count"] = 2;  // TODO: Calculate actual partitions
+    
+    publishEvent(doc, "Network Split");
+  }
+  
+  /**
+   * Publish network merged event
+   * Called when mesh partitions rejoin
+   */
+  void publishNetworkMerged() {
+    DynamicJsonDocument doc(1024);
+    
+    doc["schema_version"] = 1;
+    doc["device_id"] = generateDeviceId(mesh.getNodeId());
+    doc["device_type"] = "gateway";
+    doc["timestamp"] = getISO8601Timestamp();
+    doc["firmware_version"] = firmwareVersion;
+    
+    doc["event"] = "mesh_event";
+    doc["event_type"] = "network_merged";
+    doc["mesh_id"] = meshId;
+    
+    JsonArray affected = doc.createNestedArray("affected_nodes");
+    // TODO: List nodes that rejoined
+    
+    JsonObject details = doc.createNestedObject("details");
+    details["timestamp"] = getISO8601Timestamp();
+    
+    publishEvent(doc, "Network Merged");
+  }
+  
+private:
+  /**
+   * Internal method to publish event to MQTT
+   */
+  void publishEvent(const DynamicJsonDocument& doc, const char* eventName) {
+    if (!mqttClient.connected()) {
+      Serial.printf("[Event] ⚠️ MQTT not connected, cannot publish %s\n", eventName);
+      return;
+    }
+    
+    String payload;
+    serializeJson(doc, payload);
+    
+    bool success = mqttClient.publish(eventTopic.c_str(), payload.c_str());
+    
+    if (success) {
+      Serial.printf("[Event] ✅ Published: %s (node: %s)\n", 
+                    eventName,
+                    doc["affected_nodes"][0].as<const char*>());
+    } else {
+      Serial.printf("[Event] ❌ Failed to publish: %s\n", eventName);
+    }
+  }
+  
+  /**
+   * Generate device ID in Alteriom format (ALT-XXXXXXXXXXXX)
+   */
+  String generateDeviceId(uint32_t nodeId) {
+    char deviceId[20];
+    snprintf(deviceId, sizeof(deviceId), "ALT-%012X", nodeId);
+    return String(deviceId);
+  }
+  
+  /**
+   * Get current timestamp in ISO 8601 format
+   * TODO: Use proper NTP time if available
+   */
+  String getISO8601Timestamp() {
+    // For now, use epoch-based timestamp
+    // In production, this should use actual NTP-synced time
+    unsigned long ms = millis();
+    char timestamp[32];
+    snprintf(timestamp, sizeof(timestamp), "2025-10-12T%02lu:%02lu:%02luZ",
+             (ms / 3600000) % 24,
+             (ms / 60000) % 60,
+             (ms / 1000) % 60);
+    return String(timestamp);
+  }
+};
+
+#endif  // MESH_EVENT_PUBLISHER_HPP