@alteriom/painlessmesh 1.8.14 → 1.9.0

package/docs/platformio-publishing.md

@@ -1,255 +0,0 @@
-# PlatformIO Library Publishing Guide
-
-This guide explains how to publish the AlteriomPainlessMesh library to the PlatformIO Library Registry.
-
-## Prerequisites
-
-### 1. PlatformIO Account Setup
-
-1. Visit [https://platformio.org/](https://platformio.org/) and create an account
-2. Verify your email address
-3. Log in to your PlatformIO account
-
-### 2. Authentication Token
-
-1. Go to [https://platformio.org/account/token](https://platformio.org/account/token)
-2. Generate a new Personal Access Token
-3. Copy the token and store it securely
-4. Set up the token in your local environment:
-
-   ```powershell
-   # Set environment variable (Windows PowerShell)
-   $env:PLATFORMIO_AUTH_TOKEN="YOUR_TOKEN_HERE"
-   
-   # Or for Command Prompt
-   set PLATFORMIO_AUTH_TOKEN=YOUR_TOKEN_HERE
-   
-   # Or use login command
-   pio account login
-   ```
-
-## Library Configuration
-4. Set up the token in your local environment:
-   ```powershell
-   pio account token --set YOUR_TOKEN_HERE
-   ```
-
-## Library Configuration
-
-### Required Files
-Ensure these files are properly configured:
-
-#### 1. `library.json` (Primary PlatformIO Configuration)
-```json
-{
-    "name": "AlteriomPainlessMesh",
-    "keywords": "ethernet, m2m, iot, mesh, alteriom, sensor, esp32, esp8266, json, time-sync, wireless, communication",
-    "description": "painlessMesh library with Alteriom extensions for sensor networks",
-    "repository": {
-        "type": "git", 
-        "url": "https://github.com/Alteriom/painlessMesh"
-    },
-    "version": "1.6.1",
-    "frameworks": ["arduino"],
-    "platforms": ["espressif8266", "espressif32"],
-    "dependencies": [...],
-    "authors": [...],
-    "license": "LGPL-3.0",
-    "homepage": "https://github.com/Alteriom/painlessMesh",
-    "headers": "painlessMesh.h",
-    "examples": ["examples/basic/basic.ino", "examples/alteriom/alteriom_sensor_node.ino"],
-    "export": {
-        "include": "src"
-    }
-}
-```
-
-#### 2. `library.properties` (Arduino Library Manager)
-Should remain compatible for dual publishing:
-```properties
-name=AlteriomPainlessMesh
-version=1.6.1
-author=Coopdis,Scotty Franzyshen,Edwin van Leeuwen,Germán Martín,Maximilian Schwarz,Doanh Doanh,Alteriom
-maintainer=Alteriom
-sentence=A painless way to setup a mesh with ESP8266 and ESP32 devices with Alteriom extensions
-paragraph=...
-category=Communication
-url=https://github.com/Alteriom/painlessMesh
-architectures=esp8266,esp32
-includes=AlteriomPainlessMesh.h
-depends=ArduinoJson, TaskScheduler
-```
-
-## Publishing Process
-
-### Method 1: Git Tag Publishing (Recommended)
-
-This method automatically publishes when you create a Git tag:
-
-1. **Ensure all files are committed and pushed:**
-   ```powershell
-   git add .
-   git commit -m "Prepare v1.6.1 for PlatformIO Library Registry"
-   git push origin main
-   ```
-
-2. **Create and push a Git tag:**
-   ```powershell
-   git tag v1.6.1
-   git push origin v1.6.1
-   ```
-
-3. **PlatformIO will automatically detect the new tag and import the library**
-   - Monitor at: [https://platformio.org/lib/show/LIBRARY_ID/AlteriomPainlessMesh](https://platformio.org/lib)
-   - It may take 5-15 minutes for the library to appear
-
-### Method 2: Manual Package Upload
-
-If automatic detection doesn't work:
-
-1. **Create a tarball of your library:**
-   ```powershell
-   # Create archive excluding unnecessary files
-   tar --exclude='.git' --exclude='test' --exclude='bin' --exclude='.vscode' --exclude='node_modules' -czf AlteriomPainlessMesh-1.6.1.tar.gz .
-   ```
-
-2. **Submit via PlatformIO Library Registry:**
-   - Visit [https://platformio.org/lib/register](https://platformio.org/lib/register)
-   - Upload the created tarball
-   - Fill in any additional metadata
-
-### Method 3: Using PlatformIO CLI
-
-```powershell
-# Ensure you're authenticated
-pio account token --set YOUR_TOKEN_HERE
-
-# Publish the library
-pio pkg publish .
-```
-
-## Verification
-
-### 1. Check Library Status
-```powershell
-# Search for your published library
-pio pkg search "AlteriomPainlessMesh"
-
-# View detailed information
-pio pkg show alteriom/AlteriomPainlessMesh
-```
-
-### 2. Test Installation
-Create a test project to verify the library can be installed:
-```powershell
-mkdir test_project
-cd test_project
-pio project init --board esp32dev
-
-# Add to platformio.ini:
-# lib_deps = alteriom/AlteriomPainlessMesh@^1.6.1
-
-pio pkg install
-```
-
-## Updating the Library
-
-For future releases:
-
-1. **Update version numbers:**
-   - `library.json` → `"version": "1.6.2"`
-   - `library.properties` → `version=1.6.2`
-   - `package.json` → `"version": "1.6.2"`
-
-2. **Commit changes:**
-   ```powershell
-   git add .
-   git commit -m "Bump version to 1.6.2"
-   git push origin main
-   ```
-
-3. **Create new tag:**
-   ```powershell
-   git tag v1.6.2
-   git push origin v1.6.2
-   ```
-
-4. **Verify update appears in registry**
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Library name conflicts:**
-   - Use a unique name like "AlteriomPainlessMesh" instead of "painlessMesh"
-   - Check existing libraries: `pio pkg search "painless"`
-
-2. **Authentication errors:**
-   - Verify token: `pio account show`
-   - Regenerate token if needed
-
-3. **Dependency resolution errors:**
-   - Ensure all dependencies exist in PlatformIO Registry
-   - Check version constraints (use `^` for flexible versions)
-
-4. **Git repository requirements:**
-   - Repository must be publicly accessible
-   - Tags must follow semantic versioning (v1.6.1)
-   - library.json must be in repository root
-
-### Useful Commands
-
-```powershell
-# Check authentication status
-pio account show
-
-# List all your published packages
-pio pkg search --owner="YOUR_USERNAME"
-
-# View package statistics
-pio pkg stats
-
-# Update package metadata
-pio pkg update
-```
-
-## Best Practices
-
-1. **Semantic Versioning:**
-   - Use format: MAJOR.MINOR.PATCH (e.g., 1.6.1)
-   - Increment MAJOR for breaking changes
-   - Increment MINOR for new features
-   - Increment PATCH for bug fixes
-
-2. **Documentation:**
-   - Include comprehensive README.md
-   - Provide working examples in examples/ directory
-   - Document all public APIs
-
-3. **Testing:**
-   - Test library installation in clean environments
-   - Verify examples compile successfully
-   - Test on both ESP8266 and ESP32 platforms
-
-4. **Dependency Management:**
-   - Specify minimum required versions
-   - Use version ranges (^1.6.0) for flexibility
-   - Platform-specific dependencies when needed
-
-## PlatformIO Library Registry URLs
-
-- **Library Registry:** [https://platformio.org/lib](https://platformio.org/lib)
-- **Account Management:** [https://platformio.org/account](https://platformio.org/account)
-- **Submit Library:** [https://platformio.org/lib/register](https://platformio.org/lib/register)
-- **Documentation:** [https://docs.platformio.org/en/latest/librarymanager/index.html](https://docs.platformio.org/en/latest/librarymanager/index.html)
-
----
-
-**Note:** After successful publication, users will be able to install your library using:
-```ini
-[env:esp32dev]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_deps = alteriom/AlteriomPainlessMesh@^1.6.1
-```

package/docs/platformio-setup-summary.md

@@ -1,121 +0,0 @@
-# PlatformIO Publishing Setup Summary
-
-## ✅ What's Been Implemented
-
-### 1. Dedicated PlatformIO Publishing Workflow
-- **File**: `.github/workflows/platformio-publish.yml`
-- **Triggers**: Automatic on releases, manual dispatch for testing
-- **Features**: Complete validation, authentication, and publishing pipeline
-
-### 2. Library Configuration Enhanced
-- **Updated `library.json`**: PlatformIO-specific optimizations
-- **Name**: Changed to "AlteriomPainlessMesh" for uniqueness
-- **Dependencies**: All verified available in PlatformIO Registry
-- **Metadata**: Enhanced with license, examples, export configuration
-
-### 3. Release Process Integration
-- **Main release workflow** now references PlatformIO publishing
-- **Documentation updated** in `RELEASE_GUIDE.md`
-- **Comprehensive instructions** in `docs/platformio-publishing.md`
-
-## 🚀 How It Works
-
-### Automatic Publishing
-1. **Release Created**: GitHub release triggers PlatformIO workflow
-2. **Validation**: Library.json format and dependencies checked
-3. **Authentication**: Uses `PLATFORMIO_AUTH_TOKEN` secret
-4. **Publication**: Direct publishing via PlatformIO CLI
-5. **Verification**: Registry confirmation and user notification
-
-### Manual Publishing (Alternative)
-1. Go to GitHub Actions → PlatformIO Library Publishing
-2. Click "Run workflow"
-3. Enter version number and optional force publish
-4. Workflow handles the rest
-
-## 🔧 Setup Required
-
-### One-Time Setup: PlatformIO Account
-
-1. **Create Account**: <https://platformio.org/account/register>
-2. **Generate Token**: <https://platformio.org/account/token>
-3. **Add to Secrets**: Repository Settings → Secrets → Actions
-   - Name: `PLATFORMIO_AUTH_TOKEN`
-   - Value: [your token from step 2]
-
-**Local Testing (Optional):**
-```powershell
-# Method 1: Environment variable
-$env:PLATFORMIO_AUTH_TOKEN="YOUR_TOKEN_HERE"
-pio account show  # Verify authentication
-
-# Method 2: Interactive login (if token doesn't work)
-pio account login
-
-# Test publishing
-pio pkg publish . --no-interactive
-```
-
-**Troubleshooting Authentication:**
-```powershell
-# If authentication fails:
-1. Go to https://platformio.org/account/token
-2. Copy your existing token OR generate a new one
-3. Set it as environment variable: $env:PLATFORMIO_AUTH_TOKEN="token"
-4. Test: pio account show
-```
-
-### Current Status for v1.6.1
-Since v1.6.1 is already released and published to other platforms:
-
-#### Option A: Test with Manual Workflow
-```
-1. Go to: https://github.com/Alteriom/painlessMesh/actions/workflows/platformio-publish.yml
-2. Click "Run workflow"
-3. Set version: 1.6.1
-4. Enable force_publish: true
-5. Click "Run workflow"
-```
-
-#### Option B: Wait for Next Release
-The PlatformIO workflow will automatically trigger on your next release (v1.6.2, etc.)
-
-## 📋 Future Releases
-
-For all future releases, PlatformIO publishing is now **fully automated**:
-
-```bash
-# Standard release process remains the same
-./scripts/bump-version.sh patch
-# Edit CHANGELOG.md
-git add . && git commit -m "release: v1.6.2" && git push
-```
-
-This will now automatically:
-- ✅ Create GitHub release
-- ✅ Publish to NPM 
-- ✅ **Publish to PlatformIO Registry**
-- ✅ Update GitHub Wiki
-- ✅ Prepare Arduino Library Manager package
-
-## 🔍 Verification
-
-After publishing, verify at:
-- **Registry**: <https://registry.platformio.org/libraries>
-- **Search**: Search for "AlteriomPainlessMesh"
-- **Installation**: `pio pkg install --library "alteriom/AlteriomPainlessMesh@^1.6.1"`
-
-## 📚 Documentation
-
-Complete documentation available:
-- **Publishing Guide**: `docs/platformio-publishing.md`
-- **Release Process**: `RELEASE_GUIDE.md` (updated)
-- **Workflow Details**: `.github/workflows/platformio-publish.yml`
-
-## 🎯 Next Steps
-
-1. **Add PlatformIO Token**: Set up the `PLATFORMIO_AUTH_TOKEN` secret
-2. **Test Workflow**: Run manual workflow for v1.6.1 (optional)
-3. **Next Release**: PlatformIO publishing will be automatic
-
-The PlatformIO publishing is now fully integrated into your release pipeline! 🎉

package/docs/releases/ANNOUNCEMENT_v1.8.6.md

@@ -1,63 +0,0 @@
-# 🎉 painlessMesh v1.8.6 Released!
-
-We're excited to announce **painlessMesh v1.8.6** - a patch release that fixes a critical bridge failover issue.
-
-## 🔧 What's Fixed
-
-**Bridge Auto-Election** - Meshes now automatically elect a bridge when all nodes start without a designated initial bridge. Previously, the network would remain bridgeless indefinitely in this scenario.
-
-### The Problem
-```
---- Bridge Status ---
-I am bridge: NO
-Internet available: NO  
-Known bridges: 0
-No primary bridge available! ❌
-```
-
-### The Solution
-After a 60-second startup grace period, the mesh automatically detects the absence of a bridge and triggers an election. The node with the best WiFi signal (RSSI) becomes the bridge. ✅
-
-## 🚀 Key Features
-
-- **Automatic Recovery** - No manual intervention needed
-- **Smart Timing** - 60s grace period for network stabilization
-- **Randomized Delays** - Prevents election conflicts
-- **Fully Backward Compatible** - Existing setups work unchanged
-
-## 📦 Installation
-
-```bash
-# PlatformIO
-pio pkg update alteriom/AlteriomPainlessMesh@^1.8.6
-
-# NPM
-npm update @alteriom/painlessmesh
-
-# Arduino Library Manager
-Search for "AlteriomPainlessMesh" and update
-```
-
-## 🎯 Perfect For
-
-✅ Dynamic mesh networks with changing topologies  
-✅ IoT deployments requiring automatic bridge recovery  
-✅ Development environments without pre-configured bridges  
-✅ Fault-tolerant systems needing zero-touch setup  
-
-## 🙏 Thanks
-
-Special thanks to **@woodlist** for reporting the issue and providing detailed logs!
-
-## 📚 Learn More
-
-- 📖 [Full Release Notes](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_NOTES_v1.8.6.md)
-- 🔗 [GitHub Release](https://github.com/Alteriom/painlessMesh/releases/tag/v1.8.6)
-- 📝 [Changelog](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)
-- 💻 [Bridge Failover Example](https://github.com/Alteriom/painlessMesh/tree/main/examples/bridge_failover)
-
----
-
-**Upgrade today and enjoy seamless bridge failover! 🎊**
-
-#painlessMesh #ESP32 #ESP8266 #IoT #MeshNetwork #Arduino #Alteriom

package/docs/releases/ANNOUNCEMENT_v1.8.7.md

@@ -1,113 +0,0 @@
-# 🚀 AlteriomPainlessMesh v1.8.7 Released
-
-**Date:** November 12, 2025
-
-We're pleased to announce the release of **AlteriomPainlessMesh v1.8.7**, a patch release focused on bug fixes and documentation improvements.
-
-## 🎯 What's New
-
-### Bridge Internet Connectivity Detection Fixed
-
-Bridge nodes now correctly detect and report internet connectivity status. The previous implementation only checked WiFi connection status, which led to incorrect reporting when bridges were connected to routers with internet access.
-
-**Key Improvements:**
-- ✅ Accurate internet status reporting for bridge nodes
-- ✅ Proper gateway IP validation (not 0.0.0.0)
-- ✅ Fixed false positives on regular nodes
-- ✅ Better bridge failover logic
-
-### Version Documentation Clarity
-
-We've resolved confusion about version numbers in header files by creating comprehensive documentation and synchronizing all version references.
-
-**What Changed:**
-- ✅ All header file version comments now match library version
-- ✅ New VERSION_MANAGEMENT.md document explains versioning
-- ✅ Clear distinction between library version and file modification history
-- ✅ Best practices for version management established
-
-## 📚 New Documentation
-
-### VERSION_MANAGEMENT.md
-
-A comprehensive guide that answers:
-- What do version numbers in header files mean?
-- Where is the official library version defined?
-- How to check if a file has been modified?
-- Best practices for version comments
-- Complete version update workflow
-
-**Read it here:** [docs/VERSION_MANAGEMENT.md](https://github.com/Alteriom/painlessMesh/blob/main/docs/VERSION_MANAGEMENT.md)
-
-## 🔧 For Developers
-
-### Version Comment Best Practices
-
-When releasing new versions, remember to update header file version comments:
-
-```cpp
-/**
- * @file painlessMesh.h
- * @version 1.8.7  // ← Keep this synchronized with library version
- * @date 2025-11-12
- */
-```
-
-This helps maintain documentation consistency and prevents user confusion.
-
-## 📦 How to Update
-
-### Arduino Library Manager
-```
-Sketch → Include Library → Manage Libraries → 
-Search "AlteriomPainlessMesh" → Update to 1.8.7
-```
-
-### PlatformIO
-```ini
-[env:myenv]
-lib_deps = 
-    alteriom/AlteriomPainlessMesh@^1.8.7
-```
-
-### NPM
-```bash
-npm update @alteriom/painlessmesh
-```
-
-## ✅ Compatibility
-
-This release is **fully backward compatible** with v1.8.6. No breaking changes.
-
-- ✅ ESP32 (all variants)
-- ✅ ESP8266 (all variants)
-- ✅ Arduino Core 2.x and 3.x
-- ✅ PlatformIO
-
-## 🐛 Bug Reports
-
-If you encounter any issues with this release, please:
-
-1. Check the [VERSION_MANAGEMENT.md](https://github.com/Alteriom/painlessMesh/blob/main/docs/VERSION_MANAGEMENT.md) for version-related questions
-2. Review the [CHANGELOG.md](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md) for detailed changes
-3. [Open an issue](https://github.com/Alteriom/painlessMesh/issues) with a detailed description
-
-## 🙏 Thank You
-
-Thanks to our users for reporting issues and helping improve the library!
-
-Special thanks to the user who raised the question about version comments in `painlessMesh.h`, leading to better documentation clarity.
-
-## 📖 Resources
-
-- **Release Notes:** [RELEASE_NOTES_v1.8.7.md](RELEASE_NOTES_v1.8.7.md)
-- **CHANGELOG:** [CHANGELOG.md](../../CHANGELOG.md)
-- **Documentation:** https://alteriom.github.io/painlessMesh/
-- **GitHub Repository:** https://github.com/Alteriom/painlessMesh
-- **Issues:** https://github.com/Alteriom/painlessMesh/issues
-
----
-
-**Happy Meshing!** 🌐
-
-— The Alteriom Team