Tobias GesellchenandClaude Opus 4.7
332c7b87d0
Closes #195 and #269. Both issues reported the same symptom on freshly-paired speakers: AUX selection and preset playback failed post-pair, while /sources at :8090 still reported the sources as READY. The bug was upstream in AfterTouch's cloud-side responses. Real Bose's /streaming/account/{a}/full never emitted AUX as a cloud <source>. Verified across 61 captured upstream /full bodies covering 4669 source elements: zero match sourceproviderid=9 (AUX), zero match the literal string "AUX". Captures sample at scripts/android/captures/var/lib/soundtouch-service/parity_mismatches/. The captured speakers are SoundTouch 20s which do have physical AUX inputs — Bose deliberately kept AUX out of /full and let the speaker enumerate it locally via isLocal=true. AfterTouch's getAccountSources unconditionally included AUX (id=10001) with the wrong shape: a displayName="AUX IN" attribute (real Bose: never), <name>AUX</name> (real Bose: empty), an empty <credential> (real Bose: empty for INTERNET_RADIO providerid=2 only, never present for AUX since AUX wasn't there). The speaker's source- reconciliation logic treated AfterTouch's malformed AUX entry as a cloud-side inconsistency and refused dispatch to AUX — even though the local availability check kept reporting it READY. This was the actual cause behind a long red-herring trail (TPDA :30034 storm, IoT.xml/AVS bootstrap, userAuthToken shape, SETUP state machine bracket). All of those are universal across the firmware family; spotty has the same TPDA storm in logread and AUX still works there. Only the cloud-source-list shape diverged between working and broken speakers. The filter applies in getAccountSources because both AccountFullToXML and AccountSourcesToXML go through it. AUX stays in GetDefaultSources for non-cloud consumers (web UI source picker, default-sources init). Three handler tests updated to assert AUX is intentionally excluded from cloud responses. Verified by gesellix on rhino 2026-05-16 via full factory-reset → wifi-push → setup pair → AUX press → audio plays. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Bose SoundTouch Toolkit
Independent project. Not affiliated with or endorsed by Bose Corporation.
Context: Cloud Shutdown
Bose is shutting down SoundTouch cloud services on May 6, 2026. After that, music service browsing, preset sync, and the official SoundTouch app stop working. This toolkit lets you keep your speakers fully functional.
See the Survival Guide for the full picture.
Tools
soundtouch-service — AfterTouch
A local server that replaces the Bose cloud ("AfterTouch"). Once your speaker is redirected to it, you have full control without any Bose cloud dependency. The built-in web UI at http://localhost:8000 handles all setup — no config files needed to get started.
If you want to run a server for this - no problem. The service is small enough to run on the SoundTouch itself. See the On-Device Installer for instructions.
Two scenarios:
Before shutdown — migrate your existing setup
While the Bose cloud is still running, use soundtouch-backup to save your account data. The local service web UI then helps with the migration so your speaker keeps its presets and credentials.
After shutdown or factory reset — start fresh Create a local account, configure your speakers, and start using them immediately. No Bose infrastructure required.
Redirecting your speaker
The service needs a stable address on your local network (e.g. soundtouch.fritz.box or soundtouch.local). The speaker must then be redirected to resolve the Bose cloud hostnames to that address. Two supported methods:
| Method | How it works | Notes |
|---|---|---|
| XML redirect | Upload a config XML via the Web API | Surgical; covers only registered endpoints; best for testing |
| DNS/DHCP | Serve custom DNS on your network | Covers all devices at once; requires port 53 and TLS |
The web UI walks you through each method. DNS redirect requires HTTPS — the service manages its own CA certificate and the web UI guides you through trusting it on each speaker.
Note: A hosts-file method (direct SSH edits to
/etc/hosts) also exists in the codebase but is deprecated and not exposed in the web UI.
Enabling SSH via USB stick
Some setup steps require SSH access to the speaker. Enable it once per device: create a file named remote_services on a FAT-formatted USB drive (the drive may need its bootable flag set — see SoundCork issue #172), and insert it while the speaker is powered on. After reboot, root SSH is available with no password.
See Device Initial Setup and Migration Guide for step-by-step instructions.
soundtouch-backup
Backs up your Bose cloud account (presets, paired devices, music sources) and each speaker's local state before the shutdown. Run soundtouch-backup all to capture everything in one step; it authenticates with the Bose cloud, then polls each paired speaker over the local network.
See the soundtouch-backup README for usage.
soundtouch-cli
Command-line control of any SoundTouch device: play/pause/volume, presets, source selection, multiroom zones, device discovery, and more. Works entirely over the local network — no cloud dependency. Well-suited for scripting and home automation.
See the CLI Reference for full usage.
soundtouch-web
A standalone web UI for device control — play, pause, volume, preset selection, real-time status — served from a local Go binary. Complements soundtouch-service when you want a dedicated device-control interface separate from the setup/admin UI.
See the soundtouch-web README for usage.
Go library
pkg/client provides a Go API for all SoundTouch device endpoints: media control, volume, presets, sources, zones, real-time WebSocket events, and device discovery. Use it to build your own integrations.
go get github.com/gesellix/bose-soundtouch
See the API Reference and pkg.go.dev for documentation.
Documentation
- Getting Started
- Survival Guide
- Migration Guide
- Device Initial Setup
- Migration & Safety Guide
- CLI Reference
- SoundTouch Service Guide
- HTTPS & CA Setup
- API Reference
Related projects
- SoundCork (Deborah Kaplan et al.) — Python service interception; pioneered the cloud emulation approach this project builds on
- SoundCork Stockholm App — Companion app for SoundCork
- SoundTouch Plus (Todd Lucas) — Home Assistant integration; extensive undocumented API documentation
- ÜberBöse API (Julius) — API research and advanced endpoint discovery
- Bose SoundTouch Hook (Adrian Böckenkamp) —
LD_PRELOADhooking for reverse engineering device internals
Support
- Bug reports: GitHub Issues
- Questions & discussions: GitHub Discussions
Star this project ⭐ if you find it useful!
License
MIT — see LICENSE.
SoundTouch is a trademark of Bose Corporation.