@alteriom/painlessmesh 1.7.2 → 1.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +58 -4
  2. package/README.md +17 -3
  3. package/docs/README.md +62 -10
  4. package/docs/archive/DOCUSAURUS_DEPLOYMENT.md +166 -0
  5. package/docs/archive/LIBRARY_JSON_FIX.md +98 -0
  6. package/docs/archive/LIBRARY_STRUCTURE_FIX.md +215 -0
  7. package/docs/archive/RELEASE_SUMMARY.md +173 -0
  8. package/docs/archive/SCONS_BUILD_FIX.md +313 -0
  9. package/docs/archive/TRIGGER_RELEASE.md +280 -0
  10. package/docs/archive/VECTOR_INCLUDE_FIX.md +129 -0
  11. package/docs/development/ARDUINO_COMPLIANCE_SUMMARY.md +71 -0
  12. package/docs/development/CODE_REFACTORING_RECOMMENDATIONS.md +1011 -0
  13. package/docs/development/DOCKER_TESTING.md +196 -0
  14. package/docs/development/PLATFORMIO_USAGE.md +180 -0
  15. package/docs/development/TESTING_SUMMARY.md +126 -0
  16. package/docs/development/contributing.md +301 -0
  17. package/docs/development/documentation.md +583 -0
  18. package/docs/improvements/FUTURE_PROPOSALS.md +1016 -0
  19. package/docs/improvements/IMPLEMENTATION_HISTORY.md +1091 -0
  20. package/docs/improvements/OTA_STATUS_ENHANCEMENTS.md +709 -0
  21. package/docs/improvements/README.md +171 -46
  22. package/docs/releases/FEATURE_HISTORY.md +543 -0
  23. package/docs/releases/PATCH_v1.7.3.md +262 -0
  24. package/docs/releases/PHASE1_SUMMARY.md +246 -0
  25. package/docs/releases/PHASE2_SUMMARY.md +499 -0
  26. package/docs/releases/RELEASE_NOTES_1.7.0.md +539 -0
  27. package/docs/troubleshooting/debugging.md +455 -0
  28. package/library.json +1 -1
  29. package/library.properties +1 -1
  30. package/package.json +1 -1
  31. package/src/painlessmesh/router.hpp +35 -19
  32. /package/docs/{improvements → archive}/FEATURE_PROPOSALS.md +0 -0
  33. /package/docs/{improvements → archive}/PHASE1_IMPLEMENTATION.md +0 -0
  34. /package/docs/{improvements → archive}/PHASE2_IMPLEMENTATION.md +0 -0
  35. /package/docs/{improvements → archive}/ota-and-status-enhancements.md +0 -0
  36. /package/docs/{improvements → archive}/ota-status-architecture-diagrams.md +0 -0
  37. /package/docs/{improvements → archive}/ota-status-quick-reference.md +0 -0
package/docs/development/ARDUINO_COMPLIANCE_SUMMARY.md ADDED
@@ -0,0 +1,71 @@
1
+ # Arduino Library Manager Compliance - Summary of Changes
2
+
3
+ ## Issues Fixed
4
+
5
+ ### 1. Library Name Conflict (Fixed ✅)
6
+ - **Problem**: Library name "Alteriom painlessMesh" contained spaces and was not unique
7
+ - **Solution**: Changed to "AlteriomPainlessMesh" (no spaces, unique identifier)
8
+ - **Files Modified**: `library.properties`
9
+
10
+ ### 2. Missing Primary Header File (Fixed ✅)
11
+ - **Problem**: No header file matching the library name
12
+ - **Solution**: Created `src/AlteriomPainlessMesh.h` as the primary include
13
+ - **Files Created**: `src/AlteriomPainlessMesh.h`
14
+ - **Files Modified**: `library.properties` (updated includes field)
15
+
16
+ ### 3. Example Sketch Naming Mismatch (Fixed ✅)
17
+ - **Problem**: Example folder `alteriom` didn't have a matching `alteriom.ino` file
18
+ - **Solution**: Created `examples/alteriom/alteriom.ino` with proper header inclusion
19
+ - **Files Created**: `examples/alteriom/alteriom.ino`
20
+
21
+ ### 4. Test Sketches in Wrong Location (Fixed ✅)
22
+ - **Problem**: Arduino sketches found in `test/` directory (not allowed by Library Manager)
23
+ - **Solution**: Moved problematic sketches to `extras/test-sketches/`
24
+ - **Directories Moved**:
25
+ - `test/issue_521/` → `extras/test-sketches/issue_521/`
26
+ - `test/performance/` → `extras/test-sketches/performance/`
27
+ - `test/startHere/` → `extras/test-sketches/startHere/`
28
+ - `test/start_stop/` → `extras/test-sketches/start_stop/`
29
+ - `test/wifi/` → `extras/test-sketches/wifi/`
30
+
31
+ ## Current Compliance Status
32
+
33
+ ✅ **Library Properties**: All required fields present and valid
34
+ ✅ **Naming Convention**: Library name "AlteriomPainlessMesh" is unique and compliant
35
+ ✅ **Header File**: Primary header `src/AlteriomPainlessMesh.h` exists and matches library name
36
+ ✅ **Examples Structure**: All example folders have matching .ino files
37
+ ✅ **Directory Structure**: No Arduino sketches in prohibited locations
38
+
39
+ ## Files Created/Modified
40
+
41
+ ### New Files
42
+ - `src/AlteriomPainlessMesh.h` - Primary library header with comprehensive documentation
43
+ - `examples/alteriom/alteriom.ino` - Primary example matching folder name
44
+ - `extras/test-sketches/` - Directory for test sketches (moved from test/)
45
+
46
+ ### Modified Files
47
+ - `library.properties` - Updated name, includes, and description for compliance
48
+
49
+ ## Validation Results
50
+
51
+ The custom validation script confirms all major Arduino Library Manager requirements are met:
52
+
53
+ ```
54
+ 🎉 All checks passed! Library should be compliant.
55
+ ```
56
+
57
+ ## Next Steps
58
+
59
+ 1. **Optional**: Run official Arduino Lint tool when available for final verification
60
+ 2. **Submit**: Library is ready for Arduino Library Manager submission
61
+ 3. **Monitor**: Check for any additional feedback from Arduino Library Manager review process
62
+
63
+ ## Documentation Integration
64
+
65
+ The library now includes:
66
+ - Complete Docsify documentation website in `docsify-site/`
67
+ - Automated Doxygen API documentation generation
68
+ - GitHub Actions workflow for documentation deployment
69
+ - Embedded API documentation viewing within the website
70
+
71
+ All changes maintain compatibility with existing painlessMesh functionality while adding Alteriom-specific enhancements and ensuring Arduino Library Manager compliance.