@alteriom/painlessmesh 1.8.12 → 1.8.13

package/library.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/Alteriom/painlessMesh"
   },
-  "version": "1.8.12",
+  "version": "1.8.13",
   "frameworks": [
     "arduino"
   ],

package/library.properties

@@ -1,5 +1,5 @@
 name=Alteriom PainlessMesh
-version=1.8.12
+version=1.8.13
 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alteriom/painlessmesh",
-  "version": "1.8.12",
+  "version": "1.8.13",
   "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",
@@ -85,6 +85,6 @@
     "CHANGELOG.md",
     "RELEASE_GUIDE.md",
     "DOCUMENTATION_INDEX.md",
-    "RELEASE_NOTES_1.8.12.md"
+    "RELEASE_NOTES_1.8.13.md"
   ]
 }

package/src/AlteriomPainlessMesh.h

@@ -29,10 +29,10 @@
 /**
  * @brief AlteriomPainlessMesh library version information
  */
-#define ALTERIOM_PAINLESS_MESH_VERSION "1.8.12"
+#define ALTERIOM_PAINLESS_MESH_VERSION "1.8.13"
 #define ALTERIOM_PAINLESS_MESH_VERSION_MAJOR 1
 #define ALTERIOM_PAINLESS_MESH_VERSION_MINOR 8
-#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 12
+#define ALTERIOM_PAINLESS_MESH_VERSION_PATCH 13
 
 /**
  * @brief Library description and usage information

package/src/arduino/wifi.hpp

@@ -89,9 +89,9 @@ class Mesh : public painlessmesh::Mesh<Connection> {
 
     this->init(nodeId);
 
-    // Add bridge election package handler (Type 611)
+    // Add bridge election package handler (Type BRIDGE_ELECTION)
     this->callbackList.onPackage(
-        611,  // BRIDGE_ELECTION type
+        protocol::BRIDGE_ELECTION,
         [this](protocol::Variant& variant, std::shared_ptr<Connection>, uint32_t) {
           JsonDocument doc;
           TSTRING str;
@@ -113,9 +113,9 @@ class Mesh : public painlessmesh::Mesh<Connection> {
           return false;  // Don't consume the package
         });
 
-    // Add bridge takeover package handler (Type 612)
+    // Add bridge takeover package handler (Type BRIDGE_TAKEOVER)
     this->callbackList.onPackage(
-        612,  // BRIDGE_TAKEOVER type
+        protocol::BRIDGE_TAKEOVER,
         [this](protocol::Variant& variant, std::shared_ptr<Connection>, uint32_t) {
           JsonDocument doc;
           TSTRING str;
@@ -817,7 +817,7 @@ class Mesh : public painlessmesh::Mesh<Connection> {
         JsonDocument doc;
         JsonObject obj = doc.to<JsonObject>();
         
-        obj["type"] = 610;  // BRIDGE_STATUS type
+        obj["type"] = protocol::BRIDGE_STATUS;
         obj["from"] = this->nodeId;
         obj["routing"] = 1;  // SINGLE routing (direct to node)
         obj["dest"] = nodeId;
@@ -830,7 +830,7 @@ class Mesh : public painlessmesh::Mesh<Connection> {
         obj["routerChannel"] = WiFi.channel();
         obj["uptime"] = millis();
         obj["gatewayIP"] = WiFi.gatewayIP().toString();
-        obj["message_type"] = 610;
+        obj["message_type"] = protocol::BRIDGE_STATUS;
         
         String msg;
         serializeJson(doc, msg);
@@ -838,8 +838,10 @@ class Mesh : public painlessmesh::Mesh<Connection> {
         Log(CONNECTION, "Sending bridge status directly to node %u (Internet: %s)\n",
             nodeId, hasInternet ? "YES" : "NO");
         
-        // Send directly to the new node using routing table (which is now ready)
-        this->sendSingle(nodeId, msg);
+        // Send directly to the new node using raw message to preserve type BRIDGE_STATUS
+        // Using sendSingle() would wrap it in type 1 (SINGLE) and hide type BRIDGE_STATUS
+        protocol::Variant variant(msg);
+        router::send<Connection>(variant, (*this));
       });
     });
     
@@ -1072,7 +1074,7 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     // Broadcast candidacy using JSON directly (avoiding dependency on alteriom package)
     JsonDocument doc;
     JsonObject obj = doc.to<JsonObject>();
-    obj["type"] = 611;  // BRIDGE_ELECTION
+    obj["type"] = protocol::BRIDGE_ELECTION;
     obj["from"] = this->nodeId;
     obj["routing"] = 2;  // BROADCAST
     obj["routerRSSI"] = routerRSSI;
@@ -1080,11 +1082,14 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     obj["freeMemory"] = ESP.getFreeHeap();
     obj["timestamp"] = this->getNodeTime();
     obj["routerSSID"] = routerSSID;
-    obj["message_type"] = 611;
+    obj["message_type"] = protocol::BRIDGE_ELECTION;
     
     String msg;
     serializeJson(doc, msg);
-    this->sendBroadcast(msg);
+    
+    // Send election message using raw broadcast to preserve type BRIDGE_ELECTION
+    protocol::Variant variant(msg);
+    router::broadcast<protocol::Variant, Connection>(variant, (*this), 0);
     
     Log(CONNECTION, "startBridgeElection(): Candidacy broadcast sent\n");
     
@@ -1223,18 +1228,21 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     Log(STARTUP, "Sending takeover announcement on current channel before switching...\n");
     JsonDocument doc;
     JsonObject obj = doc.to<JsonObject>();
-    obj["type"] = 612;  // BRIDGE_TAKEOVER
+    obj["type"] = protocol::BRIDGE_TAKEOVER;
     obj["from"] = this->nodeId;
     obj["routing"] = 2;  // BROADCAST
     obj["previousBridge"] = previousBridgeId;
     obj["reason"] = "Election winner - best router signal";
     obj["routerRSSI"] = 0;  // Not yet connected to router
     obj["timestamp"] = this->getNodeTime();
-    obj["message_type"] = 612;
+    obj["message_type"] = protocol::BRIDGE_TAKEOVER;
     
     String msg;
     serializeJson(doc, msg);
-    this->sendBroadcast(msg);
+    
+    // Send takeover message using raw broadcast to preserve type BRIDGE_TAKEOVER
+    protocol::Variant variant(msg);
+    router::broadcast<protocol::Variant, Connection>(variant, (*this), 0);
     
     // Give time for announcement to propagate before channel switch
     delay(1000);
@@ -1263,18 +1271,22 @@ class Mesh : public painlessmesh::Mesh<Connection> {
       Log(STARTUP, "Sending follow-up takeover announcement on new channel %d\n", _meshChannel);
       JsonDocument doc2;
       JsonObject obj2 = doc2.to<JsonObject>();
-      obj2["type"] = 612;  // BRIDGE_TAKEOVER
+      obj2["type"] = protocol::BRIDGE_TAKEOVER;
       obj2["from"] = this->nodeId;
       obj2["routing"] = 2;  // BROADCAST
       obj2["previousBridge"] = previousBridgeId;
       obj2["reason"] = "Election winner - best router signal";
       obj2["routerRSSI"] = WiFi.RSSI();
       obj2["timestamp"] = this->getNodeTime();
-      obj2["message_type"] = 612;
+      obj2["message_type"] = protocol::BRIDGE_TAKEOVER;
       
       String msg2;
       serializeJson(doc2, msg2);
-      this->sendBroadcast(msg2);
+      
+      // Send follow-up takeover using raw broadcast to preserve type BRIDGE_TAKEOVER
+      protocol::Variant variant2(msg2);
+      router::broadcast<protocol::Variant, Connection>(variant2, (*this), 0);
+      
       Log(STARTUP, "✓ Follow-up takeover announcement sent\n");
     });
   }
@@ -1329,7 +1341,7 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     JsonDocument doc;
     JsonObject obj = doc.to<JsonObject>();
     
-    obj["type"] = 610;  // BRIDGE_STATUS type
+    obj["type"] = protocol::BRIDGE_STATUS;
     obj["from"] = this->nodeId;
     obj["routing"] = 2;  // BROADCAST routing
     obj["timestamp"] = this->getNodeTime();
@@ -1352,7 +1364,7 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     obj["routerChannel"] = channel;
     obj["uptime"] = uptime;
     obj["gatewayIP"] = gatewayIP;
-    obj["message_type"] = 610;
+    obj["message_type"] = protocol::BRIDGE_STATUS;
     
     String msg;
     serializeJson(doc, msg);
@@ -1367,7 +1379,10 @@ class Mesh : public painlessmesh::Mesh<Connection> {
     this->updateBridgeStatus(this->nodeId, hasInternet, rssi, channel, 
                             uptime, gatewayIP, this->getNodeTime());
     
-    this->sendBroadcast(msg);
+    // Send bridge status using raw broadcast to preserve type BRIDGE_STATUS
+    // Using sendBroadcast(msg) would wrap it in type 8 (BROADCAST) and hide type BRIDGE_STATUS
+    protocol::Variant variant(msg);
+    router::broadcast<protocol::Variant, Connection>(variant, (*this), 0);
   }
   void eventHandleInit() {
     using namespace logger;

package/src/painlessMesh.h

@@ -5,8 +5,8 @@
  * @file painlessMesh.h
  * @brief Main header file for Alteriom painlessMesh library
  * 
- * @version 1.8.12
- * @date 2025-11-19
+ * @version 1.8.13
+ * @date 2025-11-20
  * 
  * painlessMesh is a user-friendly library for creating mesh networks with 
  * ESP8266 and ESP32 devices. This Alteriom fork includes additional packages 

package/src/painlessmesh/mesh.hpp

@@ -167,10 +167,10 @@ class Mesh : public ntp::MeshTime, public plugin::PackageHandler<T> {
     this->callbackList = painlessmesh::router::addPackageCallback(
         std::move(this->callbackList), (*this));
 
-    // Add bridge status package handler (Type 610)
+    // Add bridge status package handler (Type BRIDGE_STATUS)
     // This will be called when any node receives a bridge status broadcast
     this->callbackList.onPackage(
-        610,  // BRIDGE_STATUS type
+        protocol::BRIDGE_STATUS,
         [this](protocol::Variant& variant, std::shared_ptr<T>, uint32_t) {
           // We need to manually parse the JSON since BridgeStatusPackage is in alteriom namespace
           // and may not be available in all contexts. We'll parse the critical fields directly.

package/src/painlessmesh/protocol.hpp

@@ -49,6 +49,13 @@ enum TimeType {
   TIME_REPLY
 };
 
+// Bridge protocol package types
+// These are used for bridge discovery, election, and coordination
+constexpr int BRIDGE_STATUS = 610;      // Bridge status broadcast (internet, RSSI, etc.)
+constexpr int BRIDGE_ELECTION = 611;    // Bridge election candidacy announcement
+constexpr int BRIDGE_TAKEOVER = 612;    // Bridge takeover notification
+constexpr int BRIDGE_COORDINATION = 613; // Multi-bridge coordination (defined in plugin.hpp)
+
 class PackageInterface {
  public:
   virtual JsonObject addTo(JsonObject&& jsonObj) const = 0;

package/RELEASE_NOTES_1.8.12.md

@@ -1,96 +0,0 @@
-# Release Notes - Version 1.8.12
-
-**Release Date:** 2025-11-19
-
-## Overview
-
-Version 1.8.12 is a maintenance release focused on documentation improvements and code quality enhancements. This release includes changes from PRs #152 and #153, ensuring comprehensive documentation coverage and adherence to code formatting standards.
-
-## What's New
-
-### Documentation Enhancements
-
-- **Comprehensive Documentation Review** - All documentation has been reviewed and updated to reflect the current state of the library
-- **API Reference Updates** - Improved clarity and completeness in API documentation
-- **Example Code Documentation** - Enhanced inline documentation for example projects
-- **Package Documentation** - Updated documentation for all Alteriom custom packages
-
-### Code Quality Improvements
-
-- **Prettier Configuration** - Added prettier configuration for consistent JSON and Markdown formatting
-  - New `.prettierrc` configuration file
-  - New `.prettierignore` file to exclude build artifacts and dependencies
-  - Added `npm run format` and `npm run format:check` scripts
-- **Clang-Format Compliance** - Ensured all C++ code follows established formatting standards
-- **Code Organization** - Improved code structure and maintainability
-
-### Version Updates
-
-- Updated all version references across:
-  - `package.json` - NPM package version
-  - `library.json` - PlatformIO library version
-  - `library.properties` - Arduino library version
-  - `src/painlessMesh.h` - Header file version comments
-  - `src/AlteriomPainlessMesh.h` - Version defines and comments
-
-## Installation
-
-### Arduino Library Manager
-```
-Sketch → Include Library → Manage Libraries → Search "AlteriomPainlessMesh" → Install
-```
-
-### PlatformIO
-```ini
-[env:myenv]
-lib_deps = 
-    alteriom/AlteriomPainlessMesh @ ^1.8.12
-```
-
-### NPM
-```bash
-npm install @alteriom/painlessmesh@1.8.12
-```
-
-## Compatibility
-
-- **ESP32** - All variants supported
-- **ESP8266** - All variants supported
-- **Arduino IDE** - Version 1.8.0 or higher
-- **PlatformIO** - Latest version
-- **ArduinoJson** - Version 7.4.2 or higher
-- **TaskScheduler** - Version 4.0.0 or higher
-
-## Migration Guide
-
-This is a patch release with no breaking changes. Users can upgrade from any 1.8.x version without code modifications.
-
-## Known Issues
-
-None identified in this release.
-
-## Pull Requests Included
-
-- PR #152 - Documentation improvements
-- PR #153 - Code quality enhancements
-
-## Contributors
-
-Special thanks to all contributors who helped make this release possible!
-
-## Documentation
-
-- **Main Documentation**: https://alteriom.github.io/painlessMesh/
-- **API Reference**: https://alteriom.github.io/painlessMesh/#/api/doxygen
-- **Examples**: https://alteriom.github.io/painlessMesh/#/tutorials/basic-examples
-- **GitHub Repository**: https://github.com/Alteriom/painlessMesh
-
-## Support
-
-For questions, issues, or feature requests:
-- **GitHub Issues**: https://github.com/Alteriom/painlessMesh/issues
-- **Documentation**: https://alteriom.github.io/painlessMesh/
-
-## License
-
-This project is licensed under LGPL-3.0. See the LICENSE file for details.