@alteriom/painlessmesh 1.6.1 → 1.7.2

package/docs/wiki/Complete-Documentation.md

@@ -1,123 +1,123 @@
-# Complete Documentation
-
-Welcome to the complete documentation for Alteriom painlessMesh Library!
-
-## 📖 Documentation Sections
-
-### Getting Started
-- [Installation Guide](Installation) - Set up the library in your development environment
-- [Quick Start](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/quickstart.md) - Your first mesh network
-- [First Mesh Tutorial](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/first-mesh.md) - Step-by-step guide
-
-### API Documentation
-- [API Reference](API-Reference) - Complete class and method documentation
-- [Core API](https://github.com/Alteriom/painlessMesh/blob/main/docs/api/core-api.md) - painlessMesh core functionality
-- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible architecture
-
-### Examples and Tutorials
-- [Examples](Examples) - Working code examples
-- [Basic Examples](https://github.com/Alteriom/painlessMesh/blob/main/docs/tutorials/basic-examples.md) - Fundamental usage patterns
-- [Alteriom Extensions](https://github.com/Alteriom/painlessMesh/blob/main/docs/alteriom/overview.md) - SensorPackage, CommandPackage, StatusPackage
-
-### Architecture
-- [Mesh Architecture](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/mesh-architecture.md) - How the mesh network works
-- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible package system
-
-### Troubleshooting
-- [FAQ](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/faq.md) - Frequently asked questions
-- [Common Issues](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/common-issues.md) - Solutions to common problems
-
-### Development
-- [Contributing Guidelines](Contributing) - How to contribute to the project
-- [Release Guide](https://github.com/Alteriom/painlessMesh/blob/main/RELEASE_GUIDE.md) - Release process documentation
-
-## 🚀 Quick Links
-
-### Installation
-```bash
-# Arduino Library Manager
-Tools → Manage Libraries → Search "Alteriom PainlessMesh"
-
-# PlatformIO
-lib_deps = alteriom/painlessMesh@^1.6.1
-
-# NPM
-npm install @alteriom/painlessmesh
-```
-
-### Basic Usage
-```cpp
-#include "painlessMesh.h"
-
-#define MESH_PREFIX     "YourMeshName"
-#define MESH_PASSWORD   "YourPassword"
-#define MESH_PORT       5555
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-void setup() {
-  Serial.begin(115200);
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
-  mesh.onReceive([](uint32_t from, String& msg) {
-    Serial.printf("Received: %s from %u\n", msg.c_str(), from);
-  });
-}
-
-void loop() {
-  mesh.update();
-}
-```
-
-## 📦 Package Types
-
-### SensorPackage (Type 200)
-For environmental sensor data collection:
-- Temperature, humidity, pressure measurements
-- Battery level monitoring
-- Timestamp synchronization
-
-### CommandPackage (Type 201)
-For device control and automation:
-- Remote device commands
-- Parameter passing via JSON
-- Command acknowledgment tracking
-
-### StatusPackage (Type 202)
-For system health monitoring:
-- Device operational status
-- Memory usage tracking
-- Network connectivity metrics
-
-## 🌟 Key Features
-
-- **Automatic Mesh Formation** - Nodes discover and connect automatically
-- **JSON-Based Messaging** - Easy to use and extend
-- **Time Synchronization** - Coordinated behaviors across nodes
-- **Multi-Platform Support** - ESP32, ESP8266
-- **Alteriom Extensions** - Enhanced packages for common use cases
-- **Comprehensive Testing** - Full CI/CD pipeline with automated testing
-
-## 📚 External Resources
-
-- **GitHub Repository**: https://github.com/Alteriom/painlessMesh
-- **NPM Package**: https://www.npmjs.com/package/@alteriom/painlessmesh
-- **PlatformIO Registry**: https://registry.platformio.org/libraries/alteriom/painlessMesh
-- **Issue Tracker**: https://github.com/Alteriom/painlessMesh/issues
-- **Discussions**: https://github.com/Alteriom/painlessMesh/discussions
-
-## 📝 License
-
-This project is licensed under LGPL-3.0 - see the [LICENSE](https://github.com/Alteriom/painlessMesh/blob/main/LICENSE) file for details.
-
-## 🤝 Contributing
-
-We welcome contributions! Please see our [Contributing Guidelines](Contributing) for details on:
-- Code style and standards
-- Pull request process
-- Issue reporting
-- Feature requests
-
----
-
+# Complete Documentation
+
+Welcome to the complete documentation for Alteriom painlessMesh Library!
+
+## 📖 Documentation Sections
+
+### Getting Started
+- [Installation Guide](Installation) - Set up the library in your development environment
+- [Quick Start](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/quickstart.md) - Your first mesh network
+- [First Mesh Tutorial](https://github.com/Alteriom/painlessMesh/blob/main/docs/getting-started/first-mesh.md) - Step-by-step guide
+
+### API Documentation
+- [API Reference](API-Reference) - Complete class and method documentation
+- [Core API](https://github.com/Alteriom/painlessMesh/blob/main/docs/api/core-api.md) - painlessMesh core functionality
+- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible architecture
+
+### Examples and Tutorials
+- [Examples](Examples) - Working code examples
+- [Basic Examples](https://github.com/Alteriom/painlessMesh/blob/main/docs/tutorials/basic-examples.md) - Fundamental usage patterns
+- [Alteriom Extensions](https://github.com/Alteriom/painlessMesh/blob/main/docs/alteriom/overview.md) - SensorPackage, CommandPackage, StatusPackage
+
+### Architecture
+- [Mesh Architecture](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/mesh-architecture.md) - How the mesh network works
+- [Plugin System](https://github.com/Alteriom/painlessMesh/blob/main/docs/architecture/plugin-system.md) - Extensible package system
+
+### Troubleshooting
+- [FAQ](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/faq.md) - Frequently asked questions
+- [Common Issues](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/common-issues.md) - Solutions to common problems
+
+### Development
+- [Contributing Guidelines](Contributing) - How to contribute to the project
+- [Release Guide](https://github.com/Alteriom/painlessMesh/blob/main/RELEASE_GUIDE.md) - Release process documentation
+
+## 🚀 Quick Links
+
+### Installation
+```bash
+# Arduino Library Manager
+Tools → Manage Libraries → Search "Alteriom PainlessMesh"
+
+# PlatformIO
+lib_deps = alteriom/painlessMesh@^1.6.1
+
+# NPM
+npm install @alteriom/painlessmesh
+```
+
+### Basic Usage
+```cpp
+#include "painlessMesh.h"
+
+#define MESH_PREFIX     "YourMeshName"
+#define MESH_PASSWORD   "YourPassword"
+#define MESH_PORT       5555
+
+Scheduler userScheduler;
+painlessMesh mesh;
+
+void setup() {
+  Serial.begin(115200);
+  mesh.init(MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT);
+  mesh.onReceive([](uint32_t from, String& msg) {
+    Serial.printf("Received: %s from %u\n", msg.c_str(), from);
+  });
+}
+
+void loop() {
+  mesh.update();
+}
+```
+
+## 📦 Package Types
+
+### SensorPackage (Type 200)
+For environmental sensor data collection:
+- Temperature, humidity, pressure measurements
+- Battery level monitoring
+- Timestamp synchronization
+
+### CommandPackage (Type 201)
+For device control and automation:
+- Remote device commands
+- Parameter passing via JSON
+- Command acknowledgment tracking
+
+### StatusPackage (Type 202)
+For system health monitoring:
+- Device operational status
+- Memory usage tracking
+- Network connectivity metrics
+
+## 🌟 Key Features
+
+- **Automatic Mesh Formation** - Nodes discover and connect automatically
+- **JSON-Based Messaging** - Easy to use and extend
+- **Time Synchronization** - Coordinated behaviors across nodes
+- **Multi-Platform Support** - ESP32, ESP8266
+- **Alteriom Extensions** - Enhanced packages for common use cases
+- **Comprehensive Testing** - Full CI/CD pipeline with automated testing
+
+## 📚 External Resources
+
+- **GitHub Repository**: https://github.com/Alteriom/painlessMesh
+- **NPM Package**: https://www.npmjs.com/package/@alteriom/painlessmesh
+- **PlatformIO Registry**: https://registry.platformio.org/libraries/alteriom/painlessMesh
+- **Issue Tracker**: https://github.com/Alteriom/painlessMesh/issues
+- **Discussions**: https://github.com/Alteriom/painlessMesh/discussions
+
+## 📝 License
+
+This project is licensed under LGPL-3.0 - see the [LICENSE](https://github.com/Alteriom/painlessMesh/blob/main/LICENSE) file for details.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](Contributing) for details on:
+- Code style and standards
+- Pull request process
+- Issue reporting
+- Feature requests
+
+---
+
 **Need Help?** Check the [FAQ](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/faq.md) or [open an issue](https://github.com/Alteriom/painlessMesh/issues).

package/examples/alteriom/README.md

@@ -1,82 +1,140 @@
-# Alteriom painlessMesh Extensions
-
-This directory contains Alteriom-specific extensions and examples for the painlessMesh library.
-
-## Package Types
-
-### SensorPackage (Type 200)
-Broadcast package for sharing environmental sensor data across the mesh.
-
-**Fields:**
-- `temperature` - Temperature in Celsius
-- `humidity` - Relative humidity percentage  
-- `pressure` - Atmospheric pressure in hPa
-- `sensorId` - Unique sensor identifier
-- `timestamp` - Unix timestamp of measurement
-- `batteryLevel` - Battery level percentage (0-100)
-
-### CommandPackage (Type 201)
-Single-destination package for sending commands to specific nodes.
-
-**Fields:**
-- `command` - Command type identifier
-- `targetDevice` - Target device ID
-- `parameters` - Command parameters as JSON string
-- `commandId` - Unique command identifier for tracking
-
-### StatusPackage (Type 202)
-Broadcast package for sharing device health and status information.
-
-**Fields:**
-- `deviceStatus` - Device status flags
-- `uptime` - Device uptime in seconds
-- `freeMemory` - Free memory in KB
-- `wifiStrength` - WiFi signal strength (0-100)
-- `firmwareVersion` - Current firmware version string
-
-## Examples
-
-### `alteriom_sensor_node.ino`
-Complete Arduino sketch demonstrating:
-- Periodic sensor data broadcasting
-- Command handling
-- Status reporting
-- Message type discrimination
-- Integration with painlessMesh
-
-## Usage
-
-```cpp
-#include "alteriom_sensor_package.hpp"
-using namespace alteriom;
-
-// Create and send sensor data
-SensorPackage sensor;
-sensor.temperature = 25.0;
-sensor.humidity = 60.0;
-// ... set other fields
-mesh.sendBroadcast(sensor.toJsonString());
-
-// Handle incoming commands
-void handleMessage(String& msg) {
-    auto doc = parseJson(msg);
-    if (doc["type"] == 201) {
-        CommandPackage cmd(doc.as<JsonObject>());
-        processCommand(cmd);
-    }
-}
-```
-
-## Testing
-
-Run the Alteriom package tests:
-```bash
-./bin/catch_alteriom_packages
-```
-
-This validates:
-- JSON serialization/deserialization
-- Package type consistency
-- Field preservation
-- Edge case handling
+# Alteriom painlessMesh Extensions
+
+This directory contains Alteriom-specific extensions and examples for the painlessMesh library.
+
+## Package Types
+
+### SensorPackage (Type 200)
+Broadcast package for sharing environmental sensor data across the mesh.
+
+**Fields:**
+- `temperature` - Temperature in Celsius
+- `humidity` - Relative humidity percentage  
+- `pressure` - Atmospheric pressure in hPa
+- `sensorId` - Unique sensor identifier
+- `timestamp` - Unix timestamp of measurement
+- `batteryLevel` - Battery level percentage (0-100)
+
+### CommandPackage (Type 201)
+Single-destination package for sending commands to specific nodes.
+
+**Fields:**
+- `command` - Command type identifier
+- `targetDevice` - Target device ID
+- `parameters` - Command parameters as JSON string
+- `commandId` - Unique command identifier for tracking
+
+### StatusPackage (Type 202)
+Broadcast package for sharing device health and status information.
+
+**Fields:**
+- `deviceStatus` - Device status flags
+- `uptime` - Device uptime in seconds
+- `freeMemory` - Free memory in KB
+- `wifiStrength` - WiFi signal strength (0-100)
+- `firmwareVersion` - Current firmware version string
+
+### EnhancedStatusPackage (Type 203) - Phase 1
+Extended status package with comprehensive health metrics (18 fields).
+
+**Additional Fields:**
+- `firmwareMD5` - Firmware hash for OTA verification
+- `nodeCount`, `connectionCount` - Mesh statistics
+- `messagesReceived`, `messagesSent`, `messagesDropped` - Message counters
+- `avgLatency`, `packetLossRate`, `throughput` - Performance metrics
+- `alertFlags`, `lastError` - Alert system
+
+## Examples
+
+### `alteriom_sensor_node.ino`
+Complete Arduino sketch demonstrating:
+- Periodic sensor data broadcasting
+- Command handling
+- Status reporting
+- Message type discrimination
+- Integration with painlessMesh
+
+### `phase1_features.ino` (NEW)
+Phase 1 OTA enhancement example demonstrating:
+- Compressed OTA transfer infrastructure
+- Enhanced status reporting with comprehensive metrics
+- Alert system implementation
+- Usage patterns for Phase 1 features
+
+## Usage
+
+```cpp
+#include "alteriom_sensor_package.hpp"
+using namespace alteriom;
+
+// Create and send sensor data
+SensorPackage sensor;
+sensor.temperature = 25.0;
+sensor.humidity = 60.0;
+// ... set other fields
+mesh.sendBroadcast(sensor.toJsonString());
+
+// Handle incoming commands
+void handleMessage(String& msg) {
+    auto doc = parseJson(msg);
+    if (doc["type"] == 201) {
+        CommandPackage cmd(doc.as<JsonObject>());
+        processCommand(cmd);
+    }
+}
+```
+
+## Building
+
+### Arduino IDE
+1. Open any `.ino` file in Arduino IDE
+2. Select your board (ESP32 or ESP8266)
+3. Install required libraries via Library Manager:
+   - AlteriomPainlessMesh
+   - ArduinoJson
+   - TaskScheduler
+   - AsyncTCP (ESP32) or ESPAsyncTCP (ESP8266)
+4. Compile and upload
+
+### PlatformIO
+Build all examples with PlatformIO:
+
+```bash
+# Build for ESP32
+cd examples/alteriom
+pio run -e esp32
+
+# Build for ESP8266
+pio run -e esp8266
+
+# Build for both platforms
+pio run
+```
+
+The `platformio.ini` file in this directory configures both ESP32 and ESP8266 platforms with all required dependencies.
+
+### Docker (Alteriom Docker Images)
+For automated builds using Alteriom's Docker images:
+
+```bash
+# Using alteriom-docker-images for PlatformIO builds
+docker run --rm -v $(pwd):/project alteriom/platformio:latest \
+  pio run -d /project/examples/alteriom -e esp32
+
+# Or use the CI test script
+bash ../../test/ci/test_platformio.sh --example alteriom
+```
+
+## Testing
+
+Run the Alteriom package tests:
+```bash
+./bin/catch_alteriom_packages
+```
+
+This validates:
+- JSON serialization/deserialization
+- Package type consistency
+- Field preservation
+- Edge case handling
 - Integration with painlessMesh plugin system