Skip to content

Commit 3e75883

Browse files
Docs: Update and restructure documentation for upcoming release (v5.0.0)
**CHANGELOG.md**: - Added [Unreleased] section with complete feature documentation - Documented QR code support for Station mode - Documented non-blocking WiFi connection architecture - Documented structured logging system implementation - Documented enhanced status command with comprehensive network info - Documented FreeRTOS task architecture improvements - Documented web server responsiveness optimizations - Listed all bug fixes with root causes and solutions - Added technical specifications (memory, performance, build stats) - Migration guide and breaking changes section **README.md**: - Added "What's New in v5.0.0" section with 8 major features - Detailed QR code functionality with use cases - Non-blocking operations explanation with code examples - Structured logging system overview - Enhanced status command documentation - FreeRTOS task architecture description - Web server improvements summary - Bug fixes and refinements list - Quick links to documentation **docs/RELEASE_NOTES_V5.0.0.md** (NEW): - Comprehensive 500+ line release documentation - Detailed overview and highlights - Feature-by-feature deep dive with examples - Code snippets showing before/after comparisons - Use cases and benefits for each feature - Complete bug fix documentation with root causes - Technical specifications (memory, performance) - Migration guide for v4.3.1 users - Known issues section - Future roadmap preview **platformio.ini**: - Updated version string to "5.0.0" in all environments - Updated comment header to reflect new features - All 6 build environments updated consistently **Documentation Restructuring**: - Moved TFT_TASK_ARCHITECTURE.md to docs/technical/ - Moved WIFI_TASK_ARCHITECTURE.md to docs/technical/ - Updated docs/DOCUMENTATION_INDEX.md with new locations - Updated docs/README.md with complete feature list - Reorganized technical documentation structure - Improved navigation and discoverability **docs/DOCUMENTATION_INDEX.md**: - Added FreeRTOS Task Architecture section - Added TFT Display Task Architecture reference - Added WiFi Command Task Architecture reference - Updated Technical Documentation section - Improved cross-referencing between documents **docs/README.md**: - Updated feature highlights with latest additions - Added QR Code Support to features list - Added Non-Blocking WiFi Operations - Added Structured Logging System - Updated documentation organization structure - Improved navigation with clear sections **Key Features Documented**: 1. QR Code Support for Station Mode 2. Non-Blocking WiFi Connection 3. Structured Logging System 4. Enhanced Status Command 5. FreeRTOS Task Architecture 6. Web Server Improvements (10x faster) 7. Critical Bug Fixes (connection timing, TFT updates, mode switching) 8. Performance Optimizations **Documentation Statistics**: - CHANGELOG: +250 lines - README: +150 lines - RELEASE_NOTES: +500 lines (new file) - docs/README.md: Updated with new features - docs/DOCUMENTATION_INDEX.md: Reorganized structure - Architecture docs: Moved to docs/technical/ - Total: ~1000 lines of documentation updates **Build Verification**: - All environments compile successfully - Flash: 1,161,085 bytes (80.5%) - RAM: 53,072 bytes (16.2%) - No breaking changes
1 parent 322e93c commit 3e75883

12 files changed

+1260
-574
lines changed

CHANGELOG.md

Lines changed: 269 additions & 6 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 146 additions & 33 deletions
Large diffs are not rendered by default.

docs/DOCUMENTATION_INDEX.md

Lines changed: 128 additions & 90 deletions
Large diffs are not rendered by default.

docs/PORT_SCANNER.md

Lines changed: 81 additions & 34 deletions
Large diffs are not rendered by default.

docs/README.md

Lines changed: 72 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,48 @@
55
Comprehensive guides for using all features of the ESP32 WiFi Utility:
66

77
### Core Features
8-
- **[Web Configuration Guide](WEB_CONFIGURATION.md)** - 🆕 v4.2.0: Complete web-based configuration system
9-
- **[Configuration System](CONFIGURATION_SYSTEM.md)** - 🆕 v4.2.0: Persistent AP and Station configuration
8+
- **[Web Configuration Guide](WEB_CONFIGURATION.md)** - Complete web-based configuration system
9+
- **[Configuration System](CONFIGURATION_SYSTEM.md)** - Persistent AP and Station configuration
10+
- **[Port Scanner](PORT_SCANNER.md)** - 🆕 v4.3.0: Port scanning and service detection
11+
- **[Signal Strength Monitor](SIGNAL_STRENGTH_MONITOR.md)** - 🆕 v4.3.0: RSSI monitoring and analysis
12+
- **[Channel Graph](CHANNEL_GRAPH.md)** - 🆕 v4.3.0: Visual spectrum analysis
1013
- **[Channel Analysis Guide](user-guides/CHANNEL_GUIDE.md)** - Professional spectrum analysis and AI recommendations
1114
- **[Latency Testing Guide](user-guides/LATENCY_GUIDE.md)** - Network performance and jitter analysis
1215
- **[Enhanced WiFi Scanning](user-guides/ENHANCED_SCANNING.md)** - Advanced network discovery and analysis
1316
- **[iPerf Network Testing](user-guides/IPERF_GUIDE.md)** - Comprehensive throughput and performance testing
1417
- **[Web Interface Guide](user-guides/WEB_INTERFACE.md)** - Complete web-based dashboard documentation (Available on both boards!)
1518
- **[NeoPixel Status Display](user-guides/NEOPIXEL_GUIDE.md)** - RGB LED status indicators (Feather ESP32-S3 TFT only)
1619

17-
### Quick References (v4.2.0)
18-
- **[AP Config Quick Reference](AP_CONFIG_QUICK_REF.md)** - 🆕 Access Point configuration commands
19-
- **[Station Config Quick Reference](STATION_CONFIG_QUICK_REF.md)** - 🆕 Station configuration commands
20-
- **[Responsive Menu Guide](RESPONSIVE_MENU.md)** - 🆕 Mobile-optimized web interface
20+
### Quick References
21+
- **[AP Config Quick Reference](AP_CONFIG_QUICK_REF.md)** - Access Point configuration commands
22+
- **[Station Config Quick Reference](STATION_CONFIG_QUICK_REF.md)** - Station configuration commands
23+
- **[Responsive Menu Guide](RESPONSIVE_MENU.md)** - Mobile-optimized web interface
2124

2225
## 🔧 Technical Documentation
2326

2427
In-depth technical information for developers and advanced users:
2528

29+
### FreeRTOS Task Architecture
30+
- **[WiFi Command Task](technical/WIFI_TASK_ARCHITECTURE.md)** - 🆕 Asynchronous WiFi mode switching
31+
- **[TFT Display Task](technical/TFT_TASK_ARCHITECTURE.md)** - 🆕 Event-driven display updates
32+
- **[RTOS Architecture](technical/RTOS_ARCHITECTURE.md)** - Overall task management system
33+
- **[RTOS API Reference](technical/RTOS_API_REFERENCE.md)** - Task and queue APIs
34+
- **[Creating New Tasks](technical/RTOS_TUTORIAL_NEW_TASK.md)** - Tutorial: Step-by-step task creation
35+
- **[Queue Communication](technical/RTOS_TUTORIAL_QUEUES.md)** - Tutorial: Inter-task messaging
36+
- **[Debugging RTOS](technical/RTOS_TUTORIAL_DEBUGGING.md)** - Tutorial: Task debugging techniques
37+
2638
### Implementation Details
27-
- **[Code Improvements v4.2.0](technical/CODE_IMPROVEMENTS_V4.2.0.md)** - 🆕 Technical changes in v4.2.0
28-
- **[Migration Guide v4.2.0](MIGRATION_GUIDE_V4.2.0.md)** - 🆕 Upgrading from v4.1.0 to v4.2.0
39+
- **[Library Structure](LIBRARY_STRUCTURE.md)** - Modular architecture overview
2940
- **[Channel Implementation](technical/CHANNEL_IMPLEMENTATION.md)** - Technical deep-dive into spectrum analysis algorithms
3041
- **[Test Infrastructure](technical/TEST_INFRASTRUCTURE.md)** - Comprehensive testing framework for dual-board support
3142
- **[Automated Releases](technical/AUTOMATED_RELEASES.md)** - GitHub Actions automated release system
3243
- **[Workflow Summary](technical/WORKFLOW_SUMMARY.md)** - Complete CI/CD pipeline and release automation overview
3344
- **[Implementation Summary](technical/IMPLEMENTATION_SUMMARY.md)** - Complete system architecture overview
3445
- **[Project Completion Summary](technical/PROJECT_COMPLETION_SUMMARY.md)** - Final project status and achievements
3546

36-
### Configuration Deep Dives (v4.2.0)
37-
- **[AP Configuration Persistence](AP_CONFIG_PERSISTENCE.md)** - 🆕 Access Point configuration system details
38-
- **[Station Configuration Persistence](STATION_CONFIG_PERSISTENCE.md)** - 🆕 Station configuration system details
47+
### Configuration Deep Dives
48+
- **[AP Configuration Persistence](AP_CONFIG_PERSISTENCE.md)** - Access Point configuration system details
49+
- **[Station Configuration Persistence](STATION_CONFIG_PERSISTENCE.md)** - Station configuration system details
3950

4051
## 🚀 Quick Start
4152

@@ -49,7 +60,27 @@ New to the ESP32 WiFi Utility? Start here:
4960

5061
## 🎯 Feature Highlights
5162

52-
### 🆕 v4.2.0: Configuration Persistence & Instant Mode Switching
63+
### 🆕 v5.0.0: TFT Display Enhancements & System Responsiveness
64+
- **QR Code Support**: Automatic WiFi credential sharing via scannable QR codes (Station mode)
65+
- **Non-Blocking WiFi**: Asynchronous connection operations - device stays responsive during connections
66+
- **Structured Logging**: Professional LOG_* framework with severity levels and component tags
67+
- **Enhanced Status Command**: Comprehensive network info (signal, uptime, channel, quality)
68+
- **FreeRTOS Task Architecture**: Dedicated WiFi command task and TFT display task
69+
- **10x Web Server Speed**: Main loop optimized from 100ms to 10ms for instant response
70+
- **Critical Bug Fixes**: Connection timing, TFT updates, mode switching, web server compatibility
71+
72+
### 🆕 v4.3.1: Comprehensive Documentation
73+
- **Port Scanner Documentation**: 1,400+ lines covering fundamentals, use cases, security
74+
- **Signal Monitor Documentation**: 1,100+ lines with RSSI guide, API integration, best practices
75+
- **Wiki Enhancements**: 2,500+ lines total, 15+ API examples, 10+ use cases
76+
77+
### 🆕 v4.3.0: Advanced Network Analysis & TFT Display
78+
- **Port Scanner**: Network security auditing with service identification (25+ services)
79+
- **Signal Strength Monitor**: Real-time RSSI monitoring with auto-scan capabilities
80+
- **Channel Graph**: Visual spectrum analysis with interactive web interface
81+
- **TFT Display Support**: QR codes, mode indicators, network information on both TFT variants
82+
83+
### v4.2.0: Configuration Persistence & Instant Mode Switching
5384
- **Persistent Configuration**: Save AP and Station settings that survive reboots
5485
- **Auto-Start/Connect**: Device boots into configured mode automatically
5586
- **Web Configuration Interface**: Complete configuration via browser
@@ -59,7 +90,7 @@ New to the ESP32 WiFi Utility? Start here:
5990
- **Reboot Modal**: Countdown timer for controlled device restarts
6091
- **Quick References**: Command cheat sheets for rapid configuration
6192

62-
### 🆕 v4.0.0: Interactive Network Details & Multi-Platform Web Server
93+
### v4.0.0: Interactive Network Details & Multi-Platform Web Server
6394
- **Clickable Network Details**: Click any scanned network to view comprehensive information
6495
- 8-level signal quality scale with visual indicators
6596
- Channel congestion analysis (Clear to Severe ratings)
@@ -104,16 +135,21 @@ New to the ESP32 WiFi Utility? Start here:
104135
```
105136
docs/
106137
├── README.md # This index file
107-
├── RELEASE_NOTES_V4.2.0.md # 🆕 v4.2.0 release notes
108-
├── WEB_CONFIGURATION.md # 🆕 v4.2.0 web config guide
109-
├── CONFIGURATION_SYSTEM.md # 🆕 v4.2.0 configuration overview
110-
├── AP_CONFIG_PERSISTENCE.md # 🆕 v4.2.0 AP configuration
111-
├── STATION_CONFIG_PERSISTENCE.md # 🆕 v4.2.0 Station configuration
112-
├── AP_CONFIG_QUICK_REF.md # 🆕 v4.2.0 AP commands
113-
├── STATION_CONFIG_QUICK_REF.md # 🆕 v4.2.0 Station commands
114-
├── RESPONSIVE_MENU.md # 🆕 v4.2.0 mobile menu
115-
├── MIGRATION_GUIDE_V4.2.0.md # 🆕 v4.2.0 upgrade guide
116-
├── IMPROVEMENTS_SUMMARY.md # 🆕 v4.2.0 improvements
138+
├── DOCUMENTATION_INDEX.md # Complete documentation catalog
139+
├── RELEASE_NOTES_V5.0.0.md # 🆕 Latest release notes
140+
├── RELEASE_NOTES_V4.3.1.md # v4.3.1 release notes
141+
├── WEB_CONFIGURATION.md # Web-based configuration guide
142+
├── CONFIGURATION_SYSTEM.md # Configuration overview
143+
├── PORT_SCANNER.md # 🆕 v4.3.0 Port scanning guide
144+
├── SIGNAL_STRENGTH_MONITOR.md # 🆕 v4.3.0 Signal monitor guide
145+
├── CHANNEL_GRAPH.md # 🆕 v4.3.0 Channel graph guide
146+
├── AP_CONFIG_PERSISTENCE.md # AP configuration details
147+
├── STATION_CONFIG_PERSISTENCE.md # Station configuration details
148+
├── AP_CONFIG_QUICK_REF.md # AP commands cheat sheet
149+
├── STATION_CONFIG_QUICK_REF.md # Station commands cheat sheet
150+
├── RESPONSIVE_MENU.md # Mobile menu guide
151+
├── LIBRARY_STRUCTURE.md # Modular architecture
152+
├── IMPROVEMENTS_SUMMARY.md # Feature improvements
117153
├── user-guides/ # End-user documentation
118154
│ ├── CHANNEL_GUIDE.md # Channel analysis user guide
119155
│ ├── LATENCY_GUIDE.md # Latency testing guide
@@ -122,11 +158,19 @@ docs/
122158
│ ├── WEB_INTERFACE.md # Web dashboard documentation
123159
│ └── NEOPIXEL_GUIDE.md # NeoPixel LED guide (Feather only)
124160
└── technical/ # Developer documentation
125-
├── CODE_IMPROVEMENTS_V4.2.0.md # 🆕 v4.2.0 technical changes
126-
├── CHANNEL_IMPLEMENTATION.md # Algorithm implementation
127-
├── TEST_INFRASTRUCTURE.md # Testing framework
128-
├── IMPLEMENTATION_SUMMARY.md # Architecture overview
129-
└── PROJECT_COMPLETION_SUMMARY.md # Project achievements
161+
├── WIFI_TASK_ARCHITECTURE.md # 🆕 WiFi command task
162+
├── TFT_TASK_ARCHITECTURE.md # 🆕 TFT display task
163+
├── RTOS_ARCHITECTURE.md # RTOS system overview
164+
├── RTOS_API_REFERENCE.md # Task and queue APIs
165+
├── RTOS_TUTORIAL_NEW_TASK.md # Tutorial: Creating tasks
166+
├── RTOS_TUTORIAL_QUEUES.md # Tutorial: Queue messaging
167+
├── RTOS_TUTORIAL_DEBUGGING.md # Tutorial: Debugging tasks
168+
├── CHANNEL_IMPLEMENTATION.md # Algorithm implementation
169+
├── TEST_INFRASTRUCTURE.md # Testing framework
170+
├── IMPLEMENTATION_SUMMARY.md # Architecture overview
171+
├── PROJECT_COMPLETION_SUMMARY.md # Project achievements
172+
├── AUTOMATED_RELEASES.md # CI/CD pipeline
173+
└── WORKFLOW_SUMMARY.md # Release automation
130174
```
131175

132176
## 🌐 Quick Access - v4.2.0 Features

0 commit comments

Comments
 (0)