mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-19 09:06:14 +00:00

Files

T

Tobias GesellchenandClaude Opus 4.7 d3b1593953 docs(analysis): add device compatibility matrix for telnet migration

New section §8 records what is currently known about which devices and
firmware our migrateViaTelnet flow handles end-to-end, derived from the
six community sources catalogued in TELNET-COMMAND-REFERENCE.md plus our
issue threads.

* §8.1 — proven to work end-to-end (ST 10, 20, 300, Wave III, Wave IV on
  FW 27.0.6 with multi-reporter agreement).
* §8.2 — proven to need the PairAccount telnet fallback (ST Portable,
  BST20 Portable: /setMargeAccount missing or wedged on those firmware
  builds).
* §8.3 — likely to fail (SA-5 on FW 9.x with the older shell generation;
  newer ST Portable builds with shrunk command set). The preflight +
  abort-on-first-rejection design ensures these fail cleanly, leaving no
  half-configured state.
* §8.4 — unverified targets that are expected to work but lack concrete
  captures (ST 30, ST 520, Wave Music System I/II).
* §8.5 — flags the apparent contradiction between S5's enumerated
  "valid roots" on ST 10 / FW 27.0.6 (which omits envswitch) and #221's
  successful envswitch use on the same firmware. Most plausible reading:
  S5 is a non-exhaustive probe, not a negative claim; preflight catches
  any real absence.
* §8.6 — maps every failure mode to its observable outcome and the unit
  test that exercises it.
* §8.7 — TL;DR.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-10 12:43:36 +02:00

analysis

docs(analysis): add device compatibility matrix for telnet migration

2026-05-10 12:43:36 +02:00

README.md

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

Enhanced Service Architecture

Concept Overview - High-level architecture vision
Upstream Service Simulation - Complete concept design
Implementation Plan - Development roadmap
Technical Specification - Detailed specifications

Development Planning

Implementation Roadmap - Project phases and milestones

💡 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.