@alteriom/painlessmesh 1.8.5 → 1.8.7

package/docs/releases/ANNOUNCEMENT_v1.8.7.md

@@ -0,0 +1,113 @@
+# 🚀 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

package/docs/releases/GITHUB_RELEASE_v1.8.6.md

@@ -0,0 +1,71 @@
+## 🐛 Bug Fixes
+
+### Bridge Failover Auto-Election (Issue #117)
+
+Fixed critical issue where mesh networks would remain bridgeless indefinitely when all nodes started without a designated initial bridge.
+
+**Before:** No initial bridge → no election → mesh stays bridgeless forever  
+**After:** No initial bridge → 60s startup → monitoring detects absence → election triggered → best RSSI node becomes bridge
+
+#### Implementation Details
+- Added periodic monitoring task (30s interval) that detects absence of healthy bridge
+- Activates after 60s startup grace period to allow network stabilization
+- Randomized election delay (1-3s) prevents thundering herd problem
+- Respects existing safeguards: election state, 60s cooldown, router visibility
+
+Fully backward compatible - pre-designated bridge mode continues to work as before.
+
+**Core fix:** `src/arduino/wifi.hpp`
+
+## 📝 Documentation
+
+### Bridge Failover Example
+
+Enhanced documentation to clarify two deployment modes:
+
+- **Auto-Election Mode**: All nodes regular (`INITIAL_BRIDGE=false`), RSSI-based election after 60s
+- **Pre-Designated Mode**: Traditional single initial bridge setup
+
+Updated:
+- `examples/bridge_failover/bridge_failover.ino` - Enhanced header comments
+- `examples/bridge_failover/README.md` - Comprehensive auto-election documentation
+
+## 🔧 Housekeeping
+
+- Synchronized `package-lock.json` version to 1.8.5
+
+## 📦 Installation
+
+### PlatformIO
+```ini
+lib_deps = alteriom/AlteriomPainlessMesh@^1.8.6
+```
+
+### NPM
+```bash
+npm install @alteriom/painlessmesh@1.8.6
+```
+
+### Arduino Library Manager
+Search for "AlteriomPainlessMesh" and update through the IDE
+
+## 🎯 Use Cases
+
+This release is valuable for:
+- Dynamic mesh networks with changing node positions
+- Fault-tolerant deployments requiring automatic bridge recovery
+- IoT systems with minimal human oversight
+- Development environments without pre-configured bridges
+
+## 🙏 Credits
+
+Special thanks to @woodlist for reporting the issue and providing detailed logs.
+
+## 📚 Resources
+
+- [Full Release Notes](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_NOTES_v1.8.6.md)
+- [Bridge Failover Example](https://github.com/Alteriom/painlessMesh/tree/main/examples/bridge_failover)
+- [Issue #117](https://github.com/Alteriom/painlessMesh/issues/117)
+- [Pull Request #118](https://github.com/Alteriom/painlessMesh/pull/118)
+
+**Full Changelog**: https://github.com/Alteriom/painlessMesh/compare/v1.8.5...v1.8.6

package/docs/releases/GITHUB_RELEASE_v1.8.7.md

@@ -0,0 +1,90 @@
+# AlteriomPainlessMesh v1.8.7
+
+**Release Date:** November 12, 2025  
+**Type:** Patch Release - Bug Fixes & Documentation
+
+## 🐛 Bug Fixes
+
+### Bridge Internet Connectivity Detection
+
+Fixed incorrect internet status reporting in bridge nodes:
+- **Before:** Bridge → Router (with Internet) → Reports "Internet: NO" ❌
+- **After:** Bridge → Router (with Internet) → Reports "Internet: YES" ✅
+
+Bridge nodes now properly check for actual internet connectivity by verifying both WiFi connection status AND valid gateway IP (not 0.0.0.0).
+
+**Impact:**
+- ✅ Accurate internet status for bridge nodes
+- ✅ Correct bridge failover behavior
+- ✅ No more false positives on regular nodes
+
+**Files changed:** `src/arduino/wifi.hpp`
+
+### Version Documentation Consistency
+
+Fixed confusing version numbers in header files:
+- Updated `painlessMesh.h` version comment: 1.8.4 → 1.8.7
+- Updated `AlteriomPainlessMesh.h` version defines: 1.6.1 → 1.8.7
+- Created comprehensive VERSION_MANAGEMENT.md documentation
+
+**Clarification:** Header file version comments indicate the library version when documentation was reviewed, not file-specific versioning. Use `library.properties` for the official version.
+
+## 📚 New Documentation
+
+### VERSION_MANAGEMENT.md
+
+New comprehensive guide explaining:
+- ✅ What version numbers in header files mean
+- ✅ Where to find the official library version
+- ✅ How to track file modification history
+- ✅ Version update workflow and best practices
+
+**Essential reading for contributors!**
+
+## 📦 Installation
+
+### Arduino Library Manager
+```
+Sketch → Include Library → Manage Libraries → 
+Search "AlteriomPainlessMesh" → Update to 1.8.7
+```
+
+### PlatformIO
+```ini
+lib_deps = alteriom/AlteriomPainlessMesh@^1.8.7
+```
+
+### NPM
+```bash
+npm install @alteriom/painlessmesh@1.8.7
+```
+
+## 🔄 Upgrade Notes
+
+**Fully backward compatible** with v1.8.6. No breaking changes.
+
+## 📖 Documentation
+
+- **Release Notes:** [docs/releases/RELEASE_NOTES_v1.8.7.md](docs/releases/RELEASE_NOTES_v1.8.7.md)
+- **Version Management Guide:** [docs/VERSION_MANAGEMENT.md](docs/VERSION_MANAGEMENT.md)
+- **Full Changelog:** [CHANGELOG.md](CHANGELOG.md)
+- **Online Documentation:** https://alteriom.github.io/painlessMesh/
+
+## 🔗 Links
+
+- **NPM Package:** https://www.npmjs.com/package/@alteriom/painlessmesh
+- **PlatformIO Registry:** https://registry.platformio.org/libraries/alteriom/AlteriomPainlessMesh
+- **Report Issues:** https://github.com/Alteriom/painlessMesh/issues
+
+## ✅ Checksums
+
+**Library Package:** `painlessMesh-v1.8.7.zip`
+- Will be generated automatically by GitHub Actions
+
+## 🙏 Credits
+
+Thanks to our users for reporting issues and helping improve the library!
+
+---
+
+**Full Changelog:** https://github.com/Alteriom/painlessMesh/compare/v1.8.6...v1.8.7

package/docs/releases/RELEASE_NOTES_v1.8.6.md

@@ -0,0 +1,205 @@
+# painlessMesh v1.8.6 Release Notes
+
+**Release Date:** November 12, 2025  
+**Type:** Patch Release  
+**Breaking Changes:** None - 100% Backward Compatible
+
+---
+
+## 🎯 Executive Summary
+
+Version 1.8.6 fixes a critical issue in the bridge failover mechanism where mesh networks would remain bridgeless indefinitely when all nodes started without a designated initial bridge. This release introduces automatic bridge election monitoring that ensures meshes always establish internet connectivity when configured for bridge failover.
+
+---
+
+## 🐛 Bug Fixes
+
+### Bridge Failover Auto-Election (Issue #117)
+
+**Problem:** The bridge failover example didn't work when all nodes had `INITIAL_BRIDGE=false`. The mesh would start but never elect a bridge, leaving the network without internet connectivity indefinitely.
+
+**Symptoms:**
+```
+--- Bridge Status ---
+I am bridge: NO
+Internet available: NO
+Known bridges: 0
+No primary bridge available!
+--------------------
+```
+
+**Root Cause:** Bridge elections only triggered when an *existing* bridge lost connectivity. When the mesh had no bridge from startup, no election was ever initiated.
+
+**Solution:** Added periodic monitoring task (30-second interval) that:
+- Detects absence of healthy bridges in the mesh
+- Triggers bridge election after 60-second startup grace period
+- Uses randomized election delay (1-3 seconds) to prevent thundering herd
+- Respects all existing safeguards (election state, cooldown, router visibility)
+
+**Behavior Changes:**
+
+| Scenario | Before v1.8.6 | After v1.8.6 |
+|----------|---------------|--------------|
+| No initial bridge | Mesh stays bridgeless forever | Election triggered after 60s, best RSSI node becomes bridge |
+| Pre-designated bridge | Works normally | Works normally (unchanged) |
+| Bridge failure | Election triggered | Election triggered (unchanged) |
+
+**Backward Compatibility:** Fully backward compatible. Pre-designated bridge mode continues to work exactly as before.
+
+**Core Changes:** `src/arduino/wifi.hpp`
+
+---
+
+## 📝 Documentation Improvements
+
+### Bridge Failover Example Clarification
+
+Enhanced documentation for `examples/bridge_failover/` to clearly explain two deployment modes:
+
+**Auto-Election Mode** (New Documentation)
+- All nodes start with `INITIAL_BRIDGE=false`
+- After 60-second startup grace period, monitoring begins
+- Best RSSI node automatically elected as bridge
+- Ideal for dynamic deployments where optimal bridge selection matters
+
+**Pre-Designated Mode** (Existing)
+- One node starts with `INITIAL_BRIDGE=true`
+- Traditional setup with guaranteed initial bridge
+- Ideal for fixed deployments with known bridge location
+
+Updated files:
+- `examples/bridge_failover/bridge_failover.ino` - Enhanced header comments
+- `examples/bridge_failover/README.md` - Comprehensive mode documentation
+
+---
+
+## 🔧 Housekeeping
+
+- Synchronized `package-lock.json` version to 1.8.5
+
+---
+
+## 🔄 Upgrade Guide
+
+### From v1.8.5 to v1.8.6
+
+This is a seamless upgrade with no breaking changes:
+
+1. **Update Package Version:**
+   ```bash
+   # PlatformIO
+   pio pkg update alteriom/AlteriomPainlessMesh@^1.8.6
+   
+   # NPM
+   npm update @alteriom/painlessmesh
+   
+   # Arduino Library Manager
+   # Update through IDE's Library Manager
+   ```
+
+2. **No Code Changes Required** - All existing code works without modification
+
+3. **Optional: Enable Auto-Election Mode**
+   ```cpp
+   // For auto-election mode, set all nodes to:
+   #define INITIAL_BRIDGE false
+   
+   // Network will automatically elect bridge after 60s startup
+   ```
+
+---
+
+## 🎯 Use Cases
+
+This release is particularly valuable for:
+
+### 1. Dynamic Mesh Networks
+- Mobile or portable mesh deployments
+- Networks where node positions change
+- Optimal bridge selection based on WiFi signal strength
+
+### 2. Fault-Tolerant Deployments
+- Meshes that must establish connectivity without manual intervention
+- Systems requiring automatic bridge recovery
+- IoT deployments with minimal human oversight
+
+### 3. Development & Testing
+- Quick prototyping without pre-configuring bridge nodes
+- Testing scenarios with varying network topologies
+- Validation of bridge election algorithms
+
+---
+
+## 📊 Technical Details
+
+### Monitoring Task Implementation
+
+```cpp
+// Periodic check every 30 seconds
+this->addTask(30000, TASK_FOREVER, [this]() {
+  // Skip if: not enabled, already bridge, or in startup grace period
+  if (!bridgeFailoverEnabled || !routerCredentialsConfigured) return;
+  if (this->isBridge() || millis() < 60000) return;
+  
+  // Check for healthy bridge
+  bool hasHealthyBridge = false;
+  for (const auto& bridge : this->getBridges()) {
+    if (bridge.isHealthy(bridgeTimeoutMs) && bridge.internetConnected) {
+      hasHealthyBridge = true;
+      break;
+    }
+  }
+  
+  // Trigger election with randomized delay if no bridge found
+  if (!hasHealthyBridge) {
+    uint32_t delay = random(1000, 3000);
+    this->addTask(delay, TASK_ONCE, [this]() {
+      this->startBridgeElection();
+    });
+  }
+});
+```
+
+### Safeguards
+
+1. **60-second startup grace period** - Allows network to stabilize
+2. **Randomized election delay** - Prevents simultaneous elections
+3. **Respects election state** - Won't trigger if election already in progress
+4. **Cooldown period** - Enforces 60-second minimum between elections
+5. **Router visibility check** - Only nodes that can see router participate
+
+---
+
+## 🙏 Credits
+
+Special thanks to @woodlist for reporting Issue #117 and providing detailed logs that helped identify the root cause.
+
+---
+
+## 📦 Distribution
+
+This release is available through:
+- **GitHub Releases**: [v1.8.6](https://github.com/Alteriom/painlessMesh/releases/tag/v1.8.6)
+- **NPM**: `npm install @alteriom/painlessmesh@1.8.6`
+- **PlatformIO**: `alteriom/AlteriomPainlessMesh@^1.8.6`
+- **Arduino Library Manager**: Search for "AlteriomPainlessMesh"
+
+---
+
+## 📚 Additional Resources
+
+- [Bridge Failover Example](https://github.com/Alteriom/painlessMesh/tree/main/examples/bridge_failover)
+- [Bridge Failover Documentation](https://github.com/Alteriom/painlessMesh/blob/main/examples/bridge_failover/README.md)
+- [Issue #117 - Bug Report](https://github.com/Alteriom/painlessMesh/issues/117)
+- [Pull Request #118 - Implementation](https://github.com/Alteriom/painlessMesh/pull/118)
+- [Full Changelog](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)
+
+---
+
+## 🐛 Found a Bug?
+
+Please report issues at: https://github.com/Alteriom/painlessMesh/issues
+
+---
+
+**Full Changelog**: [v1.8.5...v1.8.6](https://github.com/Alteriom/painlessMesh/compare/v1.8.5...v1.8.6)

package/docs/releases/RELEASE_NOTES_v1.8.7.md

@@ -0,0 +1,184 @@
+# Release Notes - Version 1.8.7
+
+**Release Date:** November 12, 2025  
+**Release Type:** Patch Release  
+**Focus:** Bug fixes and documentation improvements
+
+## 🐛 Bug Fixes
+
+### Bridge Internet Connectivity Detection
+
+**Issue:** Bridge nodes were incorrectly reporting internet connectivity status.
+
+**Problem:**
+- Bridge connected to router would report "Internet: NO" even when the router had internet
+- The `hasInternetConnection()` function was returning false positives on regular nodes
+- Only checked WiFi connection status, not actual internet connectivity
+
+**Solution:**
+- Enhanced connectivity check to verify both WiFi status AND valid gateway IP
+- Check now verifies `WiFi.status() == WL_CONNECTED` AND gateway IP is not 0.0.0.0
+- Regular nodes without WiFi connection correctly report no internet
+
+**Impact:**
+- Bridge failover logic now works correctly
+- Internet connectivity status is accurate
+- Better network topology awareness
+
+**Files Modified:**
+- `src/arduino/wifi.hpp` (lines 1188-1192)
+- `examples/bridge_failover/README.md` (added troubleshooting)
+
+**Before:**
+```
+Bridge → Router (with Internet) → Reports: "Internet: NO" ❌
+```
+
+**After:**
+```
+Bridge → Router (with Internet) → Reports: "Internet: YES" ✅
+```
+
+### Version Documentation Consistency
+
+**Issue:** Header file version comments were out of sync with library version, causing user confusion.
+
+**Problem:**
+- `painlessMesh.h` showed version 1.8.4 in header comment
+- `AlteriomPainlessMesh.h` showed version 1.6.1 in version defines
+- Library files showed version 1.8.6
+- Users were confused about whether files had been modified since those versions
+
+**Solution:**
+- Updated `painlessMesh.h` header comment to version 1.8.7
+- Updated `AlteriomPainlessMesh.h` version defines to 1.8.7
+- Created comprehensive VERSION_MANAGEMENT.md documentation
+- Clarified that header versions reflect library version, not file-specific versioning
+- Added version management guidance to RELEASE_GUIDE.md
+
+**Impact:**
+- Clear documentation about version management
+- No more confusion about header file versions
+- Established best practices for version comments
+
+**Files Modified:**
+- `src/painlessMesh.h`
+- `src/AlteriomPainlessMesh.h`
+- `docs/VERSION_MANAGEMENT.md` (new)
+- `RELEASE_GUIDE.md` (enhanced)
+
+**Documentation Added:**
+- Explains version comment purpose and meaning
+- Clarifies difference between library version and file modification history
+- Provides best practices for version management
+- Documents the complete version update process
+
+## 📚 Documentation Improvements
+
+### New Documentation
+
+1. **VERSION_MANAGEMENT.md**
+   - Comprehensive guide to version management
+   - Explains version comment purpose
+   - Clarifies common questions
+   - Documents version update workflow
+   - Best practices for version comments
+
+### Enhanced Documentation
+
+1. **RELEASE_GUIDE.md**
+   - Added reference to VERSION_MANAGEMENT.md
+   - Updated release process to include header version updates
+   - Clarified version management workflow
+
+2. **bridge_failover/README.md**
+   - Added troubleshooting for internet connectivity issues
+   - Explained the enhanced connectivity detection
+
+## 🔄 Migration Guide
+
+No breaking changes. This release is fully backward compatible with version 1.8.6.
+
+### For Users
+
+**No action required.** Simply update to version 1.8.7:
+
+**Arduino Library Manager:**
+```
+Sketch → Include Library → Manage Libraries → Search "AlteriomPainlessMesh" → Update
+```
+
+**PlatformIO:**
+```ini
+[env:myenv]
+lib_deps = 
+    alteriom/AlteriomPainlessMesh@^1.8.7
+```
+
+**NPM:**
+```bash
+npm update @alteriom/painlessmesh
+```
+
+### For Contributors
+
+**When releasing future versions:**
+1. Update header file version comments to match library version
+2. Follow the VERSION_MANAGEMENT.md guidelines
+3. Use the enhanced release process in RELEASE_GUIDE.md
+
+## 📊 Technical Details
+
+### Files Changed
+- `src/painlessMesh.h` - Version comment updated
+- `src/AlteriomPainlessMesh.h` - Version defines updated
+- `src/arduino/wifi.hpp` - Internet connectivity detection fixed
+- `examples/bridge_failover/README.md` - Troubleshooting added
+- `docs/VERSION_MANAGEMENT.md` - New documentation
+- `RELEASE_GUIDE.md` - Version management guidance added
+- `CHANGELOG.md` - Release notes added
+- `library.properties` - Version 1.8.7
+- `library.json` - Version 1.8.7
+- `package.json` - Version 1.8.7
+
+### Testing
+
+All existing tests pass. No new tests required as changes are:
+- Documentation updates
+- Bug fixes to existing functionality
+- Version comment updates
+
+### Compatibility
+
+- ✅ **ESP32**: All variants supported
+- ✅ **ESP8266**: All variants supported
+- ✅ **Arduino Core 2.x**: Fully compatible
+- ✅ **Arduino Core 3.x**: Fully compatible
+- ✅ **PlatformIO**: All platforms supported
+
+## 🙏 Acknowledgments
+
+**Issue Reporter:**
+- User question about version comments in painlessMesh.h
+
+**Contributors:**
+- @Alteriom - Bug fixes and documentation
+
+## 📖 Related Resources
+
+- **VERSION_MANAGEMENT.md** - Complete version management guide
+- **RELEASE_GUIDE.md** - Release process documentation
+- **CHANGELOG.md** - Complete version history
+- **GitHub Issues** - [Report issues](https://github.com/Alteriom/painlessMesh/issues)
+
+## 🔗 Links
+
+- **GitHub Release:** https://github.com/Alteriom/painlessMesh/releases/tag/v1.8.7
+- **NPM Package:** https://www.npmjs.com/package/@alteriom/painlessmesh
+- **PlatformIO:** https://registry.platformio.org/libraries/alteriom/AlteriomPainlessMesh
+- **Documentation:** https://alteriom.github.io/painlessMesh/
+
+---
+
+**Previous Release:** [v1.8.6](RELEASE_NOTES_v1.8.6.md) - November 12, 2025  
+**Next Release:** TBD

package/examples/bridgeAwareSensorNode/bridgeAwareSensorNode.ino

@@ -176,7 +176,6 @@ void checkCriticalConditions() {
     alarm.timestamp = mesh.getNodeTime();
     alarm.temperature = currentTemperature;
     alarm.pressure = currentOxygenLevel;
-    alarm.deviceStatus = 0xFF;  // Critical alarm flag
     alarm.batteryLevel = 85;
 
     if (internetAvailable) {