mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-04-10 13:02:59 +00:00
* docs: rename FONT_MANAGER_USAGE.md to FONT_MANAGER.md Renamed for clearer naming convention. Part of documentation consolidation effort. * docs: consolidate Plugin Store guides (2→1) Merged: - PLUGIN_STORE_USER_GUIDE.md - PLUGIN_STORE_QUICK_REFERENCE.md Into: PLUGIN_STORE_GUIDE.md - Unified writing style to professional technical - Added Quick Reference section at top for easy access - Removed duplicate content - Added cross-references to related documentation - Updated formatting to match style guidelines * docs: create user-focused Web Interface Guide Created WEB_INTERFACE_GUIDE.md consolidating: - V3_INTERFACE_README.md (technical details) - User-facing interface documentation - Focused on end-user tasks and navigation - Removed technical implementation details - Added common tasks section - Included troubleshooting - Professional technical writing style * docs: consolidate WiFi setup guides (4→1) Merged: - WIFI_SETUP.md - OPTIMAL_WIFI_AP_FAILOVER_SETUP.md - AP_MODE_MANUAL_ENABLE.md - WIFI_ETHERNET_AP_MODE_FIX.md (behavior documentation) Into: WIFI_NETWORK_SETUP.md - Comprehensive coverage of WiFi setup and configuration - Clear explanation of AP mode failover and grace period - Configuration scenarios and best practices - Troubleshooting section combining all sources - Professional technical writing style - Added quick reference table for behavior * docs: consolidate troubleshooting guides (4→1) Merged: - TROUBLESHOOTING_QUICK_START.md - WEB_INTERFACE_TROUBLESHOOTING.md - CAPTIVE_PORTAL_TROUBLESHOOTING.md - WEATHER_TROUBLESHOOTING.md Into: TROUBLESHOOTING.md - Organized by issue category (web, WiFi, plugins) - Comprehensive diagnostic commands reference - Quick diagnosis steps at the top - Service file template preserved - Complete diagnostic script included - Professional technical writing style * docs: create consolidated Advanced Features guide Merged: - VEGAS_SCROLL_MODE.md - ON_DEMAND_DISPLAY_QUICK_START.md - ON_DEMAND_DISPLAY_API.md - ON_DEMAND_CACHE_MANAGEMENT.md - BACKGROUND_SERVICE_README.md - PERMISSION_MANAGEMENT_GUIDE.md Into: ADVANCED_FEATURES.md - Comprehensive guide covering all advanced features - Vegas scroll mode with integration examples - On-demand display with API reference - Cache management troubleshooting - Background service documentation - Permission management patterns - Professional technical writing style * docs: create Getting Started guide for first-time users Created GETTING_STARTED.md: - Quick start guide (5 minutes) - Initial configuration walkthrough - Common first-time issues and solutions - Next steps and quick reference - User-friendly tone for beginners - Links to detailed documentation * docs: archive consolidated source files and ephemeral docs Archived files that have been consolidated: - Plugin Store guides (2 files → PLUGIN_STORE_GUIDE.md) - Web Interface guide (V3_INTERFACE_README.md → WEB_INTERFACE_GUIDE.md) - WiFi Setup guides (4 files → WIFI_NETWORK_SETUP.md) - Troubleshooting guides (4 files → TROUBLESHOOTING.md) - Advanced Features (6 files → ADVANCED_FEATURES.md) Archived ephemeral/debug documentation: - DEBUG_WEB_ISSUE.md - BROWSER_ERRORS_EXPLANATION.md - FORM_VALIDATION_FIXES.md - WEB_UI_RELIABILITY_IMPROVEMENTS.md - CAPTIVE_PORTAL_TESTING.md - NEXT_STEPS_COMMANDS.md - STATIC_IMAGE_MULTI_UPLOAD_PLAN.md - RECONNECT_AFTER_CAPTIVE_PORTAL_TESTING.md Archived implementation summaries: - PLUGIN_CONFIG_TABS_SUMMARY.md - PLUGIN_CONFIG_SYSTEM_VERIFICATION.md - PLUGIN_SCHEMA_AUDIT_SUMMARY.md - STARTUP_OPTIMIZATION_SUMMARY.md - PLUGIN_DISPATCH_IMPLEMENTATION.md - NESTED_SCHEMA_IMPLEMENTATION.md - AP_MODE_MANUAL_ENABLE_CHANGES.md - PLUGIN_CONFIG_SYSTEM_EXPLANATION.md Total archived: 27 files Preserves git history while cleaning up main docs directory * docs: rename API_REFERENCE.md to REST_API_REFERENCE.md Renamed for clarity - this is specifically the REST API reference for the web interface, not a general API reference. * docs: update README.md to reflect consolidated documentation structure Updated documentation index: - Reflects new consolidated guides (51 → 16-17 files) - Updated Quick Start sections with new file names - Added consolidation history (January 2026) - Updated file references (API_REFERENCE → REST_API_REFERENCE) - Documented archival of 33 files - Added benefits of consolidation - Updated statistics and highlights - Removed outdated references - Professional writing style maintained throughout * docs: add Vegas scroll mode system architecture documentation Added comprehensive internal architecture section for Vegas mode: - Component overview with diagram - VegasModeCoordinator responsibilities and main loop - StreamManager buffering strategy and content flow - PluginAdapter integration and fallback behavior - RenderPipeline 125 FPS rendering process - Component interaction flows - Thread safety patterns - Performance characteristics Covers: - How the four components work together - Initialization and render loop flows - Config update handling - Frame rate management and optimization - Memory usage and CPU characteristics --------- Co-authored-by: Chuck <chuck@example.com>
160 lines
4.1 KiB
Markdown
160 lines
4.1 KiB
Markdown
# AP Mode Manual Enable Configuration
|
|
|
|
## Overview
|
|
|
|
By default, Access Point (AP) mode is **not automatically enabled** after installation. AP mode must be manually enabled through the web interface when needed.
|
|
|
|
## Default Behavior
|
|
|
|
- **Auto-enable AP mode**: `false` (disabled by default)
|
|
- AP mode will **not** automatically activate when WiFi or Ethernet disconnects
|
|
- AP mode can only be enabled manually through the web interface
|
|
|
|
## Why Manual Enable?
|
|
|
|
This prevents:
|
|
- AP mode from activating unexpectedly after installation
|
|
- Network conflicts when Ethernet is connected
|
|
- SSH becoming unavailable due to automatic AP mode activation
|
|
- Unnecessary AP mode activation on systems with stable network connections
|
|
|
|
## Enabling AP Mode
|
|
|
|
### Via Web Interface
|
|
|
|
1. Navigate to the **WiFi** tab in the web interface
|
|
2. Click the **"Enable AP Mode"** button
|
|
3. AP mode will activate if:
|
|
- WiFi is not connected AND
|
|
- Ethernet is not connected
|
|
|
|
### Via API
|
|
|
|
```bash
|
|
# Enable AP mode
|
|
curl -X POST http://localhost:5001/api/v3/wifi/ap/enable
|
|
|
|
# Disable AP mode
|
|
curl -X POST http://localhost:5001/api/v3/wifi/ap/disable
|
|
```
|
|
|
|
## Enabling Auto-Enable (Optional)
|
|
|
|
If you want AP mode to automatically enable when WiFi/Ethernet disconnect:
|
|
|
|
### Via Web Interface
|
|
|
|
1. Navigate to the **WiFi** tab
|
|
2. Look for the **"Auto-enable AP Mode"** toggle or setting
|
|
3. Enable the toggle
|
|
|
|
### Via Configuration File
|
|
|
|
Edit `config/wifi_config.json`:
|
|
|
|
```json
|
|
{
|
|
"auto_enable_ap_mode": true,
|
|
...
|
|
}
|
|
```
|
|
|
|
Then restart the WiFi monitor service:
|
|
|
|
```bash
|
|
sudo systemctl restart ledmatrix-wifi-monitor
|
|
```
|
|
|
|
### Via API
|
|
|
|
```bash
|
|
# Get current setting
|
|
curl http://localhost:5001/api/v3/wifi/ap/auto-enable
|
|
|
|
# Set auto-enable to true
|
|
curl -X POST http://localhost:5001/api/v3/wifi/ap/auto-enable \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"auto_enable_ap_mode": true}'
|
|
```
|
|
|
|
## Behavior Summary
|
|
|
|
| Auto-Enable Setting | WiFi Status | Ethernet Status | AP Mode Behavior |
|
|
|---------------------|-------------|-----------------|------------------|
|
|
| `false` (default) | Any | Any | Manual enable only |
|
|
| `true` | Connected | Any | Disabled |
|
|
| `true` | Disconnected | Connected | Disabled |
|
|
| `true` | Disconnected | Disconnected | **Auto-enabled** |
|
|
|
|
## When Auto-Enable is Disabled (Default)
|
|
|
|
- AP mode **never** activates automatically
|
|
- Must be manually enabled via web UI or API
|
|
- Once enabled, it will automatically disable when WiFi or Ethernet connects
|
|
- Useful for systems with stable network connections (e.g., Ethernet)
|
|
|
|
## When Auto-Enable is Enabled
|
|
|
|
- AP mode automatically enables when both WiFi and Ethernet disconnect
|
|
- AP mode automatically disables when WiFi or Ethernet connects
|
|
- Useful for portable devices that may lose network connectivity
|
|
|
|
## Troubleshooting
|
|
|
|
### AP Mode Not Enabling
|
|
|
|
1. **Check if WiFi or Ethernet is connected**:
|
|
```bash
|
|
nmcli device status
|
|
```
|
|
|
|
2. **Check auto-enable setting**:
|
|
```bash
|
|
python3 -c "
|
|
from src.wifi_manager import WiFiManager
|
|
wm = WiFiManager()
|
|
print('Auto-enable:', wm.config.get('auto_enable_ap_mode', False))
|
|
"
|
|
```
|
|
|
|
3. **Manually enable AP mode**:
|
|
- Use web interface: WiFi tab → Enable AP Mode button
|
|
- Or via API: `POST /api/v3/wifi/ap/enable`
|
|
|
|
### AP Mode Enabling Unexpectedly
|
|
|
|
1. **Check auto-enable setting**:
|
|
```bash
|
|
cat config/wifi_config.json | grep auto_enable_ap_mode
|
|
```
|
|
|
|
2. **Disable auto-enable**:
|
|
```bash
|
|
# Edit config file
|
|
nano config/wifi_config.json
|
|
# Set "auto_enable_ap_mode": false
|
|
|
|
# Restart service
|
|
sudo systemctl restart ledmatrix-wifi-monitor
|
|
```
|
|
|
|
3. **Check service logs**:
|
|
```bash
|
|
sudo journalctl -u ledmatrix-wifi-monitor -f
|
|
```
|
|
|
|
## Migration from Old Behavior
|
|
|
|
If you have an existing installation that was auto-enabling AP mode:
|
|
|
|
1. The default is now `false` (manual enable)
|
|
2. Existing configs will be updated to include `auto_enable_ap_mode: false`
|
|
3. If you want the old behavior, set `auto_enable_ap_mode: true` in `config/wifi_config.json`
|
|
|
|
## Related Documentation
|
|
|
|
- [WiFi Setup Guide](WIFI_SETUP.md)
|
|
- [SSH Unavailable After Install](SSH_UNAVAILABLE_AFTER_INSTALL.md)
|
|
- [WiFi Ethernet AP Mode Fix](WIFI_ETHERNET_AP_MODE_FIX.md)
|
|
|