@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/archive/RELEASE_SUMMARY.md

@@ -1,173 +0,0 @@
-# Release Summary - Alteriom painlessMesh Library v1.6.0
-
-## 🎯 Release Overview
-
-This release marks the **comprehensive publication setup** of the Alteriom fork of the painlessMesh library. The library has been completely prepared for modern CI/CD workflows, automated releases, and distribution through multiple package managers.
-
-## ✨ What's New
-
-### 🔧 CI/CD Infrastructure
-- **GitHub Actions** for automated build and testing
-- **Multi-platform compilation** testing (ESP32, ESP8266)
-- **Automated release** generation with changelog integration
-- **Library validation** with Arduino Library Manager compliance
-- **NPM publication** to both public NPM and GitHub Packages
-
-### 📦 Package Management
-- **Arduino Library Manager** ready for submission
-- **PlatformIO** compatibility with automatic indexing
-- **NPM package** configuration for MCP server integration (@alteriom/painlessmesh)
-- **GitHub Packages** scoped publishing
-- **Semantic versioning** with automated version management
-
-### 📚 Enhanced Documentation
-- **Comprehensive README** with installation instructions
-- **Contributing guidelines** for developers
-- **Release guide** for maintainers
-- **Changelog** tracking for version history
-- **GitHub Wiki** automatic synchronization
-
-### 🛠️ Development Tools
-- **Version bump scripts** for easy releases
-- **Library validation scripts** for quality assurance
-- **Multiple build environments** and test suites
-- **Keywords.txt** for Arduino IDE syntax highlighting
-
-## 🏗️ Technical Improvements
-
-### Library Structure
-- ✅ **Arduino Library Manager** compliant structure
-- ✅ **PlatformIO** multi-environment support  
-- ✅ **NPM package** configuration with proper scoping
-- ✅ **GitHub Packages** publishing setup
-- ✅ **Example compilation** verification
-
-### Metadata Accuracy
-- ✅ **Version consistency** across all files (1.6.0)
-- ✅ **Repository URLs** updated to Alteriom fork
-- ✅ **Maintainer information** properly attributed
-- ✅ **License compliance** maintained (LGPL-3.0)
-- ✅ **Keywords and descriptions** optimized
-
-### CI/CD Pipeline
-- ✅ **Build testing** on multiple platforms
-- ✅ **Library format validation**
-- ✅ **Automated releases** with GitHub Actions
-- ✅ **NPM publishing** to public registry and GitHub Packages
-- ✅ **Wiki synchronization** with documentation updates
-- ✅ **Release notes** generation from changelog
-
-## 🎨 Features Retained
-
-All original functionality from the upstream library is maintained:
-
-- **Mesh Networking**: ESP32 and ESP8266 automatic mesh formation
-- **JSON Messaging**: Structured communication between nodes
-- **Time Synchronization**: Coordinated time across all mesh nodes
-- **Task Scheduling**: Built-in task management system
-- **Callback System**: Event-driven programming model
-- **Node Discovery**: Automatic node detection and routing
-
-## 🚀 Alteriom Extensions
-
-### Enhanced Packages
-- **SensorPackage** (Type 200): Environmental monitoring with temperature, humidity, pressure, battery levels
-- **CommandPackage (Type 400): Device control and automation commands
-- **StatusPackage** (Type 202): Health monitoring and system status reporting
-
-### Additional Features
-- **Type-safe serialization**: Automatic JSON conversion with validation
-- **Cross-platform compatibility**: TSTRING abstraction for consistent string handling
-- **Memory optimization**: Efficient data structures for resource-constrained devices
-
-## 📋 Validation Results
-
-The library passes all validation checks:
-
-```
-🔍 Validating Alteriom painlessMesh Library...
-================================================
-📁 All required files present ✅
-🔢 Version consistency across files ✅
-🔗 Repository URLs correct ✅
-📋 Arduino Library Manager compliance ✅
-🏗️ Header file structure valid ✅
-📦 NPM package configuration valid ✅
-🔑 Keywords.txt present for Arduino IDE ✅
-
-🎉 SUCCESS: Library validation passed with no issues!
-```
-
-## 🚀 Installation Methods
-
-### Arduino Library Manager (Recommended)
-```
-1. Open Arduino IDE
-2. Go to Tools → Manage Libraries
-3. Search for "painlessMesh" (author: Alteriom)
-4. Click Install
-```
-
-### PlatformIO
-```ini
-[env:myproject]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_deps = 
-    alteriom/painlessMesh@^1.6.0
-```
-
-### NPM Package (for MCP/Copilot integration)
-```bash
-# Public NPM
-npm install @alteriom/painlessmesh
-
-# GitHub Packages (requires .npmrc configuration)
-echo '@alteriom:registry=https://npm.pkg.github.com' >> .npmrc
-npm install @alteriom/painlessmesh
-```
-
-### Manual Installation
-```bash
-git clone https://github.com/Alteriom/painlessMesh.git
-# Copy to Arduino libraries folder
-```
-
-## 📊 Package Distribution
-
-The library is now available through multiple channels:
-
-- **GitHub Releases**: https://github.com/Alteriom/painlessMesh/releases
-- **Arduino Library Manager**: Search "painlessMesh" (Alteriom)
-- **PlatformIO Registry**: https://registry.platformio.org/libraries/alteriom/painlessMesh
-- **NPM Public**: https://www.npmjs.com/package/@alteriom/painlessmesh
-- **GitHub Packages**: https://github.com/Alteriom/painlessMesh/packages
-- **GitHub Wiki**: https://github.com/Alteriom/painlessMesh/wiki
-
-## 🔮 Future Roadmap
-
-- **v1.6.1**: Bug fixes and minor improvements based on community feedback
-- **v1.7.0**: Additional Alteriom packages and enhanced MCP integration
-- **v1.8.0**: Performance optimizations and memory usage improvements
-- **v2.0.0**: Breaking changes for major improvements (if needed)
-
-## 🤝 Community
-
-- **Repository**: https://github.com/Alteriom/painlessMesh
-- **Issues**: Report bugs and request features
-- **Discussions**: Community support and questions
-- **Contributing**: Follow CONTRIBUTING.md guidelines
-- **Wiki**: Comprehensive documentation and examples
-
-## 🙏 Acknowledgments
-
-- **Coopdis** - Original painlessMesh author and creator
-- **Original Contributors** - Scotty Franzyshen, Edwin van Leeuwen, Germán Martín, and others
-- **Alteriom Team** - Fork enhancements, CI/CD setup, and package management
-
----
-
-**Ready to use?** Install the library and start building your mesh projects today! 🚀
-
-For complete setup instructions and examples, visit our [GitHub Wiki](https://github.com/Alteriom/painlessMesh/wiki).

package/docs/archive/SCONS_BUILD_FIX.md

@@ -1,313 +0,0 @@
-# PlatformIO SCons Build Error Troubleshooting
-
-## Common Error: "UnboundLocalError: local variable 'dir' referenced before assignment"
-
-This error occurs during PlatformIO's SCons build process when compiling `painlessMeshSTA.cpp` and similar files.
-
----
-
-## ✅ FIXES APPLIED TO LIBRARY
-
-The following fixes have been applied to the **painlessMesh library** itself:
-
-### 0. Added Missing Header Include (CRITICAL)
-```cpp
-// src/painlessmesh/mesh.hpp
-#include <vector>  // Required for std::vector usage
-```
-**Why:** The mesh.hpp file uses `std::vector` but wasn't including the header, causing compilation errors.
-
-### 1. Added Explicit Directory Specifications
-```json
-{
-  "srcDir": "src",
-  "includeDir": "src"
-}
-```
-**Why:** Tells PlatformIO exactly where source files are located.
-
-### 2. Removed Conflicting Export Settings
-**Before:**
-```json
-{
-  "export": {
-    "include": "src"
-  }
-}
-```
-
-**After:** (Removed completely)
-
-**Why:** The `export.include` conflicts with `srcDir` and causes path resolution issues in SCons.
-
-### 3. Verified File Locations
-- ✅ All `.cpp` files in `src/` directory
-- ✅ `painlessMeshSTA.cpp` at `src/painlessMeshSTA.cpp`
-- ✅ No source files in root directory
-- ✅ No duplicate `library.json` files
-
-### 4. Fixed Header References
-- ✅ `library.properties` references `painlessMesh.h`
-- ✅ Both `painlessMesh.h` and `AlteriomPainlessMesh.h` available
-
----
-
-## 🔧 FIXES FOR YOUR PROJECT
-
-If you're still getting errors, apply these fixes in YOUR project:
-
-### Fix 1: Clean Build Cache
-
-```bash
-# Delete PlatformIO cache
-pio run --target clean
-
-# Or delete manually
-rm -rf .pio
-rm -rf .pioenvs
-rm -rf .piolibdeps
-```
-
-### Fix 2: Update Library from GitHub
-
-Make sure you're pulling the latest fixes:
-
-```ini
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_deps = 
-    ; Use the LATEST commit with fixes
-    https://github.com/Alteriom/painlessMesh#copilot/start-phase-2-implementation
-```
-
-### Fix 3: Force Library Re-download
-
-```bash
-# Remove cached library
-rm -rf .pio/libdeps/*/AlteriomPainlessMesh
-
-# Or use PlatformIO's update command
-pio pkg update
-```
-
-### Fix 4: Verify PlatformIO Version
-
-```bash
-# Check version
-pio --version
-
-# Update if needed (requires >= 6.0.0)
-pip install -U platformio
-```
-
-### Fix 5: Check for Conflicting Libraries
-
-```bash
-# List installed libraries
-pio pkg list
-
-# Remove any duplicate painlessMesh installations
-pio pkg uninstall -g painlessMesh
-pio pkg uninstall -g AlteriomPainlessMesh
-```
-
----
-
-## 🧪 TEST BUILD
-
-### Step 1: Create Test Project
-
-```bash
-mkdir test-painlessmesh
-cd test-painlessmesh
-pio init --board esp32dev
-```
-
-### Step 2: Create platformio.ini
-
-```ini
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-monitor_speed = 115200
-
-lib_deps = 
-    https://github.com/Alteriom/painlessMesh#copilot/start-phase-2-implementation
-```
-
-### Step 3: Create src/main.cpp
-
-```cpp
-#include <Arduino.h>
-#include <painlessMesh.h>
-
-Scheduler userScheduler;
-painlessMesh mesh;
-
-void setup() {
-  Serial.begin(115200);
-  
-  mesh.setDebugMsgTypes(ERROR | STARTUP);
-  mesh.init("TestMesh", "password", &userScheduler, 5555);
-  
-  Serial.println("Mesh initialized!");
-}
-
-void loop() {
-  mesh.update();
-}
-```
-
-### Step 4: Build
-
-```bash
-pio run
-```
-
-**Expected Output:**
-```
-Building .pio/build/esp32/src/main.cpp.o
-Building .pio/build/esp32/.pio/libdeps/esp32/AlteriomPainlessMesh/...
-Linking .pio/build/esp32/firmware.elf
-Building .pio/build/esp32/firmware.bin
-SUCCESS
-```
-
----
-
-## 🚨 IF STILL FAILING
-
-### Collect Diagnostic Information
-
-```bash
-# Get verbose build output
-pio run -v > build.log 2>&1
-
-# Check library structure
-cd .pio/libdeps/esp32/AlteriomPainlessMesh
-ls -la
-cat library.json
-```
-
-### Check for These Issues:
-
-**1. Verify srcDir in downloaded library:**
-```bash
-cd .pio/libdeps/esp32/AlteriomPainlessMesh
-cat library.json | grep srcDir
-# Should show: "srcDir": "src",
-```
-
-**2. Verify source files exist:**
-```bash
-ls -la src/
-# Should show: painlessMeshSTA.cpp, scheduler.cpp, wifi.cpp
-```
-
-**3. Check for duplicate files:**
-```bash
-find . -name "painlessMeshSTA.cpp"
-# Should only show: ./src/painlessMeshSTA.cpp
-```
-
-**4. Verify no export.include:**
-```bash
-cat library.json | grep export
-# Should show: (nothing) or not include "include": "src"
-```
-
----
-
-## 📋 CHECKLIST FOR SUCCESSFUL BUILD
-
-- [ ] PlatformIO version >= 6.0.0
-- [ ] Clean build cache (`pio run --target clean`)
-- [ ] Remove `.pio` directory
-- [ ] Update library.json has `srcDir` and `includeDir`
-- [ ] No `export.include` in library.json
-- [ ] All `.cpp` files in `src/` directory
-- [ ] Force library re-download from GitHub
-- [ ] Test with minimal example
-- [ ] Check verbose build log for actual error
-
----
-
-## 🔍 UNDERSTANDING THE ERROR
-
-### What Causes "UnboundLocalError: dir"?
-
-This error occurs in PlatformIO's SCons build system when:
-
-1. **Path resolution fails:** SCons can't determine the source directory
-2. **Conflicting settings:** Multiple directory specifications conflict
-3. **Cache corruption:** Old cached metadata from previous builds
-4. **Missing metadata:** No `srcDir` specified in library.json
-
-### The Fix (Applied):
-
-```json
-{
-  "name": "AlteriomPainlessMesh",
-  "srcDir": "src",           // ← Explicit source directory
-  "includeDir": "src"        // ← Explicit include directory
-  // "export": {...}         // ← REMOVED (was causing conflicts)
-}
-```
-
----
-
-## 📞 SUPPORT
-
-If issues persist after trying all fixes:
-
-1. **Check your build log:**
-   ```bash
-   pio run -v 2>&1 | tee build-verbose.log
-   ```
-
-2. **Verify library was actually updated:**
-   ```bash
-   cd .pio/libdeps/YOUR_ENV/AlteriomPainlessMesh
-   git log -1 --oneline
-   # Should show recent commit with fixes
-   ```
-
-3. **Try a completely fresh project:**
-   - New directory
-   - Fresh `pio init`
-   - No existing `.pio` folder
-   - Copy minimal example above
-
-4. **Report issue with:**
-   - PlatformIO version
-   - Platform (espressif32/espressif8266)
-   - Full build log
-   - Contents of `.pio/libdeps/*/AlteriomPainlessMesh/library.json`
-
----
-
-## ✅ VERIFICATION
-
-After applying fixes, your build should succeed with output like:
-
-```
-Dependency Graph
-|-- AlteriomPainlessMesh @ 1.7.0
-|   |-- AsyncTCP @ 3.4.7
-|   |-- ArduinoJson @ 7.4.2
-|   |-- TaskScheduler @ 4.0.0
-|   |-- WiFi @ 2.0.0
-Building .pio/build/esp32/lib/.../painlessMeshSTA.cpp.o
-...
-SUCCESS
-```
-
----
-
-**Last Updated:** October 15, 2025  
-**Library Version:** 1.7.0  
-**Branch:** copilot/start-phase-2-implementation  
-**Status:** ✅ SCons build issues resolved