@alteriom/painlessmesh 1.8.14 → 1.9.0

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.
Files changed (208) hide show
  1. package/BRIDGE_TO_INTERNET.md +229 -0
  2. package/CHANGELOG.md +89 -1
  3. package/CONTRIBUTING.md +79 -0
  4. package/README.md +70 -143
  5. package/docs/README.md +1 -0
  6. package/docs/api/shared-gateway.md +1207 -0
  7. package/docs/troubleshooting/common-issues.md +28 -0
  8. package/docs/troubleshooting/faq.md +113 -12
  9. package/examples/basic/test/simulator/CMakeLists.txt +40 -0
  10. package/examples/basic/test/simulator/README.md +149 -0
  11. package/examples/basic/test/simulator/firmware/basic_firmware.hpp +117 -0
  12. package/examples/basic/test/simulator/scenarios/basic_mesh_test.yaml +81 -0
  13. package/examples/bridge/bridge.ino +17 -4
  14. package/examples/bridge_failover/README.md +81 -0
  15. package/examples/bridge_failover/bridge_failover.ino +51 -6
  16. package/examples/sharedGateway/README.md +235 -0
  17. package/examples/{meshCommandNode → sharedGateway}/platformio.ini +3 -2
  18. package/examples/sharedGateway/sharedGateway.ino +303 -0
  19. package/library.json +3 -22
  20. package/library.properties +1 -1
  21. package/package.json +3 -3
  22. package/src/arduino/wifi.hpp +380 -13
  23. package/src/painlessmesh/gateway.hpp +2120 -0
  24. package/src/painlessmesh/mesh.hpp +1034 -6
  25. package/src/painlessmesh/message_tracker.hpp +311 -0
  26. package/src/painlessmesh/protocol.hpp +6 -0
  27. package/DOCUMENTATION_INDEX.md +0 -146
  28. package/docs/API_DESIGN_GUIDELINES.md +0 -414
  29. package/docs/ARDUINO_LIBRARY_MANAGER_SUBMISSION.md +0 -331
  30. package/docs/BOOLEAN_NAMING_CONVENTION.md +0 -235
  31. package/docs/BRIDGE_FAILOVER.md +0 -512
  32. package/docs/BRIDGE_HEALTH_MONITORING.md +0 -293
  33. package/docs/CHANNEL_SYNCHRONIZATION.md +0 -209
  34. package/docs/CREATE_MISSING_RELEASES.md +0 -321
  35. package/docs/DOCUMENTATION_MIGRATION_PLAN.md +0 -176
  36. package/docs/FAQ_VERSION_NUMBERS.md +0 -152
  37. package/docs/IMPLEMENTATION_PLAN_MESH_TOPOLOGY.md +0 -1062
  38. package/docs/MESH_TOPOLOGY_GUIDE.md +0 -992
  39. package/docs/MESH_TOPOLOGY_PROGRESS.md +0 -422
  40. package/docs/MQTT_BRIDGE_COMMANDS.md +0 -894
  41. package/docs/MQTT_BRIDGE_IMPLEMENTATION_SUMMARY.md +0 -324
  42. package/docs/MQTT_COMMAND_SCHEMA_PROPOSAL.md +0 -576
  43. package/docs/MQTT_SCHEMA_COMPLIANCE.md +0 -340
  44. package/docs/MQTT_SCHEMA_PROPOSALS.md +0 -446
  45. package/docs/MQTT_SCHEMA_REVIEW.md +0 -690
  46. package/docs/OTA_COMMANDS_REFERENCE.md +0 -554
  47. package/docs/PHASE1_GUIDE.md +0 -349
  48. package/docs/PHASE2_GUIDE.md +0 -543
  49. package/docs/QUICK_REFERENCE_VERSIONING.md +0 -127
  50. package/docs/RELEASE_AGENT_SUMMARY.md +0 -386
  51. package/docs/SCHEMA_VALIDATION_CHECKLIST.md +0 -222
  52. package/docs/VERSION_MANAGEMENT.md +0 -213
  53. package/docs/archive/DOCUSAURUS_DEPLOYMENT.md +0 -166
  54. package/docs/archive/FEATURE_PROPOSALS.md +0 -337
  55. package/docs/archive/LIBRARY_JSON_FIX.md +0 -98
  56. package/docs/archive/LIBRARY_STRUCTURE_FIX.md +0 -215
  57. package/docs/archive/PHASE1_IMPLEMENTATION.md +0 -325
  58. package/docs/archive/PHASE2_IMPLEMENTATION.md +0 -567
  59. package/docs/archive/RELEASE_SUMMARY.md +0 -173
  60. package/docs/archive/SCONS_BUILD_FIX.md +0 -313
  61. package/docs/archive/TRIGGER_RELEASE.md +0 -280
  62. package/docs/archive/VECTOR_INCLUDE_FIX.md +0 -129
  63. package/docs/archive/ota-and-status-enhancements.md +0 -911
  64. package/docs/archive/ota-status-architecture-diagrams.md +0 -658
  65. package/docs/archive/ota-status-quick-reference.md +0 -284
  66. package/docs/design/.gitkeep +0 -1
  67. package/docs/design/STATION_CREDENTIALS_DESIGN.md +0 -182
  68. package/docs/development/ARDUINO_COMPLIANCE_SUMMARY.md +0 -71
  69. package/docs/development/CODE_REFACTORING_RECOMMENDATIONS.md +0 -1011
  70. package/docs/development/DOCKER_TESTING.md +0 -196
  71. package/docs/development/PLATFORMIO_USAGE.md +0 -180
  72. package/docs/development/TESTING_SUMMARY.md +0 -126
  73. package/docs/development/contributing.md +0 -301
  74. package/docs/development/documentation.md +0 -583
  75. package/docs/features/DIAGNOSTICS_API.md +0 -534
  76. package/docs/implementation/BRIDGE_ARCHITECTURE_IMPLEMENTATION.md +0 -340
  77. package/docs/implementation/BRIDGE_HEALTH_MONITORING_IMPLEMENTATION.md +0 -213
  78. package/docs/implementation/BRIDGE_STATUS_FEATURE.md +0 -635
  79. package/docs/implementation/DIAGNOSTICS_API_IMPLEMENTATION.md +0 -232
  80. package/docs/implementation/IMPLEMENTATION_COMPLETE.md +0 -228
  81. package/docs/implementation/IMPLEMENTATION_NTP_TIME_SYNC.md +0 -325
  82. package/docs/implementation/IMPLEMENTATION_SUMMARY.md +0 -316
  83. package/docs/implementation/MESSAGE_QUEUE_IMPLEMENTATION.md +0 -405
  84. package/docs/implementation/MULTI_BRIDGE_IMPLEMENTATION.md +0 -520
  85. package/docs/implementation/NTP_TIME_SYNC_FEATURE.md +0 -392
  86. package/docs/improvements/FUTURE_PROPOSALS.md +0 -1016
  87. package/docs/improvements/IMPLEMENTATION_HISTORY.md +0 -1091
  88. package/docs/improvements/OTA_STATUS_ENHANCEMENTS.md +0 -709
  89. package/docs/improvements/README.md +0 -212
  90. package/docs/internal/CUSTOM_AGENT_ANALYSIS.md +0 -391
  91. package/docs/internal/ISSUE_65_VERIFICATION.md +0 -947
  92. package/docs/internal/ISSUE_66_CLOSURE.md +0 -249
  93. package/docs/internal/ISSUE_66_STATUS.md +0 -316
  94. package/docs/internal/PR_SUMMARY.md +0 -315
  95. package/docs/internal/REVIEW_SUMMARY.md +0 -332
  96. package/docs/multi-bridge-setup.md +0 -1025
  97. package/docs/platformio-publishing.md +0 -255
  98. package/docs/platformio-setup-summary.md +0 -121
  99. package/docs/releases/ANNOUNCEMENT_v1.8.6.md +0 -63
  100. package/docs/releases/ANNOUNCEMENT_v1.8.7.md +0 -113
  101. package/docs/releases/BRIDGE_STATUS_SELF_REGISTRATION_FIX.md +0 -221
  102. package/docs/releases/FEATURE_HISTORY.md +0 -543
  103. package/docs/releases/GITHUB_RELEASE_v1.8.6.md +0 -71
  104. package/docs/releases/GITHUB_RELEASE_v1.8.7.md +0 -90
  105. package/docs/releases/PATCH_v1.7.2.md +0 -262
  106. package/docs/releases/PATCH_v1.7.3.md +0 -262
  107. package/docs/releases/PATCH_v1.7.4.md +0 -219
  108. package/docs/releases/PHASE1_SUMMARY.md +0 -246
  109. package/docs/releases/PHASE2_SUMMARY.md +0 -499
  110. package/docs/releases/PUBLISH_v1.8.0_INSTRUCTIONS.md +0 -163
  111. package/docs/releases/QUICK_START_RELEASES.md +0 -113
  112. package/docs/releases/RELEASE_CHECKLIST_1.8.10.md +0 -331
  113. package/docs/releases/RELEASE_CHECKLIST_1.8.9.md +0 -207
  114. package/docs/releases/RELEASE_CHECKLIST_v1.7.4.md +0 -253
  115. package/docs/releases/RELEASE_CHECKLIST_v1.7.5.md +0 -315
  116. package/docs/releases/RELEASE_CHECKLIST_v1.7.6.md +0 -389
  117. package/docs/releases/RELEASE_CHECKLIST_v1.8.0.md +0 -331
  118. package/docs/releases/RELEASE_CHECKLIST_v1.8.2.md +0 -309
  119. package/docs/releases/RELEASE_NOTES_1.7.0.md +0 -539
  120. package/docs/releases/RELEASE_NOTES_1.8.10.md +0 -239
  121. package/docs/releases/RELEASE_NOTES_1.8.9.md +0 -213
  122. package/docs/releases/RELEASE_NOTES_v1.8.0.md +0 -685
  123. package/docs/releases/RELEASE_NOTES_v1.8.1.md +0 -221
  124. package/docs/releases/RELEASE_NOTES_v1.8.2.md +0 -421
  125. package/docs/releases/RELEASE_NOTES_v1.8.3.md +0 -292
  126. package/docs/releases/RELEASE_NOTES_v1.8.4.md +0 -277
  127. package/docs/releases/RELEASE_NOTES_v1.8.6.md +0 -205
  128. package/docs/releases/RELEASE_NOTES_v1.8.7.md +0 -184
  129. package/docs/releases/RELEASE_PLAN_v1.7.6.md +0 -816
  130. package/docs/releases/RELEASE_SUMMARY_1.8.10.md +0 -193
  131. package/docs/releases/RELEASE_SUMMARY_v1.7.4.md +0 -276
  132. package/docs/releases/RELEASE_SUMMARY_v1.7.5.md +0 -322
  133. package/docs/releases/RELEASE_SUMMARY_v1.7.6.md +0 -436
  134. package/docs/releases/RELEASE_SUMMARY_v1.7.7.md +0 -391
  135. package/docs/releases/RELEASE_SUMMARY_v1.7.8.md +0 -523
  136. package/docs/releases/RELEASE_SUMMARY_v1.7.9.md +0 -542
  137. package/docs/troubleshooting/ARDUINO_IDE_VERSION_FIX_SUMMARY.md +0 -229
  138. package/docs/troubleshooting/ARDUINO_LIBRARY_NAME_FIX.md +0 -197
  139. package/docs/troubleshooting/CRASH_QUICK_REF.md +0 -93
  140. package/docs/troubleshooting/ESP32_C6_COMPATIBILITY.md +0 -157
  141. package/docs/troubleshooting/FREERTOS_ASSERTION_FAILURE.md +0 -288
  142. package/docs/troubleshooting/FREERTOS_FIX_IMPLEMENTATION.md +0 -267
  143. package/docs/troubleshooting/NPM_PUBLISHING_ISSUE_SUMMARY.md +0 -110
  144. package/docs/troubleshooting/PAINLESSMESH_V1.7.4_COMPILATION_ISSUES.md +0 -547
  145. package/docs/troubleshooting/QUICK_FIX_FREERTOS.md +0 -164
  146. package/docs/troubleshooting/SENSOR_NODE_CONNECTION_CRASH.md +0 -264
  147. package/docs/troubleshooting/station-reconnection-issues.md +0 -172
  148. package/docs/v1.7.7_MQTT_IMPROVEMENTS.md +0 -794
  149. package/docs/wiki/API-Reference.md +0 -246
  150. package/docs/wiki/Complete-Documentation.md +0 -123
  151. package/examples/alteriomImproved/alteriom_sensor_package.hpp +0 -224
  152. package/examples/alteriomImproved/improved_sensor_node.ino +0 -248
  153. package/examples/alteriomImproved/platformio.ini +0 -32
  154. package/examples/alteriomMetricsHealth/alteriom_sensor_package.hpp +0 -796
  155. package/examples/alteriomMetricsHealth/metrics_health_node.ino +0 -429
  156. package/examples/alteriomMetricsHealth/platformio.ini +0 -26
  157. package/examples/alteriomPhase1/alteriom_sensor_package.hpp +0 -224
  158. package/examples/alteriomPhase1/phase1_features.ino +0 -242
  159. package/examples/alteriomPhase1/platformio.ini +0 -26
  160. package/examples/alteriomPhase2/alteriom_sensor_package.hpp +0 -224
  161. package/examples/alteriomPhase2/phase2_features.ino +0 -186
  162. package/examples/alteriomPhase2/platformio.ini +0 -26
  163. package/examples/alteriomSensorNode/alteriom_sensor_node.ino +0 -186
  164. package/examples/alteriomSensorNode/alteriom_sensor_package.hpp +0 -1227
  165. package/examples/alteriomSensorNode/platformio.ini +0 -26
  166. package/examples/bridge/alteriom_sensor_package.hpp +0 -1170
  167. package/examples/bridge/bridge_health_monitoring_example.ino +0 -188
  168. package/examples/bridge/enhanced_mqtt_bridge.hpp +0 -610
  169. package/examples/bridge/enhanced_mqtt_bridge_example.ino +0 -226
  170. package/examples/bridge/mesh_event_publisher.hpp +0 -253
  171. package/examples/bridge/mesh_topology_reporter.hpp +0 -303
  172. package/examples/bridge/mqtt_command_bridge.hpp +0 -459
  173. package/examples/bridge/mqtt_status_bridge.hpp +0 -519
  174. package/examples/bridgeAwareSensorNode/alteriom_sensor_package.hpp +0 -1227
  175. package/examples/bridgeAwareSensorNode/bridgeAwareSensorNode.ino +0 -342
  176. package/examples/bridgeAwareSensorNode/platformio.ini +0 -26
  177. package/examples/diagnosticsExample/diagnosticsExample.ino +0 -171
  178. package/examples/diagnosticsExample/platformio.ini +0 -26
  179. package/examples/echoNode/echoNode.ino +0 -33
  180. package/examples/echoNode/platformio.ini +0 -26
  181. package/examples/meshCommandNode/alteriom_sensor_package.hpp +0 -235
  182. package/examples/meshCommandNode/meshCommandNode.ino +0 -265
  183. package/examples/mqttCommandBridge/alteriom_sensor_package.hpp +0 -235
  184. package/examples/mqttCommandBridge/mesh_event_publisher.hpp +0 -253
  185. package/examples/mqttCommandBridge/mesh_topology_reporter.hpp +0 -303
  186. package/examples/mqttCommandBridge/mqttCommandBridge.ino +0 -254
  187. package/examples/mqttCommandBridge/mqtt_command_bridge.hpp +0 -462
  188. package/examples/mqttCommandBridge/platformio.ini +0 -27
  189. package/examples/mqttStatusBridge/mqttStatusBridge.ino +0 -218
  190. package/examples/mqttStatusBridge/mqtt_status_bridge.hpp +0 -522
  191. package/examples/mqttStatusBridge/platformio.ini +0 -27
  192. package/examples/mqttTopologyTest/README.md +0 -467
  193. package/examples/mqttTopologyTest/mqttTopologyTest.ino +0 -754
  194. package/examples/mqttTopologyTest/platformio.ini +0 -27
  195. package/examples/multi_bridge/README.md +0 -346
  196. package/examples/multi_bridge/primary_bridge.ino +0 -96
  197. package/examples/multi_bridge/regular_node.ino +0 -141
  198. package/examples/multi_bridge/secondary_bridge.ino +0 -111
  199. package/examples/ntpTimeSyncBridge/alteriom_sensor_package.hpp +0 -1383
  200. package/examples/ntpTimeSyncBridge/ntpTimeSyncBridge.ino +0 -86
  201. package/examples/ntpTimeSyncNode/alteriom_sensor_package.hpp +0 -1383
  202. package/examples/ntpTimeSyncNode/ntpTimeSyncNode.ino +0 -109
  203. package/examples/queued_alarms/README.md +0 -390
  204. package/examples/queued_alarms/queued_alarms.ino +0 -265
  205. package/examples/routing_demo/README.md +0 -172
  206. package/examples/routing_demo/routing_demo.ino +0 -102
  207. package/examples/rtcIntegration/README.md +0 -294
  208. package/examples/rtcIntegration/rtcIntegration.ino +0 -210
@@ -1,242 +0,0 @@
1
- /**
2
- * Phase 1 OTA Features Example - Compressed OTA & Enhanced Status
3
- *
4
- * This example demonstrates the Phase 1 enhancements to painlessMesh:
5
- * - Option 1E: Compressed OTA Transfer for 40-60% bandwidth reduction
6
- * - Option 2A: Enhanced StatusPackage with comprehensive metrics
7
- *
8
- * Features:
9
- * - Compressed firmware updates reduce network bandwidth
10
- * - Enhanced status reporting with mesh statistics and performance metrics
11
- * - Backward compatible with existing nodes
12
- */
13
-
14
- #include "alteriom_sensor_package.hpp"
15
- #include "painlessMesh.h"
16
-
17
- #define MESH_PREFIX "AlteriomPhase1Mesh"
18
- #define MESH_PASSWORD "phase1Features"
19
- #define MESH_PORT 5555
20
-
21
- #define STATUS_INTERVAL 30000 // Send enhanced status every 30 seconds
22
-
23
- Scheduler userScheduler;
24
- painlessMesh mesh;
25
-
26
- // Task declarations
27
- Task statusTask(STATUS_INTERVAL, TASK_FOREVER, &sendEnhancedStatus);
28
-
29
- // Metrics tracking
30
- unsigned long lastRebootTime = 0;
31
- uint32_t totalMessagesReceived = 0;
32
- uint32_t totalMessagesSent = 0;
33
-
34
- void setup() {
35
- Serial.begin(115200);
36
-
37
- lastRebootTime = millis();
38
-
39
- mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
40
- mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
41
-
42
- mesh.onReceive(&receivedCallback);
43
- mesh.onNewConnection(&newConnectionCallback);
44
- mesh.onChangedConnections(&changedConnectionCallback);
45
-
46
- // Add the enhanced status reporting task
47
- userScheduler.addTask(statusTask);
48
- statusTask.enable();
49
-
50
- Serial.println("Phase 1 Features Example Started");
51
- Serial.println("- Compressed OTA enabled");
52
- Serial.println("- Enhanced Status reporting active");
53
- }
54
-
55
- void loop() {
56
- mesh.update();
57
- }
58
-
59
- /**
60
- * Send Enhanced Status Package with comprehensive metrics
61
- */
62
- void sendEnhancedStatus() {
63
- alteriom::EnhancedStatusPackage status;
64
-
65
- // Device Health
66
- status.deviceStatus = 0x01; // 0x01 = Online and healthy
67
- status.uptime = (millis() - lastRebootTime) / 1000; // Uptime in seconds
68
-
69
- #ifdef ESP32
70
- status.freeMemory = ESP.getFreeHeap() / 1024; // Free heap in KB
71
- status.firmwareVersion = "1.0.0-phase1";
72
- status.wifiStrength = constrain(map(WiFi.RSSI(), -100, -50, 0, 100), 0, 100);
73
- #elif defined(ESP8266)
74
- status.freeMemory = ESP.getFreeHeap() / 1024;
75
- status.firmwareVersion = "1.0.0-phase1";
76
- status.wifiStrength = constrain(map(WiFi.RSSI(), -100, -50, 0, 100), 0, 100);
77
- #else
78
- status.freeMemory = 128; // Default for testing
79
- status.firmwareVersion = "1.0.0-test";
80
- status.wifiStrength = 75;
81
- #endif
82
-
83
- // For demonstration, use a placeholder MD5
84
- status.firmwareMD5 = "abc123def456";
85
-
86
- // Mesh Statistics
87
- auto nodeList = mesh.getNodeList();
88
- status.nodeCount = nodeList.size();
89
- status.connectionCount = nodeList.size(); // Use node count as connection count
90
- status.messagesReceived = totalMessagesReceived;
91
- status.messagesSent = totalMessagesSent;
92
- status.messagesDropped = 0; // Would need tracking in real implementation
93
-
94
- // Performance Metrics
95
- // In a real implementation, these would be calculated from actual metrics
96
- status.avgLatency = 50; // Average message latency in ms
97
- status.packetLossRate = 1; // 1% packet loss
98
- status.throughput = 512; // Bytes per second
99
-
100
- // Alerts - check for various conditions
101
- status.alertFlags = 0;
102
- if (status.freeMemory < 32) {
103
- status.alertFlags |= 0x01; // Low memory alert
104
- }
105
- if (status.wifiStrength < 30) {
106
- status.alertFlags |= 0x02; // Weak signal alert
107
- }
108
- if (status.connectionCount == 0 && status.nodeCount == 0) {
109
- status.alertFlags |= 0x04; // Isolated node alert
110
- }
111
-
112
- status.lastError = (status.alertFlags == 0) ? "" : "See alert flags";
113
-
114
- // Convert to JSON and send
115
- String msg;
116
- JsonDocument doc; // ArduinoJson v7 uses automatic sizing
117
- JsonObject obj = doc.to<JsonObject>();
118
- status.addTo(std::move(obj));
119
- serializeJson(doc, msg);
120
-
121
- mesh.sendBroadcast(msg);
122
- totalMessagesSent++;
123
-
124
- Serial.printf("Enhanced Status sent - Nodes: %d, Mem: %dKB, Uptime: %ds\n",
125
- status.nodeCount, status.freeMemory, status.uptime);
126
- }
127
-
128
- /**
129
- * Callback when messages are received
130
- */
131
- void receivedCallback(uint32_t from, String& msg) {
132
- totalMessagesReceived++;
133
-
134
- // Parse the message to identify the type
135
- JsonDocument doc; // ArduinoJson v7 uses automatic sizing
136
- DeserializationError error = deserializeJson(doc, msg);
137
-
138
- if (error) {
139
- Serial.printf("JSON parse error from %u: %s\n", from, error.c_str());
140
- return;
141
- }
142
-
143
- JsonObject obj = doc.as<JsonObject>();
144
- int msgType = obj["type"];
145
-
146
- switch (msgType) {
147
- case 203: { // Enhanced Status Package
148
- alteriom::EnhancedStatusPackage status(obj);
149
-
150
- Serial.printf("Enhanced Status from %u: v%s, Nodes: %d, Mem: %dKB, Msgs: %d/%d\n",
151
- from,
152
- status.firmwareVersion.c_str(),
153
- status.nodeCount,
154
- status.freeMemory,
155
- status.messagesReceived,
156
- status.messagesSent);
157
-
158
- if (status.alertFlags != 0) {
159
- Serial.printf(" ALERTS (0x%02X): %s\n", status.alertFlags, status.lastError.c_str());
160
- }
161
- break;
162
- }
163
-
164
- case 202: { // Basic Status Package (backward compatible)
165
- alteriom::StatusPackage status(obj);
166
- Serial.printf("Basic Status from %u: v%s, Mem: %dKB\n",
167
- from, status.firmwareVersion.c_str(), status.freeMemory);
168
- break;
169
- }
170
-
171
- default:
172
- Serial.printf("Message type %d from %u (not a status package)\n", msgType, from);
173
- break;
174
- }
175
- }
176
-
177
- void newConnectionCallback(uint32_t nodeId) {
178
- Serial.printf("New Connection: %u\n", nodeId);
179
- Serial.printf("Total nodes in mesh: %d\n", mesh.getNodeList().size());
180
- }
181
-
182
- void changedConnectionCallback() {
183
- Serial.printf("Connections changed. Nodes: %d\n", mesh.getNodeList().size());
184
- }
185
-
186
- /**
187
- * Example: How to use Compressed OTA (sender side)
188
- *
189
- * This function shows how to enable compressed OTA transfers.
190
- * In a real implementation, this would be called from an OTA sender node.
191
- */
192
- void setupCompressedOTA() {
193
- #ifdef PAINLESSMESH_ENABLE_OTA
194
-
195
- // Example firmware info
196
- String firmwareMD5 = "abc123def456789"; // MD5 of firmware
197
- size_t numParts = 100; // Number of firmware chunks
198
-
199
- // Offer OTA update with compression enabled
200
- // Parameters: role, hardware, md5, numParts, forced, broadcasted, compressed
201
- auto otaTask = mesh.offerOTA(
202
- "sensor", // Role this firmware is for
203
- "ESP32", // Hardware type
204
- firmwareMD5, // MD5 hash of firmware
205
- numParts, // Number of data chunks
206
- false, // Not forced (only update if different)
207
- false, // Not using broadcast mode (yet - Phase 2)
208
- true // COMPRESSED! 40-60% bandwidth savings
209
- );
210
-
211
- Serial.println("Compressed OTA announced!");
212
- Serial.println("Expected bandwidth savings: 40-60%");
213
- Serial.println("Nodes will receive and decompress firmware automatically");
214
-
215
- #else
216
- Serial.println("OTA not enabled. Define PAINLESSMESH_ENABLE_OTA");
217
- #endif
218
- }
219
-
220
- /**
221
- * Benefits of Phase 1 Features:
222
- *
223
- * 1. Compressed OTA (Option 1E):
224
- * - 40-60% reduction in network bandwidth
225
- * - Faster firmware distribution across mesh
226
- * - Lower energy consumption
227
- * - Backward compatible with uncompressed OTA
228
- * - Works with all future OTA options (broadcast, progressive, etc.)
229
- *
230
- * 2. Enhanced Status Package (Option 2A):
231
- * - Comprehensive device health monitoring
232
- * - Mesh network statistics (nodes, connections, messages)
233
- * - Performance metrics (latency, packet loss, throughput)
234
- * - Alert system for proactive issue detection
235
- * - Standardized format across all Alteriom nodes
236
- * - Easy integration with monitoring dashboards
237
- *
238
- * Next Steps (Phase 2):
239
- * - Broadcast OTA for even faster updates in large meshes
240
- * - MQTT bridge for cloud monitoring integration
241
- * - Professional monitoring tools (Grafana, InfluxDB)
242
- */
@@ -1,26 +0,0 @@
1
- [platformio]
2
- src_dir = .
3
-
4
- [env]
5
- lib_deps =
6
- bblanchon/ArduinoJson
7
- arkhipenko/TaskScheduler
8
-
9
- lib_ldf_mode = deep+
10
- [env:esp8266]
11
- platform = espressif8266
12
- board = nodemcuv2
13
- framework = arduino
14
- lib_extra_dirs = ../../ ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
15
- lib_deps =
16
- ${env.lib_deps} ; Inherit common dependencies
17
- esp32async/ESPAsyncTCP@^2.0.0 ; Only for ESP8266
18
-
19
- [env:esp32]
20
- platform = espressif32
21
- board = esp32dev
22
- framework = arduino
23
- lib_extra_dirs = ../../ ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
24
- lib_deps =
25
- ${env.lib_deps} ; Inherit common dependencies
26
- esp32async/AsyncTCP
@@ -1,224 +0,0 @@
1
- #ifndef ALTERIOM_SENSOR_PACKAGE_HPP
2
- #define ALTERIOM_SENSOR_PACKAGE_HPP
3
-
4
- #include "painlessmesh/plugin.hpp"
5
-
6
- namespace alteriom {
7
-
8
- /**
9
- * @brief Sensor data package for broadcasting environmental measurements
10
- *
11
- * This package is designed for Alteriom's IoT sensor network requirements,
12
- * allowing nodes to share environmental data across the mesh.
13
- */
14
- class SensorPackage : public painlessmesh::plugin::BroadcastPackage {
15
- public:
16
- double temperature = 0.0; // Temperature in Celsius
17
- double humidity = 0.0; // Relative humidity percentage
18
- double pressure = 0.0; // Atmospheric pressure in hPa
19
- uint32_t sensorId = 0; // Unique sensor identifier
20
- uint32_t timestamp = 0; // Unix timestamp of measurement
21
- uint8_t batteryLevel = 0; // Battery level percentage
22
-
23
- SensorPackage()
24
- : BroadcastPackage(200) {} // Type ID 200 for Alteriom sensors
25
-
26
- SensorPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
27
- temperature = jsonObj["temp"];
28
- humidity = jsonObj["hum"];
29
- pressure = jsonObj["press"];
30
- sensorId = jsonObj["sid"];
31
- timestamp = jsonObj["ts"];
32
- batteryLevel = jsonObj["bat"];
33
- }
34
-
35
- JsonObject addTo(JsonObject&& jsonObj) const {
36
- jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
37
- jsonObj["temp"] = temperature;
38
- jsonObj["hum"] = humidity;
39
- jsonObj["press"] = pressure;
40
- jsonObj["sid"] = sensorId;
41
- jsonObj["ts"] = timestamp;
42
- jsonObj["bat"] = batteryLevel;
43
- return jsonObj;
44
- }
45
-
46
- #if ARDUINOJSON_VERSION_MAJOR < 7
47
- size_t jsonObjectSize() const { return JSON_OBJECT_SIZE(noJsonFields + 6); }
48
- #endif
49
- };
50
-
51
- /**
52
- * @brief Command package for controlling Alteriom devices
53
- *
54
- * Single-destination package for sending specific commands to individual nodes.
55
- */
56
- class CommandPackage : public painlessmesh::plugin::SinglePackage {
57
- public:
58
- uint8_t command = 0; // Command type
59
- uint32_t targetDevice = 0; // Target device ID
60
- TSTRING parameters = ""; // Command parameters as JSON string
61
- uint32_t commandId = 0; // Unique command identifier for tracking
62
-
63
- CommandPackage() : SinglePackage(400) {} // Type ID 201 for Alteriom commands
64
-
65
- CommandPackage(JsonObject jsonObj) : SinglePackage(jsonObj) {
66
- command = jsonObj["cmd"];
67
- targetDevice = jsonObj["target"];
68
- parameters = jsonObj["params"].as<TSTRING>();
69
- commandId = jsonObj["cid"];
70
- }
71
-
72
- JsonObject addTo(JsonObject&& jsonObj) const {
73
- jsonObj = SinglePackage::addTo(std::move(jsonObj));
74
- jsonObj["cmd"] = command;
75
- jsonObj["target"] = targetDevice;
76
- jsonObj["params"] = parameters;
77
- jsonObj["cid"] = commandId;
78
- return jsonObj;
79
- }
80
-
81
- #if ARDUINOJSON_VERSION_MAJOR < 7
82
- size_t jsonObjectSize() const {
83
- return JSON_OBJECT_SIZE(noJsonFields + 4) + parameters.length();
84
- }
85
- #endif
86
- };
87
-
88
- /**
89
- * @brief Status report package for device health monitoring
90
- */
91
- class StatusPackage : public painlessmesh::plugin::BroadcastPackage {
92
- public:
93
- uint8_t deviceStatus = 0; // Device status flags
94
- uint32_t uptime = 0; // Device uptime in seconds
95
- uint16_t freeMemory = 0; // Free memory in KB
96
- uint8_t wifiStrength = 0; // WiFi signal strength
97
- TSTRING firmwareVersion = ""; // Current firmware version
98
-
99
- StatusPackage() : BroadcastPackage(202) {} // Type ID 202 for Alteriom status
100
-
101
- StatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
102
- deviceStatus = jsonObj["status"];
103
- uptime = jsonObj["uptime"];
104
- freeMemory = jsonObj["mem"];
105
- wifiStrength = jsonObj["wifi"];
106
- firmwareVersion = jsonObj["fw"].as<TSTRING>();
107
- }
108
-
109
- JsonObject addTo(JsonObject&& jsonObj) const {
110
- jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
111
- jsonObj["status"] = deviceStatus;
112
- jsonObj["uptime"] = uptime;
113
- jsonObj["mem"] = freeMemory;
114
- jsonObj["wifi"] = wifiStrength;
115
- jsonObj["fw"] = firmwareVersion;
116
- return jsonObj;
117
- }
118
-
119
- #if ARDUINOJSON_VERSION_MAJOR < 7
120
- size_t jsonObjectSize() const {
121
- return JSON_OBJECT_SIZE(noJsonFields + 5) + firmwareVersion.length();
122
- }
123
- #endif
124
- };
125
-
126
- /**
127
- * @brief Enhanced status package with comprehensive health metrics (Phase 1)
128
- *
129
- * This is an extended version of StatusPackage that includes additional
130
- * mesh statistics, performance metrics, and alerting capabilities.
131
- * Type ID 203 is used to distinguish from the basic StatusPackage (202).
132
- */
133
- class EnhancedStatusPackage : public painlessmesh::plugin::BroadcastPackage {
134
- public:
135
- // Device Health (from original StatusPackage)
136
- uint8_t deviceStatus = 0; // Device status flags
137
- uint32_t uptime = 0; // Device uptime in seconds
138
- uint16_t freeMemory = 0; // Free memory in KB
139
- uint8_t wifiStrength = 0; // WiFi signal strength
140
- TSTRING firmwareVersion = ""; // Current firmware version
141
- TSTRING firmwareMD5 = ""; // Firmware hash for OTA verification
142
-
143
- // Mesh Statistics
144
- uint16_t nodeCount = 0; // Number of known nodes in mesh
145
- uint8_t connectionCount = 0; // Number of direct connections
146
- uint32_t messagesReceived = 0; // Total messages received
147
- uint32_t messagesSent = 0; // Total messages sent
148
- uint32_t messagesDropped = 0; // Total messages dropped/failed
149
-
150
- // Performance Metrics
151
- uint16_t avgLatency = 0; // Average message latency in ms
152
- uint8_t packetLossRate = 0; // Packet loss rate percentage (0-100)
153
- uint16_t throughput = 0; // Network throughput in bytes/sec
154
-
155
- // Warnings/Alerts
156
- uint8_t alertFlags = 0; // Bit flags for various alert conditions
157
- TSTRING lastError = ""; // Last error message for diagnostics
158
-
159
- EnhancedStatusPackage()
160
- : BroadcastPackage(203) {} // Type ID 203 for enhanced status
161
-
162
- EnhancedStatusPackage(JsonObject jsonObj) : BroadcastPackage(jsonObj) {
163
- deviceStatus = jsonObj["status"];
164
- uptime = jsonObj["uptime"];
165
- freeMemory = jsonObj["mem"];
166
- wifiStrength = jsonObj["wifi"];
167
- firmwareVersion = jsonObj["fw"].as<TSTRING>();
168
- firmwareMD5 = jsonObj["fwMD5"].as<TSTRING>();
169
-
170
- nodeCount = jsonObj["nodes"];
171
- connectionCount = jsonObj["conns"];
172
- messagesReceived = jsonObj["msgRx"];
173
- messagesSent = jsonObj["msgTx"];
174
- messagesDropped = jsonObj["msgDrop"];
175
-
176
- avgLatency = jsonObj["latency"];
177
- packetLossRate = jsonObj["loss"];
178
- throughput = jsonObj["throughput"];
179
-
180
- alertFlags = jsonObj["alerts"];
181
- lastError = jsonObj["lastErr"].as<TSTRING>();
182
- }
183
-
184
- JsonObject addTo(JsonObject&& jsonObj) const {
185
- jsonObj = BroadcastPackage::addTo(std::move(jsonObj));
186
-
187
- // Device Health
188
- jsonObj["status"] = deviceStatus;
189
- jsonObj["uptime"] = uptime;
190
- jsonObj["mem"] = freeMemory;
191
- jsonObj["wifi"] = wifiStrength;
192
- jsonObj["fw"] = firmwareVersion;
193
- jsonObj["fwMD5"] = firmwareMD5;
194
-
195
- // Mesh Statistics
196
- jsonObj["nodes"] = nodeCount;
197
- jsonObj["conns"] = connectionCount;
198
- jsonObj["msgRx"] = messagesReceived;
199
- jsonObj["msgTx"] = messagesSent;
200
- jsonObj["msgDrop"] = messagesDropped;
201
-
202
- // Performance Metrics
203
- jsonObj["latency"] = avgLatency;
204
- jsonObj["loss"] = packetLossRate;
205
- jsonObj["throughput"] = throughput;
206
-
207
- // Alerts
208
- jsonObj["alerts"] = alertFlags;
209
- jsonObj["lastErr"] = lastError;
210
-
211
- return jsonObj;
212
- }
213
-
214
- #if ARDUINOJSON_VERSION_MAJOR < 7
215
- size_t jsonObjectSize() const {
216
- return JSON_OBJECT_SIZE(noJsonFields + 18) + firmwareVersion.length() +
217
- firmwareMD5.length() + lastError.length();
218
- }
219
- #endif
220
- };
221
-
222
- } // namespace alteriom
223
-
224
- #endif // ALTERIOM_SENSOR_PACKAGE_HPP
@@ -1,186 +0,0 @@
1
- //************************************************************
2
- // Phase 2 Features Example
3
- //
4
- // This example demonstrates the two major Phase 2 features:
5
- // 1. Broadcast OTA (Option 1A) - True mesh-wide firmware distribution
6
- // 2. MQTT Status Bridge (Option 2E) - Professional monitoring
7
- //
8
- // Phase 2 builds on Phase 1's foundation:
9
- // - Phase 1: Compressed OTA + Enhanced Status
10
- // - Phase 2: Broadcast OTA + MQTT Status Bridge
11
- //
12
- // Broadcast OTA Benefits:
13
- // - Dramatically reduces network traffic (1 broadcast vs N unicasts)
14
- // - Faster distribution to large meshes (parallel vs sequential)
15
- // - Scales to 50+ nodes efficiently
16
- // - Backward compatible with Phase 1
17
- //
18
- // MQTT Status Bridge Benefits:
19
- // - Professional monitoring tools (Grafana, InfluxDB, Prometheus)
20
- // - Cloud integration via MQTT
21
- // - Real-time mesh visibility
22
- // - Automated alerting
23
- //************************************************************
24
-
25
- #include "painlessMesh.h"
26
-
27
- // Mesh configuration
28
- #define MESH_PREFIX "AlteriomMesh"
29
- #define MESH_PASSWORD "meshPassword123"
30
- #define MESH_PORT 5555
31
-
32
- // OTA configuration
33
- #define OTA_PART_SIZE 1024 // Chunk size for OTA transfers
34
-
35
- Scheduler userScheduler;
36
- painlessMesh mesh;
37
-
38
- // Prototypes
39
- void sendBroadcastOTA();
40
- void receivedCallback(uint32_t from, String& msg);
41
- void newConnectionCallback(uint32_t nodeId);
42
- void changedConnectionCallback();
43
-
44
- void setup() {
45
- Serial.begin(115200);
46
- Serial.println("\n\n=== Phase 2 Features Demo ===\n");
47
-
48
- mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
49
- mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
50
- mesh.onReceive(&receivedCallback);
51
- mesh.onNewConnection(&newConnectionCallback);
52
- mesh.onChangedConnections(&changedConnectionCallback);
53
-
54
- Serial.println("Mesh initialized");
55
- Serial.println("Phase 2 features:");
56
- Serial.println(" 1. Broadcast OTA - scales to 50+ nodes");
57
- Serial.println(" 2. MQTT Status Bridge - professional monitoring");
58
- Serial.println();
59
- }
60
-
61
- void loop() {
62
- mesh.update();
63
- }
64
-
65
- /**
66
- * Phase 2 Feature 1: Broadcast OTA
67
- *
68
- * True mesh-wide broadcast distribution where firmware chunks
69
- * are broadcast to all nodes simultaneously, dramatically reducing
70
- * network traffic and improving update speed.
71
- *
72
- * Key differences from Phase 1:
73
- * - Phase 1: Each node requests chunks individually (N unicasts)
74
- * - Phase 2: Root broadcasts chunks once to all nodes (1 broadcast)
75
- *
76
- * Memory impact: +2-5KB per node for chunk tracking
77
- */
78
- void sendBroadcastOTA() {
79
- #ifdef PAINLESSMESH_ENABLE_OTA
80
-
81
- Serial.println("\n=== Phase 2: Broadcast OTA ===");
82
-
83
- // Example firmware info
84
- String firmwareMD5 = "phase2_broadcast_example_md5";
85
- size_t numParts = 150; // Number of firmware chunks
86
-
87
- // Phase 2: Enable both compression (Phase 1) AND broadcast (Phase 2)
88
- // This is the most efficient combination for large meshes
89
- auto otaTask = mesh.offerOTA(
90
- "sensor", // Role this firmware is for
91
- "ESP32", // Hardware type (ESP32 or ESP8266)
92
- firmwareMD5, // MD5 hash of firmware
93
- numParts, // Number of data chunks
94
- false, // Not forced (only update if different MD5)
95
- true, // *** BROADCAST MODE (Phase 2 feature) ***
96
- true // Compressed (Phase 1 feature for additional savings)
97
- );
98
-
99
- Serial.println("Broadcast OTA announced!");
100
- Serial.println();
101
- Serial.println("Phase 2 Broadcast Mode:");
102
- Serial.println(" - Root node broadcasts each chunk ONCE");
103
- Serial.println(" - All nodes receive chunks simultaneously");
104
- Serial.println(" - Dramatically reduced network traffic");
105
- Serial.println(" - Scales efficiently to 50+ nodes");
106
- Serial.println();
107
- Serial.println("Combined with Phase 1 Compression:");
108
- Serial.println(" - 40-60% bandwidth reduction per chunk");
109
- Serial.println(" - Faster distribution across large meshes");
110
- Serial.println(" - Lower energy consumption");
111
- Serial.println();
112
- Serial.println("Expected performance for 50-node mesh:");
113
- Serial.println(" - Without broadcast: 50 unicast transmissions per chunk");
114
- Serial.println(" - With broadcast: 1 broadcast per chunk");
115
- Serial.println(" - Network load reduction: ~98%");
116
- Serial.println();
117
- Serial.println("Architecture:");
118
- Serial.println(" Root Node:");
119
- Serial.println(" ├─> Broadcast: Announce(firmware_info)");
120
- Serial.println(" ├─> Broadcast: Data(chunk_0)");
121
- Serial.println(" ├─> Broadcast: Data(chunk_1)");
122
- Serial.println(" └─> ... continues for all chunks");
123
- Serial.println(" ");
124
- Serial.println(" All Nodes:");
125
- Serial.println(" ├─> Listen for broadcast announcements");
126
- Serial.println(" ├─> Receive and cache chunks as they arrive");
127
- Serial.println(" ├─> Assemble firmware from cached chunks");
128
- Serial.println(" └─> Reboot into new firmware when complete");
129
-
130
- #else
131
- Serial.println("OTA not enabled. Define PAINLESSMESH_ENABLE_OTA");
132
- #endif
133
- }
134
-
135
- /**
136
- * Callback when messages are received
137
- */
138
- void receivedCallback(uint32_t from, String& msg) {
139
- Serial.printf("Received from %u: %s\n", from, msg.c_str());
140
- }
141
-
142
- void newConnectionCallback(uint32_t nodeId) {
143
- Serial.printf("New connection: %u\n", nodeId);
144
- Serial.printf("Total nodes in mesh: %d\n", mesh.getNodeList().size() + 1);
145
- }
146
-
147
- void changedConnectionCallback() {
148
- Serial.println("Connections changed");
149
- Serial.printf("Total nodes: %d\n", mesh.getNodeList().size() + 1);
150
- }
151
-
152
- /**
153
- * Phase 2 Benefits Summary:
154
- *
155
- * 1. Broadcast OTA (Option 1A):
156
- * - Scales to 50-100 node meshes
157
- * - ~98% reduction in network traffic vs unicast
158
- * - Parallel distribution to all nodes
159
- * - Maintains backward compatibility
160
- * - Memory overhead: +2-5KB per node
161
- *
162
- * 2. MQTT Status Bridge (Option 2E):
163
- * - Professional monitoring tools integration
164
- * - Real-time mesh visibility via MQTT topics
165
- * - Grafana/InfluxDB dashboards
166
- * - Prometheus metrics collection
167
- * - Home Assistant automation
168
- * - Cloud-ready architecture
169
- * - Configurable publish intervals
170
- * - Multiple topic streams (nodes, topology, metrics, alerts)
171
- *
172
- * When to use Phase 2:
173
- * - Meshes with 10+ nodes (broadcast efficiency kicks in)
174
- * - Production deployments requiring monitoring
175
- * - Systems needing cloud integration
176
- * - Enterprise environments with existing monitoring tools
177
- * - Large-scale deployments (50+ nodes)
178
- *
179
- * Migration from Phase 1:
180
- * - Broadcast OTA: Just set broadcasted=true in offerOTA()
181
- * - MQTT Bridge: Include mqtt_status_bridge.hpp and configure
182
- * - Both features are fully backward compatible
183
- * - Can be deployed incrementally
184
- *
185
- * Next: Phase 3 features (progressive rollout + telemetry streams)
186
- */