@alteriom/painlessmesh 1.6.1 → 1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +380 -143
- package/LICENSE +674 -674
- package/README.md +477 -434
- package/RELEASE_GUIDE.md +504 -418
- package/docs/DOCUMENTATION_MIGRATION_PLAN.md +175 -175
- package/docs/IMPLEMENTATION_PLAN_MESH_TOPOLOGY.md +1062 -0
- package/docs/MESH_TOPOLOGY_GUIDE.md +992 -0
- package/docs/MESH_TOPOLOGY_PROGRESS.md +422 -0
- package/docs/MQTT_BRIDGE_COMMANDS.md +894 -0
- package/docs/MQTT_BRIDGE_IMPLEMENTATION_SUMMARY.md +324 -0
- package/docs/MQTT_COMMAND_SCHEMA_PROPOSAL.md +576 -0
- package/docs/MQTT_SCHEMA_COMPLIANCE.md +285 -0
- package/docs/MQTT_SCHEMA_PROPOSALS.md +446 -0
- package/docs/MQTT_SCHEMA_REVIEW.md +690 -0
- package/docs/OTA_COMMANDS_REFERENCE.md +554 -0
- package/docs/PHASE1_GUIDE.md +349 -0
- package/docs/PHASE2_GUIDE.md +543 -0
- package/docs/README.md +77 -70
- package/docs/SCHEMA_VALIDATION_CHECKLIST.md +222 -0
- package/docs/alteriom/overview.md +507 -507
- package/docs/api/core-api.md +606 -606
- package/docs/architecture/mesh-architecture.md +378 -378
- package/docs/architecture/plugin-system.md +516 -516
- package/docs/getting-started/first-mesh.md +409 -409
- package/docs/getting-started/installation.md +274 -274
- package/docs/getting-started/quickstart.md +157 -157
- package/docs/improvements/FEATURE_PROPOSALS.md +337 -0
- package/docs/improvements/PHASE1_IMPLEMENTATION.md +325 -0
- package/docs/improvements/PHASE2_IMPLEMENTATION.md +567 -0
- package/docs/improvements/README.md +86 -68
- package/docs/improvements/ota-and-status-enhancements.md +911 -0
- package/docs/improvements/ota-status-architecture-diagrams.md +658 -0
- package/docs/improvements/ota-status-quick-reference.md +284 -0
- package/docs/platformio-publishing.md +255 -0
- package/docs/platformio-setup-summary.md +121 -0
- package/docs/troubleshooting/common-issues.md +520 -520
- package/docs/troubleshooting/faq.md +472 -472
- package/docs/tutorials/basic-examples.md +717 -717
- package/docs/wiki/API-Reference.md +245 -245
- package/docs/wiki/Complete-Documentation.md +122 -122
- package/examples/alteriom/README.md +139 -81
- package/examples/alteriom/alteriom.ino +186 -185
- package/examples/alteriom/alteriom_sensor_package.hpp +240 -127
- package/examples/alteriom/platformio.ini +24 -24
- package/examples/alteriomImproved/alteriom_sensor_package.hpp +224 -0
- package/examples/{alteriom → alteriomImproved}/improved_sensor_node.ino +245 -245
- package/examples/alteriomImproved/platformio.ini +25 -0
- package/examples/alteriomPhase1/alteriom_sensor_package.hpp +224 -0
- package/examples/alteriomPhase1/phase1_features.ino +242 -0
- package/examples/alteriomPhase1/platformio.ini +25 -0
- package/examples/alteriomPhase2/alteriom_sensor_package.hpp +224 -0
- package/examples/alteriomPhase2/phase2_features.ino +186 -0
- package/examples/alteriomPhase2/platformio.ini +25 -0
- package/examples/{alteriom → alteriomSensorNode}/alteriom_sensor_node.ino +183 -183
- package/examples/alteriomSensorNode/alteriom_sensor_package.hpp +224 -0
- package/examples/alteriomSensorNode/platformio.ini +25 -0
- package/examples/basic/basic.ino +66 -66
- package/examples/basic/platformio.ini +25 -25
- package/examples/bridge/bridge.ino +51 -51
- package/examples/bridge/mesh_event_publisher.hpp +253 -0
- package/examples/bridge/mesh_topology_reporter.hpp +303 -0
- package/examples/bridge/mqtt_command_bridge.hpp +459 -0
- package/examples/bridge/mqtt_status_bridge.hpp +519 -0
- package/examples/bridge/platformio.ini +25 -25
- package/examples/echoNode/echoNode.ino +33 -33
- package/examples/echoNode/platformio.ini +25 -25
- package/examples/logClient/logClient.ino +109 -109
- package/examples/logClient/platformio.ini +25 -25
- package/examples/logServer/logServer.ino +81 -81
- package/examples/logServer/platformio.ini +25 -25
- package/examples/meshCommandNode/alteriom_sensor_package.hpp +235 -0
- package/examples/meshCommandNode/meshCommandNode.ino +263 -0
- package/examples/meshCommandNode/platformio.ini +25 -0
- package/examples/mqttBridge/mqttBridge.ino +118 -118
- package/examples/mqttBridge/platformio.ini +26 -26
- package/examples/mqttCommandBridge/alteriom_sensor_package.hpp +235 -0
- package/examples/mqttCommandBridge/mesh_event_publisher.hpp +253 -0
- package/examples/mqttCommandBridge/mesh_topology_reporter.hpp +303 -0
- package/examples/mqttCommandBridge/mqttCommandBridge.ino +252 -0
- package/examples/mqttCommandBridge/mqtt_command_bridge.hpp +459 -0
- package/examples/mqttCommandBridge/platformio.ini +26 -0
- package/examples/mqttStatusBridge/mqttStatusBridge.ino +216 -0
- package/examples/mqttStatusBridge/mqtt_status_bridge.hpp +522 -0
- package/examples/mqttStatusBridge/platformio.ini +26 -0
- package/examples/mqttTopologyTest/README.md +467 -0
- package/examples/mqttTopologyTest/mqttTopologyTest.ino +748 -0
- package/examples/mqttTopologyTest/platformio.ini +26 -0
- package/examples/namedMesh/namedMesh.ino +97 -97
- package/examples/namedMesh/platformio.ini +25 -25
- package/examples/otaReceiver/otaReceiver.ino +79 -79
- package/examples/otaReceiver/platformio.ini +25 -25
- package/examples/otaSender/otaSender.ino +160 -151
- package/examples/otaSender/platformio.ini +25 -25
- package/examples/startHere/platformio.ini +25 -25
- package/examples/startHere/startHere.ino +159 -159
- package/examples/webServer/platformio.ini +27 -27
- package/examples/webServer/webServer.ino +89 -89
- package/keywords.txt +48 -48
- package/library.json +55 -34
- package/library.properties +10 -10
- package/package.json +86 -78
- package/src/AlteriomPainlessMesh.h +97 -97
- package/src/arduino/wifi.hpp +365 -365
- package/src/boost/asynctcp.hpp +279 -279
- package/src/painlessMesh.h +70 -70
- package/src/painlessMeshSTA.cpp +236 -236
- package/src/painlessMeshSTA.h +58 -58
- package/src/painlessTaskOptions.h +4 -4
- package/src/painlessmesh/base64.hpp +111 -111
- package/src/painlessmesh/buffer.hpp +229 -229
- package/src/painlessmesh/callback.hpp +91 -91
- package/src/painlessmesh/configuration.hpp +77 -77
- package/src/painlessmesh/connection.hpp +192 -192
- package/src/painlessmesh/layout.hpp +188 -188
- package/src/painlessmesh/logger.hpp +158 -158
- package/src/painlessmesh/memory.hpp +119 -119
- package/src/painlessmesh/mesh.hpp +761 -560
- package/src/painlessmesh/metrics.hpp +322 -322
- package/src/painlessmesh/ntp.hpp +263 -263
- package/src/painlessmesh/ota.hpp +582 -553
- package/src/painlessmesh/plugin.hpp +188 -188
- package/src/painlessmesh/protocol.hpp +813 -813
- package/src/painlessmesh/router.hpp +322 -322
- package/src/painlessmesh/tcp.hpp +71 -71
- package/src/painlessmesh/validation.hpp +238 -238
- package/src/plugin/performance.hpp +214 -214
- package/src/plugin/remote.hpp +64 -64
- package/src/scheduler.cpp +10 -10
- package/src/wifi.cpp +2 -2
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
#include <Arduino.h>
|
|
2
|
+
#include "painlessMesh.h"
|
|
3
|
+
#include <PubSubClient.h>
|
|
4
|
+
#include "mqtt_command_bridge.hpp"
|
|
5
|
+
#include "mesh_topology_reporter.hpp"
|
|
6
|
+
#include "mesh_event_publisher.hpp"
|
|
7
|
+
|
|
8
|
+
// Mesh configuration
|
|
9
|
+
#define MESH_PREFIX "AlteriomMesh"
|
|
10
|
+
#define MESH_PASSWORD "somethingSneaky"
|
|
11
|
+
#define MESH_PORT 5555
|
|
12
|
+
|
|
13
|
+
// WiFi configuration
|
|
14
|
+
#define STATION_SSID "YourWiFi"
|
|
15
|
+
#define STATION_PASSWORD "YourPassword"
|
|
16
|
+
|
|
17
|
+
// MQTT configuration
|
|
18
|
+
#define MQTT_BROKER_IP "192.168.1.100"
|
|
19
|
+
#define MQTT_BROKER_PORT 1883
|
|
20
|
+
#define MQTT_CLIENT_ID "painlessMesh-commandBridge"
|
|
21
|
+
|
|
22
|
+
Scheduler userScheduler;
|
|
23
|
+
painlessMesh mesh;
|
|
24
|
+
WiFiClient wifiClient;
|
|
25
|
+
PubSubClient mqttClient(wifiClient);
|
|
26
|
+
MqttCommandBridge* commandBridge;
|
|
27
|
+
MeshTopologyReporter* topologyReporter;
|
|
28
|
+
MeshEventPublisher* eventPublisher;
|
|
29
|
+
|
|
30
|
+
// Task for MQTT reconnection
|
|
31
|
+
Task taskMqttReconnect(TASK_SECOND * 5, TASK_FOREVER, []() {
|
|
32
|
+
if (!mqttClient.connected()) {
|
|
33
|
+
Serial.println("MQTT disconnected, reconnecting...");
|
|
34
|
+
if (mqttClient.connect(MQTT_CLIENT_ID)) {
|
|
35
|
+
Serial.println("MQTT reconnected!");
|
|
36
|
+
commandBridge->begin(); // Re-subscribe to topics
|
|
37
|
+
} else {
|
|
38
|
+
Serial.printf("MQTT reconnect failed, rc=%d\n", mqttClient.state());
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
// Task for periodic gateway status
|
|
44
|
+
Task taskGatewayStatus(TASK_MINUTE, TASK_FOREVER, []() {
|
|
45
|
+
if (mqttClient.connected()) {
|
|
46
|
+
DynamicJsonDocument status(512);
|
|
47
|
+
status["gateway_id"] = mesh.getNodeId();
|
|
48
|
+
status["status"] = "online";
|
|
49
|
+
status["uptime"] = millis() / 1000;
|
|
50
|
+
status["free_memory"] = ESP.getFreeHeap();
|
|
51
|
+
status["connected_nodes"] = mesh.getNodeList().size();
|
|
52
|
+
status["wifi_rssi"] = WiFi.RSSI();
|
|
53
|
+
|
|
54
|
+
String payload;
|
|
55
|
+
serializeJson(status, payload);
|
|
56
|
+
|
|
57
|
+
mqttClient.publish("mesh/gateway/status", payload.c_str());
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
// Task for topology updates (full topology every 60 seconds)
|
|
62
|
+
Task taskTopology(TASK_SECOND * 60, TASK_FOREVER, []() {
|
|
63
|
+
if (mqttClient.connected() && topologyReporter != nullptr) {
|
|
64
|
+
Serial.println("[Topology] Publishing full mesh topology...");
|
|
65
|
+
|
|
66
|
+
String topology = topologyReporter->generateFullTopology();
|
|
67
|
+
bool success = mqttClient.publish("alteriom/mesh/MESH-001/topology", topology.c_str());
|
|
68
|
+
|
|
69
|
+
if (success) {
|
|
70
|
+
Serial.printf("[Topology] ✅ Published (%d bytes)\n", topology.length());
|
|
71
|
+
} else {
|
|
72
|
+
Serial.println("[Topology] ❌ Failed to publish (message too large or MQTT error)");
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
// Task for incremental topology updates (check every 5 seconds)
|
|
78
|
+
Task taskTopologyIncremental(TASK_SECOND * 5, TASK_FOREVER, []() {
|
|
79
|
+
if (mqttClient.connected() && topologyReporter != nullptr) {
|
|
80
|
+
if (topologyReporter->hasTopologyChanged()) {
|
|
81
|
+
Serial.println("[Topology] Topology changed, publishing incremental update...");
|
|
82
|
+
|
|
83
|
+
String topology = topologyReporter->generateFullTopology();
|
|
84
|
+
bool success = mqttClient.publish("alteriom/mesh/MESH-001/topology", topology.c_str());
|
|
85
|
+
|
|
86
|
+
if (success) {
|
|
87
|
+
Serial.printf("[Topology] ✅ Published incremental update (%d bytes)\n", topology.length());
|
|
88
|
+
} else {
|
|
89
|
+
Serial.println("[Topology] ❌ Failed to publish incremental update");
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
void setup() {
|
|
96
|
+
Serial.begin(115200);
|
|
97
|
+
|
|
98
|
+
Serial.println("\n\n=================================");
|
|
99
|
+
Serial.println("MQTT Command Bridge for painlessMesh");
|
|
100
|
+
Serial.println("=================================\n");
|
|
101
|
+
|
|
102
|
+
// Initialize mesh as bridge (root node)
|
|
103
|
+
mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
|
|
104
|
+
mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT, WIFI_AP_STA);
|
|
105
|
+
mesh.setRoot(true);
|
|
106
|
+
mesh.setContainsRoot(true);
|
|
107
|
+
|
|
108
|
+
// Connect to WiFi station
|
|
109
|
+
Serial.printf("Connecting to WiFi: %s\n", STATION_SSID);
|
|
110
|
+
mesh.stationManual(STATION_SSID, STATION_PASSWORD);
|
|
111
|
+
|
|
112
|
+
// Wait for WiFi connection
|
|
113
|
+
int attempts = 0;
|
|
114
|
+
while (WiFi.status() != WL_CONNECTED && attempts < 20) {
|
|
115
|
+
delay(500);
|
|
116
|
+
Serial.print(".");
|
|
117
|
+
attempts++;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
if (WiFi.status() == WL_CONNECTED) {
|
|
121
|
+
Serial.printf("\nWiFi connected!\n");
|
|
122
|
+
Serial.printf("IP Address: %s\n", WiFi.localIP().toString().c_str());
|
|
123
|
+
Serial.printf("RSSI: %d dBm\n", WiFi.RSSI());
|
|
124
|
+
} else {
|
|
125
|
+
Serial.println("\nWiFi connection failed!");
|
|
126
|
+
Serial.println("Bridge will continue with mesh-only mode");
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// Configure MQTT
|
|
130
|
+
mqttClient.setServer(MQTT_BROKER_IP, MQTT_BROKER_PORT);
|
|
131
|
+
mqttClient.setBufferSize(2048); // Increase buffer for larger messages
|
|
132
|
+
|
|
133
|
+
// Connect to MQTT broker
|
|
134
|
+
Serial.printf("\nConnecting to MQTT broker: %s:%d\n", MQTT_BROKER_IP, MQTT_BROKER_PORT);
|
|
135
|
+
|
|
136
|
+
int mqttAttempts = 0;
|
|
137
|
+
while (!mqttClient.connected() && mqttAttempts < 10) {
|
|
138
|
+
Serial.print("Attempting MQTT connection...");
|
|
139
|
+
|
|
140
|
+
if (mqttClient.connect(MQTT_CLIENT_ID)) {
|
|
141
|
+
Serial.println("connected!");
|
|
142
|
+
} else {
|
|
143
|
+
Serial.printf("failed, rc=%d\n", mqttClient.state());
|
|
144
|
+
Serial.println("Error codes: -4=timeout, -3=conn lost, -2=conn failed, -1=disconnected");
|
|
145
|
+
delay(2000);
|
|
146
|
+
mqttAttempts++;
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
if (!mqttClient.connected()) {
|
|
151
|
+
Serial.println("WARNING: MQTT connection failed, bridge will retry");
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
// Initialize topology reporter and event publisher first
|
|
155
|
+
topologyReporter = new MeshTopologyReporter(mesh, "MESH-001", "GW 2.3.4");
|
|
156
|
+
eventPublisher = new MeshEventPublisher(mesh, mqttClient, "MESH-001", "alteriom/mesh/MESH-001/events", "GW 2.3.4");
|
|
157
|
+
|
|
158
|
+
Serial.println("\n✅ Topology Reporter initialized");
|
|
159
|
+
Serial.println("✅ Event Publisher initialized");
|
|
160
|
+
|
|
161
|
+
// Initialize bidirectional MQTT-mesh bridge with topology reporter
|
|
162
|
+
commandBridge = new MqttCommandBridge(mesh, mqttClient, topologyReporter);
|
|
163
|
+
commandBridge->setMqttCallback();
|
|
164
|
+
commandBridge->setMeshCallback();
|
|
165
|
+
commandBridge->begin();
|
|
166
|
+
|
|
167
|
+
// Add background tasks
|
|
168
|
+
userScheduler.addTask(taskMqttReconnect);
|
|
169
|
+
userScheduler.addTask(taskGatewayStatus);
|
|
170
|
+
userScheduler.addTask(taskTopology);
|
|
171
|
+
userScheduler.addTask(taskTopologyIncremental);
|
|
172
|
+
|
|
173
|
+
taskMqttReconnect.enable();
|
|
174
|
+
taskGatewayStatus.enable();
|
|
175
|
+
taskTopology.enable();
|
|
176
|
+
taskTopologyIncremental.enable();
|
|
177
|
+
|
|
178
|
+
// Mesh callbacks with schema-compliant event publishing
|
|
179
|
+
mesh.onNewConnection([](uint32_t nodeId) {
|
|
180
|
+
Serial.printf("[Mesh] 🔗 New node connected: %u\n", nodeId);
|
|
181
|
+
|
|
182
|
+
// Publish schema-compliant node join event
|
|
183
|
+
if (eventPublisher != nullptr) {
|
|
184
|
+
eventPublisher->publishNodeJoin(nodeId);
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// Publish incremental topology update
|
|
188
|
+
if (mqttClient.connected() && topologyReporter != nullptr) {
|
|
189
|
+
String topology = topologyReporter->generateIncrementalUpdate(nodeId, true);
|
|
190
|
+
mqttClient.publish("alteriom/mesh/MESH-001/topology", topology.c_str());
|
|
191
|
+
Serial.println("[Topology] Published incremental update (node join)");
|
|
192
|
+
}
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
mesh.onDroppedConnection([](uint32_t nodeId) {
|
|
196
|
+
Serial.printf("[Mesh] ⚠️ Node disconnected: %u\n", nodeId);
|
|
197
|
+
|
|
198
|
+
// Publish schema-compliant node leave event
|
|
199
|
+
if (eventPublisher != nullptr) {
|
|
200
|
+
eventPublisher->publishNodeLeave(nodeId);
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
// Publish incremental topology update
|
|
204
|
+
if (mqttClient.connected() && topologyReporter != nullptr) {
|
|
205
|
+
String topology = topologyReporter->generateIncrementalUpdate(nodeId, false);
|
|
206
|
+
mqttClient.publish("alteriom/mesh/MESH-001/topology", topology.c_str());
|
|
207
|
+
Serial.println("[Topology] Published incremental update (node leave)");
|
|
208
|
+
}
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
Serial.println("\n=== MQTT Command Bridge Ready ===");
|
|
212
|
+
Serial.printf("Gateway ID: %u\n", mesh.getNodeId());
|
|
213
|
+
Serial.printf("Connected Nodes: %d\n", mesh.getNodeList().size());
|
|
214
|
+
Serial.println("\nMQTT Topics:");
|
|
215
|
+
Serial.println(" Commands IN:");
|
|
216
|
+
Serial.println(" - mesh/command/{nodeId}");
|
|
217
|
+
Serial.println(" - mesh/command/broadcast");
|
|
218
|
+
Serial.println(" - mesh/config/{nodeId}/get");
|
|
219
|
+
Serial.println(" - mesh/config/{nodeId}/set");
|
|
220
|
+
Serial.println(" Messages OUT:");
|
|
221
|
+
Serial.println(" - mesh/response/{nodeId}");
|
|
222
|
+
Serial.println(" - mesh/status/{nodeId}");
|
|
223
|
+
Serial.println(" - mesh/sensor/{nodeId}");
|
|
224
|
+
Serial.println(" - mesh/health/{nodeId}");
|
|
225
|
+
Serial.println(" - mesh/gateway/status");
|
|
226
|
+
Serial.println(" - alteriom/mesh/MESH-001/topology (schema v0.5.0)");
|
|
227
|
+
Serial.println(" - alteriom/mesh/MESH-001/events (schema v0.5.0)");
|
|
228
|
+
Serial.println("\nSchema Compliance:");
|
|
229
|
+
Serial.println(" ✅ @alteriom/mqtt-schema v0.5.0");
|
|
230
|
+
Serial.println(" ✅ mesh_topology.schema.json");
|
|
231
|
+
Serial.println(" ✅ mesh_event.schema.json");
|
|
232
|
+
Serial.println("\nBridge is now listening for commands...\n");
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
void loop() {
|
|
236
|
+
mesh.update();
|
|
237
|
+
|
|
238
|
+
// Process MQTT messages
|
|
239
|
+
if (mqttClient.connected()) {
|
|
240
|
+
mqttClient.loop();
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
// Handle WiFi reconnection
|
|
244
|
+
if (WiFi.status() != WL_CONNECTED) {
|
|
245
|
+
static unsigned long lastReconnectAttempt = 0;
|
|
246
|
+
if (millis() - lastReconnectAttempt > 30000) {
|
|
247
|
+
Serial.println("WiFi disconnected, attempting reconnect...");
|
|
248
|
+
WiFi.reconnect();
|
|
249
|
+
lastReconnectAttempt = millis();
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
}
|
|
@@ -0,0 +1,459 @@
|
|
|
1
|
+
#ifndef MQTT_COMMAND_BRIDGE_HPP
|
|
2
|
+
#define MQTT_COMMAND_BRIDGE_HPP
|
|
3
|
+
|
|
4
|
+
#include "painlessMesh.h"
|
|
5
|
+
#include <PubSubClient.h>
|
|
6
|
+
#include "alteriom_sensor_package.hpp"
|
|
7
|
+
#include "mesh_topology_reporter.hpp"
|
|
8
|
+
|
|
9
|
+
using namespace alteriom;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* @brief Bidirectional MQTT-Mesh Command Bridge
|
|
13
|
+
*
|
|
14
|
+
* Enables MQTT control of mesh devices and mesh status reporting to MQTT.
|
|
15
|
+
* Supports command forwarding, configuration management, and response routing.
|
|
16
|
+
*/
|
|
17
|
+
class MqttCommandBridge {
|
|
18
|
+
private:
|
|
19
|
+
painlessMesh& mesh;
|
|
20
|
+
PubSubClient& mqtt;
|
|
21
|
+
String gatewayId;
|
|
22
|
+
MeshTopologyReporter* topologyReporter;
|
|
23
|
+
|
|
24
|
+
// Command definitions matching MQTT_BRIDGE_COMMANDS.md
|
|
25
|
+
enum Commands {
|
|
26
|
+
// Device Control (1-99)
|
|
27
|
+
RESET = 1,
|
|
28
|
+
SLEEP = 2,
|
|
29
|
+
WAKE = 3,
|
|
30
|
+
LED_CONTROL = 10,
|
|
31
|
+
RELAY_SWITCH = 11,
|
|
32
|
+
PWM_SET = 12,
|
|
33
|
+
SENSOR_ENABLE = 20,
|
|
34
|
+
SENSOR_CALIBRATE = 21,
|
|
35
|
+
|
|
36
|
+
// Configuration (100-199)
|
|
37
|
+
GET_CONFIG = 100,
|
|
38
|
+
SET_CONFIG = 101,
|
|
39
|
+
RESET_CONFIG = 102,
|
|
40
|
+
SAVE_CONFIG = 103,
|
|
41
|
+
SET_SAMPLE_RATE = 110,
|
|
42
|
+
SET_DEVICE_NAME = 111,
|
|
43
|
+
|
|
44
|
+
// Status (200-255)
|
|
45
|
+
GET_STATUS = 200,
|
|
46
|
+
GET_METRICS = 201,
|
|
47
|
+
GET_DIAGNOSTICS = 202,
|
|
48
|
+
START_MONITORING = 210,
|
|
49
|
+
STOP_MONITORING = 211,
|
|
50
|
+
|
|
51
|
+
// Topology (300-399)
|
|
52
|
+
GET_TOPOLOGY = 300
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
public:
|
|
56
|
+
MqttCommandBridge(painlessMesh& m, PubSubClient& mq, MeshTopologyReporter* reporter = nullptr)
|
|
57
|
+
: mesh(m), mqtt(mq), topologyReporter(reporter) {
|
|
58
|
+
gatewayId = String(mesh.getNodeId());
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @brief Set topology reporter instance
|
|
63
|
+
*/
|
|
64
|
+
void setTopologyReporter(MeshTopologyReporter* reporter) {
|
|
65
|
+
topologyReporter = reporter;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* @brief Initialize the bridge with topic subscriptions and callbacks
|
|
70
|
+
*/
|
|
71
|
+
void begin() {
|
|
72
|
+
// Subscribe to command topics
|
|
73
|
+
String cmdTopic = "mesh/command/" + gatewayId;
|
|
74
|
+
mqtt.subscribe(cmdTopic.c_str());
|
|
75
|
+
mqtt.subscribe("mesh/command/broadcast");
|
|
76
|
+
|
|
77
|
+
String configGetTopic = "mesh/config/" + gatewayId + "/get";
|
|
78
|
+
mqtt.subscribe(configGetTopic.c_str());
|
|
79
|
+
|
|
80
|
+
String configSetTopic = "mesh/config/" + gatewayId + "/set";
|
|
81
|
+
mqtt.subscribe(configSetTopic.c_str());
|
|
82
|
+
|
|
83
|
+
Serial.printf("MQTT Command Bridge initialized - Gateway ID: %s\n", gatewayId.c_str());
|
|
84
|
+
Serial.println("Subscribed topics:");
|
|
85
|
+
Serial.printf(" - %s\n", cmdTopic.c_str());
|
|
86
|
+
Serial.println(" - mesh/command/broadcast");
|
|
87
|
+
Serial.printf(" - %s\n", configGetTopic.c_str());
|
|
88
|
+
Serial.printf(" - %s\n", configSetTopic.c_str());
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* @brief Set MQTT callback for incoming messages
|
|
93
|
+
*/
|
|
94
|
+
void setMqttCallback() {
|
|
95
|
+
mqtt.setCallback([this](char* topic, byte* payload, unsigned int length) {
|
|
96
|
+
this->onMqttMessage(topic, payload, length);
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* @brief Set mesh received callback for outgoing messages
|
|
102
|
+
*/
|
|
103
|
+
void setMeshCallback() {
|
|
104
|
+
mesh.onReceive([this](uint32_t from, String& msg) {
|
|
105
|
+
this->onMeshMessage(from, msg);
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* @brief Handle incoming MQTT messages
|
|
111
|
+
*/
|
|
112
|
+
void onMqttMessage(char* topic, byte* payload, unsigned int length) {
|
|
113
|
+
String topicStr = String(topic);
|
|
114
|
+
|
|
115
|
+
// Parse JSON payload
|
|
116
|
+
JsonDocument doc;
|
|
117
|
+
DeserializationError error = deserializeJson(doc, payload, length);
|
|
118
|
+
|
|
119
|
+
if (error) {
|
|
120
|
+
Serial.printf("JSON parse error: %s\n", error.c_str());
|
|
121
|
+
return;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
Serial.printf("MQTT message on %s\n", topic);
|
|
125
|
+
|
|
126
|
+
if (topicStr.indexOf("/command/") >= 0) {
|
|
127
|
+
forwardCommandToMesh(doc);
|
|
128
|
+
}
|
|
129
|
+
else if (topicStr.endsWith("/get")) {
|
|
130
|
+
handleConfigRequest(doc);
|
|
131
|
+
}
|
|
132
|
+
else if (topicStr.endsWith("/set")) {
|
|
133
|
+
handleConfigUpdate(doc);
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* @brief Forward MQTT command to mesh network
|
|
139
|
+
*/
|
|
140
|
+
void forwardCommandToMesh(JsonDocument& doc) {
|
|
141
|
+
// Create CommandPackage
|
|
142
|
+
CommandPackage cmd;
|
|
143
|
+
cmd.command = doc["command"];
|
|
144
|
+
cmd.targetDevice = doc["targetDevice"];
|
|
145
|
+
cmd.commandId = doc["commandId"] | millis(); // Generate if missing
|
|
146
|
+
cmd.parameters = doc["parameters"].as<String>();
|
|
147
|
+
cmd.from = mesh.getNodeId();
|
|
148
|
+
cmd.dest = cmd.targetDevice;
|
|
149
|
+
|
|
150
|
+
Serial.printf("Command: cmd=%d, target=%u, id=%u\n",
|
|
151
|
+
cmd.command, cmd.targetDevice, cmd.commandId);
|
|
152
|
+
|
|
153
|
+
// Route based on target
|
|
154
|
+
if (cmd.targetDevice == 0 || cmd.targetDevice == mesh.getNodeId()) {
|
|
155
|
+
// Execute locally on gateway
|
|
156
|
+
executeCommand(cmd);
|
|
157
|
+
} else {
|
|
158
|
+
// Forward to mesh node
|
|
159
|
+
auto variant = painlessmesh::protocol::Variant(&cmd);
|
|
160
|
+
String message;
|
|
161
|
+
variant.printTo(message);
|
|
162
|
+
|
|
163
|
+
mesh.sendSingle(cmd.targetDevice, message);
|
|
164
|
+
Serial.printf("Command forwarded to node %u\n", cmd.targetDevice);
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* @brief Execute command locally on gateway
|
|
170
|
+
*/
|
|
171
|
+
void executeCommand(const CommandPackage& cmd) {
|
|
172
|
+
Serial.printf("Executing command: %d\n", cmd.command);
|
|
173
|
+
|
|
174
|
+
StatusPackage response;
|
|
175
|
+
response.from = mesh.getNodeId();
|
|
176
|
+
response.responseToCommand = cmd.commandId;
|
|
177
|
+
response.deviceStatus = 0; // OK
|
|
178
|
+
|
|
179
|
+
switch(cmd.command) {
|
|
180
|
+
case RESET:
|
|
181
|
+
response.responseMessage = "Rebooting...";
|
|
182
|
+
sendResponse(response);
|
|
183
|
+
delay(1000);
|
|
184
|
+
ESP.restart();
|
|
185
|
+
break;
|
|
186
|
+
|
|
187
|
+
case SLEEP: {
|
|
188
|
+
JsonDocument params;
|
|
189
|
+
deserializeJson(params, cmd.parameters);
|
|
190
|
+
uint32_t duration = params["duration_ms"];
|
|
191
|
+
|
|
192
|
+
response.responseMessage = "Entering sleep for " + String(duration) + "ms";
|
|
193
|
+
sendResponse(response);
|
|
194
|
+
|
|
195
|
+
ESP.deepSleep(duration * 1000);
|
|
196
|
+
break;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
case LED_CONTROL: {
|
|
200
|
+
JsonDocument params;
|
|
201
|
+
deserializeJson(params, cmd.parameters);
|
|
202
|
+
|
|
203
|
+
bool state = params["state"];
|
|
204
|
+
uint8_t brightness = params["brightness"] | 255;
|
|
205
|
+
|
|
206
|
+
// Control LED
|
|
207
|
+
digitalWrite(LED_BUILTIN, state ? LOW : HIGH);
|
|
208
|
+
|
|
209
|
+
response.responseMessage = "LED " + String(state ? "ON" : "OFF");
|
|
210
|
+
sendResponse(response);
|
|
211
|
+
break;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
case GET_CONFIG:
|
|
215
|
+
sendConfiguration();
|
|
216
|
+
break;
|
|
217
|
+
|
|
218
|
+
case GET_STATUS:
|
|
219
|
+
sendStatus();
|
|
220
|
+
break;
|
|
221
|
+
|
|
222
|
+
case GET_METRICS:
|
|
223
|
+
sendMetrics();
|
|
224
|
+
break;
|
|
225
|
+
|
|
226
|
+
case GET_TOPOLOGY:
|
|
227
|
+
sendTopology(cmd.commandId);
|
|
228
|
+
break;
|
|
229
|
+
|
|
230
|
+
default:
|
|
231
|
+
response.deviceStatus = 2; // Error
|
|
232
|
+
response.responseMessage = "Unknown command: " + String(cmd.command);
|
|
233
|
+
sendResponse(response);
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* @brief Handle incoming mesh messages and forward to MQTT
|
|
239
|
+
*/
|
|
240
|
+
void onMeshMessage(uint32_t from, String& msg) {
|
|
241
|
+
// Parse message
|
|
242
|
+
JsonDocument doc;
|
|
243
|
+
DeserializationError error = deserializeJson(doc, msg);
|
|
244
|
+
|
|
245
|
+
if (error) return;
|
|
246
|
+
|
|
247
|
+
uint8_t msgType = doc["type"];
|
|
248
|
+
|
|
249
|
+
// Forward mesh messages to MQTT based on type
|
|
250
|
+
switch(msgType) {
|
|
251
|
+
case 200: // SensorPackage
|
|
252
|
+
publishToMqtt("mesh/sensor/" + String(from), msg);
|
|
253
|
+
break;
|
|
254
|
+
|
|
255
|
+
case 202: // StatusPackage
|
|
256
|
+
// Check if it's a command response
|
|
257
|
+
if (doc.containsKey("respTo") && doc["respTo"] > 0) {
|
|
258
|
+
publishToMqtt("mesh/response/" + String(from), msg);
|
|
259
|
+
} else {
|
|
260
|
+
publishToMqtt("mesh/status/" + String(from), msg);
|
|
261
|
+
}
|
|
262
|
+
break;
|
|
263
|
+
|
|
264
|
+
case 203: // EnhancedStatusPackage
|
|
265
|
+
publishToMqtt("mesh/health/" + String(from), msg);
|
|
266
|
+
break;
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* @brief Send status response via MQTT
|
|
272
|
+
*/
|
|
273
|
+
void sendResponse(const StatusPackage& response) {
|
|
274
|
+
auto variant = painlessmesh::protocol::Variant(&response);
|
|
275
|
+
String message;
|
|
276
|
+
variant.printTo(message);
|
|
277
|
+
|
|
278
|
+
String topic = "mesh/response/" + String(response.from);
|
|
279
|
+
publishToMqtt(topic, message);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* @brief Send configuration via MQTT
|
|
284
|
+
*/
|
|
285
|
+
void sendConfiguration() {
|
|
286
|
+
JsonDocument config;
|
|
287
|
+
config["schema_version"] = 1;
|
|
288
|
+
config["device_id"] = gatewayId;
|
|
289
|
+
config["timestamp"] = getCurrentISO8601Timestamp();
|
|
290
|
+
|
|
291
|
+
JsonObject cfg = config["config"].to<JsonObject>();
|
|
292
|
+
cfg["deviceName"] = "Gateway-" + gatewayId;
|
|
293
|
+
cfg["firmwareVersion"] = "1.7.0-alteriom";
|
|
294
|
+
cfg["role"] = "gateway";
|
|
295
|
+
cfg["meshPrefix"] = "AlteriomMesh";
|
|
296
|
+
cfg["nodeCount"] = mesh.getNodeList().size();
|
|
297
|
+
|
|
298
|
+
String payload;
|
|
299
|
+
serializeJson(config, payload);
|
|
300
|
+
|
|
301
|
+
String topic = "mesh/config/" + gatewayId;
|
|
302
|
+
publishToMqtt(topic, payload);
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* @brief Send basic status via MQTT
|
|
307
|
+
*/
|
|
308
|
+
void sendStatus() {
|
|
309
|
+
StatusPackage status;
|
|
310
|
+
status.from = mesh.getNodeId();
|
|
311
|
+
status.deviceStatus = 0;
|
|
312
|
+
status.uptime = millis() / 1000;
|
|
313
|
+
status.freeMemory = ESP.getFreeHeap() / 1024;
|
|
314
|
+
status.wifiStrength = WiFi.RSSI();
|
|
315
|
+
status.firmwareVersion = "1.7.0-alteriom";
|
|
316
|
+
|
|
317
|
+
sendResponse(status);
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* @brief Send enhanced metrics via MQTT
|
|
322
|
+
*/
|
|
323
|
+
void sendMetrics() {
|
|
324
|
+
EnhancedStatusPackage metrics;
|
|
325
|
+
metrics.from = mesh.getNodeId();
|
|
326
|
+
metrics.deviceStatus = 0;
|
|
327
|
+
metrics.uptime = millis() / 1000;
|
|
328
|
+
metrics.freeMemory = ESP.getFreeHeap() / 1024;
|
|
329
|
+
metrics.wifiStrength = WiFi.RSSI();
|
|
330
|
+
metrics.firmwareVersion = "1.7.0-alteriom";
|
|
331
|
+
|
|
332
|
+
// Mesh statistics
|
|
333
|
+
auto nodeList = mesh.getNodeList();
|
|
334
|
+
metrics.nodeCount = nodeList.size();
|
|
335
|
+
metrics.connectionCount = mesh.getNodeList().size();
|
|
336
|
+
|
|
337
|
+
auto variant = painlessmesh::protocol::Variant(&metrics);
|
|
338
|
+
String message;
|
|
339
|
+
variant.printTo(message);
|
|
340
|
+
|
|
341
|
+
String topic = "mesh/health/" + String(metrics.from);
|
|
342
|
+
publishToMqtt(topic, message);
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* @brief Send mesh topology via MQTT (Command 300)
|
|
347
|
+
* @param commandId The command ID for correlation
|
|
348
|
+
*/
|
|
349
|
+
void sendTopology(uint32_t commandId) {
|
|
350
|
+
if (!topologyReporter) {
|
|
351
|
+
Serial.println("⚠️ Topology reporter not initialized");
|
|
352
|
+
|
|
353
|
+
StatusPackage response;
|
|
354
|
+
response.from = mesh.getNodeId();
|
|
355
|
+
response.responseToCommand = commandId;
|
|
356
|
+
response.deviceStatus = 2; // Error
|
|
357
|
+
response.responseMessage = "Topology reporter not available";
|
|
358
|
+
sendResponse(response);
|
|
359
|
+
return;
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
Serial.printf("📊 Generating topology for command %u\n", commandId);
|
|
363
|
+
String topology = topologyReporter->generateFullTopology();
|
|
364
|
+
|
|
365
|
+
// Parse to add correlation_id
|
|
366
|
+
JsonDocument doc;
|
|
367
|
+
DeserializationError error = deserializeJson(doc, topology);
|
|
368
|
+
|
|
369
|
+
if (error) {
|
|
370
|
+
Serial.printf("❌ Failed to parse topology: %s\n", error.c_str());
|
|
371
|
+
return;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
// Add correlation_id at root level
|
|
375
|
+
doc["correlation_id"] = String(commandId);
|
|
376
|
+
|
|
377
|
+
String payload;
|
|
378
|
+
serializeJson(doc, payload);
|
|
379
|
+
|
|
380
|
+
// Publish to response topic
|
|
381
|
+
String topic = "alteriom/mesh/MESH-001/topology/response";
|
|
382
|
+
publishToMqtt(topic, payload);
|
|
383
|
+
|
|
384
|
+
Serial.printf("✅ Topology sent (cmd=%u, size=%d bytes)\n", commandId, payload.length());
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* @brief Handle configuration request
|
|
389
|
+
*/
|
|
390
|
+
void handleConfigRequest(JsonDocument& doc) {
|
|
391
|
+
sendConfiguration();
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* @brief Handle configuration update
|
|
396
|
+
*/
|
|
397
|
+
void handleConfigUpdate(JsonDocument& doc) {
|
|
398
|
+
JsonObject config = doc["config"];
|
|
399
|
+
|
|
400
|
+
// Apply configuration updates
|
|
401
|
+
if (config.containsKey("deviceName")) {
|
|
402
|
+
String newName = config["deviceName"];
|
|
403
|
+
Serial.printf("Config update: deviceName=%s\n", newName.c_str());
|
|
404
|
+
// Store to preferences/EEPROM in production
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
if (config.containsKey("meshPrefix")) {
|
|
408
|
+
String newPrefix = config["meshPrefix"];
|
|
409
|
+
Serial.printf("Config update: meshPrefix=%s (requires restart)\n", newPrefix.c_str());
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
// Send acknowledgment
|
|
413
|
+
JsonDocument ack;
|
|
414
|
+
ack["status"] = "success";
|
|
415
|
+
ack["device_id"] = gatewayId;
|
|
416
|
+
ack["message"] = "Configuration updated";
|
|
417
|
+
ack["timestamp"] = getCurrentISO8601Timestamp();
|
|
418
|
+
|
|
419
|
+
String payload;
|
|
420
|
+
serializeJson(ack, payload);
|
|
421
|
+
|
|
422
|
+
String topic = "mesh/response/" + gatewayId;
|
|
423
|
+
publishToMqtt(topic, payload);
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* @brief Publish message to MQTT broker
|
|
428
|
+
*/
|
|
429
|
+
void publishToMqtt(const String& topic, const String& payload) {
|
|
430
|
+
if (mqtt.connected()) {
|
|
431
|
+
bool success = mqtt.publish(topic.c_str(), payload.c_str());
|
|
432
|
+
if (success) {
|
|
433
|
+
Serial.printf("MQTT published: %s\n", topic.c_str());
|
|
434
|
+
} else {
|
|
435
|
+
Serial.printf("MQTT publish failed: %s\n", topic.c_str());
|
|
436
|
+
}
|
|
437
|
+
} else {
|
|
438
|
+
Serial.println("MQTT not connected, cannot publish");
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
private:
|
|
443
|
+
/**
|
|
444
|
+
* @brief Get current ISO8601 timestamp
|
|
445
|
+
* Note: Simple implementation, enhance with NTP for production
|
|
446
|
+
*/
|
|
447
|
+
String getCurrentISO8601Timestamp() {
|
|
448
|
+
unsigned long seconds = millis() / 1000;
|
|
449
|
+
char timestamp[25];
|
|
450
|
+
snprintf(timestamp, sizeof(timestamp),
|
|
451
|
+
"1970-01-01T%02lu:%02lu:%02luZ",
|
|
452
|
+
(seconds / 3600) % 24,
|
|
453
|
+
(seconds / 60) % 60,
|
|
454
|
+
seconds % 60);
|
|
455
|
+
return String(timestamp);
|
|
456
|
+
}
|
|
457
|
+
};
|
|
458
|
+
|
|
459
|
+
#endif // MQTT_COMMAND_BRIDGE_HPP
|