github/Bose-SoundTouch
1
0
Fork 0
mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-18 16:46:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9be1c7d588805275ed2b648b26ee7e114c8d8f2b
Bose-SoundTouch/docs/SOUNDTOUCH-SERVICE.md
T

22 KiB
Raw Blame History

SoundTouch Service

The soundtouch-service is a comprehensive local server that emulates Bose's cloud services, enabling offline SoundTouch device operation and advanced debugging capabilities. This service is particularly valuable given Bose's announcement that cloud support will end in May 2026.

Overview

The service provides:

  • 🏠 Local Service Emulation: Complete BMX (Bose Media eXchange) and Marge service implementation
  • 🔧 Device Migration: Seamlessly migrate devices from Bose cloud to local services
  • 📊 Traffic Proxying: Inspect and log all device communications for debugging
  • 🌐 Web Management UI: Browser-based interface for device management
  • 💾 Persistent Data: Store device configurations, presets, and usage statistics
  • 📝 HTTP Recording: Persist all interactions as re-playable .http files
  • 🔍 Auto-Discovery: Automatically detect and configure SoundTouch devices
  • 🔒 Offline Operation: Continue using full device functionality without internet

Architecture

The service consists of several key components:

BMX Services (Bose Media eXchange)

  • TuneIn Integration: Direct playback of radio stations and podcasts
  • Service Registry: Media service discovery and configuration
  • Playback Control: Stream URL resolution and audio metadata

Marge Services (Account & Device Management)

  • Account Management: User account simulation and device association
  • Preset Synchronization: Cross-device preset storage and sync
  • Recent Items: Playback history tracking and management
  • Configuration Management: Device settings and preferences

Discovery & Migration

  • Network Scanning: UPnP/SSDP and mDNS device discovery
  • Device Analysis: Configuration assessment and compatibility checking
  • Service Migration: Automated configuration updates for local service usage
  • Health Monitoring: Device connectivity and service status tracking

Installation

Install from Source

go install github.com/gesellix/bose-soundtouch/cmd/soundtouch-service@latest

Build from Repository

git clone https://github.com/gesellix/bose-soundtouch.git
cd Bose-SoundTouch
go build -o soundtouch-service ./cmd/soundtouch-service

Docker Support

You can run the SoundTouch service using Docker or Docker Compose.

Note for macOS and Windows users: The --net host option is only supported on Linux. On macOS and Windows, service discovery (mDNS, UPnP) will not work automatically within the container. You will need to manually enter your device's IP address in the management UI, and the service will communicate with it directly.

Using Docker

Linux (with host networking for discovery):

docker run -d \
  --name soundtouch-service \
  --network host \
  -v $(pwd)/data:/app/data \
  ghcr.io/gesellix/bose-soundtouch:latest

macOS / Windows (with port mapping):

docker run --rm -it \
  -p 8000:8000 -p 8443:8443 \
  -v $(pwd)/data:/app/data \
  --env SERVER_URL=http://soundtouch.local:8000 \
  --env HTTPS_SERVER_URL=https://soundtouch.local:8443 \
  ghcr.io/gesellix/bose-soundtouch:latest

Note

: The hostnames configured via SERVER_URL and HTTPS_SERVER_URL are automatically added as Subject Alternative Names (SAN) to the generated TLS certificate, ensuring valid SSL connections.

Using Docker Compose

Create a docker-compose.yml file:

services:
  soundtouch-service:
    image: ghcr.io/gesellix/bose-soundtouch:latest
    container_name: soundtouch-service
    # Linux users: use host networking for device discovery
    # network_mode: host
    # macOS/Windows users: use port mapping (discovery will be manual)
    ports:
      - "8000:8000"
      - "8443:8443"
    environment:
      - PORT=8000
      - SERVER_URL=http://soundtouch.local:8000
      - HTTPS_SERVER_URL=https://soundtouch.local:8443
      - DATA_DIR=/app/data
    volumes:
      - ./data:/app/data
    restart: unless-stopped

And run:

docker-compose up -d

Quick Start

1. Start the Service

# Start with default settings (port 8000)
soundtouch-service

2. Access the Web Interface

Open your browser to http://localhost:8000 to access the management interface.

3. Discover Devices

The service will automatically start discovering SoundTouch devices on your network. You can also trigger manual discovery from the web UI or API.

4. Migrate Devices

Use the web interface or API to migrate devices from Bose cloud services to your local instance.

Configuration

The service can be configured via environment variables or command-line flags:

Variable Flag Description Default
PORT --port Port to bind the service to 8000
BIND_ADDR --bind Network interface to bind to all (ipv4 and ipv6)
DATA_DIR --data-dir Directory for persistent data ./data
SERVER_URL --server-url External URL of this service http://<hostname>:8000
HTTPS_SERVER_URL --https-server-url External HTTPS URL https://<hostname>:8443
PYTHON_BACKEND_URL URL for Python-based service components (legacy)
REDACT_PROXY_LOGS --redact-logs Redact sensitive data in proxy logs true
LOG_PROXY_BODY --log-bodies Log full request/response bodies false
RECORD_INTERACTIONS --record-interactions Record HTTP interactions to disk true
DISCOVERY_INTERVAL --discovery-interval Device discovery interval 5m

Configuration Examples

# Custom port and data directory
PORT=9000 DATA_DIR=/home/user/soundtouch soundtouch-service

# External server with custom URL
SERVER_URL=https://my-soundtouch.example.com soundtouch-service --port 443

# Development mode with full logging
LOG_PROXY_BODY=true REDACT_PROXY_LOGS=false soundtouch-service

Device Migration

Understanding Migration

Device migration switches your SoundTouch devices from Bose's cloud services to your local service instance. This process:

  1. Backs up existing device configuration
  2. Updates device service URLs to point to your local server
  3. Maintains all existing presets and settings
  4. Enables offline operation and advanced debugging

Migration Methods

Web Interface (Recommended)

  1. Start the service: soundtouch-service
  2. Open http://localhost:8000
  3. Wait for device discovery to complete
  4. Click "Migrate" next to each device
  5. Monitor migration status in real-time

API Migration

# Get migration summary first
curl http://localhost:8000/setup/migration-summary/192.168.1.100

# Perform migration
curl -X POST http://localhost:8000/setup/migrate/192.168.1.100

# Verify migration status
curl http://localhost:8000/setup/devices

Advanced Migration Options

# Migration with proxy fallback for original services
curl -X POST "http://localhost:8000/setup/migrate/192.168.1.100?proxy_url=http://localhost:8000&marge=original&stats=original"

# Migration with custom target URL
curl -X POST "http://localhost:8000/setup/migrate/192.168.1.100?target_url=https://my-server.com:8000"

Post-Migration Verification

After migration, verify the device is working correctly:

# Check device status
curl http://localhost:8000/setup/devices

# Test preset functionality
curl "http://192.168.1.100:8090/presets"

# Monitor device events (if needed)
curl "http://localhost:8000/events/192.168.1.100"

API Reference

Discovery & Setup

GET /setup/devices

Lists all discovered SoundTouch devices with their current status.

Response:

[
  {
    "device_id": "08DF1F0BA325",
    "name": "Living Room Speaker",
    "ip_address": "192.168.1.100",
    "product_code": "SoundTouch 20",
    "firmware_version": "19.0.5",
    "migrated": true,
    "last_seen": "2024-01-15T10:30:00Z"
  }
]

POST /setup/discover

Triggers immediate network device discovery.

GET /setup/info/{deviceIP}

Gets detailed device information and configuration.

GET /setup/migration-summary/{deviceIP}

Analyzes device configuration and provides migration preview.

Response:

{
  "device_name": "Living Room Speaker",
  "device_model": "SoundTouch 20",
  "firmware_version": "19.0.5",
  "ssh_success": true,
  "current_config": "<?xml version=\"1.0\"?>...",
  "planned_config": "<?xml version=\"1.0\"?>...",
  "remote_services_enabled": false,
  "migration_required": true
}

POST /setup/migrate/{deviceIP}

Migrates device to use local services.

Query Parameters:

  • target_url: Custom service URL (optional)
  • proxy_url: Proxy URL for fallback (optional)
  • marge: Set to "original" to proxy Marge requests (optional)
  • stats: Set to "original" to proxy stats requests (optional)
  • sw_update: Set to "original" to proxy update requests (optional)
  • bmx: Set to "original" to proxy BMX requests (optional)

BMX Services (Bose Media eXchange)

GET /bmx/registry/v1/services

Returns available media services for device registration.

GET /bmx/tunein/v1/playbook/station/{stationID}

Provides TuneIn station playback information.

GET /bmx/tunein/v1/podcast/{podcastID}

Returns podcast episode information and playback URLs.

Marge Services (Account & Device Management)

GET /marge/streaming/sourceproviders

Lists available music service providers.

GET /marge/accounts/{account}/devices/any/presets

Returns user presets for synchronization.

GET /marge/accounts/{account}/devices/any/recents

Returns recent playback items.

PUT /marge/accounts/{account}/devices/{device}/presets/{slot}

Updates a specific preset slot.

POST /marge/streaming/support/addrecent

Adds item to recent playback history.

GET /marge/updates/soundtouch

Returns software update configuration (disabled by default).

Proxy Services

GET /proxy/{encodedURL}

Proxies requests to external services with logging.

Example:

# Proxy request to Bose services
curl "http://localhost:8000/proxy/aHR0cHM6Ly9hcGkuc291bmR0b3VjaC5ib3NlLmNvbS8="

Health & Monitoring

GET /health

Returns service health status.

GET /events/{deviceID}

WebSocket endpoint for real-time device events.

GET /stats/usage

Returns usage statistics.

GET /stats/errors

Returns error statistics.

Web Interface

Overview

The web management interface provides a comprehensive dashboard for managing your SoundTouch devices:

URL: http://localhost:8000/

Features

Device Dashboard

  • Device Discovery: Real-time view of discovered devices
  • Migration Status: Visual indicators of migration state
  • Device Health: Connectivity and service status monitoring
  • Quick Actions: One-click migration and configuration

Device Management

  • Configuration Viewer: Inspect current and planned device configs
  • Migration Wizard: Step-by-step device migration process
  • Backup Management: View and restore configuration backups
  • Service Testing: Test connectivity to local services

Monitoring & Debugging

  • Traffic Logs: Real-time proxy request/response logging
  • Event Streaming: Live device event monitoring
  • Statistics Dashboard: Usage and error analytics
  • Debug Tools: Device communication testing utilities

Usage Tips

  1. First Time Setup: The interface will guide you through initial device discovery
  2. Migration Monitoring: Watch migration progress in real-time with detailed status updates
  3. Troubleshooting: Use the debug tools to diagnose device connectivity issues
  4. Log Analysis: Enable detailed logging for development and troubleshooting

HTTP Interaction Recording

The service automatically records all HTTP interactions (both those handled locally and those proxied upstream) as .http files. These files are compatible with the IntelliJ IDEA HTTP Client.

Key Features

  • Session Grouping: All interactions from a single server session are stored in a dedicated directory named {timestamp}-{pid}.
  • Chronological Order: Files are prefixed with a sequential number (e.g., 0001-, 0002-) to preserve the exact order of requests across the entire session.
  • Path-Based Structure: Recordings are organized into subdirectories based on their URL path for better discoverability.
  • Automatic Sanitization: Variable path segments like IP addresses, Device IDs, and Account IDs are automatically identified and replaced with placeholders (e.g., {{ip}}, {{deviceId}}). The original values are preserved as comments at the top of the recorded .http files for easy identification.
  • Re-playability: An http-client.env.json file is generated for each session, allowing you to re-play the recorded requests immediately in IntelliJ IDEA.

Configuration

Redaction

By default, the service redacts sensitive information from the recorded .http files, including:

  • Authorization headers
  • Cookie headers
  • X-Bose-Token headers

This behavior is controlled by the --redact-logs flag or the REDACT_PROXY_LOGS environment variable.

Custom Patterns

The service uses regex patterns to identify variable segments in URL paths. These patterns are loaded from data/patterns.json. You can add custom patterns to this file to support additional variable segments:

[
  {
    "name": "MyVariable",
    "regexp": "^[0-9]{5}$",
    "replacement": "{myVar}"
  }
]

Variables found via these patterns will be:

  1. Used as directory names in the interactions/ folder.
  2. Parameterized as {{myVar}} within the .http files.
  3. Added to the http-client.env.json file with their actual values.

Persistent Data

Data Directory Structure

By default, the service creates a data/ directory in the current working directory:

data/
├── accounts/
│   └── default/
│       ├── devices/
│       │   ├── {DEVICE_ID}/
│       │   │   ├── DeviceInfo.xml
│       │   │   └── config_backup_*.xml
│       │   └── ...
│       ├── Sources.xml
│       ├── Presets.xml
│       └── Recents.xml
├── interactions/
│   └── {SESSION_ID}/
│       ├── self/
│       │   └── {PATH}/
│       │       └── {SEQ}-{TIME}-{METHOD}.http
│       ├── upstream/
│       │   └── {PATH}/
│       │       └── {SEQ}-{TIME}-{METHOD}.http
│       └── http-client.env.json
├── stats/
│   ├── usage/
│   │   └── *.json
│   └── error/
│       └── *.json
└── events/
    └── device_events_*.log

Data Components

Device Data (accounts/default/devices/{DEVICE_ID}/)

  • DeviceInfo.xml: Device metadata and capabilities
  • config_backup_*.xml: Configuration backups before migration
  • presets.xml: Device-specific preset configurations

Account Data (accounts/default/)

  • Sources.xml: Configured music service providers
  • Presets.xml: Cross-device preset synchronization
  • Recents.xml: Recent playback history

Statistics (stats/)

  • usage/: Device usage analytics and patterns
  • error/: Error logs and diagnostic information

Events (events/)

  • device_events_*.log: Device event history and debugging logs

HTTP Interactions (interactions/)

  • {SESSION_ID}/: A unique directory per server run (format: YYYYMMDD-HHMMSS-PID).
  • self/: Requests handled directly by the service.
  • upstream/: Requests proxied to external Bose services.
  • {PATH}/: Nested subdirectories reflecting the URL path (sanitized).
  • http-client.env.json: IntelliJ IDEA HTTP Client environment file with session variables.
  • {SEQ}-{TIME}-{METHOD}.http: Individual interaction recordings in standard HTTP Client format.

Data Management

Backup Strategy

# Manual backup
cp -r data/ backup-$(date +%Y%m%d)/

# Automated backup (cron example)
0 2 * * * cp -r /path/to/data/ /backup/soundtouch-$(date +\%Y\%m\%d)/

Data Migration

# Moving to new server
tar czf soundtouch-data.tar.gz data/
# Transfer to new server
tar xzf soundtouch-data.tar.gz

Cleanup

# Clean old event logs (older than 30 days)
find data/events/ -name "*.log" -mtime +30 -delete

# Clean old statistics (older than 90 days)
find data/stats/ -name "*.json" -mtime +90 -delete

API Endpoints

Management UI

  • URL: http://localhost:8000/ or http://localhost:8000/web/
  • Description: Browser-based guided flow for discovery, data sync, and migration.

Setup API

  • GET /setup/devices: List all known (auto-discovered and manual) devices.
  • POST /setup/devices: Manually add a device by IP.
  • POST /setup/discover: Trigger a new network discovery scan.
  • GET /setup/discovery-status: Check if a scan is currently in progress.
  • POST /setup/sync/{deviceIP}: Fetch presets, recents, and sources from a device.
  • GET /setup/summary/{deviceIP}: Get a detailed migration readiness summary.
  • POST /setup/migrate/{deviceIP}: Migrate a device using the specified method (XML/Hosts).
  • GET /setup/ca.crt: Download the Root CA certificate for manual installation.

Emulated Services

  • /bmx/registry/v1/services: BMX service registry.
  • /bmx/tunein/v1/*: TuneIn radio emulation.
  • /marge/accounts/*: Account and device management.
  • /marge/updates/soundtouch: Software update emulation.
  • /proxy/*: Logging proxy for original Bose services.

Troubleshooting

Common Issues

Device Not Discovered

# Check network connectivity
ping 192.168.1.100

# Trigger manual discovery
curl -X POST http://localhost:8000/setup/discover

# Check device accessibility
curl http://192.168.1.100:8090/info

Migration Failures

# Check SSH connectivity
ssh-keyscan 192.168.1.100

# Get migration summary
curl http://localhost:8000/setup/migration-summary/192.168.1.100

# Verify device configuration
curl http://192.168.1.100:8090/info

Service Connectivity Issues

# Test local service endpoints
curl http://localhost:8000/health
curl http://localhost:8000/bmx/registry/v1/services
curl http://localhost:8000/marge/streaming/sourceproviders

Debug Mode

Enable debug logging for detailed troubleshooting:

LOG_PROXY_BODY=true REDACT_PROXY_LOGS=false soundtouch-service

Log Analysis

# Monitor service logs
tail -f /var/log/soundtouch-service.log

# Analyze proxy traffic
grep "PROXY" /var/log/soundtouch-service.log

# Check device events
ls -la data/events/

Credits & Inspiration

This service implementation is based on and inspired by several excellent community projects:

SoundCork

  • Project: SoundCork
  • Authors: Deborah Gu and contributors
  • Contribution: The architecture and service emulation approach in this Go implementation is heavily based on SoundCork's pioneering Python implementation. SoundCork provided the foundation for understanding Bose's service architecture and migration strategies.

ÜberBöse API

  • Project: ÜberBöse API
  • Author: Julius D.
  • Contribution: Advanced API endpoint discovery and implementation details that helped make this service more complete and robust.

We are grateful to these projects for paving the way and providing the research foundation that made this comprehensive service implementation possible.

Advanced Usage

Custom Service Integration

// Example: Custom BMX service handler
package main

import (
    "net/http"
    "github.com/go-chi/chi/v5"
)

func customBMXHandler(w http.ResponseWriter, r *http.Request) {
    // Custom BMX service logic
    w.Header().Set("Content-Type", "application/json")
    w.Write([]byte(`{"custom": "service"}`))
}

func main() {
    r := chi.NewRouter()
    r.Get("/bmx/custom/endpoint", customBMXHandler)
    http.ListenAndServe(":8000", r)
}

Integration with Home Assistant

# configuration.yaml
soundtouch:
  - host: 192.168.1.100
    port: 8090
    name: "Living Room Speaker"
    
rest:
  - resource: "http://localhost:8000/setup/devices"
    scan_interval: 60
    sensor:
      - name: "SoundTouch Devices"
        value_template: "{{ value_json | length }}"

Monitoring & Alerting

# Health check script
#!/bin/bash
response=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:8000/health)
if [ $response != "200" ]; then
    echo "SoundTouch service is down!" | mail -s "Alert" admin@example.com
fi

Security Considerations

  • Network Security: The service binds to all interfaces by default. Consider using BIND_ADDR=127.0.0.1 for localhost-only access.
  • SSH Access: Migration requires SSH access to devices. Ensure your network security policies allow this.
  • Proxy Logging: Disable REDACT_PROXY_LOGS only in development environments.
  • Data Protection: The data directory contains device configurations and usage patterns. Secure appropriately.

Performance Tuning

Resource Usage

  • Memory: ~50MB baseline + ~5MB per discovered device
  • CPU: Minimal during steady state, ~10% during discovery/migration
  • Disk: ~1MB per device configuration + logs

Scaling Considerations

# For many devices, increase discovery interval
DISCOVERY_INTERVAL=10m soundtouch-service

# For high-traffic environments, consider reverse proxy
nginx -> soundtouch-service instances
Reference in New Issue View Git Blame Copy Permalink