@alteriom/painlessmesh 1.6.1 → 1.7.3

package/examples/mqttBridge/mqttBridge.ino

@@ -1,118 +1,118 @@
-//************************************************************
-// this is a simple example that uses the painlessMesh library to
-// connect to a another network and relay messages from a MQTT broker to the nodes of the mesh network.
-// To send a message to a mesh node, you can publish it to "painlessMesh/to/12345678" where 12345678 equals the nodeId.
-// To broadcast a message to all nodes in the mesh you can publish it to "painlessMesh/to/broadcast".
-// When you publish "getNodes" to "painlessMesh/to/gateway" you receive the mesh topology as JSON
-// Every message from the mesh which is send to the gateway node will be published to "painlessMesh/from/12345678" where 12345678 
-// is the nodeId from which the packet was send.
-//************************************************************
-
-#include <Arduino.h>
-#include <painlessMesh.h>
-#include <PubSubClient.h>
-#include <WiFiClient.h>
-
-#define   MESH_PREFIX     "whateverYouLike"
-#define   MESH_PASSWORD   "somethingSneaky"
-#define   MESH_PORT       5555
-
-#define   STATION_SSID     "YourAP_SSID"
-#define   STATION_PASSWORD "YourAP_PWD"
-
-#define HOSTNAME "MQTT_Bridge"
-
-// Prototypes
-void receivedCallback( const uint32_t &from, const String &msg );
-void mqttCallback(char* topic, byte* payload, unsigned int length);
-
-IPAddress getlocalIP();
-
-IPAddress myIP(0,0,0,0);
-IPAddress mqttBroker(192, 168, 1, 1);
-
-painlessMesh  mesh;
-WiFiClient wifiClient;
-PubSubClient mqttClient(mqttBroker, 1883, mqttCallback, wifiClient);
-
-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, 6 );
-  mesh.onReceive(&receivedCallback);
-
-  mesh.stationManual(STATION_SSID, STATION_PASSWORD);
-  mesh.setHostname(HOSTNAME);
-
-  // 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);
-}
-
-void loop() {
-  mesh.update();
-  mqttClient.loop();
-
-  if(myIP != getlocalIP()){
-    myIP = getlocalIP();
-    Serial.println("My IP is " + myIP.toString());
-
-    if (mqttClient.connect("painlessMeshClient")) {
-      mqttClient.publish("painlessMesh/from/gateway","Ready!");
-      mqttClient.subscribe("painlessMesh/to/#");
-    } 
-  }
-}
-
-void receivedCallback( const uint32_t &from, const String &msg ) {
-  Serial.printf("bridge: Received from %u msg=%s\n", from, msg.c_str());
-  String topic = "painlessMesh/from/" + String(from);
-  mqttClient.publish(topic.c_str(), msg.c_str());
-}
-
-void mqttCallback(char* topic, uint8_t* payload, unsigned int length) {
-  char* cleanPayload = (char*)malloc(length+1);
-  memcpy(cleanPayload, payload, length);
-  cleanPayload[length] = '\0';
-  String msg = String(cleanPayload);
-  free(cleanPayload);
-
-  String targetStr = String(topic).substring(16);
-
-  if(targetStr == "gateway")
-  {
-    if(msg == "getNodes")
-    {
-      auto nodes = mesh.getNodeList(true);
-      String str;
-      for (auto &&id : nodes)
-        str += String(id) + String(" ");
-      mqttClient.publish("painlessMesh/from/gateway", str.c_str());
-    }
-  }
-  else if(targetStr == "broadcast") 
-  {
-    mesh.sendBroadcast(msg);
-  }
-  else
-  {
-    uint32_t target = strtoul(targetStr.c_str(), NULL, 10);
-    if(mesh.isConnected(target))
-    {
-      mesh.sendSingle(target, msg);
-    }
-    else
-    {
-      mqttClient.publish("painlessMesh/from/gateway", "Client not connected!");
-    }
-  }
-}
-
-IPAddress getlocalIP() {
-  return IPAddress(mesh.getStationIP());
-}
+//************************************************************
+// this is a simple example that uses the painlessMesh library to
+// connect to a another network and relay messages from a MQTT broker to the nodes of the mesh network.
+// To send a message to a mesh node, you can publish it to "painlessMesh/to/12345678" where 12345678 equals the nodeId.
+// To broadcast a message to all nodes in the mesh you can publish it to "painlessMesh/to/broadcast".
+// When you publish "getNodes" to "painlessMesh/to/gateway" you receive the mesh topology as JSON
+// Every message from the mesh which is send to the gateway node will be published to "painlessMesh/from/12345678" where 12345678 
+// is the nodeId from which the packet was send.
+//************************************************************
+
+#include <Arduino.h>
+#include <painlessMesh.h>
+#include <PubSubClient.h>
+#include <WiFiClient.h>
+
+#define   MESH_PREFIX     "whateverYouLike"
+#define   MESH_PASSWORD   "somethingSneaky"
+#define   MESH_PORT       5555
+
+#define   STATION_SSID     "YourAP_SSID"
+#define   STATION_PASSWORD "YourAP_PWD"
+
+#define HOSTNAME "MQTT_Bridge"
+
+// Prototypes
+void receivedCallback( const uint32_t &from, const String &msg );
+void mqttCallback(char* topic, byte* payload, unsigned int length);
+
+IPAddress getlocalIP();
+
+IPAddress myIP(0,0,0,0);
+IPAddress mqttBroker(192, 168, 1, 1);
+
+painlessMesh  mesh;
+WiFiClient wifiClient;
+PubSubClient mqttClient(mqttBroker, 1883, mqttCallback, wifiClient);
+
+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, 6 );
+  mesh.onReceive(&receivedCallback);
+
+  mesh.stationManual(STATION_SSID, STATION_PASSWORD);
+  mesh.setHostname(HOSTNAME);
+
+  // 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);
+}
+
+void loop() {
+  mesh.update();
+  mqttClient.loop();
+
+  if(myIP != getlocalIP()){
+    myIP = getlocalIP();
+    Serial.println("My IP is " + myIP.toString());
+
+    if (mqttClient.connect("painlessMeshClient")) {
+      mqttClient.publish("painlessMesh/from/gateway","Ready!");
+      mqttClient.subscribe("painlessMesh/to/#");
+    } 
+  }
+}
+
+void receivedCallback( const uint32_t &from, const String &msg ) {
+  Serial.printf("bridge: Received from %u msg=%s\n", from, msg.c_str());
+  String topic = "painlessMesh/from/" + String(from);
+  mqttClient.publish(topic.c_str(), msg.c_str());
+}
+
+void mqttCallback(char* topic, uint8_t* payload, unsigned int length) {
+  char* cleanPayload = (char*)malloc(length+1);
+  memcpy(cleanPayload, payload, length);
+  cleanPayload[length] = '\0';
+  String msg = String(cleanPayload);
+  free(cleanPayload);
+
+  String targetStr = String(topic).substring(16);
+
+  if(targetStr == "gateway")
+  {
+    if(msg == "getNodes")
+    {
+      auto nodes = mesh.getNodeList(true);
+      String str;
+      for (auto &&id : nodes)
+        str += String(id) + String(" ");
+      mqttClient.publish("painlessMesh/from/gateway", str.c_str());
+    }
+  }
+  else if(targetStr == "broadcast") 
+  {
+    mesh.sendBroadcast(msg);
+  }
+  else
+  {
+    uint32_t target = strtoul(targetStr.c_str(), NULL, 10);
+    if(mesh.isConnected(target))
+    {
+      mesh.sendSingle(target, msg);
+    }
+    else
+    {
+      mqttClient.publish("painlessMesh/from/gateway", "Client not connected!");
+    }
+  }
+}
+
+IPAddress getlocalIP() {
+  return IPAddress(mesh.getStationIP());
+}

package/examples/mqttBridge/platformio.ini

@@ -1,26 +1,26 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-    PubSubClient
-
-[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
+[platformio]
+src_dir = .
+
+[env]
+lib_deps =
+    bblanchon/ArduinoJson
+    arkhipenko/TaskScheduler
+    PubSubClient
+
+[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/mqttCommandBridge/alteriom_sensor_package.hpp

@@ -0,0 +1,235 @@
+#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
+
+  // Command response fields (for MQTT bridge)
+  uint32_t responseToCommand = 0;  // CommandId this is responding to
+  TSTRING responseMessage = "";  // Success/error message
+
+  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>();
+    responseToCommand = jsonObj["respTo"] | 0;
+    responseMessage = jsonObj["respMsg"].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;
+    if (responseToCommand > 0) {
+      jsonObj["respTo"] = responseToCommand;
+      jsonObj["respMsg"] = responseMessage;
+    }
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 7) + firmwareVersion.length() +
+           responseMessage.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