github/Bose-SoundTouch
1
0
Fork 0
mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-18 08:36:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add attribution to official Bose SoundTouch Web API documentation

Browse Source 
- Reference original API documentation source from Bose Corporation
- Link to official Bose SoundTouch End-of-Life page
- Clarify this is an independent implementation
- Add disclaimer about non-affiliation with Bose Corporation
- Provide both online and local documentation references
This commit is contained in:
Tobias Gesellchen
2026-01-10 00:34:54 +01:00
parent d95af0a50a
commit ccd19d97a5
48 changed files with 118 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ANONYMIZATION-SUMMARY.md
+2 -2
View File
@@ -11,8 +11,8 @@ All specific IP addresses, device IDs, device names, and other potentially perso
### IP Addresses
**Original → Anonymized:**
- `192.168.1.35` → `192.168.1.10`
- `192.168.1.100` → `192.168.1.10`
- `192.168.178.35` → `192.168.1.10`
- `192.168.178.28` → `192.168.1.10`
- `192.168.1.100` → `192.168.1.10`
- `192.168.1.101` → `192.168.1.11`
- `192.168.1.102` → `192.168.1.12`
docs/API-COOKBOOK.md
+2 -2
View File
@@ -32,8 +32,8 @@ import (
"log"
"time"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
)
func discoverAllDevices(timeout time.Duration) ([]*client.Client, error) {
docs/BASS-CONTROLS.md
+2 -2
View File
@@ -54,7 +54,7 @@ The Bose SoundTouch Go client provides comprehensive bass control functionality
### Basic Bass Control
```go
import "github.com/user_account/bose-soundtouch/pkg/client"
import "github.com/gesellix/bose-soundtouch/pkg/client"
// Create client
config := client.ClientConfig{
@@ -117,7 +117,7 @@ newBass, err := c.DecreaseBass(1) // Decrease by 1, clamp if needed
### Validation and Limits
```go
import "github.com/user_account/bose-soundtouch/pkg/models"
import "github.com/gesellix/bose-soundtouch/pkg/models"
// Validate bass level before setting
if models.ValidateBassLevel(level) {
docs/CLAUDE.md
+2 -2
View File
@@ -73,8 +73,8 @@ For web components:
When creating test data for API endpoints, prefer real device responses over hypothetical examples:
- **Available test endpoints**:
- `http://192.168.1.100:8090/now_playing` - Different response type 1
- `http://192.168.1.35:8090/now_playing` - Different response type 2
- `http://192.168.178.28:8090/now_playing` - Different response type 1
- `http://192.168.178.35:8090/now_playing` - Different response type 2
- **Usage**: Fetch real responses to create accurate test fixtures
- **Privacy**: Anonymize any personal data (account names, personal playlists, etc.)
- **Coverage**: Use multiple real devices to cover different response variations
docs/DISCOVERY.md
+3 -3
View File
@@ -118,8 +118,8 @@ import (
"fmt"
"time"
"github.com/user_account/bose-soundtouch/pkg/config"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/config"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
)
func main() {
@@ -158,7 +158,7 @@ import (
"context"
"time"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
)
func main() {
docs/GETTING-STARTED.md
+5 -5
View File
@@ -23,7 +23,7 @@ go mod init soundtouch-example
### Step 2: Add the SoundTouch Client
```bash
go get github.com/user_account/bose-soundtouch
go get github.com/gesellix/bose-soundtouch
```
### Step 3: Find Your Device
@@ -38,7 +38,7 @@ import (
"log"
"time"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
)
func main() {
@@ -84,8 +84,8 @@ import (
"log"
"time"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
)
func main() {
@@ -313,7 +313,7 @@ import (
"os/signal"
"syscall"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/client"
)
func main() {
docs/HOST-PORT-PARSING.md
+4 -4
View File
@@ -12,7 +12,7 @@ The SoundTouch CLI now supports parsing host and port combinations in the `-host
```bash
# Specify host and port together
soundtouch-cli -host 192.168.1.100:8090 -info
soundtouch-cli -host 192.168.1.35:8090 -play
soundtouch-cli -host 192.168.178.35:8090 -play
soundtouch-cli -host soundtouch.local:8090 -pause
```
@@ -20,7 +20,7 @@ soundtouch-cli -host soundtouch.local:8090 -pause
```bash
# Traditional separate host and port flags
soundtouch-cli -host 192.168.1.100 -port 8090 -info
soundtouch-cli -host 192.168.1.35 -port 8090 -play
soundtouch-cli -host 192.168.178.35 -port 8090 -play
```
### Precedence Rules
@@ -99,8 +99,8 @@ Comprehensive test coverage in `cmd/soundtouch-cli/main_test.go`:
### Integration Tests
Tested with real SoundTouch devices:
- ✅ SoundTouch 10 (192.168.1.100:8090)
- ✅ SoundTouch 20 (192.168.1.35:8090)
- ✅ SoundTouch 10 (192.168.178.28:8090)
- ✅ SoundTouch 20 (192.168.178.35:8090)
## Benefits
docs/KEY-CONTROLS.md
+2 -2
View File
@@ -207,8 +207,8 @@ package main
import (
"log"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func main() {
docs/PLAN.md
+4 -4
View File
@@ -36,7 +36,7 @@ This document describes the planning for a Golang-based API client for the Bose
### Final Project Structure
```
github.com/user_account/bose-soundtouch/
github.com/gesellix/bose-soundtouch/
├── cmd/
│ ├── cli/ # CLI Tool (Main Application)
│ │ └── main.go
@@ -545,9 +545,9 @@ import (
"log"
"time"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/discovery"
"github.com/user_account/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/discovery"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func main() {
docs/PRESET-MANAGEMENT.md
+1 -1
View File
@@ -61,7 +61,7 @@ package main
import (
"fmt"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/client"
)
func main() {
docs/SOURCE-SELECTION.md
+1 -1
View File
@@ -44,7 +44,7 @@ The Bose SoundTouch Go client provides comprehensive source selection functional
### Basic Source Selection
```go
import "github.com/user_account/bose-soundtouch/pkg/client"
import "github.com/gesellix/bose-soundtouch/pkg/client"
// Create client
config := client.ClientConfig{
docs/VOLUME-CONTROLS.md
+2 -2
View File
@@ -226,8 +226,8 @@ package main
import (
"fmt"
"log"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func main() {
docs/websocket-events.md
+4 -4
View File
@@ -27,8 +27,8 @@ import (
"log"
"time"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func main() {
@@ -551,8 +551,8 @@ wsClient.OnVolumeUpdated(func(event *models.VolumeUpdatedEvent) {
See the generated Go documentation for complete API details:
```bash
go doc github.com/user_account/bose-soundtouch/pkg/client.WebSocketClient
go doc github.com/user_account/bose-soundtouch/pkg/models.WebSocketEvent
go doc github.com/gesellix/bose-soundtouch/pkg/client.WebSocketClient
go doc github.com/gesellix/bose-soundtouch/pkg/models.WebSocketEvent
```
## Testing
docs/zone-management.md
+2 -2
View File
@@ -25,8 +25,8 @@ import (
"fmt"
"log"
"github.com/user_account/bose-soundtouch/pkg/client"
"github.com/user_account/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
func main() {