soundtouch

README

Bose SoundTouch API Client

A comprehensive Go library and CLI tool for controlling Bose SoundTouch devices via their Web API.

Note: This is an independent project based on the official Bose SoundTouch Web API documentation. Not affiliated with or endorsed by Bose Corporation.

Features

• ✅ Complete API Coverage: All available SoundTouch Web API endpoints implemented
• 🎵 Media Control: Play, pause, stop, volume, bass, balance, source selection
• 🏠 Multiroom Support: Create and manage zones across multiple speakers
• ⚡ Real-time Events: WebSocket connection for live device state monitoring
• 🔍 Device Discovery: Automatic discovery via UPnP/SSDP and mDNS
• 🖥️ CLI Tool: Comprehensive command-line interface
• 🔒 Production Ready: Extensive testing with real SoundTouch hardware
• 🌐 Cross-Platform: Windows, macOS, Linux support

Quick Start

Installation

Install CLI Tool

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

Add Library to Your Project

go get github.com/gesellix/bose-soundtouch

CLI Usage

Discover Devices

# Find SoundTouch devices on your network
soundtouch-cli discover devices

Control a Device

# Basic device information
soundtouch-cli --host 192.168.1.100 info get

# Media controls
soundtouch-cli --host 192.168.1.100 play start
soundtouch-cli --host 192.168.1.100 volume set --level 50
soundtouch-cli --host 192.168.1.100 source select --source SPOTIFY

# Real-time monitoring
soundtouch-cli --host 192.168.1.100 events subscribe

Library Usage

Basic Control

package main

import (
    "fmt"
    "log"
    
    "github.com/gesellix/bose-soundtouch/pkg/client"
)

func main() {
    // Connect to your SoundTouch device
    c := client.NewClient(&client.Config{
        Host: "192.168.1.100",
        Port: 8090,
    })
    
    // Get device information
    info, err := c.GetDeviceInfo()
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("Device: %s\n", info.Name)
    
    // Control playback
    err = c.Play()
    if err != nil {
        log.Fatal(err)
    }
    
    // Set volume
    err = c.SetVolume(50)
    if err != nil {
        log.Fatal(err)
    }
}

Device Discovery

package main

import (
    "context"
    "fmt"
    "log"
    "time"
    
    "github.com/gesellix/bose-soundtouch/pkg/discovery"
)

func main() {
    // Discover SoundTouch devices
    service := discovery.NewService(5 * time.Second)
    devices, err := service.DiscoverDevices(context.Background())
    if err != nil {
        log.Fatal(err)
    }
    
    for _, device := range devices {
        fmt.Printf("Found: %s at %s:%d\n", 
            device.Name, device.Host, device.Port)
    }
}

Real-time Events

package main

import (
    "context"
    "fmt"
    "log"
    
    "github.com/gesellix/bose-soundtouch/pkg/client"
    "github.com/gesellix/bose-soundtouch/pkg/models"
)

func main() {
    c := client.NewClient(&client.Config{
        Host: "192.168.1.100",
        Port: 8090,
    })
    
    // Subscribe to device events
    events, err := c.SubscribeToEvents(context.Background())
    if err != nil {
        log.Fatal(err)
    }
    
    for event := range events {
        switch e := event.(type) {
        case *models.NowPlayingUpdated:
            fmt.Printf("Now playing: %s by %s\n", e.Track, e.Artist)
        case *models.VolumeUpdated:
            fmt.Printf("Volume changed to: %d\n", e.ActualVolume)
        case *models.ConnectionStateUpdated:
            fmt.Printf("Connection state: %s\n", e.State)
        }
    }
}

Multiroom Zones

package main

import (
    "log"
    
    "github.com/gesellix/bose-soundtouch/pkg/client"
    "github.com/gesellix/bose-soundtouch/pkg/models"
)

func main() {
    master := client.NewClient(&client.Config{
        Host: "192.168.1.100", // Master speaker
        Port: 8090,
    })
    
    // Create a multiroom zone
    zone := &models.Zone{
        Master: "192.168.1.100",
        Members: []models.ZoneMember{
            {IPAddress: "192.168.1.101"}, // Living room
            {IPAddress: "192.168.1.102"}, // Kitchen
        },
    }
    
    err := master.SetZone(zone)
    if err != nil {
        log.Fatal(err)
    }
    
    fmt.Println("Multiroom zone created!")
}

Supported Devices

This library supports all Bose SoundTouch-compatible devices, including:

• SoundTouch 10, 20, 30 series
• SoundTouch Portable
• Wave SoundTouch music system
• SoundTouch-enabled Bose speakers

Tested Hardware:

• ✅ SoundTouch 10
• ✅ SoundTouch 20

API Coverage

Feature	Status	Description
Device Info	✅ Complete	Device details, name, capabilities
Media Control	✅ Complete	Play/pause/stop, track navigation
Volume & Audio	✅ Complete	Volume, bass, balance control
Source Selection	✅ Complete	Spotify, Bluetooth, AUX, etc.
Preset Management	✅ Complete	Read preset configurations
Real-time Events	✅ Complete	WebSocket event streaming
Multiroom Zones	✅ Complete	Zone creation and management
System Settings	✅ Complete	Clock, display, network info
Advanced Audio	✅ Complete	DSP controls, tone controls

API Limitations: Preset creation is not supported by the SoundTouch API itself.

Documentation

• 📖 Contributing Guide - How to contribute to the project
• 📚 API Reference - Complete endpoint documentation
• 🔧 CLI Reference - Command-line tool guide
• 🎯 Getting Started - Detailed setup and usage
• ⚙️ Advanced Features - Advanced functionality
• 🏠 Multiroom Setup - Zone configuration guide
• ⚡ WebSocket Events - Real-time event handling
• 🔍 Device Discovery - Discovery configuration
• 🛠️ Troubleshooting - Common issues and solutions

Development

Prerequisites

• Go 1.25.5 or later
• Optional: SoundTouch device for testing

Building from Source

# Clone the repository
git clone https://github.com/gesellix/bose-soundtouch.git
cd Bose-SoundTouch

# Install dependencies
go mod download

# Build CLI tool
make build

# Run tests
make test

# Install CLI locally
go install ./cmd/soundtouch-cli

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Setting up your development environment
• Coding guidelines and best practices
• Testing with real devices
• Submitting pull requests

Examples

Check out the examples/ directory for more usage patterns:

• Basic HTTP Client: Simple device control
• WebSocket Events: Real-time monitoring
• Device Discovery: Finding devices on your network
• Multiroom Management: Zone operations
• Advanced Audio: DSP and tone controls

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This is an independent project based on the official Bose SoundTouch Web API documentation provided by Bose Corporation. It is not affiliated with, endorsed by, or supported by Bose Corporation. Use at your own risk.

SoundTouch is a trademark of Bose Corporation.

Support

• 🐛 Bug Reports: Create an issue
• 💡 Feature Requests: Start a discussion
• ❓ Questions: Check existing discussions
• 📖 Documentation: Browse the docs/ directory

---

Star this project ⭐ if you find it useful!

Documentation

Overview

Package soundtouch provides a comprehensive Go library and CLI tool for controlling Bose SoundTouch devices.

This library implements the complete Bose SoundTouch Web API, enabling programmatic control of SoundTouch speakers including playback control, volume management, source selection, multiroom zone management, and real-time event monitoring via WebSocket connections.

Quick Start

Install the library:

go get github.com/gesellix/bose-soundtouch

Basic usage example:

package main

import (
	"fmt"
	"log"

	"github.com/gesellix/bose-soundtouch/pkg/client"
)

func main() {
	// Create a client for your SoundTouch device
	config := &client.Config{
		Host: "192.168.1.100",
		Port: 8090,
	}
	client := client.NewClient(config)

	// Get device information
	info, err := client.GetInfo()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Device: %s\n", info.Name)

	// Control playback
	err = client.Play()
	if err != nil {
		log.Fatal(err)
	}

	// Set volume
	err = client.SetVolume(50)
	if err != nil {
		log.Fatal(err)
	}
}

Device Discovery

Automatically discover SoundTouch devices on your network:

import "github.com/gesellix/bose-soundtouch/pkg/discovery"

// Discover devices using UPnP/SSDP
service := discovery.NewService(5*time.Second)
devices, err := service.DiscoverDevices(ctx)
if err != nil {
	log.Fatal(err)
}

for _, device := range devices {
	fmt.Printf("Found device: %s at %s\n", device.Name, device.Host)
}

Real-time Events

Monitor device state changes in real-time using WebSocket connections:

// Subscribe to device events
events, err := client.SubscribeToEvents(ctx)
if err != nil {
	log.Fatal(err)
}

for event := range events {
	switch e := event.(type) {
	case *models.NowPlayingUpdated:
		fmt.Printf("Now playing: %s by %s\n", e.Track, e.Artist)
	case *models.VolumeUpdated:
		fmt.Printf("Volume changed to: %d\n", e.ActualVolume)
	}
}

Multiroom Zone Management

Create and manage multiroom zones:

// Create a zone with multiple speakers
zone := &models.Zone{
	Master: "192.168.1.100",
	Members: []models.ZoneMember{
		{IPAddress: "192.168.1.101"},
		{IPAddress: "192.168.1.102"},
	},
}
err = client.SetZone(zone)

CLI Tool

The package includes a comprehensive CLI tool for device control:

# Install the CLI
go install github.com/gesellix/bose-soundtouch/cmd/soundtouch-cli@latest

# Discover devices
soundtouch-cli discover devices

# Control a device
soundtouch-cli --host 192.168.1.100 play start
soundtouch-cli --host 192.168.1.100 volume set --level 50
soundtouch-cli --host 192.168.1.100 source select --source SPOTIFY

Supported Features

• ✅ Device Information & Capabilities
• ✅ Playback Control (Play/Pause/Stop/Next/Previous)
• ✅ Volume, Bass, and Balance Control
• ✅ Source Selection (Spotify, Bluetooth, AUX, etc.)
• ✅ Preset Management
• ✅ Clock/Time Management
• ✅ Network Information
• ✅ Real-time WebSocket Events
• ✅ Multiroom Zone Management
• ✅ Device Discovery (UPnP/SSDP and mDNS)
• ✅ Cross-platform Support (Windows, macOS, Linux)

Package Structure

• client: HTTP client for SoundTouch Web API
• discovery: Device discovery using UPnP/SSDP and mDNS
• models: Data structures for API requests/responses
• config: Configuration management
• cmd/soundtouch-cli: Command-line interface tool

Hardware Compatibility

This library has been tested with real Bose SoundTouch hardware and supports all SoundTouch-compatible devices including:

• SoundTouch 10, 20, 30 series
• SoundTouch Portable
• Wave SoundTouch music system
• And other SoundTouch-enabled Bose speakers

Implementation Notes

This implementation is based on the official Bose SoundTouch Web API documentation and provides 90% coverage of all available endpoints. It is an independent project and is not affiliated with or endorsed by Bose Corporation.

For detailed API documentation, examples, and advanced usage patterns, visit: https://pkg.go.dev/github.com/gesellix/bose-soundtouch