@alteriom/painlessmesh 1.6.1 → 1.7.2

package/examples/{alteriom → alteriomSensorNode}/alteriom_sensor_node.ino

@@ -1,184 +1,184 @@
-//************************************************************
-// Alteriom Sensor Node Example
-//
-// This example demonstrates how to create an Alteriom-specific
-// sensor node using custom packages with painlessMesh
-//************************************************************
-
-#include "alteriom_sensor_package.hpp"
-#include "painlessMesh.h"
-
-#define MESH_PREFIX "AlteriomMesh"
-#define MESH_PASSWORD "somethingSneaky"
-#define MESH_PORT 5555
-
-Scheduler userScheduler;  // to control your personal task
-painlessMesh mesh;
-
-// Alteriom package handlers
-using namespace alteriom;
-
-// User stub
-void sendSensorData();
-void handleIncomingPackage(uint32_t from, String& msg);
-void handleCommandPackage(CommandPackage& cmd);
-void handleStatusRequest();
-
-Task taskSendSensorData(30000, TASK_FOREVER, &sendSensorData);
-Task taskSendStatus(60000, TASK_FOREVER, &handleStatusRequest);
-
-void setup() {
-  Serial.begin(115200);
-
-  // Initialize mesh
-  mesh.setDebugMsgTypes(ERROR | MESH_STATUS | CONNECTION | SYNC |
-                        COMMUNICATION | GENERAL | MSG_TYPES | REMOTE);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  mesh.onReceive(&handleIncomingPackage);
-  mesh.onNewConnection(&newConnectionCallback);
-  mesh.onChangedConnections(&changedConnectionCallback);
-  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);
-
-  // Add tasks
-  userScheduler.addTask(taskSendSensorData);
-  taskSendSensorData.enable();
-
-  userScheduler.addTask(taskSendStatus);
-  taskSendStatus.enable();
-
-  // Initialize sensors (placeholder)
-  Serial.println("Alteriom Sensor Node initialized");
-}
-
-void loop() { mesh.update(); }
-
-void sendSensorData() {
-  // Create sensor package
-  SensorPackage sensorData;
-  sensorData.from = mesh.getNodeId();
-  sensorData.sensorId = mesh.getNodeId();  // Use node ID as sensor ID
-  sensorData.timestamp = mesh.getNodeTime();
-
-  // Read sensor values (placeholder - replace with actual sensor readings)
-  sensorData.temperature =
-      23.5 + random(-50, 50) / 10.0;  // Simulate temperature
-  sensorData.humidity = 45.0 + random(-100, 100) / 10.0;   // Simulate humidity
-  sensorData.pressure = 1013.25 + random(-50, 50) / 10.0;  // Simulate pressure
-  sensorData.batteryLevel = 85 + random(-20, 15);          // Simulate battery
-
-  // Serialize and send
-  DynamicJsonDocument doc(sensorData.jsonObjectSize());
-  JsonObject obj = doc.to<JsonObject>();
-  sensorData.addTo(std::move(obj));
-
-  String msg;
-  serializeJson(doc, msg);
-  mesh.sendBroadcast(msg);
-
-  Serial.printf("Sent sensor data: T=%.1f, H=%.1f, P=%.1f, Bat=%d%%\n",
-                sensorData.temperature, sensorData.humidity,
-                sensorData.pressure, sensorData.batteryLevel);
-}
-
-void handleStatusRequest() {
-  StatusPackage status;
-  status.from = mesh.getNodeId();
-  status.deviceStatus = 0x01;  // Device operational
-  status.uptime = millis() / 1000;
-  status.freeMemory = ESP.getFreeHeap() / 1024;  // KB
-  status.wifiStrength = 75;                      // Placeholder
-  status.firmwareVersion = "1.0.0-alteriom";
-
-  // Serialize and send
-  DynamicJsonDocument doc(status.jsonObjectSize());
-  JsonObject obj = doc.to<JsonObject>();
-  status.addTo(std::move(obj));
-
-  String msg;
-  serializeJson(doc, msg);
-  mesh.sendBroadcast(msg);
-
-  Serial.printf("Sent status: uptime=%ds, mem=%dKB\n", status.uptime,
-                status.freeMemory);
-}
-
-void handleIncomingPackage(uint32_t from, String& msg) {
-  Serial.printf("Received from %u: %s\n", from, msg.c_str());
-
-  // Parse the JSON message
-  DynamicJsonDocument doc(1024);
-  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 data from %u: T=%.1f, H=%.1f\n",
-                    receivedSensor.from, receivedSensor.temperature,
-                    receivedSensor.humidity);
-      // Process sensor data (store, forward, analyze, etc.)
-    } break;
-
-    case 201:  // CommandPackage
-    {
-      CommandPackage receivedCmd(obj);
-      if (receivedCmd.dest == mesh.getNodeId()) {
-        handleCommandPackage(receivedCmd);
-      }
-    } break;
-
-    case 202:  // StatusPackage
-    {
-      StatusPackage receivedStatus(obj);
-      Serial.printf("Status from %u: uptime=%ds, mem=%dKB, fw=%s\n",
-                    receivedStatus.from, receivedStatus.uptime,
-                    receivedStatus.freeMemory,
-                    receivedStatus.firmwareVersion.c_str());
-    } break;
-
-    default:
-      Serial.printf("Unknown message type: %d\n", msgType);
-      break;
-  }
-}
-
-void handleCommandPackage(CommandPackage& cmd) {
-  Serial.printf("Received command %d for device %u\n", cmd.command,
-                cmd.targetDevice);
-
-  // Process different command types
-  switch (cmd.command) {
-    case 1:  // Reset command
-      Serial.println("Reset command received");
-      // Implement reset logic
-      break;
-
-    case 2:  // Configuration update
-      Serial.printf("Config update: %s\n", cmd.parameters.c_str());
-      // Parse and apply configuration
-      break;
-
-    case 3:  // Data request
-      Serial.println("Data request received");
-      sendSensorData();  // Send current sensor data
-      break;
-
-    default:
-      Serial.printf("Unknown command: %d\n", cmd.command);
-      break;
-  }
-}
-
-void newConnectionCallback(uint32_t nodeId) {
-  Serial.printf("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);
+//************************************************************
+// Alteriom Sensor Node Example
+//
+// This example demonstrates how to create an Alteriom-specific
+// sensor node using custom packages with painlessMesh
+//************************************************************
+
+#include "alteriom_sensor_package.hpp"
+#include "painlessMesh.h"
+
+#define MESH_PREFIX "AlteriomMesh"
+#define MESH_PASSWORD "somethingSneaky"
+#define MESH_PORT 5555
+
+Scheduler userScheduler;  // to control your personal task
+painlessMesh mesh;
+
+// Alteriom package handlers
+using namespace alteriom;
+
+// User stub
+void sendSensorData();
+void handleIncomingPackage(uint32_t from, String& msg);
+void handleCommandPackage(CommandPackage& cmd);
+void handleStatusRequest();
+
+Task taskSendSensorData(30000, TASK_FOREVER, &sendSensorData);
+Task taskSendStatus(60000, TASK_FOREVER, &handleStatusRequest);
+
+void setup() {
+  Serial.begin(115200);
+
+  // Initialize mesh
+  mesh.setDebugMsgTypes(ERROR | MESH_STATUS | CONNECTION | SYNC |
+                        COMMUNICATION | GENERAL | MSG_TYPES | REMOTE);
+  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
+  mesh.onReceive(&handleIncomingPackage);
+  mesh.onNewConnection(&newConnectionCallback);
+  mesh.onChangedConnections(&changedConnectionCallback);
+  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);
+
+  // Add tasks
+  userScheduler.addTask(taskSendSensorData);
+  taskSendSensorData.enable();
+
+  userScheduler.addTask(taskSendStatus);
+  taskSendStatus.enable();
+
+  // Initialize sensors (placeholder)
+  Serial.println("Alteriom Sensor Node initialized");
+}
+
+void loop() { mesh.update(); }
+
+void sendSensorData() {
+  // Create sensor package
+  SensorPackage sensorData;
+  sensorData.from = mesh.getNodeId();
+  sensorData.sensorId = mesh.getNodeId();  // Use node ID as sensor ID
+  sensorData.timestamp = mesh.getNodeTime();
+
+  // Read sensor values (placeholder - replace with actual sensor readings)
+  sensorData.temperature =
+      23.5 + random(-50, 50) / 10.0;  // Simulate temperature
+  sensorData.humidity = 45.0 + random(-100, 100) / 10.0;   // Simulate humidity
+  sensorData.pressure = 1013.25 + random(-50, 50) / 10.0;  // Simulate pressure
+  sensorData.batteryLevel = 85 + random(-20, 15);          // Simulate battery
+
+  // Serialize and send
+  JsonDocument doc;
+  JsonObject obj = doc.to<JsonObject>();
+  sensorData.addTo(std::move(obj));
+
+  String msg;
+  serializeJson(doc, msg);
+  mesh.sendBroadcast(msg);
+
+  Serial.printf("Sent sensor data: T=%.1f, H=%.1f, P=%.1f, Bat=%d%%\n",
+                sensorData.temperature, sensorData.humidity,
+                sensorData.pressure, sensorData.batteryLevel);
+}
+
+void handleStatusRequest() {
+  StatusPackage status;
+  status.from = mesh.getNodeId();
+  status.deviceStatus = 0x01;  // Device operational
+  status.uptime = millis() / 1000;
+  status.freeMemory = ESP.getFreeHeap() / 1024;  // KB
+  status.wifiStrength = 75;                      // Placeholder
+  status.firmwareVersion = "1.0.0-alteriom";
+
+  // Serialize and send
+  JsonDocument doc;
+  JsonObject obj = doc.to<JsonObject>();
+  status.addTo(std::move(obj));
+
+  String msg;
+  serializeJson(doc, msg);
+  mesh.sendBroadcast(msg);
+
+  Serial.printf("Sent status: uptime=%ds, mem=%dKB\n", status.uptime,
+                status.freeMemory);
+}
+
+void handleIncomingPackage(uint32_t from, String& msg) {
+  Serial.printf("Received from %u: %s\n", from, msg.c_str());
+
+  // 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 data from %u: T=%.1f, H=%.1f\n",
+                    receivedSensor.from, receivedSensor.temperature,
+                    receivedSensor.humidity);
+      // Process sensor data (store, forward, analyze, etc.)
+    } break;
+
+    case 201:  // CommandPackage
+    {
+      CommandPackage receivedCmd(obj);
+      if (receivedCmd.dest == mesh.getNodeId()) {
+        handleCommandPackage(receivedCmd);
+      }
+    } break;
+
+    case 202:  // StatusPackage
+    {
+      StatusPackage receivedStatus(obj);
+      Serial.printf("Status from %u: uptime=%ds, mem=%dKB, fw=%s\n",
+                    receivedStatus.from, receivedStatus.uptime,
+                    receivedStatus.freeMemory,
+                    receivedStatus.firmwareVersion.c_str());
+    } break;
+
+    default:
+      Serial.printf("Unknown message type: %d\n", msgType);
+      break;
+  }
+}
+
+void handleCommandPackage(CommandPackage& cmd) {
+  Serial.printf("Received command %d for device %u\n", cmd.command,
+                cmd.targetDevice);
+
+  // Process different command types
+  switch (cmd.command) {
+    case 1:  // Reset command
+      Serial.println("Reset command received");
+      // Implement reset logic
+      break;
+
+    case 2:  // Configuration update
+      Serial.printf("Config update: %s\n", cmd.parameters.c_str());
+      // Parse and apply configuration
+      break;
+
+    case 3:  // Data request
+      Serial.println("Data request received");
+      sendSensorData();  // Send current sensor data
+      break;
+
+    default:
+      Serial.printf("Unknown command: %d\n", cmd.command);
+      break;
+  }
+}
+
+void newConnectionCallback(uint32_t nodeId) {
+  Serial.printf("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);
 }

package/examples/alteriomSensorNode/alteriom_sensor_package.hpp

@@ -0,0 +1,224 @@
+#ifndef ALTERIOM_SENSOR_PACKAGE_HPP
+#define ALTERIOM_SENSOR_PACKAGE_HPP
+
+#include "painlessmesh/plugin.hpp"
+
+namespace alteriom {
+
+/**
+ * @brief Sensor data package for broadcasting environmental measurements
+ *
+ * This package is designed for Alteriom's IoT sensor network requirements,
+ * allowing nodes to share environmental data across the mesh.
+ */
+class SensorPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  double temperature = 0.0;  // Temperature in Celsius
+  double humidity = 0.0;     // Relative humidity percentage
+  double pressure = 0.0;     // Atmospheric pressure in hPa
+  uint32_t sensorId = 0;     // Unique sensor identifier
+  uint32_t timestamp = 0;    // Unix timestamp of measurement
+  uint8_t batteryLevel = 0;  // Battery level percentage
+
+  SensorPackage()
+      : BroadcastPackage(200) {}  // Type ID 200 for Alteriom sensors
+
+  SensorPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    temperature = jsonObj["temp"];
+    humidity = jsonObj["hum"];
+    pressure = jsonObj["press"];
+    sensorId = jsonObj["sid"];
+    timestamp = jsonObj["ts"];
+    batteryLevel = jsonObj["bat"];
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["temp"] = temperature;
+    jsonObj["hum"] = humidity;
+    jsonObj["press"] = pressure;
+    jsonObj["sid"] = sensorId;
+    jsonObj["ts"] = timestamp;
+    jsonObj["bat"] = batteryLevel;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const { return JSON_OBJECT_SIZE(noJsonFields + 6); }
+#endif
+};
+
+/**
+ * @brief Command package for controlling Alteriom devices
+ *
+ * Single-destination package for sending specific commands to individual nodes.
+ */
+class CommandPackage : public painlessmesh::plugin::SinglePackage {
+ public:
+  uint8_t command = 0;        // Command type
+  uint32_t targetDevice = 0;  // Target device ID
+  TSTRING parameters = "";    // Command parameters as JSON string
+  uint32_t commandId = 0;     // Unique command identifier for tracking
+
+  CommandPackage() : SinglePackage(201) {}  // Type ID 201 for Alteriom commands
+
+  CommandPackage(JsonObject jsonObj) : SinglePackage(jsonObj) {
+    command = jsonObj["cmd"];
+    targetDevice = jsonObj["target"];
+    parameters = jsonObj["params"].as<TSTRING>();
+    commandId = jsonObj["cid"];
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = SinglePackage::addTo(std::move(jsonObj));
+    jsonObj["cmd"] = command;
+    jsonObj["target"] = targetDevice;
+    jsonObj["params"] = parameters;
+    jsonObj["cid"] = commandId;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 4) + parameters.length();
+  }
+#endif
+};
+
+/**
+ * @brief Status report package for device health monitoring
+ */
+class StatusPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  uint8_t deviceStatus = 0;      // Device status flags
+  uint32_t uptime = 0;           // Device uptime in seconds
+  uint16_t freeMemory = 0;       // Free memory in KB
+  uint8_t wifiStrength = 0;      // WiFi signal strength
+  TSTRING firmwareVersion = "";  // Current firmware version
+
+  StatusPackage() : BroadcastPackage(202) {}  // Type ID 202 for Alteriom status
+
+  StatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    deviceStatus = jsonObj["status"];
+    uptime = jsonObj["uptime"];
+    freeMemory = jsonObj["mem"];
+    wifiStrength = jsonObj["wifi"];
+    firmwareVersion = jsonObj["fw"].as<TSTRING>();
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["status"] = deviceStatus;
+    jsonObj["uptime"] = uptime;
+    jsonObj["mem"] = freeMemory;
+    jsonObj["wifi"] = wifiStrength;
+    jsonObj["fw"] = firmwareVersion;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 5) + firmwareVersion.length();
+  }
+#endif
+};
+
+/**
+ * @brief Enhanced status package with comprehensive health metrics (Phase 1)
+ *
+ * This is an extended version of StatusPackage that includes additional
+ * mesh statistics, performance metrics, and alerting capabilities.
+ * Type ID 203 is used to distinguish from the basic StatusPackage (202).
+ */
+class EnhancedStatusPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  // Device Health (from original StatusPackage)
+  uint8_t deviceStatus = 0;      // Device status flags
+  uint32_t uptime = 0;           // Device uptime in seconds
+  uint16_t freeMemory = 0;       // Free memory in KB
+  uint8_t wifiStrength = 0;      // WiFi signal strength
+  TSTRING firmwareVersion = "";  // Current firmware version
+  TSTRING firmwareMD5 = "";      // Firmware hash for OTA verification
+
+  // Mesh Statistics
+  uint16_t nodeCount = 0;         // Number of known nodes in mesh
+  uint8_t connectionCount = 0;    // Number of direct connections
+  uint32_t messagesReceived = 0;  // Total messages received
+  uint32_t messagesSent = 0;      // Total messages sent
+  uint32_t messagesDropped = 0;   // Total messages dropped/failed
+
+  // Performance Metrics
+  uint16_t avgLatency = 0;     // Average message latency in ms
+  uint8_t packetLossRate = 0;  // Packet loss rate percentage (0-100)
+  uint16_t throughput = 0;     // Network throughput in bytes/sec
+
+  // Warnings/Alerts
+  uint8_t alertFlags = 0;  // Bit flags for various alert conditions
+  TSTRING lastError = "";  // Last error message for diagnostics
+
+  EnhancedStatusPackage()
+      : BroadcastPackage(203) {}  // Type ID 203 for enhanced status
+
+  EnhancedStatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    deviceStatus = jsonObj["status"];
+    uptime = jsonObj["uptime"];
+    freeMemory = jsonObj["mem"];
+    wifiStrength = jsonObj["wifi"];
+    firmwareVersion = jsonObj["fw"].as<TSTRING>();
+    firmwareMD5 = jsonObj["fwMD5"].as<TSTRING>();
+
+    nodeCount = jsonObj["nodes"];
+    connectionCount = jsonObj["conns"];
+    messagesReceived = jsonObj["msgRx"];
+    messagesSent = jsonObj["msgTx"];
+    messagesDropped = jsonObj["msgDrop"];
+
+    avgLatency = jsonObj["latency"];
+    packetLossRate = jsonObj["loss"];
+    throughput = jsonObj["throughput"];
+
+    alertFlags = jsonObj["alerts"];
+    lastError = jsonObj["lastErr"].as<TSTRING>();
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+
+    // Device Health
+    jsonObj["status"] = deviceStatus;
+    jsonObj["uptime"] = uptime;
+    jsonObj["mem"] = freeMemory;
+    jsonObj["wifi"] = wifiStrength;
+    jsonObj["fw"] = firmwareVersion;
+    jsonObj["fwMD5"] = firmwareMD5;
+
+    // Mesh Statistics
+    jsonObj["nodes"] = nodeCount;
+    jsonObj["conns"] = connectionCount;
+    jsonObj["msgRx"] = messagesReceived;
+    jsonObj["msgTx"] = messagesSent;
+    jsonObj["msgDrop"] = messagesDropped;
+
+    // Performance Metrics
+    jsonObj["latency"] = avgLatency;
+    jsonObj["loss"] = packetLossRate;
+    jsonObj["throughput"] = throughput;
+
+    // Alerts
+    jsonObj["alerts"] = alertFlags;
+    jsonObj["lastErr"] = lastError;
+
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 18) + firmwareVersion.length() +
+           firmwareMD5.length() + lastError.length();
+  }
+#endif
+};
+
+}  // namespace alteriom
+
+#endif  // ALTERIOM_SENSOR_PACKAGE_HPP

package/examples/alteriomSensorNode/platformio.ini

@@ -0,0 +1,25 @@
+[platformio]
+src_dir = .
+
+[env]
+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  ; 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