@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,754 +0,0 @@
1
- /**
2
- * @file mqttTopologyTest.ino
3
- * @brief Hardware test sketch for painlessMesh topology reporting with MQTT
4
- *
5
- * This sketch tests mesh topology reporting according to @alteriom/mqtt-schema v0.5.0
6
- *
7
- * HARDWARE REQUIREMENTS:
8
- * - 3x ESP32 boards (or ESP8266, but ESP32 recommended)
9
- * - MQTT broker accessible on network (e.g., Mosquitto)
10
- * - USB cables for programming and Serial monitoring
11
- *
12
- * TEST CONFIGURATION:
13
- * - Node 1: Gateway (this sketch with IS_GATEWAY = true)
14
- * - Node 2: Sensor node (this sketch with IS_GATEWAY = false, role = "sensor")
15
- * - Node 3: Repeater node (this sketch with IS_GATEWAY = false, role = "repeater")
16
- *
17
- * MQTT TOPICS TESTED:
18
- * - alteriom/mesh/MESH-001/topology (full topology every 60s, incremental every 5s)
19
- * - alteriom/mesh/MESH-001/events (node join/leave events)
20
- * - alteriom/mesh/MESH-001/topology/response (GET_TOPOLOGY command response)
21
- * - alteriom/mesh/MESH-001/command (receive GET_TOPOLOGY commands)
22
- *
23
- * SCHEMA COMPLIANCE:
24
- * - Device ID format: ALT-XXXXXXXXXXXX (uppercase hex)
25
- * - Quality metrics: 0-100 range
26
- * - RSSI values: negative dBm
27
- * - Timestamps: ISO 8601 format
28
- * - Envelope fields: schema_version, device_id, device_type, timestamp, firmware_version
29
- *
30
- * TEST PROCEDURE:
31
- * 1. Configure WiFi credentials (WIFI_SSID, WIFI_PASSWORD)
32
- * 2. Configure MQTT broker (MQTT_BROKER, MQTT_PORT)
33
- * 3. Flash Node 1 with IS_GATEWAY = true
34
- * 4. Flash Node 2 with IS_GATEWAY = false, NODE_ROLE = "sensor"
35
- * 5. Flash Node 3 with IS_GATEWAY = false, NODE_ROLE = "repeater"
36
- * 6. Open Serial monitors for all 3 nodes
37
- * 7. Wait for mesh formation (watch for "Node joined" messages)
38
- * 8. Verify full topology published every 60s
39
- * 9. Verify incremental updates on node join/leave
40
- * 10. Send GET_TOPOLOGY command and verify response
41
- *
42
- * EXPECTED BEHAVIOR:
43
- * - All nodes join mesh within 30 seconds
44
- * - Gateway publishes full topology every 60 seconds
45
- * - Gateway publishes incremental updates within 5 seconds of node join/leave
46
- * - All messages conform to @alteriom/mqtt-schema v0.5.0
47
- * - Connection quality metrics are calculated correctly
48
- *
49
- * @author Alteriom Development Team
50
- * @date October 14, 2025
51
- * @version 1.0.0
52
- */
53
-
54
- #include "painlessTaskOptions.h" // Must be first to configure TaskScheduler
55
- #include <TaskScheduler.h> // Required for LDF to find TaskScheduler dependency
56
- #include "painlessMesh.h"
57
- #ifdef ESP8266
58
- #include <ESP8266WiFi.h>
59
- #else
60
- #include <WiFi.h>
61
- #endif
62
- #include <PubSubClient.h>
63
- #include <ArduinoJson.h>
64
-
65
- // ============================================================================
66
- // CONFIGURATION - MODIFY THESE FOR YOUR SETUP
67
- // ============================================================================
68
-
69
- // Mesh Configuration
70
- #define MESH_PREFIX "AlteriomMesh"
71
- #define MESH_PASSWORD "alteriom2025"
72
- #define MESH_PORT 5555
73
-
74
- // WiFi Configuration (for gateway only)
75
- #define WIFI_SSID "YourWiFiSSID"
76
- #define WIFI_PASSWORD "YourWiFiPassword"
77
-
78
- // MQTT Configuration (for gateway only)
79
- #define MQTT_BROKER "192.168.1.100" // Your MQTT broker IP
80
- #define MQTT_PORT 1883
81
- #define MQTT_USER "" // Leave empty if no auth
82
- #define MQTT_PASS "" // Leave empty if no auth
83
-
84
- // Node Configuration - CHANGE THIS FOR EACH NODE
85
- #define IS_GATEWAY true // Set to false for sensor/repeater nodes
86
- #define NODE_ROLE "gateway" // "gateway", "sensor", or "repeater"
87
- #define MESH_ID "MESH-001"
88
- #define FIRMWARE_VERSION "TEST 1.0.0"
89
-
90
- // Topology Publishing Configuration
91
- #define FULL_TOPOLOGY_INTERVAL 60000 // Full topology every 60 seconds
92
- #define INCREMENTAL_INTERVAL 5000 // Check for changes every 5 seconds
93
- #define COMMAND_CHECK_INTERVAL 1000 // Check for commands every 1 second
94
-
95
- // ============================================================================
96
- // GLOBAL OBJECTS
97
- // ============================================================================
98
-
99
- Scheduler userScheduler;
100
- painlessMesh mesh;
101
-
102
- #if IS_GATEWAY
103
- WiFiClient wifiClient;
104
- PubSubClient mqttClient(wifiClient);
105
- #endif
106
-
107
- // Task declarations
108
- Task taskSendFullTopology(FULL_TOPOLOGY_INTERVAL, TASK_FOREVER, &sendFullTopology);
109
- Task taskCheckIncrementalUpdate(INCREMENTAL_INTERVAL, TASK_FOREVER, &checkIncrementalUpdate);
110
- Task taskCheckCommands(COMMAND_CHECK_INTERVAL, TASK_FOREVER, &checkCommands);
111
-
112
- // Topology state tracking
113
- struct NodeState {
114
- uint32_t nodeId;
115
- String role;
116
- bool online;
117
- unsigned long lastSeen;
118
- int connectionCount;
119
- };
120
-
121
- std::map<uint32_t, NodeState> lastTopology;
122
- unsigned long lastTopologyUpdate = 0;
123
-
124
- // ============================================================================
125
- // DEVICE ID GENERATION
126
- // ============================================================================
127
-
128
- /**
129
- * Generate Alteriom-compliant device ID from chip ID
130
- * Format: ALT-XXXXXXXXXXXX (uppercase hex)
131
- */
132
- String getDeviceId() {
133
- #ifdef ESP32
134
- uint64_t chipid = ESP.getEfuseMac(); // ESP32 unique ID
135
- #else
136
- uint32_t chipid = ESP.getChipId(); // ESP8266 chip ID
137
- #endif
138
- char deviceId[17];
139
- snprintf(deviceId, sizeof(deviceId), "ALT-%012llX", (uint64_t)chipid);
140
- return String(deviceId);
141
- }
142
-
143
- // ============================================================================
144
- // ISO 8601 TIMESTAMP
145
- // ============================================================================
146
-
147
- /**
148
- * Get current timestamp in ISO 8601 format
149
- * Note: Uses mesh time, not real-world time (no NTP in this test)
150
- */
151
- String getTimestamp() {
152
- uint32_t meshTime = mesh.getNodeTime();
153
- // Convert microseconds to seconds
154
- uint32_t seconds = meshTime / 1000000;
155
-
156
- // Simple ISO 8601 format (no actual date, just offset from boot)
157
- char timestamp[30];
158
- snprintf(timestamp, sizeof(timestamp), "2025-10-14T%02d:%02d:%02dZ",
159
- (seconds / 3600) % 24,
160
- (seconds / 60) % 60,
161
- seconds % 60);
162
- return String(timestamp);
163
- }
164
-
165
- // ============================================================================
166
- // CONNECTION QUALITY CALCULATION
167
- // ============================================================================
168
-
169
- /**
170
- * Calculate connection quality (0-100) based on mesh metrics
171
- * This is a simplified calculation for testing
172
- */
173
- int calculateQuality(uint32_t nodeId) {
174
- // In a real implementation, this would use:
175
- // - RSSI measurements
176
- // - Packet loss rate
177
- // - Latency measurements
178
- // For testing, we'll use a simulated value based on node ID
179
-
180
- // Simulate quality degradation with distance (hop count)
181
- SimpleList<uint32_t> nodeList = mesh.getNodeList();
182
- int nodeCount = nodeList.size();
183
-
184
- // Base quality: 95 for direct connections
185
- int quality = 95;
186
-
187
- // Reduce quality based on mesh size (simulate congestion)
188
- if (nodeCount > 3) quality -= (nodeCount - 3) * 5;
189
-
190
- // Add some variation based on node ID
191
- quality -= (nodeId % 10);
192
-
193
- // Clamp to 0-100 range
194
- return std::max(0, std::min(100, quality));
195
- }
196
-
197
- /**
198
- * Simulate RSSI (WiFi signal strength in dBm)
199
- * Real implementation would read actual WiFi RSSI
200
- */
201
- int calculateRSSI(uint32_t nodeId) {
202
- // RSSI ranges from -30 (excellent) to -90 (poor)
203
- int rssi = -40 - (nodeId % 50); // Simulated based on node ID
204
- return std::max(-90, std::min(-30, rssi));
205
- }
206
-
207
- /**
208
- * Simulate round-trip latency in milliseconds
209
- * Real implementation would measure actual ping times
210
- */
211
- int calculateLatency(uint32_t nodeId) {
212
- // Latency increases with hop count
213
- int baseLatency = 10;
214
- int variation = nodeId % 20;
215
- return baseLatency + variation;
216
- }
217
-
218
- // ============================================================================
219
- // MQTT PUBLISHING (GATEWAY ONLY)
220
- // ============================================================================
221
-
222
- #if IS_GATEWAY
223
-
224
- /**
225
- * Connect to MQTT broker
226
- */
227
- void connectMQTT() {
228
- while (!mqttClient.connected()) {
229
- Serial.print("Connecting to MQTT broker...");
230
-
231
- String clientId = "AlteriomGateway-" + getDeviceId();
232
-
233
- if (mqttClient.connect(clientId.c_str(), MQTT_USER, MQTT_PASS)) {
234
- Serial.println(" connected!");
235
-
236
- // Subscribe to command topic
237
- String commandTopic = "alteriom/mesh/" + String(MESH_ID) + "/command";
238
- mqttClient.subscribe(commandTopic.c_str());
239
- Serial.println("Subscribed to: " + commandTopic);
240
- } else {
241
- Serial.print(" failed, rc=");
242
- Serial.print(mqttClient.state());
243
- Serial.println(" retrying in 5 seconds");
244
- delay(5000);
245
- }
246
- }
247
- }
248
-
249
- /**
250
- * Publish message to MQTT with envelope fields
251
- */
252
- bool publishMQTT(const String& topic, JsonDocument& doc) {
253
- // Add envelope fields
254
- doc["schema_version"] = 1;
255
- doc["device_id"] = getDeviceId();
256
- doc["device_type"] = NODE_ROLE;
257
- doc["timestamp"] = getTimestamp();
258
- doc["firmware_version"] = FIRMWARE_VERSION;
259
-
260
- // Serialize to JSON
261
- String jsonString;
262
- serializeJson(doc, jsonString);
263
-
264
- // Publish
265
- bool success = mqttClient.publish(topic.c_str(), jsonString.c_str());
266
-
267
- if (success) {
268
- Serial.println("✅ Published to " + topic);
269
- Serial.println(" Size: " + String(jsonString.length()) + " bytes");
270
- } else {
271
- Serial.println("❌ Failed to publish to " + topic);
272
- }
273
-
274
- return success;
275
- }
276
-
277
- /**
278
- * Publish mesh event (node join/leave)
279
- */
280
- void publishMeshEvent(const String& eventType, uint32_t nodeId, const String& reason = "") {
281
- JsonDocument doc;
282
-
283
- doc["event"] = "mesh_event";
284
- doc["mesh_id"] = MESH_ID;
285
- doc["event_type"] = eventType;
286
-
287
- JsonArray affectedNodes = doc["affected_nodes"].to<JsonArray>();
288
- char nodeIdStr[17];
289
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
290
- affectedNodes.add(nodeIdStr);
291
-
292
- if (reason != "") {
293
- JsonObject details = doc["details"].to<JsonObject>();
294
- details["reason"] = reason;
295
- details["last_seen"] = getTimestamp();
296
- }
297
-
298
- String topic = "alteriom/mesh/" + String(MESH_ID) + "/events";
299
- publishMQTT(topic, doc);
300
- }
301
-
302
- #endif
303
-
304
- // ============================================================================
305
- // TOPOLOGY REPORTING
306
- // ============================================================================
307
-
308
- /**
309
- * Build and send full mesh topology
310
- */
311
- void sendFullTopology() {
312
- #if IS_GATEWAY
313
- Serial.println("\n📊 Generating FULL topology report...");
314
-
315
- if (!mqttClient.connected()) {
316
- connectMQTT();
317
- return;
318
- }
319
-
320
- JsonDocument doc;
321
-
322
- doc["event"] = "mesh_topology";
323
- doc["mesh_id"] = MESH_ID;
324
- doc["gateway_node_id"] = getDeviceId();
325
- doc["update_type"] = "full";
326
-
327
- // Get node list
328
- SimpleList<uint32_t> nodeList = mesh.getNodeList();
329
-
330
- // Add nodes array
331
- JsonArray nodes = doc["nodes"].to<JsonArray>();
332
-
333
- // Add gateway node
334
- JsonObject gatewayNode = nodes.add<JsonObject>();
335
- gatewayNode["node_id"] = getDeviceId();
336
- gatewayNode["role"] = NODE_ROLE;
337
- gatewayNode["status"] = "online";
338
- gatewayNode["last_seen"] = getTimestamp();
339
- gatewayNode["firmware_version"] = FIRMWARE_VERSION;
340
- gatewayNode["uptime_seconds"] = millis() / 1000;
341
- gatewayNode["free_memory_kb"] = ESP.getFreeHeap() / 1024;
342
- gatewayNode["connection_count"] = nodeList.size();
343
-
344
- // Add other nodes
345
- for (auto nodeId : nodeList) {
346
- JsonObject node = nodes.add<JsonObject>();
347
-
348
- char nodeIdStr[17];
349
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
350
- node["node_id"] = nodeIdStr;
351
-
352
- // Simulate role based on node ID
353
- node["role"] = (nodeId % 2 == 0) ? "sensor" : "repeater";
354
- node["status"] = "online";
355
- node["last_seen"] = getTimestamp();
356
- node["firmware_version"] = FIRMWARE_VERSION;
357
- node["uptime_seconds"] = 0; // Unknown for remote nodes
358
- node["free_memory_kb"] = 0; // Unknown for remote nodes
359
- node["connection_count"] = 1; // Simplified
360
- }
361
-
362
- // Add connections array
363
- JsonArray connections = doc["connections"].to<JsonArray>();
364
-
365
- for (auto nodeId : nodeList) {
366
- JsonObject conn = connections.add<JsonObject>();
367
- conn["from_node"] = getDeviceId();
368
-
369
- char nodeIdStr[17];
370
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
371
- conn["to_node"] = nodeIdStr;
372
-
373
- conn["quality"] = calculateQuality(nodeId);
374
- conn["latency_ms"] = calculateLatency(nodeId);
375
- conn["rssi"] = calculateRSSI(nodeId);
376
- conn["hop_count"] = 1; // Direct connection to gateway
377
- }
378
-
379
- // Add metrics
380
- JsonObject metrics = doc["metrics"].to<JsonObject>();
381
- metrics["total_nodes"] = nodeList.size() + 1; // +1 for gateway
382
- metrics["online_nodes"] = nodeList.size() + 1;
383
- metrics["network_diameter"] = 1; // Single hop for this test
384
-
385
- int avgQuality = 0;
386
- for (auto nodeId : nodeList) {
387
- avgQuality += calculateQuality(nodeId);
388
- }
389
- if (nodeList.size() > 0) {
390
- avgQuality /= nodeList.size();
391
- }
392
- metrics["avg_connection_quality"] = avgQuality;
393
- metrics["messages_per_second"] = 0.0; // Not tracked in this test
394
-
395
- String topic = "alteriom/mesh/" + String(MESH_ID) + "/topology";
396
- publishMQTT(topic, doc);
397
-
398
- // Update last topology state
399
- lastTopology.clear();
400
- for (auto nodeId : nodeList) {
401
- NodeState state;
402
- state.nodeId = nodeId;
403
- state.role = (nodeId % 2 == 0) ? "sensor" : "repeater";
404
- state.online = true;
405
- state.lastSeen = millis();
406
- state.connectionCount = 1;
407
- lastTopology[nodeId] = state;
408
- }
409
- lastTopologyUpdate = millis();
410
-
411
- Serial.println("✅ Full topology published");
412
- Serial.println(" Nodes: " + String(nodeList.size() + 1));
413
- Serial.println(" Connections: " + String(nodeList.size()));
414
-
415
- #endif
416
- }
417
-
418
- /**
419
- * Check for topology changes and send incremental update
420
- */
421
- void checkIncrementalUpdate() {
422
- #if IS_GATEWAY
423
- if (!mqttClient.connected()) {
424
- connectMQTT();
425
- return;
426
- }
427
-
428
- SimpleList<uint32_t> currentNodes = mesh.getNodeList();
429
- bool hasChanges = false;
430
-
431
- // Check for new nodes
432
- std::vector<uint32_t> newNodes;
433
- for (auto nodeId : currentNodes) {
434
- if (lastTopology.find(nodeId) == lastTopology.end()) {
435
- newNodes.push_back(nodeId);
436
- hasChanges = true;
437
- }
438
- }
439
-
440
- // Check for removed nodes
441
- std::vector<uint32_t> removedNodes;
442
- for (auto& pair : lastTopology) {
443
- uint32_t nodeId = pair.first;
444
- bool found = false;
445
- for (auto currentId : currentNodes) {
446
- if (currentId == nodeId) {
447
- found = true;
448
- break;
449
- }
450
- }
451
- if (!found) {
452
- removedNodes.push_back(nodeId);
453
- hasChanges = true;
454
- }
455
- }
456
-
457
- if (hasChanges) {
458
- Serial.println("\n🔄 Topology changed! Generating incremental update...");
459
-
460
- JsonDocument doc;
461
-
462
- doc["event"] = "mesh_topology";
463
- doc["mesh_id"] = MESH_ID;
464
- doc["gateway_node_id"] = getDeviceId();
465
- doc["update_type"] = "incremental";
466
-
467
- JsonArray nodes = doc["nodes"].to<JsonArray>();
468
- JsonArray connections = doc["connections"].to<JsonArray>();
469
-
470
- // Add new nodes
471
- for (auto nodeId : newNodes) {
472
- JsonObject node = nodes.add<JsonObject>();
473
-
474
- char nodeIdStr[17];
475
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
476
- node["node_id"] = nodeIdStr;
477
- node["role"] = (nodeId % 2 == 0) ? "sensor" : "repeater";
478
- node["status"] = "online";
479
- node["last_seen"] = getTimestamp();
480
-
481
- JsonObject conn = connections.add<JsonObject>();
482
- conn["from_node"] = getDeviceId();
483
- conn["to_node"] = nodeIdStr;
484
- conn["quality"] = calculateQuality(nodeId);
485
- conn["latency_ms"] = calculateLatency(nodeId);
486
- conn["rssi"] = calculateRSSI(nodeId);
487
- conn["hop_count"] = 1;
488
-
489
- Serial.println(" + Node joined: " + String(nodeIdStr));
490
-
491
- // Publish event
492
- publishMeshEvent("node_join", nodeId);
493
-
494
- // Update state
495
- NodeState state;
496
- state.nodeId = nodeId;
497
- state.role = (nodeId % 2 == 0) ? "sensor" : "repeater";
498
- state.online = true;
499
- state.lastSeen = millis();
500
- state.connectionCount = 1;
501
- lastTopology[nodeId] = state;
502
- }
503
-
504
- // Mark removed nodes as offline
505
- for (auto nodeId : removedNodes) {
506
- JsonObject node = nodes.add<JsonObject>();
507
-
508
- char nodeIdStr[17];
509
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
510
- node["node_id"] = nodeIdStr;
511
- node["status"] = "offline";
512
- node["last_seen"] = getTimestamp();
513
-
514
- Serial.println(" - Node left: " + String(nodeIdStr));
515
-
516
- // Publish event
517
- publishMeshEvent("node_leave", nodeId, "timeout");
518
-
519
- // Remove from state
520
- lastTopology.erase(nodeId);
521
- }
522
-
523
- String topic = "alteriom/mesh/" + String(MESH_ID) + "/topology";
524
- publishMQTT(topic, doc);
525
-
526
- Serial.println("✅ Incremental update published");
527
- }
528
- #endif
529
- }
530
-
531
- /**
532
- * Check for incoming MQTT commands
533
- */
534
- void checkCommands() {
535
- #if IS_GATEWAY
536
- mqttClient.loop();
537
- #endif
538
- }
539
-
540
- // ============================================================================
541
- // MQTT COMMAND HANDLER (GATEWAY ONLY)
542
- // ============================================================================
543
-
544
- #if IS_GATEWAY
545
-
546
- /**
547
- * Handle incoming MQTT messages (commands)
548
- */
549
- void mqttCallback(char* topic, byte* payload, unsigned int length) {
550
- Serial.println("\n📥 MQTT message received:");
551
- Serial.println(" Topic: " + String(topic));
552
-
553
- // Parse JSON
554
- JsonDocument doc;
555
- DeserializationError error = deserializeJson(doc, payload, length);
556
-
557
- if (error) {
558
- Serial.println(" ❌ JSON parse error: " + String(error.c_str()));
559
- return;
560
- }
561
-
562
- String event = doc["event"];
563
- String command = doc["command"];
564
- String correlationId = doc["correlation_id"];
565
-
566
- Serial.println(" Event: " + event);
567
- Serial.println(" Command: " + command);
568
- Serial.println(" Correlation ID: " + correlationId);
569
-
570
- // Handle GET_TOPOLOGY command (command ID 300)
571
- if (event == "command" && command == "get_topology") {
572
- Serial.println(" 🔍 Processing GET_TOPOLOGY command...");
573
-
574
- unsigned long startTime = millis();
575
-
576
- // Build topology response
577
- JsonDocument responseDoc;
578
- responseDoc["event"] = "command_response";
579
- responseDoc["command"] = "get_topology";
580
- responseDoc["correlation_id"] = correlationId;
581
- responseDoc["success"] = true;
582
-
583
- // Build topology result
584
- JsonObject result = responseDoc["result"].to<JsonObject>();
585
- result["event"] = "mesh_topology";
586
- result["mesh_id"] = MESH_ID;
587
- result["gateway_node_id"] = getDeviceId();
588
- result["update_type"] = "full";
589
-
590
- SimpleList<uint32_t> nodeList = mesh.getNodeList();
591
-
592
- // Add nodes
593
- JsonArray nodes = result["nodes"].to<JsonArray>();
594
-
595
- JsonObject gatewayNode = nodes.add<JsonObject>();
596
- gatewayNode["node_id"] = getDeviceId();
597
- gatewayNode["role"] = NODE_ROLE;
598
- gatewayNode["status"] = "online";
599
- gatewayNode["connection_count"] = nodeList.size();
600
-
601
- for (auto nodeId : nodeList) {
602
- JsonObject node = nodes.add<JsonObject>();
603
- char nodeIdStr[17];
604
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
605
- node["node_id"] = nodeIdStr;
606
- node["role"] = (nodeId % 2 == 0) ? "sensor" : "repeater";
607
- node["status"] = "online";
608
- }
609
-
610
- // Add connections
611
- JsonArray connections = result["connections"].to<JsonArray>();
612
- for (auto nodeId : nodeList) {
613
- JsonObject conn = connections.add<JsonObject>();
614
- conn["from_node"] = getDeviceId();
615
- char nodeIdStr[17];
616
- snprintf(nodeIdStr, sizeof(nodeIdStr), "ALT-%012X", nodeId);
617
- conn["to_node"] = nodeIdStr;
618
- conn["quality"] = calculateQuality(nodeId);
619
- conn["hop_count"] = 1;
620
- }
621
-
622
- // Add metrics
623
- JsonObject metrics = result["metrics"].to<JsonObject>();
624
- metrics["total_nodes"] = nodeList.size() + 1;
625
- metrics["online_nodes"] = nodeList.size() + 1;
626
-
627
- // Calculate latency
628
- unsigned long latency = millis() - startTime;
629
- responseDoc["latency_ms"] = latency;
630
-
631
- // Publish response
632
- String responseTopic = "alteriom/mesh/" + String(MESH_ID) + "/topology/response";
633
- publishMQTT(responseTopic, responseDoc);
634
-
635
- Serial.println(" ✅ GET_TOPOLOGY response sent");
636
- Serial.println(" Latency: " + String(latency) + "ms");
637
- }
638
- }
639
-
640
- #endif
641
-
642
- // ============================================================================
643
- // MESH CALLBACKS
644
- // ============================================================================
645
-
646
- void receivedCallback(uint32_t from, String &msg) {
647
- Serial.printf("Received from %u: %s\n", from, msg.c_str());
648
- }
649
-
650
- void newConnectionCallback(uint32_t nodeId) {
651
- Serial.printf("✅ New connection: %u\n", nodeId);
652
-
653
- #if IS_GATEWAY
654
- // Trigger incremental update on next check
655
- lastTopologyUpdate = 0;
656
- #endif
657
- }
658
-
659
- void changedConnectionCallback() {
660
- Serial.println("🔄 Connections changed");
661
- }
662
-
663
- void nodeTimeAdjustedCallback(int32_t offset) {
664
- Serial.printf("⏰ Time adjusted: %d us\n", offset);
665
- }
666
-
667
- void droppedConnectionCallback(uint32_t nodeId) {
668
- Serial.printf("❌ Connection dropped: %u\n", nodeId);
669
-
670
- #if IS_GATEWAY
671
- // Trigger incremental update on next check
672
- lastTopologyUpdate = 0;
673
- #endif
674
- }
675
-
676
- // ============================================================================
677
- // SETUP
678
- // ============================================================================
679
-
680
- void setup() {
681
- Serial.begin(115200);
682
- delay(1000);
683
-
684
- Serial.println("\n\n");
685
- Serial.println("================================");
686
- Serial.println("Alteriom Mesh Topology Test");
687
- Serial.println("================================");
688
- Serial.println("Device ID: " + getDeviceId());
689
- Serial.println("Role: " + String(NODE_ROLE));
690
- Serial.println("Firmware: " + String(FIRMWARE_VERSION));
691
- Serial.println("Gateway: " + String(IS_GATEWAY ? "YES" : "NO"));
692
- Serial.println("================================\n");
693
-
694
- // Initialize mesh
695
- mesh.setDebugMsgTypes(ERROR | STARTUP | CONNECTION);
696
- mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
697
-
698
- // Set callbacks
699
- mesh.onReceive(&receivedCallback);
700
- mesh.onNewConnection(&newConnectionCallback);
701
- mesh.onChangedConnections(&changedConnectionCallback);
702
- mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);
703
- mesh.onDroppedConnection(&droppedConnectionCallback);
704
-
705
- #if IS_GATEWAY
706
- // Gateway: Connect to WiFi
707
- Serial.println("Connecting to WiFi: " + String(WIFI_SSID));
708
- WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
709
-
710
- while (WiFi.status() != WL_CONNECTED) {
711
- delay(500);
712
- Serial.print(".");
713
- }
714
-
715
- Serial.println("\n✅ WiFi connected!");
716
- Serial.println(" IP: " + WiFi.localIP().toString());
717
-
718
- // Connect to MQTT
719
- mqttClient.setServer(MQTT_BROKER, MQTT_PORT);
720
- mqttClient.setCallback(mqttCallback);
721
- mqttClient.setBufferSize(2048); // Increase buffer for large topology messages
722
- connectMQTT();
723
-
724
- // Add topology reporting tasks
725
- userScheduler.addTask(taskSendFullTopology);
726
- userScheduler.addTask(taskCheckIncrementalUpdate);
727
- userScheduler.addTask(taskCheckCommands);
728
-
729
- taskSendFullTopology.enable();
730
- taskCheckIncrementalUpdate.enable();
731
- taskCheckCommands.enable();
732
-
733
- Serial.println("✅ Topology reporting enabled");
734
- Serial.println(" Full topology: every " + String(FULL_TOPOLOGY_INTERVAL/1000) + "s");
735
- Serial.println(" Incremental check: every " + String(INCREMENTAL_INTERVAL/1000) + "s");
736
- #endif
737
-
738
- Serial.println("\n🚀 Setup complete! Mesh is running...\n");
739
- }
740
-
741
- // ============================================================================
742
- // LOOP
743
- // ============================================================================
744
-
745
- void loop() {
746
- mesh.update();
747
-
748
- #if IS_GATEWAY
749
- // Keep MQTT connected
750
- if (!mqttClient.connected()) {
751
- connectMQTT();
752
- }
753
- #endif
754
- }