@alteriom/painlessmesh 1.8.14 → 1.9.0

package/README.md

@@ -1,15 +1,17 @@
 # AlteriomPainlessMesh
 
-> **📚 [Complete Documentation](https://alteriom.github.io/painlessMesh/)** | **📖 [API Reference](https://alteriom.github.io/painlessMesh/#/api/doxygen)** | **🎯 [Examples](https://alteriom.github.io/painlessMesh/#/tutorials/basic-examples)** | **🗂️ [Documentation Index](DOCUMENTATION_INDEX.md)**
+> **📚 [Complete Documentation](https://alteriom.github.io/painlessMesh/)** | **📖 [API Reference](https://alteriom.github.io/painlessMesh/#/api/doxygen)** | **🎯 [Examples](https://alteriom.github.io/painlessMesh/#/tutorials/basic-examples)** | **📋 [Changelog](CHANGELOG.md)**
 
 <div align="center">
 
+**Version 1.9.0** - Major update with improved bridge detection, consolidated examples, and cleaned documentation
+
 [![CI/CD Pipeline](https://github.com/Alteriom/painlessMesh/actions/workflows/ci.yml/badge.svg)](https://github.com/Alteriom/painlessMesh/actions/workflows/ci.yml)
 [![Documentation](https://github.com/Alteriom/painlessMesh/actions/workflows/docs.yml/badge.svg)](https://github.com/Alteriom/painlessMesh/actions/workflows/docs.yml)
 [![Release](https://github.com/Alteriom/painlessMesh/actions/workflows/release.yml/badge.svg)](https://github.com/Alteriom/painlessMesh/actions/workflows/release.yml)
 [![GitHub release](https://img.shields.io/github/v/release/Alteriom/painlessMesh?label=version)](https://github.com/Alteriom/painlessMesh/releases)
 [![NPM Version](https://img.shields.io/npm/v/@alteriom/painlessmesh?label=npm)](https://www.npmjs.com/package/@alteriom/painlessmesh)
-[![PlatformIO Registry](https://badges.registry.platformio.org/packages/alteriom/library/painlessMesh.svg)](https://registry.platformio.org/libraries/alteriom/painlessMesh)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/alteriom/library/AlteriomPainlessMesh.svg)](https://registry.platformio.org/libraries/alteriom/AlteriomPainlessMesh)
 [![Arduino Library Manager](https://img.shields.io/badge/Arduino-Library%20Manager-blue.svg)](https://www.arduino.cc/reference/en/libraries/alteriompainlessmesh/)
 
 </div>
@@ -141,7 +143,7 @@ All packages provide type-safe serialization, automatic JSON conversion, and mes
 - 🎯 **Production Ready** - Enterprise IoT and commercial deployments
 - ⚙️ **Fully Configurable** - Adjustable intervals and feature toggles
 
-See [Phase 2 Guide](docs/PHASE2_GUIDE.md) for complete documentation.
+See [BRIDGE_TO_INTERNET.md](BRIDGE_TO_INTERNET.md) for complete documentation.
 
 #### 🔄 Automatic Bridge Failover (v1.8.0)
 
@@ -173,7 +175,7 @@ void bridgeRoleCallback(bool isBridge, String reason) {
 }
 ```
 
-See [Bridge Failover Guide](docs/BRIDGE_FAILOVER.md) and [bridge_failover example](examples/bridge_failover/) for complete documentation.
+See [bridge_failover example](examples/bridge_failover/) for complete documentation.
 
 #### 🌉 Multi-Bridge Coordination (v1.8.2)
 
@@ -207,7 +209,7 @@ mesh.setBridgeSelectionStrategy(ROUND_ROBIN);
 mesh.onBridgeCoordination(&bridgeCoordinationCallback);
 ```
 
-See [Multi-Bridge Implementation](docs/implementation/MULTI_BRIDGE_IMPLEMENTATION.md), [Issue #65 Verification](docs/internal/ISSUE_65_VERIFICATION.md), and [examples/multi_bridge/](examples/multi_bridge/) for complete documentation.
+See [BRIDGE_TO_INTERNET.md](BRIDGE_TO_INTERNET.md) for multi-bridge documentation.
 
 #### 📬 Message Queue for Offline Mode (v1.8.2)
 
@@ -242,7 +244,50 @@ mesh.onQueueFull(&queueFullCallback);
 mesh.onQueueFlushed(&queueFlushedCallback);
 ```
 
-See [Message Queue Implementation](docs/implementation/MESSAGE_QUEUE_IMPLEMENTATION.md), [Issue #66 Closure](docs/internal/ISSUE_66_CLOSURE.md), and [examples/queued_alarms/](examples/queued_alarms/) for complete documentation.
+See [BRIDGE_TO_INTERNET.md](BRIDGE_TO_INTERNET.md) for message queue documentation.
+
+#### 🌐 Shared Gateway Mode (v1.9.0+)
+
+**All Nodes as Internet Gateways with Automatic Failover**
+
+- 🌍 **Universal Internet Access** - All nodes connect to the same router and can send to Internet
+- 🔄 **Instant Failover** - Near-instant relay through mesh when local Internet fails
+- ⚡ **No Single Point of Failure** - Any node can serve as gateway, eliminating bridge dependency
+- 🎯 **Automatic Gateway Election** - RSSI-based election determines primary gateway
+- 🛡️ **Duplicate Prevention** - Built-in deduplication prevents multiple deliveries
+- 📊 **Delivery Confirmation** - Acknowledgment system confirms Internet delivery
+
+**Use Cases:**
+- Fish farm monitoring where any node can send critical O₂ alarms
+- Industrial sensor networks with redundant Internet paths
+- Smart building systems with resilient cloud connectivity
+- Remote monitoring stations with shared WiFi infrastructure
+
+**Example:**
+```cpp
+// Initialize all nodes as shared gateways
+bool success = mesh.initAsSharedGateway(
+    MESH_PREFIX, MESH_PASSWORD,
+    ROUTER_SSID, ROUTER_PASSWORD,
+    &userScheduler, MESH_PORT
+);
+
+// Send data with automatic failover
+mesh.sendToInternet(
+    "https://api.example.com/data",
+    sensorJson,
+    [](bool success, uint16_t status, String error) {
+        Serial.printf("Delivery: %s\n", success ? "OK" : error.c_str());
+    }
+);
+
+// Monitor gateway changes
+mesh.onGatewayChanged([](uint32_t newGateway) {
+    Serial.printf("Primary gateway: %u\n", newGateway);
+});
+```
+
+See [sharedGateway example](examples/sharedGateway/) for complete documentation.
 
 #### MQTT Bridge Commands
 
@@ -255,12 +300,11 @@ The MQTT bridge enables bidirectional communication between MQTT brokers and mes
 
 **Documentation:**
 
-- 📖 [MQTT Bridge Commands Reference](docs/MQTT_BRIDGE_COMMANDS.md) - Complete command API documentation
-- 🔧 [OTA Commands Reference](docs/OTA_COMMANDS_REFERENCE.md) - Over-the-air firmware updates
+See [mqttBridge example](examples/mqttBridge/) for MQTT integration.
 
 **Examples:**
 
-- 🌉 [MQTT Command Bridge](examples/mqttCommandBridge/mqttCommandBridge.ino) - Gateway bridge with bidirectional MQTT-mesh routing
+- 🌉 [MQTT Bridge](examples/mqttBridge/mqttBridge.ino) - Gateway bridge with bidirectional MQTT-mesh routing
 - 📡 [Alteriom Sensor Node](examples/alteriom/alteriom.ino) - Example node using SensorPackage, CommandPackage, and StatusPackage
 
 ### 🌐 Core Features
@@ -294,11 +338,6 @@ painlessMesh does not create a TCP/IP network of nodes. Rather each of the nodes
 
 ### Arduino Library Manager
 
-> **✅ FIXED**: Library name restored to match Arduino Library Manager registry.  
-> **Status**: New releases (v1.8.3+) will now be indexed automatically within 24-48 hours.  
-> **Issue**: Versions v1.7.0-v1.8.1 had incorrect library name and were not indexed.  
-> See [Arduino Library Manager Documentation](docs/ARDUINO_LIBRARY_MANAGER_SUBMISSION.md) for details.
-
 **Once registered**, installation will be available via Arduino IDE:
 
 1. Open Arduino IDE
@@ -313,26 +352,12 @@ The library includes the header file `AlteriomPainlessMesh.h` which provides acc
 **Option 1: Download ZIP from GitHub Release**
 
 1. Go to [Releases](https://github.com/Alteriom/painlessMesh/releases/latest)
-2. Download `painlessMesh-v1.8.3.zip` (or latest version)
+2. Download the latest release ZIP file
 3. In Arduino IDE: **Sketch** → **Include Library** → **Add .ZIP Library...**
 4. Select the downloaded ZIP file
 5. Restart Arduino IDE
 
-**Option 2: Create ZIP from Repository**
-
-If you need to create a ZIP file from source (e.g., for testing unreleased versions):
-
-```bash
-# Clone and create ZIP
-git clone https://github.com/Alteriom/painlessMesh.git
-cd painlessMesh
-./scripts/create-arduino-zip.sh
-
-# Output: dist/painlessMesh-vX.X.X.zip
-# Import this ZIP in Arduino IDE
-```
-
-**Option 3: Git Clone**
+**Option 2: Git Clone**
 
 ```bash
 cd ~/Arduino/libraries/
@@ -340,8 +365,6 @@ git clone https://github.com/Alteriom/painlessMesh.git AlteriomPainlessMesh
 # Restart Arduino IDE
 ```
 
-📖 **Detailed Guide**: See [Manual Arduino IDE Installation](docs/getting-started/arduino-manual-install.md) for complete instructions, troubleshooting, and ZIP creation details.
-
 ### PlatformIO
 
 `painlessMesh` is included in both the Arduino Library Manager and the platformio library registry and can easily be installed via either of those methods.
@@ -357,8 +380,6 @@ painlessMesh makes use of the following libraries, which can be installed throug
 
 If platformio is used to install the library, then the dependencies will be installed automatically.
 
-> **⚠️ ESP32-C6 Users:** If you experience crashes with `tcp_alloc` errors, you need AsyncTCP v3.3.0+ with LWIP locking support. Use the [ESP32Async/AsyncTCP](https://github.com/ESP32Async/AsyncTCP) library or see the [ESP32-C6 Compatibility Guide](docs/troubleshooting/ESP32_C6_COMPATIBILITY.md) for details.
-
 ## Quick Start with Alteriom Packages
 
 ### Basic Sensor Node
@@ -532,111 +553,29 @@ These are the message types used by applications built on painlessMesh:
 - **Event Coordination** - Synchronized displays, distributed processing
 - **Bridge Networks** - Connect mesh to WiFi/Internet/MQTT - [📖 Bridge Guide](BRIDGE_TO_INTERNET.md)
 
-## Latest Release: v1.8.4 (November 12, 2025)
-
-**Bridge Discovery Timing Fix for Instant Node Discovery**:
-
-- 🚀 **Instant Bridge Discovery** - Bridge nodes now discoverable in <1 second (was up to 30 seconds)
-- 🔧 **Immediate Status Broadcast** - Bridge sends status immediately on initialization
-- 🔗 **Connection-Triggered Broadcast** - Status broadcast when new nodes join mesh
-- ✅ **Fixes "No Primary Bridge Available"** - Eliminates discovery delays in bridge_failover example
-- 🔧 **100% Backward Compatible** - No breaking changes, enhanced timing only
-
-**[📋 Full Release Notes](docs/releases/RELEASE_NOTES_v1.8.4.md)** | **[📋 Full CHANGELOG](CHANGELOG.md)**
-
-## Previous Release: v1.8.3 (November 11, 2025)
-
-**ZIP File Integrity Fix for Arduino IDE Installation**:
+## Latest Release: v1.9.0 (November 30, 2025)
 
-- 🐛 **Critical Bug Fix** - Resolved Arduino IDE installation crashes caused by symlink in release archives
-- 📦 **Clean ZIP Packages** - 50% smaller packages (420K) with only essential files
-- 📝 **Version Documentation** - Added version timestamp to main header file
-- ✅ **Verified Installation** - Tested and working in Arduino IDE "Add .ZIP Library"
-- 🔧 **100% Backward Compatible** - No code changes, packaging fix only
+**Major Update: Improved Bridge Detection, Consolidated Examples & Documentation**
 
-**[📋 Full Release Notes](docs/releases/RELEASE_NOTES_v1.8.3.md)**
+- 🔍 **Mesh Connectivity Detection** - New `hasActiveMeshConnections()` and `getLastKnownBridge()` APIs
+- 🌉 **Improved Bridge Detection** - `getPrimaryBridge()` returns last known bridge when disconnected
+- ⚡ **Election Guard** - Skip election trigger when node is disconnected from mesh
+- 📦 **Consolidated Examples** - Reduced from 32 to 14 essential examples
+- 📚 **Cleaned Documentation** - Removed obsolete docs, kept only essentials
+- ⚙️ **Configurable Election Timing** - Prevent split-brain with `setElectionStartupDelay()` and `setElectionRandomDelay()`
 
-## Previous Release: v1.8.2 (November 11, 2025)
-
-**Multi-Bridge Coordination & Message Queue for Critical Systems**:
-
-- 🌉 **Multi-Bridge Load Balancing** - Enterprise-grade coordination for geographic redundancy and traffic distribution
-- 📬 **Message Queue for Offline Mode** - Zero data loss during Internet outages with priority-based queuing
-- ⚖️ **Three Load Balancing Strategies** - Priority-Based, Round-Robin, Best Signal (RSSI)
-- 🛡️ **Production Ready** - Battle-tested features for critical deployments (Issues #65 & #66)
-- 📊 **230+ New Test Assertions** - Comprehensive test coverage for both features
-
-**[📋 Full Release Notes](docs/releases/RELEASE_NOTES_v1.8.2.md)**
-
-## Previous Release: v1.8.1 (November 10, 2025)
-
-**GitHub Copilot Integration & Developer Experience**:
-
-- 🤖 **GitHub Copilot Custom Agent** - AI-assisted release management with `@release-agent`
-- 📚 **Enhanced Developer Context** - Improved repository context for all Copilot users
-- ✅ **Release Automation** - 21+ automated validation checks for quality assurance
-- 🔧 **Zero Breaking Changes** - Purely additive developer experience improvements
-- 📖 **Complete Documentation** - Agent setup guides and knowledge sources
-
-**[📋 Full Release Notes](docs/releases/RELEASE_NOTES_v1.8.1.md)**
-
-## Previous Release: v1.8.0 (November 9, 2025)
-
-**Bridge-Centric Architecture & Comprehensive Monitoring**:
-
-- ✅ **Bridge Auto-Detection** - One-line bridge setup with automatic channel detection
-- 📊 **Diagnostics API** - Comprehensive monitoring and debugging tools
-- 🕐 **RTC Integration** - Hardware RTC support for offline timekeeping
-- 🔄 **Bridge Failover** - Automatic bridge election and high availability
-- ⚡ **Production Ready** - All features tested, documented, and backward compatible
-
-**[📋 Full Release Notes](docs/releases/RELEASE_NOTES_v1.8.0.md)**
+**[📋 Full CHANGELOG](CHANGELOG.md)**
 
 ## Getting Help
 
 - **[FAQ](docs/troubleshooting/faq.md)** - Common questions and solutions
-- **[Version Numbers FAQ](docs/FAQ_VERSION_NUMBERS.md)** - Understanding version numbers in header files
-- **[Version Management Guide](docs/VERSION_MANAGEMENT.md)** - Complete versioning documentation
+- **[Common Issues](docs/troubleshooting/common-issues.md)** - Troubleshooting guide
 - **[GitHub Issues](https://github.com/Alteriom/painlessMesh/issues)** - Bug reports and feature requests  
 - **[Community Forum](https://groups.google.com/forum/#!forum/painlessmesh-user)** - Community support
 - **[API Documentation](http://painlessmesh.gitlab.io/painlessMesh/index.html)** - Generated API docs
 
 ## Development
 
-### GitHub Copilot Integration (v1.8.1+)
-
-AlteriomPainlessMesh includes GitHub Copilot custom agent support for AI-assisted development:
-
-- **🤖 Release Agent** - AI assistant for release management and quality assurance
-- **📚 Enhanced Context** - Repository knowledge available to all Copilot users
-- **🎯 Enterprise Features** - Use `@release-agent` in Copilot Chat (Enterprise)
-
-**For GitHub Copilot Enterprise Users:**
-```
-@release-agent How do I prepare a release?
-@release-agent Check version consistency
-@release-agent Validate release readiness
-```
-
-**Configuration:** The custom agent is defined in `copilot-agents.json` at the repository root.
-
-**Documentation:** [Copilot Agent Setup](.github/COPILOT_AGENT_SETUP.md) | [Agent Index](.github/AGENTS_INDEX.md)
-
-### Release Agent & Automation
-
-AlteriomPainlessMesh includes a comprehensive release automation system:
-
-- **📋 [Release Agent Documentation](.github/agents/release-agent.md)** - Complete release process specification
-- **🤖 Release Validation Script**: `./scripts/release-agent.sh` - Automated pre-release checks
-- **⚙️ CI/CD Integration**: Workflows validate every release automatically
-
-**Quick Release Validation:**
-```bash
-./scripts/release-agent.sh  # Run all pre-release checks
-```
-
-See [Release Agent Guide](.github/agents/README.md) for complete documentation.
-
 ### Building from Source
 
 ```bash
@@ -755,29 +694,17 @@ If you like the library please consider supporting its development. Your contrib
 - **[📁 File Structure](https://alteriom.github.io/painlessMesh/#/api/doxygen/files)** - Source code organization
 - **[❓ FAQ](https://alteriom.github.io/painlessMesh/#/troubleshooting/faq)** - Frequently asked questions
 
-**📖 Tutorials & Examples:**
-
-- **[Basic Examples](docs/tutorials/basic-examples.md)** - Essential patterns and techniques
-- **[Custom Packages](docs/tutorials/custom-packages.md)** - Type-safe message handling
-- **[Sensor Networks](docs/tutorials/sensor-networks.md)** - IoT sensor network patterns
-
-**🚀 Alteriom Extensions:**
-
-- **[Alteriom Overview](docs/alteriom/overview.md)** - Production-ready IoT packages
-- **[Sensor Packages](docs/alteriom/sensor-packages.md)** - Environmental monitoring
-- **[Command System](docs/alteriom/command-system.md)** - Device control and automation
-
-**🔧 Troubleshooting:**
+**📖 Examples:**
 
-- **[Common Issues](docs/troubleshooting/common-issues.md)** - Solutions to frequent problems
-- **[FAQ](docs/troubleshooting/faq.md)** - Frequently asked questions
-- **[Debugging Guide](docs/troubleshooting/debugging.md)** - Tools and techniques
+- **[Basic Example](examples/basic/basic.ino)** - Essential patterns and techniques
+- **[Alteriom Sensor Node](examples/alteriom/alteriom.ino)** - IoT sensor packages
+- **[Bridge Example](examples/bridge/bridge.ino)** - Connect mesh to Internet
 
 **📋 Complete Documentation Index:** [docs/README.md](docs/README.md)
 
 ## painlessMesh API Summary
 
-Here's a quick API overview. **For complete documentation, see [Core API Reference](docs/api/core-api.md)**
+Here's a quick API overview.
 
 ```cpp
 #include "painlessMesh.h"

package/docs/README.md

@@ -27,6 +27,7 @@ Welcome to the comprehensive documentation for the Alteriom fork of painlessMesh
 ### API Reference
 
 - [Core API](api/core-api.md) - Main painlessMesh class methods
+- [Shared Gateway API](api/shared-gateway.md) - Shared Gateway Mode reference (v1.9.0+)
 - [Plugin API](api/plugin-api.md) - Creating custom packages and plugins
 - [Configuration](api/configuration.md) - Configuration options and constants
 - [Callbacks](api/callbacks.md) - Event handling and callbacks