@alteriom/painlessmesh 1.7.6 → 1.7.8

package/docs/MQTT_BRIDGE_COMMANDS.md

@@ -36,7 +36,7 @@ Target Node → Mesh Network → Gateway Bridge → MQTT Broker → Web Applicat
 
 | Direction | Package Type | Purpose |
 |-----------|--------------|---------|
-| MQTT → Mesh | CommandPackage (201) | Control device, request data |
+| MQTT → Mesh | CommandPackage (400) | Control device, request data |
 | Mesh → MQTT | StatusPackage (202) | Report device status |
 | Mesh → MQTT | SensorPackage (200) | Sensor data reports |
 | Mesh → MQTT | EnhancedStatusPackage (203) | Detailed health metrics |
@@ -74,7 +74,7 @@ Target Node → Mesh Network → Gateway Bridge → MQTT Broker → Web Applicat
 | Command ID | Name | Description | Parameters |
 |------------|------|-------------|------------|
 | 200 | GET_STATUS | Request basic status | None |
-| 201 | GET_METRICS | Request performance metrics | None |
+| 400 | GET_METRICS | Request performance metrics | None |
 | 202 | GET_DIAGNOSTICS | Request detailed diagnostics | None |
 | 210 | START_MONITORING | Begin continuous monitoring | `interval_ms` (uint32_t) |
 | 211 | STOP_MONITORING | Stop continuous monitoring | None |
@@ -155,7 +155,7 @@ alteriom/mesh/{mesh_id}/events            # Real-time mesh state change events
 
 ## Command Definitions
 
-### CommandPackage Structure (Type 201)
+### CommandPackage (Type 400)
 
 Defined in `examples/alteriom/alteriom_sensor_package.hpp`:
 
@@ -167,7 +167,7 @@ public:
   uint32_t commandId = 0;       // Unique command tracking ID
   TSTRING parameters = "";      // JSON-encoded parameters
   
-  CommandPackage() : SinglePackage(201) {}
+  CommandPackage() : SinglePackage(400) {}
 };
 ```
 
@@ -235,7 +235,7 @@ The gateway bridge is implemented in `examples/bridge/mqtt_command_bridge.hpp` a
 Mesh nodes implement command handlers in `examples/alteriom/mesh_command_node.ino`:
 
 1. **Command Reception**
-   - Listen for CommandPackage (Type 201)
+   - Listen for CommandPackage (Type 400)
    - Parse command and parameters
    - Execute appropriate action
 
@@ -354,7 +354,7 @@ The mesh topology system provides real-time visibility into the structure and he
 
 ```json
 {
-  "type": 201,
+  "type": 400,
   "command": 300,
   "targetDevice": 0,
   "commandId": 12345,
@@ -525,7 +525,7 @@ client.loop_forever()
 
 ```json
 {
-  "type": 201,
+  "type": 400,
   "command": 10,
   "targetDevice": 123456,
   "commandId": 1001,
@@ -554,7 +554,7 @@ client.loop_forever()
 
 ```json
 {
-  "type": 201,
+  "type": 400,
   "command": 100,
   "targetDevice": 0,
   "commandId": 2001,
@@ -594,7 +594,7 @@ All nodes respond with their configuration on respective `mesh/config/<nodeId>`
 
 ```json
 {
-  "type": 201,
+  "type": 400,
   "command": 200,
   "targetDevice": 123456,
   "commandId": 3001,
@@ -673,7 +673,7 @@ def on_connect(client, userdata, flags, rc):
     
     # Send LED control command
     command = {
-        "type": 201,
+        "type": 400,
         "command": 10,
         "targetDevice": 123456,
         "commandId": int(time.time() * 1000),

package/docs/MQTT_BRIDGE_IMPLEMENTATION_SUMMARY.md

@@ -172,7 +172,7 @@ const client = mqtt.connect('mqtt://192.168.1.100:1883');
 
 // Send LED control command
 const command = {
-  type: 201,
+  type: 400,
   command: 10,
   targetDevice: 123456,
   commandId: Date.now(),

package/docs/MQTT_SCHEMA_COMPLIANCE.md

@@ -6,10 +6,65 @@ The painlessMesh library is compliant with the **@alteriom/mqtt-schema** specifi
 
 ## Schema Package
 
-- **Package:** `@alteriom/mqtt-schema` v0.5.0 (latest)
+- **Package:** `@alteriom/mqtt-schema` v0.7.2 (latest)
 - **Registry:** npm (https://www.npmjs.com/package/@alteriom/mqtt-schema)
 - **Documentation:** https://github.com/Alteriom/alteriom-mqtt-schema
-- **Release:** v0.5.0 includes mesh topology and event schemas!
+- **Release:** v0.7.2 includes sensor metrics and enhanced message types!
+
+## v0.7.2 Schema Alignment
+
+### Message Type Codes (Faster Classification)
+
+The schema now includes standardized message type codes for 90% faster message classification:
+
+**Standard Schema Codes:**
+- **200:** SENSOR_DATA - Sensor telemetry readings
+- **201:** SENSOR_HEARTBEAT - Sensor presence/health
+- **202:** SENSOR_STATUS - Sensor status change
+- **203:** SENSOR_INFO - Sensor identification and capabilities (v0.7.2+)
+- **204:** SENSOR_METRICS - Sensor health and performance metrics (v0.7.2+)
+- **300:** GATEWAY_INFO - Gateway identification
+- **301:** GATEWAY_METRICS - Gateway health metrics
+- **302:** GATEWAY_DATA - Gateway telemetry (v0.7.2+)
+- **303:** GATEWAY_HEARTBEAT - Gateway presence (v0.7.2+)
+- **304:** GATEWAY_STATUS - Gateway status (v0.7.2+)
+- **400:** COMMAND - Device control command
+- **401:** COMMAND_RESPONSE - Command execution result
+- **500:** FIRMWARE_STATUS - Firmware update status
+- **600:** MESH_NODE_LIST - Mesh node inventory
+- **601:** MESH_TOPOLOGY - Mesh network topology
+- **602:** MESH_ALERT - Mesh network alert
+- **603:** MESH_BRIDGE - Mesh protocol bridge (v0.7.1+)
+- **604:** MESH_STATUS - Mesh status (v0.7.2+)
+- **605:** MESH_METRICS - Mesh-level metrics (v0.7.2+)
+- **700:** DEVICE_CONFIG - Device configuration management
+
+**painlessMesh Mesh-Specific Codes (600+ range):**
+- **600:** MeshNodeListPackage → MESH_NODE_LIST (v1.7.7+)
+- **601:** MeshTopologyPackage → MESH_TOPOLOGY (v1.7.7+)
+- **602:** MeshAlertPackage → MESH_ALERT (v1.7.7+)
+- **603:** MeshBridgePackage → MESH_BRIDGE (v1.7.7+)
+- **604:** EnhancedStatusPackage → MESH_STATUS (v1.7.7+)
+- **605:** HealthCheckPackage → MESH_METRICS (v1.7.7+)
+
+**painlessMesh Schema-Aligned Codes:**
+- **200:** SensorPackage → SENSOR_DATA ✓
+- **202:** StatusPackage → SENSOR_STATUS ✓
+- **204:** MetricsPackage → SENSOR_METRICS ✓ (aligns with v0.7.2+)
+- **400:** CommandPackage → COMMAND ✓ (moved from 201 in v1.7.7 for full schema compliance)
+
+All painlessMesh packages now include the optional `message_type` field for optimal performance.
+
+### Mesh Bridge Schema (Type 603)
+
+New schema for bridging painlessMesh protocol to MQTT, enabling standardized mesh protocol integration.
+
+**Key Features:**
+- Native painlessMesh message encapsulation
+- Support for SINGLE, BROADCAST, and other mesh message types
+- RSSI, hop count, and timing information
+- Optional payload decoding for MQTT v1 messages
+- Multiple mesh protocol support (painlessMesh, ESP-NOW, BLE Mesh, etc.)
 
 ---
 

package/docs/PHASE1_GUIDE.md

@@ -194,7 +194,7 @@ The `alertFlags` field uses bit flags for different alert conditions:
 | Type | Package Name | Description |
 |------|--------------|-------------|
 | 200  | SensorPackage | Environmental sensor data |
-| 201  | CommandPackage | Device control commands |
+| 400  | CommandPackage | Device control commands |
 | 202  | StatusPackage | Basic status (original) |
 | **203** | **EnhancedStatusPackage** | **Comprehensive status (Phase 1)** |
 

package/docs/alteriom/overview.md

@@ -36,7 +36,7 @@ mesh.sendPackage(&sensor);
 - Greenhouse automation
 - Industrial sensor networks
 
-### CommandPackage (Type 201)
+### CommandPackage (Type 400)
 For sending control commands to specific devices.
 
 ```cpp
@@ -155,7 +155,7 @@ Alteriom uses reserved type ID range 200-299:
 ```cpp
 enum AlteriomTypes {
     ALTERIOM_SENSOR = 200,    // SensorPackage
-    ALTERIOM_COMMAND = 201,   // CommandPackage  
+    ALTERIOM_COMMAND = 400,   // CommandPackage  
     ALTERIOM_STATUS = 202,    // StatusPackage
     // 203-299 reserved for future Alteriom packages
 };
@@ -498,11 +498,34 @@ public:
 3. **Validate under memory pressure**
 4. **Test with maximum expected node count**
 
+## Code Conventions
+
+### Boolean Field Naming
+
+Alteriom packages follow a consistent naming convention for boolean fields to improve code clarity:
+
+- **`*Set` suffix**: Configuration data has been provided (e.g., `deviceSecretSet`)
+- **`*Enabled` suffix**: Feature is currently active (e.g., `displayEnabled`)
+- **`is*` prefix or `*Connected`**: Current runtime state (e.g., `mqttConnected`)
+
+See [Boolean Naming Convention](../BOOLEAN_NAMING_CONVENTION.md) for complete guidelines.
+
+### Time Field Naming
+
+Time-based configuration fields follow a dual-unit convention:
+
+- **Internal storage**: Always milliseconds (e.g., `sensorReadInterval`)
+- **JSON serialization**: Both milliseconds (`_ms`) and seconds (`_s`) variants
+- **JSON deserialization**: Read from milliseconds (`_ms`) variant
+
+See package header documentation for complete details.
+
 ## Next Steps
 
 - Learn about [Sensor Packages](sensor-packages.md) in detail
 - Explore [Command System](command-system.md) implementation
 - Study [Status Monitoring](status-monitoring.md) patterns
+- Review [Boolean Naming Convention](../BOOLEAN_NAMING_CONVENTION.md) guidelines
 - See [Tutorial Examples](../tutorials/sensor-networks.md) for hands-on practice
 
 The Alteriom extensions provide a solid foundation for building robust IoT applications with painlessMesh. They demonstrate production-ready patterns while remaining flexible enough to adapt to your specific needs.

package/docs/architecture/plugin-system.md

@@ -155,7 +155,7 @@ enum CustomTypes {
 // Alteriom types: 200+ (for Alteriom extensions)
 enum AlteriomTypes {
     ALTERIOM_SENSOR = 200,
-    ALTERIOM_COMMAND = 201,
+    ALTERIOM_COMMAND = 400,
     ALTERIOM_STATUS = 202
 };
 ```

package/docs/archive/RELEASE_SUMMARY.md

@@ -72,7 +72,7 @@ All original functionality from the upstream library is maintained:
 
 ### Enhanced Packages
 - **SensorPackage** (Type 200): Environmental monitoring with temperature, humidity, pressure, battery levels
-- **CommandPackage** (Type 201): Device control and automation commands
+- **CommandPackage (Type 400): Device control and automation commands
 - **StatusPackage** (Type 202): Health monitoring and system status reporting
 
 ### Additional Features

package/docs/releases/RELEASE_CHECKLIST_v1.7.6.md

@@ -0,0 +1,389 @@
+# painlessMesh v1.7.6 Release Checklist
+
+**Release Date:** October 19, 2025  
+**Release Type:** Critical Bug Fix  
+**Git Commit:** c17384a  
+**Git Tag:** v1.7.6  
+
+---
+
+## ✅ Completed Steps
+
+### Code Implementation
+- [x] Removed `src/painlessmesh/scheduler_queue.hpp` (30 lines deleted)
+- [x] Removed `src/painlessmesh/scheduler_queue.cpp` (70 lines deleted)
+- [x] Updated `src/painlessmesh/mesh.hpp` (removed queue includes and initialization)
+- [x] Created comprehensive unit test `test/catch/catch_scheduler_queue_removal.cpp` (200+ lines)
+
+### Version Updates
+- [x] Updated `library.json` version: 1.7.5 → 1.7.6
+- [x] Updated `library.properties` version: 1.7.5 → 1.7.6
+- [x] Updated `package.json` version: 1.7.5 → 1.7.6
+
+### Documentation
+- [x] Updated `CHANGELOG.md` with v1.7.6 section
+- [x] Created `docs/releases/RELEASE_PLAN_v1.7.6.md` (850+ lines)
+- [x] Created `docs/releases/RELEASE_SUMMARY_v1.7.6.md` (comprehensive release notes)
+- [x] Created `docs/troubleshooting/PAINLESSMESH_V1.7.4_COMPILATION_ISSUES.md` (historical reference)
+- [x] Updated `README.md` with v1.7.6 information
+
+### Git Operations
+- [x] Staged all changes (`git add -A`)
+- [x] Committed with detailed message (commit c17384a)
+- [x] Created annotated tag v1.7.6
+- [x] Pushed to GitHub (`git push origin main --tags`)
+
+### Statistics
+- **Files Changed:** 12 files
+- **Insertions:** +2046 lines
+- **Deletions:** -131 lines
+- **Net:** +1915 lines (mostly documentation and tests)
+
+---
+
+## 🔄 Manual Steps Required
+
+### 1. Create GitHub Release
+
+**URL:** https://github.com/Alteriom/painlessMesh/releases/new
+
+**Release Details:**
+- **Tag:** v1.7.6 (select existing tag)
+- **Title:** `v1.7.6 - Critical Compilation Fix`
+- **Set as latest release:** ✅ Checked
+
+**Release Description Template:**
+
+```markdown
+# v1.7.6 - Critical Compilation Fix
+
+🚨 **URGENT**: If you are using v1.7.4 or v1.7.5, upgrade immediately. Those versions fail to compile.
+
+## What's Fixed
+
+✅ **Compilation Failure** - Fixed "_task_request_t was not declared" error  
+✅ **ESP32 Support** - All ESP32 builds now compile successfully  
+✅ **ESP8266 Support** - All ESP8266 builds now compile successfully  
+✅ **FreeRTOS Stability** - Maintained ~85% crash reduction on ESP32  
+
+## What Changed
+
+This release removes the thread-safe scheduler queue that was causing compilation failures:
+
+- **Removed**: `scheduler_queue.hpp` and `scheduler_queue.cpp`
+- **Simplified**: `mesh.hpp` initialization code
+- **Maintained**: Semaphore timeout fix for FreeRTOS crash protection
+
+## Why This Fix
+
+The thread-safe scheduler queue required `_TASK_THREAD_SAFE` macro, but:
+- This macro conflicts with `_TASK_STD_FUNCTION` in TaskScheduler v4.0.x
+- painlessMesh **requires** `_TASK_STD_FUNCTION` for lambda callbacks
+- The queue code was disabled but still trying to compile
+- Result: Type definitions were missing, causing compilation errors
+
+## Upgrade Instructions
+
+### PlatformIO
+```ini
+[env:your_board]
+lib_deps =
+    https://github.com/Alteriom/painlessMesh.git#v1.7.6
+```
+
+### Arduino IDE
+Update through Library Manager: **AlteriomPainlessMesh v1.7.6**
+
+### NPM
+```bash
+npm update @alteriom/painlessmesh
+```
+
+## Performance
+
+- ✅ ESP32 crash rate: ~5-8% (down from 30-40%)
+- ✅ Crash reduction: ~85% via semaphore timeout increase
+- ✅ No performance impact vs v1.7.2
+- ✅ Full lambda and std::function support maintained
+
+## Testing
+
+- ✅ 710+ unit tests passing
+- ✅ All 19 examples compile successfully
+- ✅ ESP32 and ESP8266 platforms verified
+- ✅ CI/CD pipeline passing
+
+## Breaking Changes
+
+**None** - This is a pure bug fix release.
+
+## Known Limitations
+
+- ESP32 crash protection is ~85% effective (not 95-98% as originally targeted)
+- Thread-safe scheduler queue feature removed (may return in v1.8.0)
+- Requires TaskScheduler v4.1+ for future thread-safe re-implementation
+
+## Documentation
+
+📋 [Complete Release Notes](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_SUMMARY_v1.7.6.md)  
+📖 [CHANGELOG](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)  
+📋 [Implementation Plan](https://github.com/Alteriom/painlessMesh/blob/main/docs/releases/RELEASE_PLAN_v1.7.6.md)  
+🐛 [Compilation Issues (Resolved)](https://github.com/Alteriom/painlessMesh/blob/main/docs/troubleshooting/PAINLESSMESH_V1.7.4_COMPILATION_ISSUES.md)
+
+---
+
+**Release Date**: October 19, 2025  
+**Build Status**: ✅ All tests passing  
+**Upgrade Priority**: 🚨 CRITICAL for v1.7.4/v1.7.5 users
+```
+
+**Action:** Copy the template above and create the release on GitHub.
+
+---
+
+### 2. Publish NPM Package
+
+**Prerequisites:**
+- NPM account with publish access
+- Logged in to NPM (`npm whoami` to verify)
+
+**Commands:**
+
+```bash
+# 1. Verify login
+npm whoami
+
+# 2. (Optional) Test package creation
+npm pack
+
+# 3. Publish to NPM
+npm publish --access public
+
+# 4. Verify publication
+npm view @alteriom/painlessmesh version
+# Should show: 1.7.6
+```
+
+**NPM Package URL:** https://www.npmjs.com/package/@alteriom/painlessmesh
+
+**Checklist:**
+- [ ] Logged in to NPM
+- [ ] Package built successfully
+- [ ] Published to NPM registry
+- [ ] Version 1.7.6 visible on npmjs.com
+- [ ] Installation tested: `npm install @alteriom/painlessmesh@1.7.6`
+
+---
+
+### 3. Monitor PlatformIO Registry
+
+**URL:** https://registry.platformio.org/libraries/sparck75/AlteriomPainlessMesh
+
+**Update Process:**
+- **Automatic:** PlatformIO scans GitHub releases every 24 hours
+- **Expected:** v1.7.6 should appear within 24 hours of GitHub Release
+- **Manual Trigger (if needed):** `pio pkg publish .`
+
+**Checklist:**
+- [ ] Wait 24 hours after GitHub Release
+- [ ] Verify v1.7.6 appears on registry
+- [ ] Test installation: `pio pkg install --library "AlteriomPainlessMesh@1.7.6"`
+- [ ] Verify example compilation
+
+---
+
+### 4. Monitor Arduino Library Manager
+
+**Update Process:**
+- **Automatic:** Arduino syncs from `library.properties` in GitHub releases
+- **Expected:** v1.7.6 should appear within 24-48 hours
+- **No manual action required**
+
+**Verification:**
+- [ ] Wait 24-48 hours after GitHub Release
+- [ ] Open Arduino IDE Library Manager
+- [ ] Search for "AlteriomPainlessMesh"
+- [ ] Verify v1.7.6 is available
+- [ ] Test installation and example compilation
+
+---
+
+## 📊 Success Criteria
+
+### Immediate (Within 1 Hour)
+- [ ] GitHub Release published successfully
+- [ ] NPM package published and available
+- [ ] CI/CD pipeline status: Green
+
+### First 24 Hours
+- [ ] Zero compilation error reports on GitHub Issues
+- [ ] PlatformIO registry updated to v1.7.6
+- [ ] Positive community feedback (if any)
+- [ ] No critical bugs discovered
+
+### First Week
+- [ ] Arduino Library Manager synced to v1.7.6
+- [ ] ESP32 crash reports show ~5-8% rate (not increasing)
+- [ ] No regression reports from users
+- [ ] CI/CD continues to pass
+
+---
+
+## 🔍 Monitoring Tasks
+
+### GitHub Issues
+Monitor for:
+- Compilation errors (should be zero)
+- Runtime crashes (should be ~5-8% on ESP32)
+- Breaking API changes (should be none)
+- Documentation issues
+
+### CI/CD Pipeline
+Check that:
+- All tests continue to pass
+- ESP32 examples compile
+- ESP8266 examples compile
+- No new lint errors
+
+### Community Feedback
+Watch for:
+- User reports of successful upgrades
+- Questions about migration
+- Feature requests for v1.8.0
+- Reports of improved stability
+
+---
+
+## 🚨 Rollback Plan
+
+If critical issues are discovered:
+
+### Immediate (Within 1 Hour)
+1. **Advise users to downgrade:**
+   ```ini
+   lib_deps = https://github.com/Alteriom/painlessMesh.git#v1.7.2
+   ```
+
+2. **Mark GitHub Release as pre-release** (if possible)
+
+### Short-term (Within 24 Hours)
+1. **Revert commit:**
+   ```bash
+   git revert c17384a
+   git push origin main
+   ```
+
+2. **Delete tag:**
+   ```bash
+   git tag -d v1.7.6
+   git push origin :refs/tags/v1.7.6
+   ```
+
+3. **Unpublish NPM package** (if within 72 hours):
+   ```bash
+   npm unpublish @alteriom/painlessmesh@1.7.6
+   ```
+
+### Medium-term (Within 1 Week)
+1. Investigate root cause of rollback
+2. Prepare hotfix v1.7.7
+3. Re-test thoroughly
+4. Re-release with fixes
+
+**Rollback Criteria:**
+- Compilation failures reported
+- Critical functionality broken
+- Crash rate increases significantly
+- Data corruption or security issues
+
+---
+
+## 📝 Communication
+
+### GitHub Discussions (Optional)
+
+**Post announcement in Discussions:**
+
+**Title:** `v1.7.6 Released - Critical Compilation Fix`
+
+**Body:**
+```markdown
+Hi everyone! 👋
+
+We've just released **v1.7.6**, which is a critical emergency fix for compilation issues in v1.7.4 and v1.7.5.
+
+## 🚨 If you're on v1.7.4 or v1.7.5
+
+**Please upgrade immediately.** Those versions fail to compile with the error:
+```
+'_task_request_t' was not declared
+```
+
+## ✅ What's Fixed
+
+- ESP32 and ESP8266 now compile successfully
+- Removed problematic thread-safe queue code
+- Maintained ~85% FreeRTOS crash reduction
+- Zero breaking changes to API
+
+## 📦 How to Upgrade
+
+**PlatformIO:**
+```ini
+lib_deps = https://github.com/Alteriom/painlessMesh.git#v1.7.6
+```
+
+**Arduino IDE:** Update through Library Manager
+
+**NPM:** `npm update @alteriom/painlessmesh`
+
+## 📚 Documentation
+
+- [Release Notes](https://github.com/Alteriom/painlessMesh/releases/tag/v1.7.6)
+- [Full CHANGELOG](https://github.com/Alteriom/painlessMesh/blob/main/CHANGELOG.md)
+
+Thanks for your patience, and apologies for the broken releases! 🙏
+```
+
+---
+
+## 📋 Post-Release Checklist
+
+### Day 1 (October 19, 2025)
+- [ ] GitHub Release created
+- [ ] NPM package published
+- [ ] CI/CD verified green
+- [ ] No immediate issues reported
+
+### Day 2 (October 20, 2025)
+- [ ] PlatformIO registry check
+- [ ] GitHub Issues monitored
+- [ ] Community feedback reviewed
+
+### Week 1 (October 19-26, 2025)
+- [ ] Arduino Library Manager verified
+- [ ] No critical bugs reported
+- [ ] Crash rate statistics collected
+- [ ] Plan v1.8.0 roadmap
+
+---
+
+## 🎯 Next Steps
+
+### Immediate
+1. Create GitHub Release (use template above)
+2. Publish NPM package
+3. Monitor CI/CD pipeline
+
+### Future (v1.8.0 Planning)
+1. Monitor TaskScheduler updates for v4.1+
+2. Collect user feedback on v1.7.6
+3. Evaluate thread-safe queue re-implementation
+4. Consider alternative FreeRTOS fixes
+
+---
+
+**Release Manager:** Alteriom Development Team  
+**Completion Status:** Automated steps complete, manual steps pending  
+**Estimated Time for Manual Steps:** 30 minutes  
+**Priority:** HIGH - Users are waiting for working version