@alteriom/painlessmesh 1.6.1 → 1.7.3

package/library.json

@@ -1,34 +1,55 @@
-{
-    "name": "painlessMesh",
-    "keywords": "ethernet, m2m, iot, mesh, alteriom, sensor",
-    "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Alteriom/painlessMesh"
-    },
-    "version": "1.6.1",
-    "frameworks": "arduino",
-    "platforms": "espressif8266, espressif32",
-    "dependencies": [
-        { "owner": "esp32async", "name": "AsyncTCP", "version": "^3.4.7",  "platforms" : ["espressif32"] },
-        { "owner": "esp32async", "name": "ESPAsyncTCP", "version": "^2.0.0",  "platforms" : ["espressif8266"] },
-        { "owner": "bblanchon", "name": "ArduinoJson", "version": "^7.4.2" },
-        { "owner": "arkhipenko", "name": "TaskScheduler", "version": "^3.8.5" }
-    ],
-    "authors": [
-        { "name": "Scotty Franzyshen" }, 
-        { 
-            "name": "Coopdis",
-            "url": "https://github.com/Coopdis"
-        }, 
-        { "name": "Edwin van Leeuwen" },
-        { "name": "Germán Martín" },
-        { "name": "Maximilian Schwarz" },
-        { "name": "Doanh Doanh" },
-        { 
-            "name": "Alteriom",
-            "url": "https://github.com/Alteriom"
-        }
-    ],
-    "headers": "painlessMesh.h"
-}
+{
+    "name": "AlteriomPainlessMesh",
+    "keywords": "ethernet, m2m, iot, mesh, alteriom, sensor, esp32, esp8266, json, time-sync, wireless, communication",
+    "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Alteriom/painlessMesh"
+    },
+    "version": "1.7.3",
+    "frameworks": ["arduino"],
+    "platforms": ["espressif8266", "espressif32"],
+    "srcDir": "src",
+    "includeDir": "src",
+    "dependencies": [
+        { "owner": "esp32async", "name": "AsyncTCP", "version": "^3.4.7",  "platforms" : ["espressif32"] },
+        { "owner": "esp32async", "name": "ESPAsyncTCP", "version": "^2.0.0",  "platforms" : ["espressif8266"] },
+        { "owner": "bblanchon", "name": "ArduinoJson", "version": "^7.4.2" },
+        { "owner": "arkhipenko", "name": "TaskScheduler", "version": "^4.0.0" }
+    ],
+    "authors": [
+        { "name": "Scotty Franzyshen" }, 
+        { 
+            "name": "Coopdis",
+            "url": "https://github.com/Coopdis"
+        }, 
+        { "name": "Edwin van Leeuwen" },
+        { "name": "Germán Martín" },
+        { "name": "Maximilian Schwarz" },
+        { "name": "Doanh Doanh" },
+        { 
+            "name": "Alteriom",
+            "url": "https://github.com/Alteriom",
+            "maintainer": true
+        }
+    ],
+    "license": "LGPL-3.0",
+    "homepage": "https://github.com/Alteriom/painlessMesh",
+    "headers": ["painlessMesh.h", "AlteriomPainlessMesh.h"],
+    "examples": [
+        "examples/alteriom/alteriom.ino",
+        "examples/alteriom/alteriom_sensor_node.ino", 
+        "examples/alteriom/improved_sensor_node.ino",
+        "examples/basic/basic.ino",
+        "examples/bridge/bridge.ino",
+        "examples/echoNode/echoNode.ino",
+        "examples/logClient/logClient.ino",
+        "examples/logServer/logServer.ino",
+        "examples/mqttBridge/mqttBridge.ino",
+        "examples/namedMesh/namedMesh.ino",
+        "examples/otaReceiver/otaReceiver.ino",
+        "examples/otaSender/otaSender.ino",
+        "examples/startHere/startHere.ino",
+        "examples/webServer/webServer.ino"
+    ]
+}

package/library.properties

@@ -1,11 +1,11 @@
-name=AlteriomPainlessMesh
-version=1.6.1
-author=Coopdis,Scotty Franzyshen,Edwin van Leeuwen,Germán Martín,Maximilian Schwarz,Doanh Doanh,Alteriom
-maintainer=Alteriom
-sentence=A painless way to setup a mesh with ESP8266 and ESP32 devices with Alteriom extensions
-paragraph=painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.
-category=Communication
-url=https://github.com/Alteriom/painlessMesh
-architectures=esp8266,esp32
-includes=AlteriomPainlessMesh.h
+name=AlteriomPainlessMesh
+version=1.7.3
+author=Coopdis,Scotty Franzyshen,Edwin van Leeuwen,Germán Martín,Maximilian Schwarz,Doanh Doanh,Alteriom
+maintainer=Alteriom
+sentence=A painless way to setup a mesh with ESP8266 and ESP32 devices with Alteriom extensions
+paragraph=painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.
+category=Communication
+url=https://github.com/Alteriom/painlessMesh
+architectures=esp8266,esp32
+includes=painlessMesh.h
 depends=ArduinoJson, TaskScheduler

package/package.json

@@ -1,78 +1,86 @@
-{
-  "name": "@alteriom/painlessmesh",
-  "version": "1.6.1",
-  "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
-  "keywords": [
-    "arduino",
-    "mesh",
-    "esp32",
-    "esp8266",
-    "embedded",
-    "iot",
-    "wireless",
-    "alteriom",
-    "sensor",
-    "painlessmesh",
-    "mcp-server",
-    "github-copilot",
-    "json",
-    "time-sync",
-    "mesh-networking"
-  ],
-  "author": {
-    "name": "Coopdis",
-    "url": "https://github.com/Coopdis"
-  },
-  "maintainers": [
-    {
-      "name": "Alteriom",
-      "url": "https://github.com/Alteriom"
-    }
-  ],
-  "license": "LGPL-3.0",
-  "homepage": "https://github.com/Alteriom/painlessMesh",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Alteriom/painlessMesh.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Alteriom/painlessMesh/issues"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.0.0",
-    "prettier": "^3.0.0"
-  },
-  "scripts": {
-    "test": "run-parts --regex catch_ bin/ || echo 'Tests completed'",
-    "build": "cmake -G Ninja . && ninja",
-    "validate-library": "./scripts/validate-release.sh",
-    "postpublish": "echo 'Package published successfully to NPM!'",
-    "prebuild": "git submodule update --init"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "config": {
-    "arduino": {
-      "library": true,
-      "platforms": ["arduino", "esp32", "esp8266"]
-    }
-  },
-  "directories": {
-    "example": "examples",
-    "test": "test",
-    "doc": "docs"
-  },
-  "files": [
-    "src/",
-    "examples/",
-    "docs/",
-    "library.properties",
-    "library.json",
-    "keywords.txt",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md",
-    "RELEASE_GUIDE.md"
-  ]
-}
+{
+  "name": "@alteriom/painlessmesh",
+  "version": "1.7.3",
+  "description": "painlessMesh is a user-friendly library for creating mesh networks with ESP8266 and ESP32 devices. This Alteriom fork includes additional packages for sensor data (SensorPackage), device commands (CommandPackage), and status monitoring (StatusPackage). It handles routing and network management automatically, so you can focus on your application. The library uses JSON-based messaging and syncs time across all nodes, making it ideal for coordinated behaviour like synchronized light displays or sensor networks reporting to a central node.",
+  "keywords": [
+    "arduino",
+    "mesh",
+    "esp32",
+    "esp8266",
+    "embedded",
+    "iot",
+    "wireless",
+    "alteriom",
+    "sensor",
+    "painlessmesh",
+    "mcp-server",
+    "github-copilot",
+    "json",
+    "time-sync",
+    "mesh-networking"
+  ],
+  "author": {
+    "name": "Coopdis",
+    "url": "https://github.com/Coopdis"
+  },
+  "maintainers": [
+    {
+      "name": "Alteriom",
+      "url": "https://github.com/Alteriom"
+    }
+  ],
+  "license": "LGPL-3.0",
+  "homepage": "https://github.com/Alteriom/painlessMesh",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Alteriom/painlessMesh.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Alteriom/painlessMesh/issues"
+  },
+  "devDependencies": {
+    "@alteriom/mqtt-schema": "^0.5.0",
+    "@eslint/js": "^9.0.0",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "prettier": "^3.0.0"
+  },
+  "scripts": {
+    "test": "run-parts --regex catch_ bin/ || echo 'Tests completed'",
+    "dev:build": "cmake -G Ninja . && ninja",
+    "dev:prebuild": "git submodule update --init",
+    "validate-library": "./scripts/validate-release.sh",
+    "prepublishOnly": "npm run validate-library",
+    "postpublish": "echo 'Package published successfully to NPM!'"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "config": {
+    "arduino": {
+      "library": true,
+      "platforms": [
+        "arduino",
+        "esp32",
+        "esp8266"
+      ]
+    }
+  },
+  "directories": {
+    "example": "examples",
+    "test": "test",
+    "doc": "docs"
+  },
+  "files": [
+    "src/",
+    "examples/",
+    "docs/",
+    "library.properties",
+    "library.json",
+    "keywords.txt",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "RELEASE_GUIDE.md"
+  ]
+}

package/src/AlteriomPainlessMesh.h

@@ -1,98 +1,98 @@
-#ifndef ALTERIOM_PAINLESS_MESH_H
-#define ALTERIOM_PAINLESS_MESH_H
-
-/**
- * @file AlteriomPainlessMesh.h
- * @brief Main header file for AlteriomPainlessMesh library
- * 
- * This is the primary header file that includes all necessary components
- * for the AlteriomPainlessMesh library, including the core painlessMesh
- * functionality and Alteriom-specific extensions.
- */
-
-// Include the core painlessMesh library
-#include "painlessMesh.h"
-
-// Include Alteriom extensions
-#include "examples/alteriom/alteriom_sensor_package.hpp"
-
-/**
- * @namespace alteriom
- * @brief Namespace containing Alteriom-specific extensions for painlessMesh
- * 
- * This namespace includes production-ready packages for common IoT scenarios:
- * - SensorPackage: Environmental sensor data broadcasting
- * - CommandPackage: Device control and configuration
- * - StatusPackage: Device health and operational status
- */
-
-/**
- * @brief AlteriomPainlessMesh library version information
- */
-#define ALTERIOM_PAINLESS_MESH_VERSION "1.6.1"
-#define ALTERIOM_PAINLESS_MESH_VERSION_MAJOR 1
-#define ALTERIOM_PAINLESS_MESH_VERSION_MINOR 6
-#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 1
-
-/**
- * @brief Library description and usage information
- * 
- * AlteriomPainlessMesh is an enhanced fork of the popular painlessMesh library
- * that adds production-ready, type-safe packages for common IoT communication
- * patterns. It provides:
- * 
- * - Automatic mesh network formation and management
- * - Type-safe messaging with compile-time validation
- * - Pre-built packages for sensors, commands, and status reporting
- * - Cross-platform compatibility (ESP32, ESP8266, desktop)
- * - Time synchronization across all mesh nodes
- * 
- * @section quick_start Quick Start
- * 
- * @code{.cpp}
- * #include "AlteriomPainlessMesh.h"
- * 
- * #define MESH_PREFIX     "MyMesh"
- * #define MESH_PASSWORD   "MyPassword"
- * #define MESH_PORT       5555
- * 
- * Scheduler userScheduler;
- * painlessMesh mesh;
- * 
- * void setup() {
- *     Serial.begin(115200);
- *     
- *     mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
- *     mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
- *     
- *     mesh.onReceive([](uint32_t from, String& msg) {
- *         Serial.printf("Received: %s\n", msg.c_str());
- *     });
- * }
- * 
- * void loop() {
- *     mesh.update();
- * }
- * @endcode
- * 
- * @section alteriom_packages Alteriom Packages
- * 
- * @code{.cpp}
- * using namespace alteriom;
- * 
- * // Send sensor data
- * SensorPackage sensor;
- * sensor.temperature = 25.5;
- * sensor.humidity = 60.0;
- * mesh.sendPackage(&sensor);
- * 
- * // Handle received sensor data
- * mesh.onPackage(200, [](protocol::Variant& variant) {
- *     SensorPackage data = variant.to<SensorPackage>();
- *     Serial.printf("Temperature: %.1f°C\n", data.temperature);
- *     return true;
- * });
- * @endcode
- */
-
+#ifndef ALTERIOM_PAINLESS_MESH_H
+#define ALTERIOM_PAINLESS_MESH_H
+
+/**
+ * @file AlteriomPainlessMesh.h
+ * @brief Main header file for AlteriomPainlessMesh library
+ * 
+ * This is the primary header file that includes all necessary components
+ * for the AlteriomPainlessMesh library, including the core painlessMesh
+ * functionality and Alteriom-specific extensions.
+ */
+
+// Include the core painlessMesh library
+#include "painlessMesh.h"
+
+// Note: Alteriom extensions (alteriom_sensor_package.hpp) are provided as examples
+// and should be included directly in your sketch when needed
+
+/**
+ * @namespace alteriom
+ * @brief Namespace containing Alteriom-specific extensions for painlessMesh
+ * 
+ * This namespace includes production-ready packages for common IoT scenarios:
+ * - SensorPackage: Environmental sensor data broadcasting
+ * - CommandPackage: Device control and configuration
+ * - StatusPackage: Device health and operational status
+ */
+
+/**
+ * @brief AlteriomPainlessMesh library version information
+ */
+#define ALTERIOM_PAINLESS_MESH_VERSION "1.6.1"
+#define ALTERIOM_PAINLESS_MESH_VERSION_MAJOR 1
+#define ALTERIOM_PAINLESS_MESH_VERSION_MINOR 6
+#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 1
+
+/**
+ * @brief Library description and usage information
+ * 
+ * AlteriomPainlessMesh is an enhanced fork of the popular painlessMesh library
+ * that adds production-ready, type-safe packages for common IoT communication
+ * patterns. It provides:
+ * 
+ * - Automatic mesh network formation and management
+ * - Type-safe messaging with compile-time validation
+ * - Pre-built packages for sensors, commands, and status reporting
+ * - Cross-platform compatibility (ESP32, ESP8266, desktop)
+ * - Time synchronization across all mesh nodes
+ * 
+ * @section quick_start Quick Start
+ * 
+ * @code{.cpp}
+ * #include "AlteriomPainlessMesh.h"
+ * 
+ * #define MESH_PREFIX     "MyMesh"
+ * #define MESH_PASSWORD   "MyPassword"
+ * #define MESH_PORT       5555
+ * 
+ * Scheduler userScheduler;
+ * painlessMesh mesh;
+ * 
+ * void setup() {
+ *     Serial.begin(115200);
+ *     
+ *     mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
+ *     mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
+ *     
+ *     mesh.onReceive([](uint32_t from, String& msg) {
+ *         Serial.printf("Received: %s\n", msg.c_str());
+ *     });
+ * }
+ * 
+ * void loop() {
+ *     mesh.update();
+ * }
+ * @endcode
+ * 
+ * @section alteriom_packages Alteriom Packages
+ * 
+ * @code{.cpp}
+ * using namespace alteriom;
+ * 
+ * // Send sensor data
+ * SensorPackage sensor;
+ * sensor.temperature = 25.5;
+ * sensor.humidity = 60.0;
+ * mesh.sendPackage(&sensor);
+ * 
+ * // Handle received sensor data
+ * mesh.onPackage(200, [](protocol::Variant& variant) {
+ *     SensorPackage data = variant.to<SensorPackage>();
+ *     Serial.printf("Temperature: %.1f°C\n", data.temperature);
+ *     return true;
+ * });
+ * @endcode
+ */
+
 #endif // ALTERIOM_PAINLESS_MESH_H