@alteriom/painlessmesh 1.7.9 → 1.8.0

package/examples/alteriom/alteriom_sensor_package.hpp

@@ -1165,6 +1165,219 @@ class MeshBridgePackage : public painlessmesh::plugin::BroadcastPackage {
 #endif
 };
 
+/**
+ * @brief Bridge status package for monitoring Internet connectivity (Type 610
+ * - BRIDGE_STATUS)
+ *
+ * This package is broadcast by bridge nodes to inform the mesh about their
+ * Internet connectivity status. Regular nodes can use this information to
+ * decide whether to send data, queue messages, or failover to backup bridges.
+ *
+ * Broadcast interval: Configurable, default 30 seconds
+ * Timeout threshold: 60 seconds (nodes consider bridge offline if no heartbeat)
+ *
+ * Type ID 610 for BRIDGE_STATUS per mqtt-schema v0.7.3+.
+ */
+class BridgeStatusPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  // Bridge connectivity status
+  bool internetConnected = false;  // Is the bridge connected to Internet?
+  int8_t routerRSSI = 0;           // Router WiFi signal strength in dBm
+  uint8_t routerChannel = 0;       // Router WiFi channel
+  uint32_t uptime = 0;             // Bridge uptime in milliseconds
+  TSTRING gatewayIP = "";          // Router gateway IP address
+  uint32_t timestamp = 0;          // Timestamp of status check
+
+  // MQTT Schema v0.7.3+ message_type
+  uint16_t messageType = 610;  // BRIDGE_STATUS
+
+  BridgeStatusPackage() : BroadcastPackage(610) {}
+
+  BridgeStatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    internetConnected = jsonObj["internetConnected"] | false;
+    routerRSSI = jsonObj["routerRSSI"] | 0;
+    routerChannel = jsonObj["routerChannel"] | 0;
+    uptime = jsonObj["uptime"] | 0;
+    gatewayIP = jsonObj["gatewayIP"].as<TSTRING>();
+    timestamp = jsonObj["timestamp"] | 0;
+    messageType = jsonObj["message_type"] | 610;
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["internetConnected"] = internetConnected;
+    jsonObj["routerRSSI"] = routerRSSI;
+    jsonObj["routerChannel"] = routerChannel;
+    jsonObj["uptime"] = uptime;
+    jsonObj["gatewayIP"] = gatewayIP;
+    jsonObj["timestamp"] = timestamp;
+    jsonObj["message_type"] = messageType;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 7) + gatewayIP.length();
+  }
+#endif
+};
+
+/**
+ * @brief Bridge election package for automatic failover (Type 611 -
+ * BRIDGE_ELECTION)
+ *
+ * When a bridge node goes offline, regular nodes with router credentials can
+ * participate in an election to become the new bridge. Each candidate
+ * broadcasts its RSSI to the router, uptime, and available memory. The node
+ * with the best RSSI wins the election.
+ *
+ * Election process:
+ * 1. Bridge failure detected (no heartbeat for 60+ seconds)
+ * 2. Nodes broadcast BridgeElectionPackage with their router RSSI
+ * 3. 5-second collection window for all candidates
+ * 4. Each node evaluates all candidates locally (deterministic)
+ * 5. Winner promotes itself to bridge, others remain as regular nodes
+ *
+ * Type ID 611 for BRIDGE_ELECTION per mqtt-schema v0.7.3+.
+ */
+class BridgeElectionPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  int8_t routerRSSI = 0;    // Router WiFi signal strength in dBm (-127 to 0)
+  uint32_t uptime = 0;      // Node uptime in milliseconds
+  uint32_t freeMemory = 0;  // Free memory in bytes
+  uint32_t timestamp = 0;   // Election timestamp
+  TSTRING routerSSID = "";  // Router SSID (for verification)
+
+  // MQTT Schema v0.7.3+ message_type
+  uint16_t messageType = 611;  // BRIDGE_ELECTION
+
+  BridgeElectionPackage() : BroadcastPackage(611) {}
+
+  BridgeElectionPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    routerRSSI = jsonObj["routerRSSI"] | 0;
+    uptime = jsonObj["uptime"] | 0;
+    freeMemory = jsonObj["freeMemory"] | 0;
+    timestamp = jsonObj["timestamp"] | 0;
+    routerSSID = jsonObj["routerSSID"].as<TSTRING>();
+    messageType = jsonObj["message_type"] | 611;
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["routerRSSI"] = routerRSSI;
+    jsonObj["uptime"] = uptime;
+    jsonObj["freeMemory"] = freeMemory;
+    jsonObj["timestamp"] = timestamp;
+    jsonObj["routerSSID"] = routerSSID;
+    jsonObj["message_type"] = messageType;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 6) + routerSSID.length();
+  }
+#endif
+};
+
+/**
+ * @brief Bridge takeover announcement package (Type 612 - BRIDGE_TAKEOVER)
+ *
+ * After winning the bridge election, the new bridge node broadcasts this
+ * package to inform all mesh nodes that it is now the primary bridge.
+ * This allows nodes to update their bridge tracking and routing tables.
+ *
+ * Type ID 612 for BRIDGE_TAKEOVER per mqtt-schema v0.7.3+.
+ */
+class BridgeTakeoverPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  uint32_t previousBridge = 0;  // Previous bridge node ID (0 if none)
+  TSTRING reason =
+      "";  // Reason for takeover (e.g., "Election winner - best router signal")
+  int8_t routerRSSI = 0;   // New bridge's router signal strength
+  uint32_t timestamp = 0;  // Takeover timestamp
+
+  // MQTT Schema v0.7.3+ message_type
+  uint16_t messageType = 612;  // BRIDGE_TAKEOVER
+
+  BridgeTakeoverPackage() : BroadcastPackage(612) {}
+
+  BridgeTakeoverPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    previousBridge = jsonObj["previousBridge"] | 0;
+    reason = jsonObj["reason"].as<TSTRING>();
+    routerRSSI = jsonObj["routerRSSI"] | 0;
+    timestamp = jsonObj["timestamp"] | 0;
+    messageType = jsonObj["message_type"] | 612;
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["previousBridge"] = previousBridge;
+    jsonObj["reason"] = reason;
+    jsonObj["routerRSSI"] = routerRSSI;
+    jsonObj["timestamp"] = timestamp;
+    jsonObj["message_type"] = messageType;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 5) + reason.length();
+  }
+#endif
+};
+
+/**
+ * @brief NTP time synchronization package (Type 614 - TIME_SYNC_NTP)
+ *
+ * Broadcast by bridge nodes to distribute authoritative NTP time to the mesh.
+ * When a bridge has Internet connectivity, it can provide NTP time to improve
+ * accuracy across the entire mesh network.
+ *
+ * Regular nodes should:
+ * 1. Accept time from bridge nodes (verify sender is bridge)
+ * 2. Update local time with mesh.setTimeFromNTP(ntpTime)
+ * 3. Optionally sync RTC modules if available
+ *
+ * Type ID 614 for TIME_SYNC_NTP.
+ */
+class NTPTimeSyncPackage : public painlessmesh::plugin::BroadcastPackage {
+ public:
+  uint32_t ntpTime = 0;    // Unix timestamp from NTP server
+  uint16_t accuracy = 0;   // Milliseconds uncertainty/precision
+  TSTRING source = "";     // NTP server source (e.g., "pool.ntp.org")
+  uint32_t timestamp = 0;  // Collection timestamp
+
+  // MQTT Schema message_type
+  uint16_t messageType = 614;  // TIME_SYNC_NTP
+
+  NTPTimeSyncPackage() : BroadcastPackage(614) {}
+
+  NTPTimeSyncPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
+    ntpTime = jsonObj["ntpTime"];
+    accuracy = jsonObj["accuracy"];
+    source = jsonObj["source"].as<TSTRING>();
+    timestamp = jsonObj["timestamp"];
+    messageType = jsonObj["message_type"] | 614;
+  }
+
+  JsonObject addTo(JsonObject&& jsonObj) const {
+    jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
+    jsonObj["ntpTime"] = ntpTime;
+    jsonObj["accuracy"] = accuracy;
+    jsonObj["source"] = source;
+    jsonObj["timestamp"] = timestamp;
+    jsonObj["message_type"] = messageType;
+    return jsonObj;
+  }
+
+#if ARDUINOJSON_VERSION_MAJOR < 7
+  size_t jsonObjectSize() const {
+    return JSON_OBJECT_SIZE(noJsonFields + 5) + source.length();
+  }
+#endif
+};
+
 }  // namespace alteriom
 
 #endif  // ALTERIOM_SENSOR_PACKAGE_HPP