mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
Tobias GesellchenandClaude Sonnet 4.6
56462d7145
Problem: the existing docs gave no clear path for non-technical users. - GETTING-STARTED.md is a Go library developer guide - RASPBERRY-PI.md stops after the service is running (no migration or preset steps) - DEVICE-LOCAL-INSTALL.md is an architectural analysis that confused installation intent - No single page helped a user choose between external-host vs on-device Changes: - docs/DEVICE-LOCAL-INSTALL.md → docs/architecture/DEVICE-LOCAL-INSTALL.md Move the planning/architecture doc out of the user-visible guides root; add a redirect banner pointing to the user guides - docs/guides/DEPLOYMENT-OVERVIEW.md (new) Navigation landing page: comparison table (external host vs on-device), links to user-friendly walkthrough + technical reference for each scenario - docs/guides/EXTERNAL-HOST-WALKTHROUGH.md (new) Step-by-step for Raspberry Pi / any always-on host: install, discover speaker, run migration wizard, Health QuickFix, verify pairing, set presets via UI or CLI — the post-install steps that RASPBERRY-PI.md did not cover - docs/guides/RASPBERRY-PI.md: cross-link to full walkthrough and overview - README.md: replace the one-liner "see On-Device Installer" with a pointer to the Deployment Overview so both paths are equally visible Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Bose SoundTouch Toolkit Documentation
Welcome to the documentation for the Bose SoundTouch Toolkit. This comprehensive toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026, with enhanced local management and monitoring capabilities.
🚀 Start Here
For New Users
- Complete Migration Guide - Step-by-step guide from Bose Cloud to local control
- Getting Started - Quick introduction to the toolkit
For Existing Users
- Cloud Shutdown Survival Guide - Prepare for the May 2026 shutdown
- Backup Tool - Back up your cloud account and speaker data before shutdown
- SoundTouch Service Guide - Advanced service configuration
📋 Essential Documentation
The documentation is organized into three main categories:
1. User Guides - For everyday users migrating and managing devices
2. Technical Reference - For developers and advanced configuration
3. Concept Documentation - For contributors and system architects
🗂 Documentation Structure
🗂 User Guides
Migration & Setup
- Complete Migration Guide - 📖 Main guide for migrating from Bose Cloud
- Cloud Shutdown Survival Guide - Prepare for service shutdown
- Migration & Safety Guide - Advanced migration strategies
- Initial Device Setup - First-time device configuration
- Raspberry Pi Setup - Installing on Raspberry Pi
Daily Management
- SoundTouch Service Guide - Service operation and maintenance
- Troubleshooting - Common issues and solutions
- HTTPS Setup - Secure connections
- Deployment Guide - Production deployments
Advanced Features
- MAC Address Mapping - Device identification
- CLI Reference - Command-line tools
- Backup Tool - Cloud account and speaker data backup
- IoT Implementation Guide - IoT integrations
- MQTT Integration Design - MQTT setup
📚 Technical Reference
API Documentation
- API Endpoints - REST API reference
- Spotify Account Addition - Technical requests for Spotify
- WebSocket Events - Real-time events
- Zone Management - Multi-room control
- Preset Management - Preset operations
Analysis & Research
- Upstream URLs - Bose service endpoints
- Device Redirect Methods - Migration techniques
- IoT Configuration Analysis - Device configurations
- IoT Config Summary - Configuration summaries
Device Lifecycle & Network Independence
- Device Lifecycle and /power_on Enhancement - Complete analysis of device registration and network independence improvements
- /power_on Implementation Guide - Technical implementation details for enhanced device management
🏗 Concept Documentation
Current concept docs are listed under the Concepts section of SUMMARY.md. Highlights:
- Spotify Overview — mental model, Spotify Connect vs OAuth-intercept, DNS rewrite gotcha
- Spotify OAuth — flows and management endpoints
- Amazon Music OAuth — companion to Spotify OAuth; same protocol shape, different scopes
- Encrypted Export —
.age-encrypted diagnostic bundles - Request Recording — how the proxy captures live device traffic for parity testing
Older planning artefacts ("Enhanced State Management System", "Upstream Service Simulation") live under docs/archive/ — kept for the record, no longer current.
💡 Quick Reference
Common Tasks
- Migrate first device: Follow Migration Guide Step 5
- Check device health: Dashboard → Devices → [Device Name] → Health Status
- Backup configuration: Dashboard → Settings → Backup → Create Backup
- Add new device: Dashboard → Devices → Discover Devices → Register
Getting Help
- Issues & Bugs: GitHub Issues
- Questions & Discussion: GitHub Discussions
- Documentation: Check troubleshooting guides first
- Community: Share experiences and help others
For a complete list of all documents, see the Summary.