@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/development/DOCKER_TESTING.md

@@ -1,196 +0,0 @@
-# Docker Build & Test Scripts for painlessMesh
-
-## Quick Start
-
-### Prerequisites
-- Install Docker Desktop for Windows: https://www.docker.com/products/docker-desktop/
-- Ensure Docker is running (check system tray)
-
-### Run Tests (Automated)
-
-```powershell
-# Build and run all tests
-docker-compose up painlessmesh-test
-
-# Or using plain Docker
-docker build -t painlessmesh-test .
-docker run --rm -v ${PWD}:/workspace painlessmesh-test
-```
-
-### Interactive Development Shell
-
-```powershell
-# Start interactive shell
-docker-compose run --rm painlessmesh-dev
-
-# Inside the container, you can:
-cmake -G Ninja .
-ninja
-./bin/catch_mqtt_bridge
-./bin/catch_alteriom_packages
-# etc.
-```
-
-## Available Commands
-
-### Build Docker Image
-```powershell
-docker-compose build
-```
-
-### Run Specific Test
-```powershell
-docker-compose run --rm painlessmesh-test ./bin/catch_mqtt_bridge
-```
-
-### Run All Tests
-```powershell
-docker-compose up painlessmesh-test
-```
-
-### Clean Build Artifacts
-```powershell
-docker-compose down -v
-```
-
-### Rebuild from Scratch
-```powershell
-docker-compose build --no-cache
-docker-compose up painlessmesh-test
-```
-
-## CI/CD Integration
-
-### GitHub Actions Example
-
-```yaml
-name: Test with Docker
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      
-      - name: Build and Test
-        run: |
-          docker build -t painlessmesh-test .
-          docker run --rm painlessmesh-test
-```
-
-### Local PowerShell Script
-
-Create `test.ps1`:
-```powershell
-#!/usr/bin/env pwsh
-Write-Host "Building Docker image..." -ForegroundColor Cyan
-docker build -t painlessmesh-test .
-
-Write-Host "`nRunning tests..." -ForegroundColor Cyan
-docker run --rm painlessmesh-test
-
-if ($LASTEXITCODE -eq 0) {
-    Write-Host "`n✅ All tests passed!" -ForegroundColor Green
-} else {
-    Write-Host "`n❌ Tests failed!" -ForegroundColor Red
-    exit 1
-}
-```
-
-Run with: `.\test.ps1`
-
-## Troubleshooting
-
-### Docker Not Running
-```
-Error: Cannot connect to the Docker daemon
-```
-**Solution:** Start Docker Desktop from Windows Start Menu
-
-### Port Conflicts
-If you see port binding errors, stop conflicting containers:
-```powershell
-docker ps
-docker stop <container_id>
-```
-
-### Disk Space Issues
-Clean up unused images and containers:
-```powershell
-docker system prune -a
-```
-
-### Build Cache Issues
-Force rebuild without cache:
-```powershell
-docker-compose build --no-cache
-```
-
-## What Gets Tested
-
-The Docker environment runs all Catch2 tests:
-- ✅ `catch_mqtt_bridge` - MQTT command routing and parameter parsing
-- ✅ `catch_alteriom_packages` - Alteriom package serialization
-- ✅ `catch_protocol` - Protocol validation
-- ✅ `catch_router` - Mesh routing logic
-- ✅ `catch_plugin` - Plugin system
-- ✅ And all other `catch_*.cpp` tests
-
-## Benefits of Docker Testing
-
-1. **Consistent Environment** - Same results on all machines
-2. **No Local Installation** - No need for CMake, Ninja, compilers
-3. **CI/CD Ready** - Same container in development and CI
-4. **Isolated** - Doesn't affect your Windows installation
-5. **Reproducible** - Anyone can run tests identically
-
-## Integration with VS Code
-
-Install the "Docker" extension, then you can:
-- Right-click `Dockerfile` → "Build Image"
-- Right-click `docker-compose.yml` → "Compose Up"
-- View logs in VS Code terminal
-
-## Performance Tips
-
-### Use BuildKit for Faster Builds
-```powershell
-$env:DOCKER_BUILDKIT=1
-docker build -t painlessmesh-test .
-```
-
-### Mount Source as Volume (Faster Iteration)
-```powershell
-docker run --rm -v ${PWD}:/workspace painlessmesh-test
-```
-
-This way, changes to source files don't require rebuilding the image.
-
-## Advanced Usage
-
-### Run Single Test File
-```powershell
-docker-compose run --rm painlessmesh-test bash -c "cmake -G Ninja . && ninja && ./bin/catch_mqtt_bridge"
-```
-
-### Debug Build
-```powershell
-docker-compose run --rm painlessmesh-dev
-# Inside container:
-cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .
-ninja
-gdb ./bin/catch_mqtt_bridge
-```
-
-### Check for Memory Leaks (with Valgrind)
-Add to Dockerfile:
-```dockerfile
-RUN apt-get update && apt-get install -y valgrind
-```
-
-Then run:
-```powershell
-docker-compose run --rm painlessmesh-test valgrind ./bin/catch_mqtt_bridge
-```

package/docs/development/PLATFORMIO_USAGE.md

@@ -1,180 +0,0 @@
-# Using AlteriomPainlessMesh in Your PlatformIO Project
-
-## Quick Start
-
-### Step 1: Add to platformio.ini
-
-```ini
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_deps = 
-    https://github.com/Alteriom/painlessMesh#copilot/start-phase-2-implementation
-```
-
-Or for ESP8266:
-
-```ini
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_deps = 
-    https://github.com/Alteriom/painlessMesh#copilot/start-phase-2-implementation
-```
-
-### Step 2: Include in your code
-
-```cpp
-#include <painlessMesh.h>
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-void setup() {
-  Serial.begin(115200);
-  
-  mesh.setDebugMsgTypes(ERROR | STARTUP);
-  mesh.init("MESH_SSID", "MESH_PASSWORD", &userScheduler, 5555);
-  mesh.onReceive(&receivedCallback);
-  mesh.onNewConnection(&newConnectionCallback);
-  mesh.onChangedConnections(&changedConnectionCallback);
-}
-
-void loop() {
-  mesh.update();
-}
-
-void receivedCallback(uint32_t from, String& msg) {
-  Serial.printf("Received from %u: %s\n", from, msg.c_str());
-}
-
-void newConnectionCallback(uint32_t nodeId) {
-  Serial.printf("New Connection: %u\n", nodeId);
-}
-
-void changedConnectionCallback() {
-  Serial.println("Connections changed");
-}
-```
-
-### Step 3: Build
-
-```bash
-pio run
-```
-
-## Troubleshooting
-
-### Error: "cannot resolve directory"
-
-**Solution:** This is now FIXED! The library has:
-- ✅ Explicit `srcDir: "src"` in library.json
-- ✅ All source files in src/ directory
-- ✅ No duplicate library.json files
-- ✅ Proper header references
-
-### Error: "UnboundLocalError: dir"
-
-**Solution:** This was caused by npm build scripts. Now FIXED:
-- ✅ Build scripts renamed to `dev:build` (won't auto-run)
-- ✅ npm link works without triggering cmake
-
-### Error: "header not found"
-
-**Solution:** Use the correct include:
-
-```cpp
-// ✅ Correct
-#include <painlessMesh.h>
-
-// ❌ Wrong
-#include <AlteriomPainlessMesh.h>  // Alternative header, use painlessMesh.h instead
-```
-
-## Library Structure (Verified ✓)
-
-```
-painlessMesh/
-├── library.json              ✓ Root metadata with srcDir
-├── library.properties        ✓ Arduino IDE compatibility
-├── src/                      ✓ All source files here
-│   ├── painlessMesh.h        ✓ Main header
-│   ├── painlessMeshSTA.cpp   ✓ Implementation
-│   ├── scheduler.cpp
-│   ├── wifi.cpp
-│   └── painlessmesh/         ✓ Library modules
-└── examples/                 ✓ 20 example sketches
-```
-
-## Validation Status
-
-Run validation script to verify:
-
-```bash
-python scripts/validate_library_structure.py
-```
-
-**Current Status:** ✅ 8/8 checks passed (100%)
-
-## Alteriom Extensions
-
-This fork includes additional features:
-
-### SensorPackage (Type 200)
-```cpp
-#include "examples/alteriom/alteriom_sensor_package.hpp"
-
-alteriom::SensorPackage sensor;
-sensor.temperature = 22.5;
-sensor.humidity = 55.0;
-sensor.pressure = 1013.25;
-mesh.sendBroadcast(sensor.to_string());
-```
-
-### CommandPackage (Type 201)
-```cpp
-alteriom::CommandPackage cmd;
-cmd.command = 1;  // LED_CONTROL
-cmd.targetDevice = targetNodeId;
-cmd.parameters = "{\"state\":true}";
-mesh.sendSingle(targetNodeId, cmd.to_string());
-```
-
-### StatusPackage (Type 202)
-```cpp
-alteriom::StatusPackage status;
-status.deviceStatus = 1;  // Online
-status.uptime = millis() / 1000;
-status.freeMemory = ESP.getFreeHeap() / 1024;
-mesh.sendBroadcast(status.to_string());
-```
-
-## MQTT Integration
-
-For MQTT gateway functionality, see:
-- `examples/mqttBridge/mqttBridge.ino`
-- `docs/MESH_TOPOLOGY_GUIDE.md` - Visualization examples
-- `docs/MQTT_BRIDGE_COMMANDS.md` - Command reference
-
-## Schema Compliance
-
-This library implements **@alteriom/mqtt-schema v0.5.0**:
-- ✅ Device ID format: `ALT-XXXXXXXXXXXX`
-- ✅ Envelope fields (schema_version, device_id, timestamp, etc.)
-- ✅ Mesh topology reporting
-- ✅ Command/response tracking with correlation IDs
-
-## Support
-
-- **Issues:** https://github.com/Alteriom/painlessMesh/issues
-- **Pull Request:** #17 (Phase 2 Implementation)
-- **Documentation:** `docs/` directory
-- **Examples:** `examples/` directory (20 sketches)
-
----
-
-**Last Validated:** October 15, 2025  
-**Branch:** copilot/start-phase-2-implementation  
-**Status:** ✅ Ready for PlatformIO use

package/docs/development/TESTING_SUMMARY.md

@@ -1,126 +0,0 @@
-# Testing Summary
-
-## ✅ Implementation Complete & CI Fixed
-
-All MQTT Bridge Command System files have been created and committed.
-
-### 🔧 CI Build Fixes (Commit 81ba4bc)
-
-**Fixed Issues:**
-1. ❌ **Include Path Error** - `catch_mqtt_bridge.cpp` couldn't find `alteriom_sensor_package.hpp`
-   - **Solution**: Changed from `#include "examples/alteriom/..."` to `#include "../../examples/alteriom/..."`
-   - **Reason**: Test files need relative paths from `test/catch/` directory
-
-2. ❌ **Clang-Format Violations** - 3 formatting errors in `alteriom_sensor_package.hpp`
-   - Line 97: Comment alignment on `firmwareVersion` field
-   - Line 101: Comment alignment on `responseMessage` field  
-   - Line 131: Long line exceeding format guidelines
-   - **Solution**: Aligned comments consistently and broke long line across two lines
-
-**Build Status:**
-- Commit `6aa7c3f`: ❌ Failed (include path + formatting)
-- Commit `81ba4bc`: 🔄 Building now...
-
-### Core Implementation (2,656+ lines of code)
-- ✅ `docs/MQTT_BRIDGE_COMMANDS.md` - Complete API documentation
-- ✅ `docs/MQTT_BRIDGE_IMPLEMENTATION_SUMMARY.md` - Architecture overview
-- ✅ `examples/bridge/mqtt_command_bridge.hpp` - Bidirectional bridge class
-- ✅ `examples/mqttCommandBridge/mqttCommandBridge.ino` - Gateway example
-- ✅ `examples/alteriom/mesh_command_node.ino` - Command handler node
-- ✅ `examples/alteriom/alteriom_sensor_package.hpp` - Enhanced StatusPackage
-- ✅ `test/catch/catch_mqtt_bridge.cpp` - Comprehensive test suite
-
-### Docker Testing Infrastructure
-- ✅ `Dockerfile` - Containerized build environment
-- ✅ `docker-compose.yml` - Orchestration config
-- ✅ `docker-test.ps1` - PowerShell helper script
-- ✅ `.dockerignore` - Optimized build context
-- ✅ `DOCKER_TESTING.md` - Docker usage guide
-
-## 🧪 Testing Strategy
-
-### Cloud-Based CI/CD (Recommended) ✨
-**Status:** Active - Tests running now!
-
-GitHub Actions automatically tests every commit with:
-- ✅ GCC 13 compiler
-- ✅ Clang 18 compiler  
-- ✅ All unit tests including `catch_mqtt_bridge`
-- ✅ ESP32 and ESP8266 platform builds
-- ✅ Code quality checks
-
-**View Results:** https://github.com/Alteriom/painlessMesh/actions
-
-**Commit:** `6aa7c3f` - "feat: Add MQTT Bridge Command System"
-
-### Local Testing (Optional)
-
-#### Option 1: GitHub Actions (No Local Setup)
-```bash
-# Just push and watch the tests run in the cloud
-git push
-# View at: https://github.com/Alteriom/painlessMesh/actions
-```
-
-#### Option 2: Docker (Requires Docker Desktop)
-```powershell
-# Build and test in container
-.\docker-test.ps1
-```
-
-#### Option 3: Native Build (Requires C++ Compiler)
-```powershell
-# If you have Visual Studio or MinGW installed
-cmake -G Ninja .
-ninja
-.\bin\catch_mqtt_bridge.exe
-```
-
-## 📊 Test Coverage
-
-### catch_mqtt_bridge.cpp Test Scenarios
-1. ✅ Command routing (unicast/broadcast)
-2. ✅ Parameter parsing (LED, relay, PWM, sleep)
-3. ✅ Response tracking with command IDs
-4. ✅ Configuration management
-5. ✅ StatusPackage serialization
-6. ✅ Error handling
-7. ✅ Broadcast command handling
-8. ✅ JSON validation
-
-**Total Assertions:** 45+
-
-## 🎯 What Happens Next
-
-1. **GitHub Actions Running** - Tests are executing now in the cloud
-2. **Results in ~5 minutes** - Check the Actions tab for results
-3. **Automatic PR Updates** - Test status will appear on PR #17
-4. **No PC Impact** - All heavy lifting done in GitHub's infrastructure
-
-## 🚀 Ready for Deployment
-
-Once tests pass, you can:
-1. **Flash Gateway:** Upload `mqttCommandBridge.ino` to ESP32
-2. **Flash Nodes:** Upload `mesh_command_node.ino` to sensors
-3. **Control via MQTT:** Use any MQTT client to send commands
-4. **Monitor Status:** Receive real-time updates
-
-## 📚 Documentation
-
-- 📖 [MQTT Bridge Commands API](docs/MQTT_BRIDGE_COMMANDS.md)
-- 📋 [Implementation Summary](docs/MQTT_BRIDGE_IMPLEMENTATION_SUMMARY.md)
-- 🔧 [OTA Commands](docs/OTA_COMMANDS_REFERENCE.md)
-- 🐳 [Docker Testing Guide](DOCKER_TESTING.md)
-
-## 🎉 Summary
-
-✅ **Implementation:** Complete (2,656+ lines)  
-✅ **Documentation:** Complete  
-✅ **Tests:** Running in GitHub Actions  
-✅ **Docker:** Optional local testing available  
-✅ **No PC Crashes:** Cloud-based testing prevents local issues  
-
-**Last Commit:** 6aa7c3f  
-**Branch:** copilot/start-phase-2-implementation  
-**PR:** #17  
-**Date:** October 12, 2025