Compare commits

...
20 Commits
Author SHA1 Message Date
Tobias Gesellchen 49ec2d58db wip 2026-03-07 19:51:19 +01:00
Tobias Gesellchen c78664ee59 wip 2026-03-07 19:51:19 +01:00
Tobias Gesellchen c17ba0e839 Add Stockholm Mini (3)
This is also a refactoring of our api paths
2026-03-07 19:51:19 +01:00
Tobias Gesellchen 17f052308f wip 2026-03-07 19:51:19 +01:00
Tobias Gesellchenandlnx01 2e9f931797 Potential fix for code scanning alert no. 8: Workflow does not contain permissions
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2026-03-07 15:02:57 +01:00
Tobias Gesellchenandlnx01 41378f720b Potential fix for code scanning alert no. 7: Workflow does not contain permissions
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2026-03-07 15:02:15 +01:00
Tobias Gesellchenandlnx01 c87a28f3ba Potential fix for code scanning alert no. 4: Workflow does not contain permissions
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2026-03-07 15:01:03 +01:00
Tobias Gesellchenandlnx01 df18749220 Potential fix for code scanning alert no. 1: Workflow does not contain permissions
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2026-03-07 14:55:55 +01:00
Tobias Gesellchenandlnx01 b6702cd4b5 Potential fix for code scanning alert no. 2: Workflow does not contain permissions
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2026-03-07 14:55:55 +01:00
Tobias GesellchenandJunie fc5de2bbc7 refactor: replace deprecated httputil.ReverseProxy.Director with Rewrite
- Update pkg/service/handlers/handlers_proxy.go and mirror_middleware.go to
  use the modern httputil.ReverseProxy.Rewrite hook (available since Go 1.20).
- Fix SA1019 staticcheck warnings triggered by Go 1.26 deprecation notice.
- Refactor proxy initialization to avoid NewSingleHostReverseProxy to prevent
  conflicts between Director and Rewrite hooks.
- Standardize request modification using ProxyRequest.SetURL and ProxyRequest.Out.

Co-authored-by: Junie <junie@jetbrains.com>
2026-03-07 12:58:01 +01:00
Tobias GesellchenandJunie cf82feca06 security: upgrade Go to 1.26.1 and update dependencies
- Update Go version to 1.26.1 in go.mod and examples to address:
  - GO-2026-4602 (os: FileInfo escape)
  - GO-2026-4601 (net/url: IPv6 host literal parsing)
  - GO-2026-4600 (crypto/x509: panic in name constraint checking)
  - GO-2026-4599 (crypto/x509: incorrect email constraint enforcement)
- Upgrade golang.org/x/* and other dependencies to latest stable versions.
- Synchronize go.sum via go mod tidy.

Co-authored-by: Junie <junie@jetbrains.com>
2026-03-07 12:58:01 +01:00
Tobias Gesellchen b8bbc52803 Refine migration guide (#100) 2026-03-07 12:56:25 +01:00
Tobias Gesellchen a36c2e4629 Prevent browser freeze for large payloads (#101) 2026-03-07 12:56:06 +01:00
Tobias Gesellchen d15cebdc95 Work around Jekyll/Liquid template engine issues
Fix for:

```
  Liquid Exception: Liquid syntax error (line 27): Tag '{% // Response: 200 OK %}' was not properly terminated with regexp: /\%\}/ in REQUEST_RECORDING_CONCEPT.md
/usr/local/bundle/gems/liquid-4.0.4/lib/liquid/block_body.rb:132:in `raise_missing_tag_terminator': Liquid syntax error (line 27): Tag '{%  (Liquid::SyntaxError)
    // Response: 200 OK
%}' was not properly terminated with regexp: /\%\}/
```
2026-03-06 21:57:38 +01:00
Tobias Gesellchen d296b59a9e Add/update docs. Some are only in preparation for future improvements and features (#99) 2026-03-06 21:50:41 +01:00
Tobias Gesellchen d2aaed0f9f View parity mismatches as diff (#98) 2026-03-06 21:26:24 +01:00
Tobias Gesellchen eb50e9b6f6 Decode SCMUDC event details (#97)
This should help understanding events from the SoundTouch app to the
speakers and from speakers to the BMX service.
2026-03-05 23:19:39 +01:00
dependabot[bot] 1e24ca076a ci(deps): bump the actions-core group with 2 updates
Bumps the actions-core group with 2 updates: [actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact).


Updates `actions/upload-artifact` from 6 to 7
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

Updates `actions/download-artifact` from 7 to 8
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v7...v8)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-core
- dependency-name: actions/download-artifact
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-core
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-03 22:21:24 +01:00
dependabot[bot] b19835427b deps(deps): bump golang.org/x/net in the golang group
Bumps the golang group with 1 update: [golang.org/x/net](https://github.com/golang/net).


Updates `golang.org/x/net` from 0.50.0 to 0.51.0
- [Commits](https://github.com/golang/net/compare/v0.50.0...v0.51.0)

---
updated-dependencies:
- dependency-name: golang.org/x/net
  dependency-version: 0.51.0
  dependency-type: indirect
  update-type: version-update:semver-minor
  dependency-group: golang
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-03 22:21:15 +01:00
Tobias Gesellchen 6ee0fc8115 Remove Soundcork fallback 2026-02-26 22:26:35 +01:00
82 changed files with 11556 additions and 2851 deletions
+17
View File
@@ -0,0 +1,17 @@
root = true
[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.html]
# HTML-specific formatting
# Standardize on tag layout
ij_html_do_not_indent_children_of_tags = html,body,thead,tbody,tfoot
ij_html_keep_blank_lines = 1
ij_html_attribute_wrap = normal
ij_html_space_inside_empty_tag = false
+3
View File
@@ -25,6 +25,9 @@
},
{
"pattern": "^https://pkg.go.dev.*badge"
},
{
"pattern": "^\\.\\./images/(dashboard-home|account-creation|account-dashboard|usb-remote-services|device-discovery|device-registration|account-migration|migration-setup|migration-progress|migration-health|migration-complete|backup-setup)\\.png$"
}
],
"replacementPatterns": [
+27 -1
View File
@@ -1,5 +1,8 @@
name: CI
permissions:
contents: read
on:
push:
branches: [main]
@@ -100,7 +103,7 @@ jobs:
go build -o "$output_name" ./cmd/soundtouch-cli
- name: Upload build artifacts
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: soundtouch-cli-${{ matrix.goos }}-${{ matrix.goarch }}
path: soundtouch-cli-*
@@ -144,6 +147,29 @@ jobs:
use-verbose-mode: "yes"
config-file: ".github/markdown-link-check.json"
- name: Warn on pending images
run: |
IMAGES=(
"dashboard-home.png"
"account-creation.png"
"account-dashboard.png"
"usb-remote-services.png"
"device-discovery.png"
"device-registration.png"
"account-migration.png"
"migration-setup.png"
"migration-progress.png"
"migration-health.png"
"migration-complete.png"
"backup-setup.png"
)
for img in "${IMAGES[@]}"; do
if [ ! -f "docs/images/$img" ]; then
echo "::warning file=docs/guides/MIGRATION-GUIDE.md::Pending image '$img' is missing from docs/images/"
fi
done
- name: Validate API documentation
run: |
# Check that all documented endpoints exist in code
+6 -6
View File
@@ -192,7 +192,7 @@ jobs:
echo "✅ Checksums generated successfully"
- name: Upload build artifact
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: binaries-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.goarm }}
path: |
@@ -207,7 +207,7 @@ jobs:
steps:
- name: Download binary artifacts
uses: actions/download-artifact@v7
uses: actions/download-artifact@v8
with:
pattern: binaries-*
path: ./binaries
@@ -264,7 +264,7 @@ jobs:
fi
- name: Upload checksums
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: checksums
path: |
@@ -275,7 +275,7 @@ jobs:
retention-days: 1
- name: Upload all release assets
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: release-assets
path: binaries/release-files/
@@ -294,7 +294,7 @@ jobs:
fetch-depth: 0
- name: Download release assets
uses: actions/download-artifact@v7
uses: actions/download-artifact@v8
with:
name: release-assets
path: ./release-assets
@@ -464,7 +464,7 @@ jobs:
steps:
- name: Download release assets
uses: actions/download-artifact@v7
uses: actions/download-artifact@v8
with:
name: release-assets
path: ./release-assets
+9 -1
View File
@@ -14,6 +14,8 @@ jobs:
vulnerability-scan:
name: Vulnerability Scan
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout code
@@ -43,7 +45,7 @@ jobs:
- name: Upload vulnerability scan results
if: failure()
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: vulnerability-scan-results
path: |
@@ -53,6 +55,8 @@ jobs:
static-analysis:
name: Static Security Analysis
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout code
@@ -119,6 +123,8 @@ jobs:
dependency-review:
name: Dependency Review
runs-on: ubuntu-latest
permissions:
contents: read
if: github.event_name == 'pull_request'
steps:
@@ -137,6 +143,8 @@ jobs:
runs-on: ubuntu-latest
needs: [vulnerability-scan, static-analysis, codeql-analysis]
if: always()
permissions:
contents: read
steps:
- name: Security scan summary
+1 -1
View File
@@ -1,5 +1,5 @@
# Build stage
FROM --platform=$BUILDPLATFORM golang:1.26.0-alpine AS builder
FROM --platform=$BUILDPLATFORM golang:1.26.1-alpine AS builder
# Declare automatic platform ARGs to make them available in build stage
# See https://docs.docker.com/reference/dockerfile#automatic-platform-args-in-the-global-scope
+1
View File
@@ -78,6 +78,7 @@ The `soundtouch-service` is a local server that emulates Bose's cloud services.
- **🔌 Easy Setup**: Activate SSH via USB stick (`remote_services` file)
- **🔧 Device Migration**: Seamlessly transition devices to local control
- **🌐 Web Management UI**: Easy browser-based setup and management
- **🎮 Stockholm Mini**: A minimal reverse-engineered UI for device control (accessible at `/web/stockholm-mini/`)
- **💾 Persistent Data**: Store presets, recents, and sources locally
- **🔄 Endpoint Mirroring**: Asynchronously mirror local requests to Bose cloud for parity testing
- **⚖️ Parity Logging**: Detect and record discrepancies between local and official Bose responses
+106 -98
View File
@@ -82,17 +82,6 @@ func main() {
Usage: "Network interface to bind to",
EnvVars: []string{"BIND_ADDR"},
},
&cli.StringFlag{
Name: "soundcork-url",
Usage: "URL for Soundcork-based service components (legacy)",
Value: "http://localhost:8001",
EnvVars: []string{"SOUNDCORK_BACKEND_URL", "TARGET_URL"},
},
&cli.BoolFlag{
Name: "enable-soundcork-proxy",
Usage: "Enable proxying unknown requests to the Soundcork backend",
EnvVars: []string{"ENABLE_SOUNDCORK_PROXY"},
},
&cli.StringFlag{
Name: "data-dir",
Usage: "Directory for persistent data",
@@ -246,9 +235,8 @@ func main() {
sm := setup.NewManager(config.serverURL, ds, cm)
sm.MgmtUsername = config.mgmtUsername
sm.MgmtPassword = config.mgmtPassword
server := handlers.NewServer(ds, sm, config.serverURL, config.redact, config.logBody, config.record, config.enableSoundcorkProxy, config.migrationEnabled, config.migrationDryRun)
server := handlers.NewServer(ds, sm, config.serverURL, config.redact, config.logBody, config.record, config.migrationEnabled, config.migrationDryRun)
sm.GetDNSRunning = server.GetDNSRunning
server.SetSoundcorkURL(config.soundcorkURL)
server.SetHTTPServerURL(config.httpsServerURL)
server.SetVersionInfo(version, commit, date)
server.SetDiscoverySettings(config.discoveryInterval, persisted.DiscoveryEnabled)
@@ -337,7 +325,7 @@ func main() {
r := setupRouter(server)
log.Printf("Go service starting on %s, proxying to %s", config.serverURL, config.soundcorkURL)
log.Printf("Go service starting on %s", config.serverURL)
if tlsConfig != nil {
startHTTPSServer(config.httpsAddr, r, tlsConfig, config.httpsServerURL)
@@ -371,34 +359,32 @@ func showVersionInfo(_ *cli.Context) error {
}
type serviceConfig struct {
port string
bindAddr string
addr string
soundcorkURL string
dataDir string
serverURL string
httpsServerURL string
httpsAddr string
redact bool
logBody bool
record bool
enableSoundcorkProxy bool
dnsEnabled bool
dnsUpstream string
dnsBind string
mirrorEnabled bool
mirrorEndpoints []string
internalPaths []string
discoveryInterval time.Duration
domains []string
spotifyClientID string
spotifyClientSecret string
spotifyRedirectURI string
mgmtUsername string
mgmtPassword string
migrationEnabled bool
migrationDryRun bool
preferredSource string
port string
bindAddr string
addr string
dataDir string
serverURL string
httpsServerURL string
httpsAddr string
redact bool
logBody bool
record bool
dnsEnabled bool
dnsUpstream string
dnsBind string
mirrorEnabled bool
mirrorEndpoints []string
internalPaths []string
discoveryInterval time.Duration
domains []string
spotifyClientID string
spotifyClientSecret string
spotifyRedirectURI string
mgmtUsername string
mgmtPassword string
migrationEnabled bool
migrationDryRun bool
preferredSource string
}
func loadConfig(c *cli.Context) serviceConfig {
@@ -410,7 +396,6 @@ func loadConfig(c *cli.Context) serviceConfig {
addr = ":" + port
}
soundcorkURL := c.String("soundcork-url")
dataDir := c.String("data-dir")
hostname, _ := os.Hostname()
@@ -442,7 +427,6 @@ func loadConfig(c *cli.Context) serviceConfig {
redact := c.Bool("redact-logs")
logBody := c.Bool("log-bodies")
record := c.Bool("record-interactions")
enableSoundcorkProxy := c.Bool("enable-soundcork-proxy")
dnsEnabled := c.Bool("dns-discovery")
dnsUpstream := c.String("dns-upstream")
@@ -470,34 +454,32 @@ func loadConfig(c *cli.Context) serviceConfig {
preferredSource := c.String("preferred-source")
return serviceConfig{
port: port,
bindAddr: bindAddr,
addr: addr,
soundcorkURL: soundcorkURL,
dataDir: dataDir,
serverURL: serverURL,
httpsServerURL: httpsServerURL,
httpsAddr: httpsAddr,
redact: redact,
logBody: logBody,
record: record,
enableSoundcorkProxy: enableSoundcorkProxy,
dnsEnabled: dnsEnabled,
dnsUpstream: dnsUpstream,
dnsBind: dnsBind,
mirrorEnabled: mirrorEnabled,
mirrorEndpoints: mirrorEndpoints,
internalPaths: internalPaths,
discoveryInterval: discoveryInterval,
domains: domains,
spotifyClientID: spotifyClientID,
spotifyClientSecret: spotifyClientSecret,
spotifyRedirectURI: spotifyRedirectURI,
mgmtUsername: mgmtUsername,
mgmtPassword: mgmtPassword,
migrationEnabled: migrationEnabled,
migrationDryRun: migrationDryRun,
preferredSource: preferredSource,
port: port,
bindAddr: bindAddr,
addr: addr,
dataDir: dataDir,
serverURL: serverURL,
httpsServerURL: httpsServerURL,
httpsAddr: httpsAddr,
redact: redact,
logBody: logBody,
record: record,
dnsEnabled: dnsEnabled,
dnsUpstream: dnsUpstream,
dnsBind: dnsBind,
mirrorEnabled: mirrorEnabled,
mirrorEndpoints: mirrorEndpoints,
internalPaths: internalPaths,
discoveryInterval: discoveryInterval,
domains: domains,
spotifyClientID: spotifyClientID,
spotifyClientSecret: spotifyClientSecret,
spotifyRedirectURI: spotifyRedirectURI,
mgmtUsername: mgmtUsername,
mgmtPassword: mgmtPassword,
migrationEnabled: migrationEnabled,
migrationDryRun: migrationDryRun,
preferredSource: preferredSource,
}
}
@@ -558,10 +540,6 @@ func applyPersistedSettings(ds *datastore.DataStore, config *serviceConfig) data
config.serverURL = persisted.ServerURL
}
if persisted.SoundcorkURL != "" {
config.soundcorkURL = persisted.SoundcorkURL
}
if persisted.HTTPServerURL != "" {
config.httpsServerURL = persisted.HTTPServerURL
}
@@ -575,7 +553,6 @@ func applyPersistedSettings(ds *datastore.DataStore, config *serviceConfig) data
config.redact = persisted.RedactLogs
config.logBody = persisted.LogBodies
config.record = persisted.RecordInteractions
config.enableSoundcorkProxy = persisted.EnableSoundcorkProxy
config.dnsEnabled = persisted.DNSEnabled
if len(persisted.DNSUpstream) > 0 {
@@ -596,22 +573,20 @@ func applyPersistedSettings(ds *datastore.DataStore, config *serviceConfig) data
func createDefaultSettings(ds *datastore.DataStore, config serviceConfig) datastore.Settings {
settings := datastore.Settings{
ServerURL: config.serverURL,
SoundcorkURL: config.soundcorkURL,
HTTPServerURL: config.httpsServerURL,
RedactLogs: config.redact,
LogBodies: config.logBody,
RecordInteractions: config.record,
DiscoveryInterval: config.discoveryInterval.String(),
DiscoveryEnabled: true,
EnableSoundcorkProxy: config.enableSoundcorkProxy,
DNSEnabled: config.dnsEnabled,
DNSUpstream: strings.Split(config.dnsUpstream, ","),
DNSBindAddr: config.dnsBind,
MirrorEnabled: config.mirrorEnabled,
MirrorEndpoints: config.mirrorEndpoints,
PreferredSource: config.preferredSource,
InternalPaths: config.internalPaths,
ServerURL: config.serverURL,
HTTPServerURL: config.httpsServerURL,
RedactLogs: config.redact,
LogBodies: config.logBody,
RecordInteractions: config.record,
DiscoveryInterval: config.discoveryInterval.String(),
DiscoveryEnabled: true,
DNSEnabled: config.dnsEnabled,
DNSUpstream: strings.Split(config.dnsUpstream, ","),
DNSBindAddr: config.dnsBind,
MirrorEnabled: config.mirrorEnabled,
MirrorEndpoints: config.mirrorEndpoints,
PreferredSource: config.preferredSource,
InternalPaths: config.internalPaths,
Shortcuts: map[string]int{
"/.well-known/appspecific/com.chrome.devtools.json": http.StatusNotFound,
"/sw.js": http.StatusNotFound,
@@ -778,10 +753,32 @@ func setupRouter(server *handlers.Server) *chi.Mux {
r.Get("/proxy/*", server.HandleProxyRequest)
r.Get("/devices", server.HandleListDiscoveredDevices)
r.Get("/devices/{deviceId}/info", server.HandleGetStockholmDeviceInfo)
r.Post("/devices/{deviceId}/key/{key}", server.HandleDeviceKey)
r.Post("/devices/{deviceId}/volume/{level}", server.HandleDeviceVolume)
// Stockholm Mini app
r.Handle("/stockholm-mini/*", http.StripPrefix("/stockholm-mini/", http.FileServer(http.Dir("pkg/service/handlers/web/stockholm-mini"))))
r.Route("/devices", func(r chi.Router) {
r.Get("/", server.HandleListDiscoveredDevices)
r.Post("/", server.HandleAddManualDevice)
r.Route("/{deviceId}", func(r chi.Router) {
r.Delete("/", server.HandleRemoveDevice)
r.Get("/events", server.HandleGetDeviceEvents)
r.Get("/info", server.HandleGetDeviceInfo)
r.Get("/ws", server.HandleDeviceWebSocket)
r.Post("/key/{key}", server.HandleDeviceKey)
r.Post("/volume/{level}", server.HandleDeviceVolume)
r.Post("/reboot", server.HandleRebootDevice)
})
})
r.Get("/version", server.HandleGetVersionInfo)
r.Route("/setup", func(r chi.Router) {
r.Get("/devices", server.HandleListDiscoveredDevices)
r.Post("/devices", server.HandleAddManualDevice)
r.Delete("/devices/{deviceId}", server.HandleRemoveDevice)
r.Post("/discover", server.HandleTriggerDiscovery)
r.Get("/discovery-status", server.HandleGetDiscoveryStatus)
r.Get("/settings", server.HandleGetSettings)
@@ -802,7 +799,6 @@ func setupRouter(server *handlers.Server) *chi.Mux {
r.Get("/ca.crt", server.HandleGetCACert)
r.Get("/proxy-settings", server.HandleGetProxySettings)
r.Post("/proxy-settings", server.HandleUpdateProxySettings)
r.Get("/version", server.HandleGetVersionInfo)
r.Get("/interaction-stats", server.HandleGetInteractionStats)
r.Get("/interactions", server.HandleListInteractions)
r.Get("/interaction-content", server.HandleGetInteractionContent)
@@ -816,7 +812,19 @@ func setupRouter(server *handlers.Server) *chi.Mux {
r.Get("/dns-discoveries/download", server.HandleDownloadDNSDiscoveries)
r.Delete("/dns-discoveries", server.HandleClearDNSDiscoveries)
r.Get("/devices/{deviceId}/events", server.HandleGetDeviceEvents)
r.Route("/devices/{deviceId}", func(r chi.Router) {
r.Get("/summary", server.HandleGetMigrationSummary)
r.Post("/migrate", server.HandleMigrateDevice)
r.Post("/revert", server.HandleRevertMigration)
r.Post("/trust-ca", server.HandleTrustCACert)
r.Post("/ensure-remote-services", server.HandleEnsureRemoteServices)
r.Post("/remove-remote-services", server.HandleRemoveRemoteServices)
r.Post("/backup", server.HandleBackupConfig)
r.Post("/sync", server.HandleInitialSync)
r.Post("/test-connection", server.HandleTestConnection)
r.Post("/test-hosts", server.HandleTestHostsRedirection)
r.Post("/test-dns", server.HandleTestDNSRedirection)
})
})
r.NotFound(server.HandleNotFound)
+6 -11
View File
@@ -18,10 +18,9 @@ func TestApplyPersistedSettings(t *testing.T) {
t.Run("overrides true with false", func(t *testing.T) {
config := &serviceConfig{
redact: true,
logBody: true,
record: true,
enableSoundcorkProxy: true,
redact: true,
logBody: true,
record: true,
}
// Simulate the bug by using the old bitwise OR logic in the test,
@@ -29,10 +28,9 @@ func TestApplyPersistedSettings(t *testing.T) {
// config.redact = config.redact || false -> stays true
settings := datastore.Settings{
RedactLogs: false,
LogBodies: false,
RecordInteractions: false,
EnableSoundcorkProxy: false,
RedactLogs: false,
LogBodies: false,
RecordInteractions: false,
}
err := ds.SaveSettings(settings)
if err != nil {
@@ -50,9 +48,6 @@ func TestApplyPersistedSettings(t *testing.T) {
if config.record != false {
t.Errorf("Expected record to be false, got true")
}
if config.enableSoundcorkProxy != false {
t.Errorf("Expected enableSoundcorkProxy to be false, got true")
}
})
t.Run("retains false when settings are false", func(t *testing.T) {
+1
View File
@@ -3,5 +3,6 @@ certs/
default/
dns/
interactions/
parity_mismatches/
patterns.json
settings.json
+77 -21
View File
@@ -1,33 +1,89 @@
# Bose SoundTouch Toolkit Documentation
Welcome to the documentation for the Bose SoundTouch Toolkit. This toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026.
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.
## 📖 Quick Links
## 🚀 Start Here
- [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)
- [Migration & Safety Guide](guides/MIGRATION-SAFETY.md)
- [CLI Reference](guides/CLI-REFERENCE.md)
- [Getting Started](guides/GETTING-STARTED.md)
- [SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md)
### For New Users
- **[Complete Migration Guide](guides/MIGRATION-GUIDE.md)** - Step-by-step guide from Bose Cloud to local control
- **[Getting Started](guides/GETTING-STARTED.md)** - Quick introduction to the toolkit
### For Existing Users
- **[Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md)** - Prepare for the May 2026 shutdown
- **[SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md)** - 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
- [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md)
- [HTTPS Setup](guides/HTTPS-SETUP.md)
- [Deployment Guide](guides/DEPLOYMENT.md)
- [Raspberry Pi Setup](guides/RASPBERRY-PI.md)
- [MAC Address Mapping](guides/MAC-ADDRESS-MAPPING.md)
- [Troubleshooting](guides/TROUBLESHOOTING.md)
## 🗂 User Guides
### Technical Reference
- [API Endpoints](reference/API-ENDPOINTS.md)
- [WebSocket Events](reference/WEBSOCKET-EVENTS.md)
- [Zone Management](reference/ZONE-MANAGEMENT.md)
- [Preset Management](reference/PRESET-MANAGEMENT.md)
### Migration & Setup
- **[Complete Migration Guide](guides/MIGRATION-GUIDE.md)** - 📖 **Main guide** for migrating from Bose Cloud
- [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md) - Prepare for service shutdown
- [Migration & Safety Guide](guides/MIGRATION-SAFETY.md) - Advanced migration strategies
- [Initial Device Setup](guides/DEVICE-INITIAL-SETUP.md) - First-time device configuration
- [Raspberry Pi Setup](guides/RASPBERRY-PI.md) - Installing on Raspberry Pi
### Daily Management
- [SoundTouch Service Guide](guides/SOUNDTOUCH-SERVICE.md) - Service operation and maintenance
- [Troubleshooting](guides/TROUBLESHOOTING.md) - Common issues and solutions
- [HTTPS Setup](guides/HTTPS-SETUP.md) - Secure connections
- [Deployment Guide](guides/DEPLOYMENT.md) - Production deployments
### Advanced Features
- [MAC Address Mapping](guides/MAC-ADDRESS-MAPPING.md) - Device identification
- [CLI Reference](guides/CLI-REFERENCE.md) - Command-line tools
- [IoT Implementation Guide](guides/IOT-IMPLEMENTATION-GUIDE.md) - IoT integrations
- [MQTT Integration Design](guides/MQTT-INTEGRATION-DESIGN.md) - MQTT setup
## 📚 Technical Reference
### API Documentation
- [API Endpoints](reference/API-ENDPOINTS.md) - REST API reference
- [WebSocket Events](reference/WEBSOCKET-EVENTS.md) - Real-time events
- [Zone Management](reference/ZONE-MANAGEMENT.md) - Multi-room control
- [Preset Management](reference/PRESET-MANAGEMENT.md) - Preset operations
### Analysis & Research
- [Upstream URLs](analysis/UPSTREAM-URLS.md)
- [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md)
- [Upstream URLs](analysis/UPSTREAM-URLS.md) - Bose service endpoints
- [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md) - Migration techniques
- [IoT Configuration Analysis](analysis/IOT-CONFIGURATION-ANALYSIS.md) - Device configurations
- [IoT Config Summary](analysis/IOT-CONFIG-SUMMARY.md) - Configuration summaries
### Device Lifecycle & Network Independence
- **[Device Lifecycle and /power_on Enhancement](device-lifecycle-and-power-on-enhancement.md)** - Complete analysis of device registration and network independence improvements
- [/power_on Implementation Guide](power-on-implementation-guide.md) - Technical implementation details for enhanced device management
## 🏗 Concept Documentation
### Enhanced Service Architecture
- **[Concept Overview](concepts/README.md)** - High-level architecture vision
- [Upstream Service Simulation](concepts/upstream-service-simulation.md) - Complete concept design
- [Implementation Plan](concepts/implementation-plan.md) - Development roadmap
- [Technical Specification](concepts/technical-specification.md) - Detailed specifications
### Development Planning
- [Implementation Roadmap](concepts/implementation-roadmap.md) - Project phases and milestones
## 💡 Quick Reference
### Common Tasks
- **Migrate first device**: Follow [Migration Guide Step 5](guides/MIGRATION-GUIDE.md#step-5-migrate-individual-devices)
- **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](https://github.com/gesellix/Bose-SoundTouch/issues)
- **Questions & Discussion**: [GitHub Discussions](https://github.com/gesellix/Bose-SoundTouch/discussions)
- **Documentation**: Check troubleshooting guides first
- **Community**: Share experiences and help others
For a complete list of all documents, see the [Summary](SUMMARY.md).
+20 -12
View File
@@ -24,9 +24,11 @@ Authorization: Bearer jGwEmFWr...
{"envelope":{"monoTime":234906,"payloadProtocolVersion":"3.1","payloadType":"scmudc","protocolVersion":"1.0","time":"2026-02-25T23:03:14.976349+00:00","uniqueId":"A81B6A536A98"},"payload":{"deviceInfo":{"boseID":"3230304","deviceID":"A81B6A536A98","deviceType":"SoundTouch 10","serialNumber":"I6332527703739342000020","softwareVersion":"27.0.6.46330.5043500 epdbuild.trunk.hepdswbld04.2022-08-04T11:20:29","systemSerialNumber":"069231P63364828AE"},"events":[{"data":{"play-state":"PAUSE_STATE"},"monoTime":234904,"time":"2026-02-25T23:03:14.973466+00:00","type":"play-state-changed"}]}}
> {%
{% raw %}
> {%
// Response: 200 OK
%}
{% endraw %}
```
**Mirror Recording** (missing body):
@@ -40,11 +42,13 @@ Authorization: Bearer jGwEmFWr...
> {%
{% raw %}
> {%
// Response: 200 OK
// Headers:
// X-Proxy-Origin: upstream-mirror
%}
{% endraw %}
```
### Issue 2: Request Flow Complexity
@@ -135,7 +139,7 @@ func (s *Server) SnapshotMiddleware(next http.Handler) http.Handler {
// 3. Inject pointer into context
ctx := context.WithValue(r.Context(), SnapshotKey, snapshot)
// 4. Restore r.Body for downstream compatibility
r = r.WithContext(ctx)
r.Body = io.NopCloser(bytes.NewReader(snapshot.Body))
@@ -209,7 +213,7 @@ func (rm *RecordingManager) RecordInteraction(snapshotID string, response *Respo
log.Printf("Request snapshot not found: %s", snapshotID)
return
}
// Record with guaranteed data integrity
rm.recorder.RecordInteraction(request, response)
}
@@ -217,35 +221,39 @@ func (rm *RecordingManager) RecordInteraction(snapshotID string, response *Respo
func (r *Recorder) RecordInteraction(req *RequestSnapshot, res *ResponseSnapshot) error {
// Generate .http file with complete data
var buf bytes.Buffer
// Write request
fmt.Fprintf(&buf, "### %s %s\n", req.Method, req.URL.String())
fmt.Fprintf(&buf, "%s %s\n", req.Method, req.URL.String())
fmt.Fprintf(&buf, "Host: %s\n", req.Host)
for k, vv := range req.Headers {
for _, v := range vv {
fmt.Fprintf(&buf, "%s: %s\n", k, v)
}
}
buf.WriteString("\n")
buf.Write(req.Body)
buf.WriteString("\n\n")
// Write response
{% raw %}
buf.WriteString("> {% \n")
{% endraw %}
fmt.Fprintf(&buf, " // Response: %d %s\n", res.StatusCode, http.StatusText(res.StatusCode))
buf.WriteString(" // Headers:\n")
for k, vv := range res.Headers {
for _, v := range vv {
fmt.Fprintf(&buf, " // %s: %s\n", k, v)
}
}
{% raw %}
buf.WriteString("%}\n\n")
{% endraw %}
if len(res.Body) > 0 {
buf.WriteString("/*\n")
buf.Write(res.Body)
@@ -253,7 +261,7 @@ func (r *Recorder) RecordInteraction(req *RequestSnapshot, res *ResponseSnapshot
} else {
buf.WriteString("// [Binary response body: 0 bytes]\n")
}
// Write to file
return r.writeToFile(buf.Bytes(), req, res)
}
+192
View File
@@ -0,0 +1,192 @@
# SCMUDC Enrichment Implementation Summary
## Overview
This document summarizes the implementation of SCMUDC (Sound Control Management Usage Data Collection) event enrichment in the AfterTouch toolkit. The enhancement provides human-readable analysis of device telemetry data to improve usability and debugging capabilities.
## Problem Solved
Previously, SCMUDC telemetry events were stored as raw JSON with Base64-encoded XML content, making them difficult to analyze. Users had to manually decode content to understand what device interactions were being recorded.
## Solution Implemented
### 1. Backend Enrichment (`pkg/service/proxy/`)
#### New File: `scmudc.go`
- **SCMUDCRequest/SCMUDCEvent Structs**: Parse incoming telemetry JSON
- **EnrichedSCMUDCEvent Struct**: Human-readable analysis with decoded content
- **DecodedContent Struct**: Parsed XML metadata (track names, artwork URLs, etc.)
- **enrichSCMUDCRequest()**: Main enrichment function that:
- Identifies event origin (app, hardware, or internal system)
- Decodes Base64 XML content for device events
- Creates human-readable summaries
- **Helper Functions**: Button formatting, content summarization, origin descriptions
#### Enhanced File: `recorder.go`
- **Updated save() method**: Extracts SCMUDC data during recording
- **New writeRequestWithEnrichment()**: Adds enriched comments to .http files
- **New writeResponseWithEnrichment()**: Includes SCMUDC analysis in response section
- **Updated Interaction struct**: Added `SCMUDCData` field for API responses
- **New extractSCMUDCFromFile()**: Parses enrichment data from existing .http files
- **Enhanced parseInteractionFile()**: Populates SCMUDC data when listing interactions
### 2. Frontend Enhancement
#### Updated HTML (`pkg/service/handlers/web/index.html`)
- **New Column**: Added "Event Details" to interactions table
- **Table Structure**: Updated to accommodate SCMUDC enrichment display
#### Enhanced JavaScript (`pkg/service/handlers/web/js/script.js`)
- **Updated fetchInteractions()**: Displays enriched SCMUDC data with icons
- **New Helper Functions**:
- `getOriginIcon()`: Maps origins to emojis (📱 App, 🎛️ Hardware, 🔄 Internal)
- `getActionIcon()`: Maps actions to emojis (▶️ Play, ⏸️ Pause, etc.)
- `showSCMUDCDetails()`: Detailed popover for complex events
- `displaySCMUDCPopover()`: Modal dialog with full decoded content
- **Truncation Logic**: Long content shows "(...)" with click-to-expand
## Event Origin Clarification
Based on analysis of recorded data:
| Origin | Source | Description | Example Events |
|--------|--------|-------------|----------------|
| `gabbo` | **SoundTouch App** | Mobile/desktop app UI interactions | Play, Pause, Power via app |
| `console` | **Device Hardware** | Physical buttons on speaker | Preset buttons, hardware power |
| `device` | **Internal System** | Automatic device responses | Content playback, system actions |
## Enhanced .http File Format
### Before (Raw)
```http
### POST /v1/scmudc/A81B6A536A98
POST /v1/scmudc/A81B6A536A98
Host: events.api.bosecm.com
...
{"envelope":...,"payload":{"events":[{"data":{"contentItem":"PD94bWw..."}}]}}
```
### After (Enriched)
```http
### POST /v1/scmudc/A81B6A536A98
// Origin: Internal System (device)
// Action: play-item
// Command: Billie Eilish - bad guy (instrumental version)
// Summary: Device: Spotify: Billie Eilish - bad guy (instrumental version)
//
// Decoded Content:
// - Source: SPOTIFY
// - Item: Billie Eilish - bad guy (instrumental version)
// - Account: gesellix
// - Artwork: https://i.scdn.co/image/ab67616d0000b273...
//
// Full XML Content:
// <?xml version="1.0" encoding="UTF-8"?>
// <ContentItem source="SPOTIFY" type="tracklisturl" ...>
// <itemName>Billie Eilish - bad guy (instrumental version)</itemName>
// <containerArt>https://i.scdn.co/image/ab67616d0000b273...</containerArt>
// </ContentItem>
POST /v1/scmudc/A81B6A536A98
...
{% raw %}
> {%
// Response: 200 OK
// SCMUDC Event Analysis:
// - Origin: Internal System (device)
// - Action: play-item
// - Summary: Device: Spotify: Billie Eilish - bad guy (instrumental version)
// - Content: Billie Eilish - bad guy (instrumental version)
// - Account: gesellix
%}
{% endraw %}
```
## Web UI Enhancement
### Interactions Table
- **New Column**: "Event Details" shows enriched summaries
- **Visual Icons**: Origin and action type indicators
- **Truncation**: Long content abbreviated with "(...)" expansion
- **Backward Compatibility**: Works with existing recordings
### Event Details Display
```
📱 ▶️ Play Button (Simple app action)
🔄 🎵 Billie Eilish - bad guy... (...) (Complex device event with details)
🎛️ ⭐ Preset 5 (Hardware preset button)
```
### Detailed Popover
For complex events, clicking "(...)" shows:
- **Origin Description**: "SoundTouch App" instead of "gabbo"
- **Full Content Information**: Track names, artwork URLs, account details
- **Complete XML**: Formatted and readable content item data
## Implementation Benefits
### For Users
- **Immediate Recognition**: See what actions were performed without decoding
- **Better Debugging**: Quick identification of app vs. hardware vs. system events
- **Rich Context**: Track names, accounts, and content sources visible at a glance
### For Developers
- **Structured Data**: Consistent parsing and enrichment pipeline
- **Extensible**: Easy to add new event types and origins
- **Backward Compatible**: Existing recordings work without re-processing
### For Analysis
- **Pattern Recognition**: Quickly identify user behavior patterns
- **Service Integration**: See which music services are being used
- **Device Usage**: Understand app vs. hardware control preferences
## File Structure
```
pkg/service/proxy/
├── scmudc.go # New: SCMUDC enrichment logic
├── recorder.go # Enhanced: Enrichment integration
pkg/service/handlers/web/
├── index.html # Enhanced: New table column
├── js/script.js # Enhanced: SCMUDC display logic
docs/
├── scmudc-events-analysis.md # New: Analysis documentation
├── SCMUDC-ENRICHMENT-IMPLEMENTATION.md # This file
```
## Technical Decisions
### Base64 Decoding Strategy
- **When**: During recording (not on-demand) for performance
- **Fallback**: Parse from .http files if enrichment missing
- **Storage**: Both enriched comments and structured data in API responses
### Icon Selection
- **Emoji Usage**: Universal, colorful, intuitive recognition
- **Semantic Mapping**: Icons match function (📱 for app, 🎛️ for hardware)
- **Fallback**: Generic icons (❓, 🔘) for unknown types
### Backward Compatibility
- **Graceful Degradation**: Missing enrichment data doesn't break UI
- **File Parsing**: Extract enrichment from existing .http files
- **API Enhancement**: New fields optional in Interaction struct
## Future Enhancement Opportunities
1. **Event Correlation**: Link device events to user actions
2. **Statistics Dashboard**: Origin-based usage analytics
3. **Content Recommendations**: Track listening patterns
4. **Device Health**: Monitor interaction frequency and patterns
5. **Export Features**: CSV/JSON export of enriched event data
## Testing Considerations
- **Edge Cases**: Malformed Base64, missing XML elements
- **Performance**: Large numbers of SCMUDC events
- **Browser Compatibility**: Emoji display across different browsers
- **Data Validation**: Ensure enrichment doesn't introduce errors
This implementation significantly improves the usability of SCMUDC telemetry data while maintaining full backward compatibility and raw data access for advanced users.
+1 -1
View File
@@ -119,7 +119,7 @@ soundtouch-service
```go
// Build custom applications on top of local services
client := &http.Client{}
resp, _ := client.Get("http://localhost:8000/setup/devices")
resp, _ := client.Get("http://localhost:8000/devices")
```
### Privacy-Conscious Users
+11
View File
@@ -14,6 +14,9 @@
* [Deployment](guides/DEPLOYMENT.md)
* [Raspberry Pi Guide](guides/RASPBERRY-PI.md)
* [Troubleshooting](guides/TROUBLESHOOTING.md)
* [IoT Implementation Guide](guides/IOT-IMPLEMENTATION-GUIDE.md)
* [Migration Guide](guides/MIGRATION-GUIDE.md)
* [MQTT Integration Design](guides/MQTT-INTEGRATION-DESIGN.md)
* [Useful Links](#useful-links)
### Useful Links
@@ -50,7 +53,10 @@
* [Upstream URLs](analysis/UPSTREAM-URLS.md)
* [Anonymization Summary](analysis/ANONYMIZATION-SUMMARY.md)
* [Device Redirect Methods](analysis/DEVICE-REDIRECT-METHODS.md)
* [Stockholm App Analysis](analysis/stockholm-app-analysis.md)
* [Wiki API Comparison](analysis/WIKI-COMPARISON.md)
* [IoT Config Summary](analysis/IOT-CONFIG-SUMMARY.md)
* [IoT Configuration Analysis](analysis/IOT-CONFIGURATION-ANALYSIS.md)
## Appendix (Other Documents)
* [API Navigation Reference](API-NAVIGATION-REFERENCE.md)
@@ -70,3 +76,8 @@
* [Undocumented Community Features](UNDOCUMENTED-COMMUNITY-FEATURES.md)
* [Unimplemented Endpoints](UNIMPLEMENTED-ENDPOINTS.md)
* [Preset Store](preset-store.md)
* [SCMUDC Enrichment Implementation](SCMUDC-ENRICHMENT-IMPLEMENTATION.md)
* [Device Lifecycle and Power On Enhancement](device-lifecycle-and-power-on-enhancement.md)
* [Device Lifecycle Summary](device-lifecycle-summary.md)
* [Power On Implementation Guide](power-on-implementation-guide.md)
* [SCMUDC Events Analysis](scmudc-events-analysis.md)
+189
View File
@@ -0,0 +1,189 @@
# IoT Configuration Quick Reference
## Key Files and Locations
| File/Location | Purpose | Notes |
|-----------------------------------------|------------------------|-----------------------------------------|
| `/mnt/nv/BoseApp-Persistence/1/IoT.xml` | Main IoT configuration | Contains clientID, endpoint, deployment |
| `/opt/Bose/IoT` | IoT service binary | ARM executable, AWS IoT SDK |
| `/mnt/nv/IoTCerts/` | Certificate storage | Device certs and private keys |
| `/etc/init.d/SoundTouch` | System startup script | Creates directory structure |
| `/opt/Bose/etc/Shepherd-noncore.xml` | Service configuration | Defines IoT daemon startup |
## Configuration Parameters
### IoT.xml Structure
```xml
<Configuration
clientID="[UUID]"
iotEndpoint="[AWS_IOT_ENDPOINT]"
deployment="PROD" />
```
### Device-Specific Values
- **ST20**: `clientID="577ecfcc-2db3-4989-92c9-76d7704f9fb3"`
- **ST10**: `clientID="eb1a6d8f-0bb1-4aa7-9113-ea673fcef96e"`
- **Endpoint**: `a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com` (XML)
- **Backup Endpoint**: `amqmidtcohfms.iot.us-east-1.amazonaws.com` (hardcoded)
## Protocol Stack
```
Application Layer: AWS IoT Device Shadows (JSON)
Presentation Layer: RapidJSON parsing/serialization
Session Layer: MQTT v3.1.1
Transport Layer: TLS v1.2
Network Layer: TCP/IP
```
## Certificate Files
| File | Location | Purpose |
|-----------------------|---------------------|---------------------------|
| `iot-cert.pem.crt` | `/mnt/nv/IoTCerts/` | Device client certificate |
| `iot-private.pem.key` | `/mnt/nv/IoTCerts/` | Device private key |
| `rootCA.crt` | `/var/lib/iot/` | AWS IoT Root CA |
## MQTT Topics
### Shadow Operations
```
$aws/things/{clientID}/shadow/update
$aws/things/{clientID}/shadow/update/accepted
$aws/things/{clientID}/shadow/update/rejected
$aws/things/{clientID}/shadow/delete
```
### JSON Payload Examples
#### Device State Report
```json
{
"state": {
"reported": {
"deviceState": "CONNECTED",
"powerState": "ON",
"zoneState": "...",
"groupState": "..."
}
}
}
```
#### Disconnection Message
```json
{
"state": {
"reported": {
"deviceState": "DISCONNECTED"
}
}
}
```
## Process Information
- **IoT Service PID**: 1837
- **BoseApp PID**: 1846
- **Daemon Manager**: Shepherd
- **Service Type**: Non-core (stopped during updates)
## Registration Flow
1. Device generates X.509 CSR
2. Calls `https://voice.api.bose.io/alexa/certificate`
3. Receives device certificate
4. Stores cert/key in `/mnt/nv/IoTCerts/`
5. Connects to AWS IoT using certificate auth
## Directory Creation (Init Script)
```bash
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
```
## Error Messages and Debugging
### Common Log Messages
- `"Connection attempt %u to MQTT port at host %s"`
- `"MQTT port not available. Retrying in %u seconds"`
- `"Device connected with MQTT"`
- `"got shadow response: accepted. Payload: %s"`
- `"Failed to register device and get certificate, retrying"`
### Connection States
- `"MQTT port is open"`
- `"Successfully connected to MQTT server"`
- `"Disconnecting from IoT server"`
- `"UpdateShadow called when network is not ready"`
## Integration Points
### AWS Services
- AWS IoT Core (MQTT broker)
- AWS IoT Device Management (certificates)
- AWS IoT Device Shadows (state sync)
### Bose Ecosystem
- Mobile apps (remote control)
- Alexa integration (voice commands)
- Multi-room audio (zone coordination)
- OTA updates (firmware management)
## Quick Troubleshooting
1. **No IoT connectivity**: Check certificate files in `/mnt/nv/IoTCerts/`
2. **Certificate errors**: Verify registration endpoint accessibility
3. **MQTT failures**: Check both primary and backup endpoints
4. **Config issues**: Validate IoT.xml format and clientID uniqueness
5. **Service not starting**: Check Shepherd configuration and process status
## MQTT Monitoring Capabilities
### Direct Access with Device Credentials
```bash
# Subscribe to device shadow events (own device only)
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
-p 8883 --cafile /var/lib/iot/rootCA.crt \
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
--key /mnt/nv/IoTCerts/iot-private.pem.key \
-t '$aws/things/577ecfcc-2db3-4989-92c9-76d7704f9fb3/shadow/#'
```
### AWS IoT Policy Restrictions
- Device certificates limited to own clientID topics only
- No wildcard subscriptions across devices
- IP/location restrictions may apply
- Certificate revocation for unusual activity
### Alternative Monitoring Methods
```bash
# Network traffic capture (less intrusive)
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
# Monitor connection patterns
tcpdump -i eth0 -n "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
```
### Expected Message Examples
```json
// Power state change
{"state":{"reported":{"powerState":"ON","deviceState":"CONNECTED"}}}
// Volume adjustment
{"state":{"reported":{"volume":25,"muted":false}}}
// Zone configuration
{"state":{"reported":{"zoneState":"master","groupMembers":["device1"]}}}
```
## Security Notes
- TLS 1.2 encryption for all communications
- X.509 mutual authentication
- Private keys stored with 700 permissions
- No hardcoded credentials in binaries
- Automatic certificate lifecycle management
- **Monitoring Constraints**: Device credentials restricted to own device topics
- **Ethical Consideration**: Only monitor devices you own
+370
View File
@@ -0,0 +1,370 @@
# IoT Configuration Analysis
## Overview
This document provides a detailed analysis of the AWS IoT configuration system used by Bose SoundTouch devices, based on firmware backup analysis from ST10 and ST20 models.
## Configuration Files
### IoT.xml Location and Content
The IoT configuration is stored in XML format at:
- **Path**: `/mnt/nv/BoseApp-Persistence/1/IoT.xml`
- **Purpose**: Contains AWS IoT Core connection parameters
#### ST20 Configuration
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<Configuration clientID="uuid1"
iotEndpoint="a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
deployment="PROD" />
```
#### ST10 Configuration
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<Configuration clientID="uuid2"
iotEndpoint="a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
deployment="PROD" />
```
### Key Observations
- Each device has a unique `clientID` (UUID format)
- Both devices use the same AWS IoT endpoint
- Both are configured for production deployment (`PROD`)
## Binary Analysis
### Primary IoT Service Binary
**Location**: `/opt/Bose/IoT`
- **Type**: ARM ELF 32-bit executable
- **Purpose**: Main IoT daemon process
- **Framework**: AWS IoT SDK for C++
### Certificate and Key Management
The IoT binary manages the following certificate files:
| File | Location | Purpose |
|-----------------------|---------------------|-----------------------------|
| `iot-cert.pem.crt` | `/mnt/nv/IoTCerts/` | Device client certificate |
| `iot-private.pem.key` | `/mnt/nv/IoTCerts/` | Device private key |
| `rootCA.crt` | `/var/lib/iot/` | AWS IoT Root CA certificate |
### Certificate Registration Process
1. **CSR Generation**: Device generates X.509 certificate signing request
2. **Registration Endpoint**: `https://voice.api.bose.io/alexa/certificate`
3. **Certificate Storage**: Certificates stored in `/mnt/nv/IoTCerts/`
4. **Automatic Provisioning**: Process appears to be automated during device setup
## Protocol Analysis
### Connection Details
- **Protocol**: MQTT over TLS 1.2
- **Port**: Standard MQTT over SSL (likely 8883)
- **Authentication**: X.509 client certificate mutual authentication
- **Endpoint Redundancy**:
- Primary (hardcoded): `amqmidtcohfms.iot.us-east-1.amazonaws.com`
- Fallback (XML config): `a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com`
### AWS IoT Device Shadow Integration
The system uses AWS IoT Device Shadows for state management:
#### Topic Structure
```
$aws/things/{thing_name}/shadow/update
$aws/things/{thing_name}/shadow/update/accepted
$aws/things/{thing_name}/shadow/update/rejected
$aws/things/{thing_name}/shadow/delete
```
#### Shadow JSON Format
```json
{
"state": {
"desired": {},
"reported": {
"deviceState": "CONNECTED|DISCONNECTED",
"powerState": "ON|OFF",
"zoneState": "...",
"groupState": "..."
}
},
"version": 0,
"clientToken": "...",
"timestamp": 0
}
```
### Message Types
1. **Device State Updates**
- Connection status (`CONNECTED`/`DISCONNECTED`)
- Power state changes
- Audio zone configuration
- Multi-room grouping status
2. **Shadow Delta Processing**
- Receives desired state changes
- Updates device configuration
- Reports new state back to shadow
## System Integration
### Service Management
The IoT service is managed by the Shepherd daemon system:
**Configuration**: `/opt/Bose/etc/Shepherd-noncore.xml`
```xml
<ShepherdConfig>
<daemon name="STSCertified"/>
<daemon name="IoT"/>
<daemon name="TPDA">
<arg>-c</arg>
<arg>/opt/Bose/etc/Voice.xml</arg>
</daemon>
</ShepherdConfig>
```
### Directory Structure Creation
The SoundTouch init script (`/etc/init.d/SoundTouch`) ensures proper directory structure:
```bash
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
```
### Process Information
From runtime analysis (`/var/run/shepherd/pids`):
- IoT service runs as PID 1837
- BoseApp service runs as PID 1846
- Both services are active during normal operation
## Configuration Dependencies
### Files That Reference IoT Configuration
1. **IoT Binary** (`/opt/Bose/IoT`)
- Primary consumer of IoT.xml configuration
- Contains hardcoded backup endpoints
- Manages certificate lifecycle
2. **BoseApp Binary** (`/opt/Bose/BoseApp`)
- References BoseApp-Persistence directory structure
- May trigger IoT updates based on device state changes
3. **SoundTouch Init Script** (`/etc/init.d/SoundTouch`)
- Creates necessary directory structure
- Ensures proper permissions for certificate storage
4. **Shepherd Configuration** (`/opt/Bose/etc/Shepherd-noncore.xml`)
- Defines IoT service startup parameters
- Manages service lifecycle
## Security Considerations
### Certificate Management
- Private keys stored with 700 permissions
- Certificates managed automatically by the device
- Registration process appears to use device-specific authentication
### Network Security
- All communication over TLS 1.2
- Mutual authentication using X.509 certificates
- AWS IoT Core provides additional access controls
### Configuration Protection
- Configuration files stored in persistent storage
- Directory structure created with appropriate permissions
- No hardcoded credentials in binaries (uses certificate-based auth)
## Integration Points
### AWS Services
- **AWS IoT Core**: Primary messaging and device management
- **AWS IoT Device Management**: Certificate provisioning
- **AWS IoT Device Shadows**: State synchronization
### Bose Services
- **Mobile Applications**: Remote control and monitoring
- **Alexa Integration**: Voice control capabilities
- **Multi-room Audio**: Zone and group coordination
### Device Functions
- **Power Management**: Remote power on/off
- **Audio Control**: Volume, source selection
- **Network Configuration**: WiFi and connectivity settings
- **Firmware Updates**: OTA update coordination
## Troubleshooting
### Common Issues
1. **Certificate Problems**
- Check `/mnt/nv/IoTCerts/` for valid certificates
- Verify certificate registration endpoint accessibility
- Ensure proper file permissions (600 for keys)
2. **Connection Issues**
- Verify both primary and fallback endpoints
- Check TLS 1.2 support and cipher suites
- Validate clientID uniqueness
3. **Configuration Issues**
- Ensure IoT.xml has proper XML format
- Verify clientID is valid UUID format
- Check deployment parameter matches environment
### Debug Information
The IoT binary provides extensive logging for:
- MQTT connection attempts and status
- Certificate loading and validation
- Shadow message processing
- Network state changes
## MQTT Monitoring and Security Considerations
### Direct MQTT Access with Device Credentials
With access to the device's private key and certificate, it's technically possible to subscribe to MQTT events:
```bash
# Subscribe to device shadow events
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
-p 8883 --cafile /var/lib/iot/rootCA.crt \
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
--key /mnt/nv/IoTCerts/iot-private.pem.key \
-t '$aws/things/_uuid_/shadow/#'
```
### Security Constraints and Limitations
#### AWS IoT Policy Restrictions
Device certificates are bound to specific policies that typically restrict:
- Access to device-specific topics only (`$aws/things/{clientID}/shadow/*`)
- No wildcard subscriptions across multiple devices
- Limited publish/subscribe permissions
- Possible IP geolocation restrictions
#### Example Policy Structure
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "iot:Connect",
"Resource": "arn:aws:iot:us-east-1:*:client/${iot:ClientId}"
},
{
"Effect": "Allow",
"Action": ["iot:Publish", "iot:Subscribe", "iot:Receive"],
"Resource": [
"arn:aws:iot:us-east-1:*:topic/$aws/things/${iot:ClientId}/shadow/*",
"arn:aws:iot:us-east-1:*:topicfilter/$aws/things/${iot:ClientId}/shadow/*"
]
}
]
}
```
#### Additional Security Measures
- Certificate revocation for unusual activity
- Device fingerprinting and connection frequency limits
- Service shutdown timeline (May 2026) affecting endpoint availability
### Alternative Monitoring Approaches
#### Network Traffic Capture
A less intrusive method to analyze MQTT communication patterns:
```bash
# Capture encrypted MQTT traffic from the actual device
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
# Monitor connection patterns
tcpdump -i eth0 -n "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
```
#### Local MQTT Broker Setup
For development and testing, create a local MQTT broker that mimics AWS IoT behavior:
```bash
# Install and configure Mosquitto
sudo apt-get install mosquitto mosquitto-clients
# Create test shadow topics
mosquitto_pub -h localhost -t '$aws/things/test-device/shadow/update' \
-m '{"state":{"reported":{"deviceState":"CONNECTED"}}}'
```
### Ethical and Legal Considerations
- **Device Ownership**: Only monitor devices you own
- **Terms of Service**: Using credentials outside device context may violate Bose ToS
- **Unauthorized Access**: Accessing Bose's AWS infrastructure could be considered inappropriate
- **Research Purpose**: Limit monitoring to understanding message formats for local alternatives
### Expected Message Examples
If monitoring is successful, typical shadow messages include:
```json
// Power state change
{
"state": {
"reported": {
"powerState": "ON",
"deviceState": "CONNECTED",
"timestamp": 1703875200
}
}
}
// Volume adjustment
{
"state": {
"reported": {
"volume": 25,
"muted": false
}
}
}
// Zone configuration
{
"state": {
"reported": {
"zoneState": "master",
"groupMembers": ["device1", "device2"]
}
}
}
```
### Recommended Research Approach
1. **Document Message Formats**: Capture and analyze JSON structures
2. **Understand State Transitions**: Map device actions to shadow updates
3. **Build Local Alternative**: Use insights to create local MQTT shadow service
4. **Prepare for Service Shutdown**: Develop migration strategy before May 2026
## Conclusion
The Bose SoundTouch IoT configuration system is a sophisticated implementation using AWS IoT Core for real-time device management. The system provides:
- Secure, certificate-based authentication
- Reliable bi-directional communication
- Comprehensive device state management
- Integration with voice assistants and mobile applications
- Robust error handling and retry mechanisms
This architecture enables seamless remote control, monitoring, and coordination of SoundTouch devices across multiple platforms and services.
+7 -7
View File
@@ -6,13 +6,13 @@ This document provides a comprehensive overview of the upstream Bose cloud servi
SoundTouch devices use a set of primary domains for their operation. These are often configurable via the `SoundTouchSdkPrivateCfg.xml` file.
| Service | Primary Domain | Purpose |
| :--- | :--- | :--- |
| **Marge** | `streaming.bose.com` | Account management, streaming source providers, and preset sync. |
| **BMX Registry** | `content.api.bose.io` | Bose Media eXchange service discovery and registry. |
| **Stats/Analytics** | `events.api.bosecm.com` | Telemetry, device events, and usage statistics. |
| **Software Update** | `worldwide.bose.com` | Firmware update checks and downloads (path: `/updates/soundtouch`). |
| **Voice/Alexa** | `voice.api.bose.io` | Token management for Amazon Alexa integration. |
| Service | Primary Domain | Purpose |
|:--------------------|:------------------------|:--------------------------------------------------------------------|
| **Marge** | `streaming.bose.com` | Account management, streaming source providers, and preset sync. |
| **BMX Registry** | `content.api.bose.io` | Bose Media eXchange service discovery and registry. |
| **Stats/Analytics** | `events.api.bosecm.com` | Telemetry, device events, and usage statistics. |
| **Software Update** | `worldwide.bose.com` | Firmware update checks and downloads (path: `/updates/soundtouch`). |
| **Voice/Alexa** | `voice.api.bose.io` | Token management for Amazon Alexa integration. |
## Internal & Development Domains
+71 -71
View File
@@ -1,7 +1,7 @@
# SoundTouch API Comparison: Community Wiki vs Current Implementation
**Date:** January 2026
**Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API)
**Source:** [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API)
**Our Implementation:** Bose-SoundTouch Go Library v1.0
## Executive Summary
@@ -20,84 +20,84 @@ The SoundTouch Plus community wiki documents **87 distinct API endpoints** with
### ✅ Already Implemented (23 endpoints)
| Endpoint | Wiki Status | Our Status | Notes |
|----------|-------------|------------|-------|
| `/info` | ✅ Documented | ✅ Complete | Device information |
| `/now_playing` | ✅ Documented | ✅ Complete | Current playback status |
| `/key` | ✅ Documented | ✅ Complete | Key press/release simulation |
| `/volume` | ✅ Documented | ✅ Complete | Volume and mute control |
| `/bass` | ✅ Documented | ✅ Complete | Bass level control |
| `/bassCapabilities` | ✅ Documented | ✅ Complete | Bass capability detection |
| `/sources` | ✅ Documented | ✅ Complete | Available audio sources |
| `/select` | ✅ Documented | ✅ Complete | Source selection |
| `/presets` | ✅ Documented | ✅ Complete | Preset configurations (read-only) |
| `/getZone` | ✅ Documented | ✅ Complete | Zone status and membership |
| `/setZone` | ✅ Documented | ✅ Complete | Zone creation and management |
| `/addZoneSlave` | ✅ Documented | ✅ Complete | Add device to zone |
| `/removeZoneSlave` | ✅ Documented | ✅ Complete | Remove device from zone |
| `/capabilities` | ✅ Documented | ✅ Complete | Device feature capabilities |
| `/audiodspcontrols` | ✅ Documented | ✅ Complete | Audio DSP modes and video sync |
| `/audioproducttonecontrols` | ✅ Documented | ✅ Complete | Advanced bass/treble controls |
| `/audioproductlevelcontrols` | ✅ Documented | ✅ Complete | Speaker level controls |
| `/name` (GET/POST) | ✅ Documented | ✅ Complete | Device name management |
| `/balance` | ✅ Documented | ✅ Complete | Stereo balance control |
| `/clockTime` | ✅ Documented | ✅ Complete | Device time management |
| `/clockDisplay` | ✅ Documented | ✅ Complete | Clock display settings |
| `/networkInfo` | ✅ Documented | ✅ Complete | Network connectivity info |
| `/requestToken` | ✅ Documented | ✅ Complete | Bearer token generation |
| Endpoint | Wiki Status | Our Status | Notes |
|------------------------------|--------------|------------|-----------------------------------|
| `/info` | ✅ Documented | ✅ Complete | Device information |
| `/now_playing` | ✅ Documented | ✅ Complete | Current playback status |
| `/key` | ✅ Documented | ✅ Complete | Key press/release simulation |
| `/volume` | ✅ Documented | ✅ Complete | Volume and mute control |
| `/bass` | ✅ Documented | ✅ Complete | Bass level control |
| `/bassCapabilities` | ✅ Documented | ✅ Complete | Bass capability detection |
| `/sources` | ✅ Documented | ✅ Complete | Available audio sources |
| `/select` | ✅ Documented | ✅ Complete | Source selection |
| `/presets` | ✅ Documented | ✅ Complete | Preset configurations (read-only) |
| `/getZone` | ✅ Documented | ✅ Complete | Zone status and membership |
| `/setZone` | ✅ Documented | ✅ Complete | Zone creation and management |
| `/addZoneSlave` | ✅ Documented | ✅ Complete | Add device to zone |
| `/removeZoneSlave` | ✅ Documented | ✅ Complete | Remove device from zone |
| `/capabilities` | ✅ Documented | ✅ Complete | Device feature capabilities |
| `/audiodspcontrols` | ✅ Documented | ✅ Complete | Audio DSP modes and video sync |
| `/audioproducttonecontrols` | ✅ Documented | ✅ Complete | Advanced bass/treble controls |
| `/audioproductlevelcontrols` | ✅ Documented | ✅ Complete | Speaker level controls |
| `/name` (GET/POST) | ✅ Documented | ✅ Complete | Device name management |
| `/balance` | ✅ Documented | ✅ Complete | Stereo balance control |
| `/clockTime` | ✅ Documented | ✅ Complete | Device time management |
| `/clockDisplay` | ✅ Documented | ✅ Complete | Clock display settings |
| `/networkInfo` | ✅ Documented | ✅ Complete | Network connectivity info |
| `/requestToken` | ✅ Documented | ✅ Complete | Bearer token generation |
### 🔥 High Priority Missing (20 endpoints)
| Endpoint | Wiki Status | Priority | Use Case |
|----------|-------------|----------|----------|
| `/storePreset` | ✅ Detailed | **HIGH** | Save stations/playlists to presets |
| `/removePreset` | ✅ Detailed | **HIGH** | Delete saved presets |
| `/selectPreset` | ✅ Detailed | **HIGH** | Play preset by ID |
| `/setMusicServiceAccount` | ✅ Detailed | **HIGH** | Add Spotify/Pandora accounts |
| `/removeMusicServiceAccount` | ✅ Detailed | **HIGH** | Remove music service accounts |
| `/searchStation` | ✅ Detailed | **HIGH** | Find Pandora/Spotify content |
| `/addStation` | ✅ Detailed | **HIGH** | Add stations to favorites |
| `/removeStation` | ✅ Detailed | **HIGH** | Remove stations from favorites |
| `/navigate` | ✅ Detailed | **HIGH** | Browse music libraries/services |
| `/search` | ✅ Detailed | **HIGH** | Search music content |
| `/userPlayControl` | ✅ Detailed | **HIGH** | Play/pause/stop controls |
| `/userRating` | ✅ Detailed | **HIGH** | Thumbs up/down ratings |
| `/recents` | ✅ Detailed | **HIGH** | Recently played content |
| `/standby` | ✅ Detailed | **HIGH** | Power management |
| `/powerManagement` | ✅ Detailed | **HIGH** | Power state information |
| `/lowPowerStandby` | ✅ Detailed | **HIGH** | Low-power mode |
| `/listMediaServers` | ✅ Detailed | **HIGH** | UPnP/DLNA server discovery |
| `/serviceAvailability` | ✅ Detailed | **HIGH** | Source availability status |
| `/introspect` | ✅ Detailed | **HIGH** | Music service account status |
| `/language` | ✅ Detailed | **HIGH** | Device language settings |
| Endpoint | Wiki Status | Priority | Use Case |
|------------------------------|-------------|----------|------------------------------------|
| `/storePreset` | ✅ Detailed | **HIGH** | Save stations/playlists to presets |
| `/removePreset` | ✅ Detailed | **HIGH** | Delete saved presets |
| `/selectPreset` | ✅ Detailed | **HIGH** | Play preset by ID |
| `/setMusicServiceAccount` | ✅ Detailed | **HIGH** | Add Spotify/Pandora accounts |
| `/removeMusicServiceAccount` | ✅ Detailed | **HIGH** | Remove music service accounts |
| `/searchStation` | ✅ Detailed | **HIGH** | Find Pandora/Spotify content |
| `/addStation` | ✅ Detailed | **HIGH** | Add stations to favorites |
| `/removeStation` | ✅ Detailed | **HIGH** | Remove stations from favorites |
| `/navigate` | ✅ Detailed | **HIGH** | Browse music libraries/services |
| `/search` | ✅ Detailed | **HIGH** | Search music content |
| `/userPlayControl` | ✅ Detailed | **HIGH** | Play/pause/stop controls |
| `/userRating` | ✅ Detailed | **HIGH** | Thumbs up/down ratings |
| `/recents` | ✅ Detailed | **HIGH** | Recently played content |
| `/standby` | ✅ Detailed | **HIGH** | Power management |
| `/powerManagement` | ✅ Detailed | **HIGH** | Power state information |
| `/lowPowerStandby` | ✅ Detailed | **HIGH** | Low-power mode |
| `/listMediaServers` | ✅ Detailed | **HIGH** | UPnP/DLNA server discovery |
| `/serviceAvailability` | ✅ Detailed | **HIGH** | Source availability status |
| `/introspect` | ✅ Detailed | **HIGH** | Music service account status |
| `/language` | ✅ Detailed | **HIGH** | Device language settings |
### 🎵 Music Service Management (12 endpoints)
| Category | Endpoints | Wiki Coverage | Notes |
|----------|-----------|---------------|-------|
| **Account Management** | `/setMusicServiceAccount`, `/removeMusicServiceAccount` | ✅ Full XML examples | Pandora, Spotify, NAS setup |
| **Station Management** | `/searchStation`, `/addStation`, `/removeStation` | ✅ Pandora tested | Station discovery and favorites |
| **Content Navigation** | `/navigate`, `/search` | ✅ Detailed examples | Music library browsing |
| **Track Information** | `/trackInfo`, `/introspect` | ✅ Service-specific | Extended metadata |
| Category | Endpoints | Wiki Coverage | Notes |
|------------------------|---------------------------------------------------------|---------------------|---------------------------------|
| **Account Management** | `/setMusicServiceAccount`, `/removeMusicServiceAccount` | ✅ Full XML examples | Pandora, Spotify, NAS setup |
| **Station Management** | `/searchStation`, `/addStation`, `/removeStation` | ✅ Pandora tested | Station discovery and favorites |
| **Content Navigation** | `/navigate`, `/search` | ✅ Detailed examples | Music library browsing |
| **Track Information** | `/trackInfo`, `/introspect` | ✅ Service-specific | Extended metadata |
### 🏠 Smart Home Integration (15 endpoints)
| Category | Endpoints | Wiki Coverage | Notes |
|----------|-----------|---------------|-------|
| **Notifications** | `/speaker`, `/playNotification` | ✅ TTS examples | Text-to-speech, URL playback |
| **Power Management** | `/standby`, `/powerManagement`, `/lowPowerStandby` | ✅ Complete | Smart home automation |
| **Network Management** | `/performWirelessSiteSurvey`, `/addWirelessProfile`, `/getActiveWirelessProfile` | ✅ WiFi setup | Network configuration |
| **Bluetooth** | `/enterBluetoothPairing`, `/clearBluetoothPaired`, `/bluetoothInfo` | ✅ Pairing control | Bluetooth management |
| **Source Control** | `/selectLastSource`, `/selectLastSoundTouchSource`, `/selectLocalSource` | ✅ Source switching | Quick source access |
| Category | Endpoints | Wiki Coverage | Notes |
|------------------------|----------------------------------------------------------------------------------|--------------------|------------------------------|
| **Notifications** | `/speaker`, `/playNotification` | ✅ TTS examples | Text-to-speech, URL playback |
| **Power Management** | `/standby`, `/powerManagement`, `/lowPowerStandby` | ✅ Complete | Smart home automation |
| **Network Management** | `/performWirelessSiteSurvey`, `/addWirelessProfile`, `/getActiveWirelessProfile` | ✅ WiFi setup | Network configuration |
| **Bluetooth** | `/enterBluetoothPairing`, `/clearBluetoothPaired`, `/bluetoothInfo` | ✅ Pairing control | Bluetooth management |
| **Source Control** | `/selectLastSource`, `/selectLastSoundTouchSource`, `/selectLocalSource` | ✅ Source switching | Quick source access |
### 📱 Advanced Device Features (19 endpoints)
| Category | Endpoints | Wiki Coverage | Notes |
|----------|-----------|---------------|-------|
| **Stereo Pairs** | `/getGroup`, `/addGroup`, `/removeGroup`, `/updateGroup` | ✅ ST-10 specific | L/R speaker pairing |
| **System Info** | `/soundTouchConfigurationStatus`, `/systemtimeout`, `/rebroadcastlatencymode` | ✅ Configuration | Device state management |
| **Software Updates** | `/swUpdateCheck`, `/swUpdateQuery`, `/swUpdateAbort`, `/swUpdateStart` | ✅ Update process | Firmware management |
| **Audio Processing** | `/DSPMonoStereo`, `/audiospeakerattributeandsetting` | ✅ Hardware-specific | Advanced audio features |
| Category | Endpoints | Wiki Coverage | Notes |
|----------------------|-------------------------------------------------------------------------------|---------------------|-------------------------|
| **Stereo Pairs** | `/getGroup`, `/addGroup`, `/removeGroup`, `/updateGroup` | ✅ ST-10 specific | L/R speaker pairing |
| **System Info** | `/soundTouchConfigurationStatus`, `/systemtimeout`, `/rebroadcastlatencymode` | ✅ Configuration | Device state management |
| **Software Updates** | `/swUpdateCheck`, `/swUpdateQuery`, `/swUpdateAbort`, `/swUpdateStart` | ✅ Update process | Firmware management |
| **Audio Processing** | `/DSPMonoStereo`, `/audiospeakerattributeandsetting` | ✅ Hardware-specific | Advanced audio features |
---
@@ -137,7 +137,7 @@ The SoundTouch Plus community wiki documents **87 distinct API endpoints** with
**WebSocket Events Documented:**
- `presetsUpdated` - Preset changes
- `groupUpdated` - Stereo pair changes
- `groupUpdated` - Stereo pair changes
- `zoneUpdated` - Multi-room changes
- `nowPlayingUpdated` - Source/playback changes
- `volumeUpdated` - Volume/mute changes
@@ -194,7 +194,7 @@ func (c *Client) RateCurrentTrack(rating RatingValue) error
func (c *Client) CreateStereoPair(leftIP, rightIP string, name string) error
func (c *Client) GetStereoPairStatus() (*StereoPair, error)
// System Management
// System Management
func (c *Client) CheckSoftwareUpdate() (*UpdateInfo, error)
func (c *Client) GetSystemTimeout() (*TimeoutConfig, error)
```
@@ -283,7 +283,7 @@ The SoundTouch Plus Wiki represents a **treasure trove** of production-ready API
### Key Opportunities:
- 🎯 **3x Coverage Expansion**: From 23 to 87+ endpoints
- 🏠 **Smart Home Ready**: Complete automation integration
- 🎵 **Music Service Integration**: Full streaming service support
- 🎵 **Music Service Integration**: Full streaming service support
- 📱 **Professional Features**: Advanced audio and system control
-**Production Ready**: Real-world tested examples and error handling
@@ -297,4 +297,4 @@ The SoundTouch Plus Wiki represents a **treasure trove** of production-ready API
---
*Note: All endpoints documented in the wiki are tested against real hardware. Device-specific limitations are clearly documented with compatibility matrices for ST-10, ST-300, and other SoundTouch models.*
*Note: All endpoints documented in the wiki are tested against real hardware. Device-specific limitations are clearly documented with compatibility matrices for ST-10, ST-300, and other SoundTouch models.*
+52
View File
@@ -0,0 +1,52 @@
### Stockholm App Analysis Report
#### 1. Overview
The Stockholm app is a CEPE MAUI SoundTouch Controller HTML5/JS UI. It is designed to run as a web-based interface for Bose SoundTouch devices, likely served by the device itself or an associated controller.
- **Technology Stack**: HTML5, CSS3, JavaScript (Minified).
- **Key Libraries**:
- **jQuery**: Core DOM manipulation and event handling.
- **iScroll**: Used for smooth scrolling in lists and carousels.
- **Forge**: Used for cryptographic operations (likely for secure communication or authentication).
- **WebSocket Polyfill**: Ensures WebSocket compatibility across environments.
#### 2. Directory Structure
- `js/`: Core application logic.
- `app/`: Main application entry point (`app.js`).
- `models/`: Data models for UI components (Presets, Favorites, Onboarding, etc.).
- `music_services/`: Implementation of various music services (Amazon, Deezer, Spotify, BMX, etc.).
- `views/`: UI view templates and logic.
- `utils/`: Utility functions for security, data analytics, and general-purpose tasks.
- `json/`: Configuration files and static data.
- `config.json`: Core application configuration including Base64 encoded Bose API endpoints (e.g., streaming, events, BMX registry).
- `sourceFeatures.json`: Capability mapping for different sources.
- `setup/`: Onboarding and initial device setup logic.
- `lang/`: Localization files for multi-language support.
#### 3. Communication Architecture
The app uses several communication channels to interact with the SoundTouch ecosystem:
- **Socket Communication (`socket_comm.js`)**: Real-time updates and low-latency commands via WebSockets.
- **BMX (`bmx.js` & `js/music_services/bmx/`)**: Interactions with the Bose Music eXperience services. Handles account management, navigation, and API response validation.
- **Marge (`marge_comm.js`)**: Likely used for interaction with the Marge service (Bose's legacy cloud/proxy service).
- **Worker-based Architecture**: Many services use Web Workers (`bmx_worker.js`, `spotify_worker.js`) to handle API requests and data processing in the background, keeping the UI responsive.
#### 4. Key Features & Functionality
- **Multi-Device Management**: Discovering and controlling multiple speakers on the network.
- **Music Service Integration**: Deep integration with Spotify, Amazon Music, Deezer, and Pandora.
- **Preset Management**: Browsing and setting presets directly from the UI.
- **Zone Control**: Creating and managing multi-room groups (Master/Slave configurations).
- **Onboarding**: A dedicated setup flow for new devices.
- **Analytics & Data Collection**: Modules like `data_analytics.js` and `dc_server.js` suggest tracking of user interactions.
#### 5. Integration Opportunities for Bose-SoundTouch Project
Based on the Stockholm app's capabilities, the following features could be enhanced or added to our Go-based `soundtouch-service`:
1. **Enhanced BMX Emulation**: Use insights from `bmx_client.js` and `bmx_navigate_response_generator.js` to improve our local BMX implementation.
2. **Spotify/Amazon Service Proxies**: Implement the backend logic required to support the same API calls the Stockholm app makes to these services.
3. **UI parity**: The Stockholm app's view templates (`views/`) can serve as a reference for our Web Management UI.
4. **WebSocket Support**: Ensure our service provides a robust WebSocket interface similar to what the Stockholm app expects for real-time state synchronization.
5. **Capability Discovery**: Better utilization of the `sourceFeatures.json` logic to dynamically show/hide features based on the device model and firmware version.
#### 6. Conclusion
The Stockholm app is a mature, full-featured controller that relies heavily on Bose's proprietary BMX and Marge services. By analyzing its client-side logic, we can better understand the expected API responses and interaction patterns needed to provide a seamless local replacement for the Bose Cloud.
+181
View File
@@ -0,0 +1,181 @@
# Upstream Bose Service Simulation - Concept Overview
## Executive Summary
This document serves as the entry point for understanding the comprehensive plan to enhance the SoundTouch service with advanced state management capabilities, preparing for the eventual shutdown of Bose's upstream services while providing a superior local management experience.
## Project Objectives
### Primary Goal
Create a robust, local replacement for Bose's upstream services that can seamlessly handle the transition from cloud-dependent to fully autonomous operation while maintaining and improving upon the existing functionality.
### Key Outcomes
- **Zero-downtime transition** from Bose services to local management
- **Enhanced visibility** into device states, health, and system operations
- **Data preservation** during migrations with full rollback capabilities
- **Improved reliability** through local control and reduced external dependencies
- **Future-proof architecture** that can evolve beyond Bose's original design
## Architecture Vision
### Current State
The existing SoundTouch service provides:
- BMX service for TuneIn integration
- Marge service for account and device management
- Basic mirroring of upstream Bose endpoints
- File-based persistence for device data
- Migration support for device directory structures
### Enhanced State (This Project)
The enhanced system will add:
- **Comprehensive Account Management** with explicit creation and migration tracking
- **Device Lifecycle Management** with full state machine and event processing
- **Advanced Mirroring** with disparity detection and analysis
- **Dual-Source Data Management** supporting gradual migration strategies
- **Real-time Monitoring** with health checks and performance metrics
- **Text-based Storage** optimized for debugging and small hardware deployments
## Use Case Coverage
### Case 0: Account Management
- **Explicit Account Creation**: Accounts created through deliberate user action
- **Mirror-Enhanced Setup**: Use upstream data to enrich account creation
- **Passive Data Collection**: Record account information during normal operations
### Case 1a: Fresh Device Registration
- **Factory Reset Support**: Handle devices with no prior Bose association
- **Default Configuration**: Initialize devices with sensible presets and sources
- **Local-First Setup**: Complete registration without upstream dependencies
### Case 1b: Bose Account Migration
- **Data Preservation**: Maintain existing presets, recents, and sources
- **Gradual Migration**: Support partial migration while maintaining upstream compatibility
- **Rollback Capability**: Revert to Bose services if needed
### Case 2: Lifecycle and State Management
- **Real-time State Tracking**: Monitor device states and health continuously
- **Event-Driven Updates**: Process device events asynchronously
- **Disparity Detection**: Identify differences between local and upstream behavior
- **Comprehensive Logging**: Maintain detailed audit trails for troubleshooting
## Technical Approach
### Design Principles
1. **Text-First Storage**: Human-readable formats (JSON, XML, logs) for easy debugging
2. **Small Hardware Optimization**: Designed for Raspberry Pi Zero 2W deployments
3. **Mirror-First Strategy**: Keep upstream mirroring active until migration complete
4. **Event-Driven Architecture**: Asynchronous processing with comprehensive event tracking
5. **Backward Compatibility**: Seamless integration with existing installations
### Data Structure
```
data/
├── accounts/{account-id}/
│ ├── account.json # Account metadata and settings
│ ├── account-events.log # High-level account behavior tracking
│ ├── devices/{device-id}/
│ │ ├── lifecycle.json # Device state and history
│ │ ├── info.xml # Device information (existing)
│ │ ├── presets.xml # Device presets (existing)
│ │ ├── recents.xml # Recent plays (existing)
│ │ ├── sources.xml # Configured sources (existing)
│ │ └── events.log # Device event history
│ └── sessions/ # Recorded interaction sessions (existing)
└── system/
├── discovery.log # Device discovery events
└── migration.log # Migration activities
```
### Development Targets
- **Simplicity**: Keep It Simple, Stupid (KISS) principle over optimization
- **Quality**: 100% test pass rate and lint-clean code for every change
- **Compatibility**: Zero breaking changes to existing functionality
- **Leveraging**: Reuse existing systems (interaction recording, parity detection)
## Implementation Strategy
### Phase 1: Foundation (2-3 weeks) - Small, Testable Steps
- Account management foundation with basic create/read operations
- Device lifecycle data models and simple state tracking
- Basic API endpoints with comprehensive testing
- Integration with existing datastore patterns
### Phase 2: Device Lifecycle (2-3 weeks) - Build on Existing Systems
- Event processing using existing WebSocket system
- Lifecycle integration with current discovery and migration
- Enhanced logging building on existing parity detection
- Simple state machine with thorough testing
### Phase 3: Enhanced Features (2-3 weeks) - Leverage Current Systems
- Improve existing parity mismatch detection with better categorization
- Smart data source routing with fallback mechanisms
- Basic monitoring using existing health check patterns
- Reuse interaction recording for request/response tracking
## Key Benefits
### For Users
- **Continuity**: Seamless operation when Bose services shut down
- **Reliability**: Local control reduces dependency on external services
- **Visibility**: Clear insight into device states and system health
- **Control**: Full management of device data and configurations
### For Developers
- **Simplicity**: KISS principle makes code easy to understand and maintain
- **Quality**: Comprehensive testing and linting ensures reliable code
- **Debugging**: Text-based storage enables easy troubleshooting
- **Testing**: Every change requires full test suite pass and lint compliance
### For Community
- **Open Source**: Transparent implementation available for community contributions
- **Standards**: Well-documented APIs and data formats
- **Collaboration**: Disparity detection helps improve implementation accuracy
- **Future-Proof**: Architecture designed to outlast original Bose services
### Technical Risks
- **Data Loss Prevention**: Atomic file operations and comprehensive testing
- **Complexity Creep**: KISS principle and simple-first approach
- **Compatibility Issues**: Extensive regression testing and existing system reuse
- **Code Quality**: Mandatory linting and test coverage for every change
### Operational Risks
- **Service Disruption**: Small, incremental changes with rollback capability
- **Testing Overhead**: Automated quality gates (`golangci-lint run --fix` + `go test ./...`)
- **Migration Challenges**: Leverage existing migration system and patterns
- **Maintenance Burden**: Simple, well-tested code is easier to maintain
### Technical
- All tests pass consistently (100%)
- Zero linting issues in codebase
- No breaking changes to existing functionality
- Code coverage maintained or improved
### Quality Assurance
- Every commit passes `golangci-lint run --fix`
- Every milestone passes `go test ./...`
- Integration tests verify existing functionality
- Simple, maintainable code that follows Go idioms
## Documentation Structure
This concept is detailed across several documents:
- **[upstream-service-simulation.md](./upstream-service-simulation.md)**: Complete architectural concept with detailed use cases and implementation guidelines
- **[implementation-roadmap.md](./implementation-roadmap.md)**: Detailed project phases, milestones, and delivery timeline
- **[technical-specification.md](./technical-specification.md)**: Comprehensive technical details including APIs, data models, and performance requirements
## Getting Started
1. **Review the Concept**: Read through the main concept document to understand the full scope
2. **Examine Technical Details**: Review the technical specification for implementation details
3. **Follow the Roadmap**: Use the implementation roadmap for project planning and execution
4. **Integration Planning**: Consider how the enhanced features will integrate with existing deployments
## Next Steps
1. **Stakeholder Review**: Gather feedback on the concept and approach
2. **Technical Validation**: Prototype key components to validate technical assumptions
3. **Resource Planning**: Allocate development resources for the three-phase implementation
4. **Community Engagement**: Share plans with the community for feedback and contributions
This enhanced state management system represents a significant evolution of the SoundTouch service, transforming it from a basic cloud replacement into a comprehensive, future-proof device management platform that can serve users well beyond the Bose service shutdown timeline.
+355
View File
@@ -0,0 +1,355 @@
# Implementation Plan - Enhanced State Management System
## Overview
This document provides a detailed, step-by-step implementation plan for the enhanced state management system. Each step is designed to be small, testable, and independently valuable while maintaining backward compatibility.
## Development Principles
### Quality Gates
Every step must pass these checks before proceeding:
1. `golangci-lint run --fix` - no linting issues
2. `go test ./...` - all tests pass
3. Existing functionality remains intact
4. New functionality has appropriate test coverage
### KISS Principle
- Write the simplest code that works
- Avoid premature optimization
- Use straightforward algorithms
- Build incrementally with small changes
### Leverage Existing Systems
- Reuse interaction recording for request/response tracking
- Build upon current parity mismatch detection
- Extend existing datastore patterns
- Integrate with established workflows
## Phase 1: Foundation Preparation (2-3 weeks)
### Step 1.1: Code Organization Preparation
**Duration**: 2-3 days
**Goal**: Prepare package structure without changing behavior
#### Mini-milestone 1.1.1: Create account package structure
- Create `pkg/service/account/` directory
- Add basic `account.go` with placeholder structs
- Add `account_test.go` with basic test structure
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.1.2: Create lifecycle package structure
- Create `pkg/service/lifecycle/` directory
- Add basic `lifecycle.go` with placeholder structs
- Add `lifecycle_test.go` with basic test structure
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.1.3: Extend datastore interface preparation
- Add placeholder methods to existing datastore for account operations
- Ensure all existing functionality still works
- Add tests for new placeholder methods
- **Quality Check**: Lint + test all packages
### Step 1.2: Account Management Foundation
**Duration**: 3-4 days
**Goal**: Basic account creation and retrieval
#### Mini-milestone 1.2.1: Account data model
- Define `Account` struct with basic fields
- Add validation functions
- Add comprehensive unit tests
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.2.2: Account persistence
- Implement account.json file read/write
- Add atomic file operations
- Test file operations thoroughly
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.2.3: Account manager basic operations
- Implement `CreateAccount()` function
- Implement `GetAccount()` function
- Add error handling and validation
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.2.4: Integration with existing datastore
- Modify datastore to use account manager
- Ensure backward compatibility with existing accounts
- Test migration of existing data structure
- **Quality Check**: Lint + test all packages
### Step 1.3: Basic API Endpoints
**Duration**: 2-3 days
**Goal**: Add REST endpoints for account management
#### Mini-milestone 1.3.1: Account creation endpoint
- Add `POST /api/v1/accounts` handler
- Integrate with existing HTTP router
- Add input validation and error responses
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.3.2: Account retrieval endpoint
- Add `GET /api/v1/accounts/{id}` handler
- Add proper JSON serialization
- Test endpoint functionality
- **Quality Check**: Lint + test all packages
#### Mini-milestone 1.3.3: Integration testing
- Test new endpoints with existing functionality
- Ensure XML endpoints still work
- Verify no breaking changes
- **Quality Check**: Lint + test all packages
## Phase 2: Device Lifecycle Foundation (2-3 weeks)
### Step 2.1: Device State Model
**Duration**: 3-4 days
**Goal**: Basic device lifecycle tracking
#### Mini-milestone 2.1.1: Device lifecycle data model
- Define `DeviceLifecycle` struct
- Define device states and transitions
- Add validation and helper functions
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.1.2: State transition logic
- Implement basic state machine
- Add transition validation
- Create comprehensive tests for all transitions
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.1.3: Lifecycle persistence
- Implement lifecycle.json file operations
- Add atomic updates and error handling
- Test persistence thoroughly
- **Quality Check**: Lint + test all packages
### Step 2.2: Event Processing Foundation
**Duration**: 3-4 days
**Goal**: Basic event handling and logging
#### Mini-milestone 2.2.1: Event data model
- Define `DeviceEvent` struct
- Add event types and validation
- Create event builder helpers
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.2.2: Simple event logging
- Implement append-only event log writing
- Add structured log format
- Test log operations and rotation
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.2.3: Event processing pipeline
- Create basic synchronous event processor
- Add event validation and filtering
- Integrate with existing WebSocket events
- **Quality Check**: Lint + test all packages
### Step 2.3: Lifecycle Integration
**Duration**: 2-3 days
**Goal**: Connect lifecycle to existing systems
#### Mini-milestone 2.3.1: Discovery integration
- Trigger lifecycle events on device discovery
- Update device state on discovery
- Test discovery workflow with lifecycle
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.3.2: WebSocket integration
- Process WebSocket events through lifecycle
- Update device state based on events
- Log significant state changes
- **Quality Check**: Lint + test all packages
#### Mini-milestone 2.3.3: Migration integration
- Integrate lifecycle with existing migration system
- Track migration events and state changes
- Ensure existing migration still works
- **Quality Check**: Lint + test all packages
## Phase 3: Enhanced Features (2-3 weeks)
### Step 3.1: Enhanced Mirroring
**Duration**: 3-4 days
**Goal**: Improve existing parity detection
#### Mini-milestone 3.1.1: Extended disparity logging
- Enhance existing parity mismatch logging
- Add more detailed disparity information
- Improve log format for analysis
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.1.2: Disparity categorization
- Add severity levels to disparities
- Categorize different types of mismatches
- Add filtering and search capabilities
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.1.3: Enhanced mirror middleware
- Extend existing mirror functionality
- Add better response comparison
- Integrate with lifecycle events
- **Quality Check**: Lint + test all packages
### Step 3.2: Data Source Management
**Duration**: 3-4 days
**Goal**: Smart routing between local and upstream
#### Mini-milestone 3.2.1: Data source configuration
- Add per-device source preferences
- Implement source switching logic
- Add configuration persistence
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.2.2: Fallback mechanisms
- Add graceful fallback on source failure
- Implement simple health checking
- Test fallback scenarios
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.2.3: Migration orchestration
- Add device-by-device migration control
- Track migration progress
- Add rollback capabilities
- **Quality Check**: Lint + test all packages
### Step 3.3: Monitoring and Health
**Duration**: 2-3 days
**Goal**: Basic system monitoring
#### Mini-milestone 3.3.1: Health check endpoints
- Add system health endpoints
- Report service status
- Add basic metrics collection
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.3.2: Device health tracking
- Track device connectivity
- Monitor response times
- Log health status changes
- **Quality Check**: Lint + test all packages
#### Mini-milestone 3.3.3: System metrics
- Add basic performance metrics
- Track resource usage
- Add metrics endpoints
- **Quality Check**: Lint + test all packages
## Quality Assurance Strategy
### Testing Requirements
Each mini-milestone must include:
- Unit tests for new functions
- Integration tests for modified workflows
- Regression tests for existing functionality
- Performance tests for critical paths
### Test Categories
#### Unit Tests
- Test individual functions and methods
- Mock external dependencies
- Cover error conditions and edge cases
- Aim for >90% code coverage on new code
#### Integration Tests
- Test component interactions
- Use real file operations in test environment
- Test HTTP endpoints end-to-end
- Verify existing functionality unchanged
#### Regression Tests
- Ensure existing XML endpoints work
- Verify device discovery still functions
- Check migration compatibility
- Test WebSocket event processing
### Continuous Quality Checks
#### Pre-commit Checks
```bash
# Before each commit
golangci-lint run --fix
go test ./...
go test -race ./...
```
#### Milestone Validation
```bash
# Before marking milestone complete
golangci-lint run --fix
go test ./... -v
go test -race ./... -v
go test ./... -bench=.
```
#### Integration Validation
```bash
# Test with real soundtouch-service
make build
./soundtouch-service &
# Run integration test suite
make integration-test
```
## Risk Mitigation
### Backward Compatibility
- All existing APIs must continue working
- File structure changes must be additive
- Configuration changes must have defaults
- Migration paths for existing data
### Rollback Strategy
- Each step can be independently reverted
- Configuration flags for new features
- Graceful degradation when features disabled
- Clear rollback documentation
### Performance Impact
- Monitor memory usage during development
- Profile critical paths before and after changes
- Set performance regression alerts
- Simple before complex solutions
## Documentation Requirements
### Code Documentation
- Comprehensive godoc comments
- Example usage in comments
- Error conditions documented
- Performance characteristics noted
### User Documentation
- Update existing guides for new features
- Add migration guides for new functionality
- Create troubleshooting documentation
- Update API documentation
### Development Documentation
- Architecture decision records
- Testing strategy documentation
- Deployment and rollback procedures
- Performance benchmarking results
## Success Criteria
### Technical Metrics
- All tests pass consistently
- No linting issues
- Memory usage increase <50MB
- Response time degradation <10%
### Functional Metrics
- All existing functionality preserved
- New account management works reliably
- Device lifecycle tracking is accurate
- Enhanced monitoring provides value
### Quality Metrics
- Code coverage maintained >85%
- No critical security issues
- Documentation completeness >95%
- Community feedback positive
This implementation plan ensures steady, reliable progress while maintaining the quality and simplicity principles essential for the project's success.
+403
View File
@@ -0,0 +1,403 @@
# Implementation Roadmap for Upstream Service Simulation
## Overview
This document provides a detailed implementation roadmap for the upstream Bose service simulation concept. It breaks down the implementation into manageable phases with specific deliverables, technical requirements, and integration points.
## Phase 1: Foundation and Enhanced State Tracking (4-6 weeks)
### Milestone 1.1: Account Management Service (1-2 weeks)
#### Deliverables
- `pkg/service/account/` package with core account management
- Account creation, retrieval, and status management APIs
- Text-based account persistence in JSON format
- Integration with existing datastore structure
#### Implementation Tasks
1. **Create Account Manager**
```
pkg/service/account/
├── account.go # Core account management
├── manager.go # Account manager implementation
├── persistence.go # File-based persistence
└── account_test.go # Comprehensive tests
```
2. **Account Data Structure**
- JSON-based account metadata storage
- Integration with existing `data/accounts/{id}/` structure
- Account status tracking (active, migrating, suspended)
- Migration metadata tracking
3. **API Integration**
- Add account management endpoints to existing HTTP router
- RESTful API alongside existing XML endpoints
- Account creation validation and error handling
#### Technical Requirements
- Maintain backward compatibility with existing account structure
- Thread-safe account operations
- Atomic file operations for account metadata
- Comprehensive error handling and logging
### Milestone 1.2: Device Lifecycle Manager (2-3 weeks)
#### Deliverables
- `pkg/service/lifecycle/` package for device state management
- Device state machine with comprehensive state tracking
- Event-driven state transitions
- Integration with existing device discovery and migration
#### Implementation Tasks
1. **Lifecycle Core**
```
pkg/service/lifecycle/
├── lifecycle.go # Device lifecycle management
├── states.go # State definitions and transitions
├── events.go # Event processing
├── persistence.go # Lifecycle persistence
└── lifecycle_test.go # State machine tests
```
2. **State Machine Implementation**
- Define device states: unregistered → registering → active → migrating → offline → retired
- Implement state transition rules and validation
- Event-driven state changes with history tracking
- Integration with existing migration system
3. **Event Processing**
- Asynchronous event queue for device events
- Event categorization and filtering
- Text-based event logging with structured format
- Event replay capabilities for debugging
#### Technical Requirements
- Non-blocking event processing
- Persistent state across service restarts
- Integration with existing WebSocket event system
- Memory-efficient event storage
### Milestone 1.3: Enhanced Mirror System (1-2 weeks)
#### Deliverables
- Extended mirroring with disparity detection
- Parity analysis logging and reporting
- Selective data source switching
- Integration with existing mirror middleware
#### Implementation Tasks
1. **Disparity Detection**
```
pkg/service/mirror/
├── disparity.go # Disparity detection logic
├── analyzer.go # Response analysis and comparison
├── logger.go # Structured disparity logging
└── disparity_test.go # Analysis tests
```
2. **Enhanced Mirror Middleware**
- Extend existing mirror functionality
- Add response comparison and hash calculation
- Structured logging of disparities
- Configurable disparity sensitivity
3. **Data Source Management**
- Smart routing between local and upstream sources
- Per-endpoint source preference configuration
- Fallback mechanisms for upstream unavailability
- Source switching with history tracking
#### Technical Requirements
- Minimal performance impact on request processing
- Configurable disparity detection sensitivity
- Structured logging for analysis tools
- Integration with existing mirror configuration
## Phase 2: Migration and Dual-Source Management (3-4 weeks)
### Milestone 2.1: Migration Controller (2-3 weeks)
#### Deliverables
- Device-by-device migration orchestration
- Migration progress tracking and status reporting
- Rollback capabilities with state preservation
- Integration with existing setup manager
#### Implementation Tasks
1. **Migration Orchestration**
```
pkg/service/migration/
├── controller.go # Migration orchestration
├── strategy.go # Migration strategies
├── rollback.go # Rollback functionality
├── progress.go # Progress tracking
└── migration_integration_test.go
```
2. **Migration Strategies**
- Fresh device registration flow
- Bose account data migration flow
- Gradual migration with dual-source support
- Emergency migration for service outages
3. **Progress Tracking**
- Real-time migration status updates
- Migration timeline and milestone tracking
- Error handling and recovery procedures
- Migration completion verification
#### Technical Requirements
- Integration with existing migration system
- Atomic migration operations with rollback
- Progress persistence across service restarts
- Comprehensive migration logging
### Milestone 2.2: Dual-Source Data Management (1-2 weeks)
#### Deliverables
- Smart data routing between local and upstream sources
- Graceful fallback mechanisms
- Data source preference management
- Conflict resolution strategies
#### Implementation Tasks
1. **Data Source Router**
```
pkg/service/datasource/
├── router.go # Smart routing logic
├── preferences.go # Source preference management
├── fallback.go # Fallback mechanisms
└── conflict.go # Conflict resolution
```
2. **Source Management**
- Per-device, per-endpoint source preferences
- Dynamic source switching based on availability
- Conflict detection and resolution
- Source health monitoring
3. **Integration Points**
- Marge service integration for account data
- BMX service integration for content data
- Preset and recent management integration
- Source configuration management
#### Technical Requirements
- Zero-downtime source switching
- Conflict resolution without data loss
- Health check integration
- Performance monitoring and metrics
## Phase 3: Advanced Features and Analytics (2-3 weeks)
### Milestone 3.1: System Monitoring and Health Checks (1-2 weeks)
#### Deliverables
- Comprehensive system health monitoring
- Device connectivity and availability tracking
- Performance metrics collection
- Health check endpoints and dashboards
#### Implementation Tasks
1. **Health Monitoring**
```
pkg/service/health/
├── monitor.go # System health monitoring
├── metrics.go # Performance metrics
├── connectivity.go # Device connectivity tracking
└── alerts.go # Health alerting
```
2. **Metrics Collection**
- Device availability tracking
- Response time monitoring
- Error rate tracking
- Migration success rates
3. **Dashboard Integration**
- Health status endpoints
- Metrics export for monitoring tools
- Real-time status updates
- Historical trend analysis
#### Technical Requirements
- Minimal performance overhead
- Configurable monitoring intervals
- Integration with existing health checks
- Memory-efficient metrics storage
### Milestone 3.2: Data Export and Backup (1 week)
#### Deliverables
- Account data export functionality
- Incremental backup strategies
- Data integrity verification
- Migration-ready data formats
#### Implementation Tasks
1. **Export Functionality**
```
pkg/service/export/
├── exporter.go # Data export logic
├── formats.go # Export format definitions
├── validation.go # Data integrity checks
└── backup.go # Backup strategies
```
2. **Backup Management**
- Incremental backup creation
- Backup validation and verification
- Automated backup scheduling
- Restore functionality
3. **Data Formats**
- Migration-ready JSON exports
- XML compatibility for device imports
- Compressed archive support
- Selective export capabilities
#### Technical Requirements
- Consistent data export across all account types
- Backup integrity verification
- Configurable export scheduling
- Resource-efficient backup operations
## Integration Strategy
### Existing Service Integration Points
#### 1. Datastore Integration
- Extend existing datastore with lifecycle and account management
- Maintain backward compatibility with current file structure
- Add new persistence methods for enhanced state tracking
- Implement migration for existing data to new formats
#### 2. Handler Integration
- Integrate account management into existing HTTP handlers
- Add lifecycle information to device responses
- Extend mirror middleware with disparity detection
- Add new management endpoints alongside existing XML APIs
#### 3. Discovery Integration
- Link device discovery to lifecycle state transitions
- Integrate migration triggers with discovery events
- Add account association during discovery
- Maintain existing discovery functionality
#### 4. Migration System Integration
- Extend existing migration manager with new capabilities
- Integrate lifecycle management with device migrations
- Add rollback functionality to existing migration flows
- Maintain compatibility with current migration methods
### Configuration Management
#### New Configuration Options
```yaml
accounts:
auto_create: false
mirror_enhanced_creation: true
default_migration_strategy: "gradual"
lifecycle:
event_retention_days: 30
state_transition_timeout: "5m"
async_processing: true
mirror:
disparity_detection: true
disparity_sensitivity: "medium"
source_switching_enabled: true
fallback_timeout: "10s"
migration:
batch_size: 1
progress_reporting: true
rollback_enabled: true
verification_required: true
```
### Performance Considerations
#### Resource Usage
- Target: <100MB additional memory usage on Raspberry Pi Zero 2W
- CPU usage: <5% additional overhead during normal operations
- Storage: Text-based logs with configurable rotation
- Network: Minimal additional upstream requests
#### Optimization Strategies
- Lazy loading of historical data
- Configurable log retention policies
- Memory-efficient event processing
- Background cleanup processes
- Efficient file I/O operations
## Testing Strategy
### Unit Testing
- Comprehensive test coverage for all new packages
- State machine transition testing
- Data persistence and integrity tests
- Mock integration tests for external dependencies
### Integration Testing
- End-to-end migration flow testing
- Multi-device scenario testing
- Disparity detection accuracy testing
- Performance impact testing
### Compatibility Testing
- Backward compatibility with existing installations
- Device compatibility across SoundTouch models
- Migration from various existing configurations
- Stress testing with multiple concurrent devices
## Deployment Strategy
### Rollout Plan
1. **Alpha Release**: Core functionality with limited device support
2. **Beta Release**: Full feature set with extensive testing
3. **Stable Release**: Production-ready with documentation
### Migration Path
1. Existing installations can upgrade incrementally
2. New features are opt-in with configuration flags
3. Existing data structures are preserved and extended
4. Rollback capability for critical issues
### Documentation Requirements
- Updated API documentation with new endpoints
- Migration guide for existing users
- Configuration reference for new options
- Troubleshooting guide for common issues
## Risk Mitigation
### Technical Risks
- **Data Loss**: Atomic operations and rollback capabilities
- **Performance Impact**: Gradual rollout and monitoring
- **Compatibility Issues**: Comprehensive testing and fallback options
- **Resource Constraints**: Efficient algorithms and configurable limits
### Operational Risks
- **Service Disruption**: Zero-downtime deployment strategies
- **Configuration Complexity**: Sensible defaults and validation
- **User Adoption**: Clear documentation and migration assistance
- **Support Burden**: Comprehensive logging and diagnostic tools
## Success Metrics
### Technical Metrics
- Migration success rate >95%
- Disparity detection accuracy >90%
- Performance overhead <5%
- System availability >99.5%
### User Experience Metrics
- Reduced support requests
- Improved device reliability
- Faster problem resolution
- Enhanced system visibility
This roadmap provides a structured approach to implementing the upstream service simulation concept while maintaining compatibility with existing deployments and ensuring smooth migration paths for users.
+989
View File
@@ -0,0 +1,989 @@
# Technical Specification - Enhanced State Management System
## Table of Contents
1. [System Architecture](#system-architecture)
2. [Data Models](#data-models)
3. [API Specifications](#api-specifications)
4. [File Format Specifications](#file-format-specifications)
5. [State Machine Definitions](#state-machine-definitions)
6. [Event Processing](#event-processing)
7. [Performance Requirements](#performance-requirements)
8. [Security Considerations](#security-considerations)
9. [Error Handling](#error-handling)
10. [Monitoring and Observability](#monitoring-and-observability)
## System Architecture
### Component Overview
```
┌─────────────────────────────────────────────────────────────┐
│ SoundTouch Service │
├─────────────────────────────────────────────────────────────┤
│ HTTP Router & Middleware │
│ ├── Mirror Middleware (Enhanced) │
│ ├── Recorder Middleware │
│ ├── Disparity Detection │
│ └── Health Check Middleware │
├─────────────────────────────────────────────────────────────┤
│ Service Layer │
│ ├── Account Manager ├── Lifecycle Manager │
│ ├── Migration Controller ├── Data Source Router │
│ ├── Event Processor ├── Health Monitor │
│ └── Export Manager └── Analytics Engine │
├─────────────────────────────────────────────────────────────┤
│ Data Layer │
│ ├── Enhanced DataStore ├── Event Store │
│ ├── Mirror Cache ├── Metrics Store │
│ └── Configuration Store └── Session Store │
├─────────────────────────────────────────────────────────────┤
│ External Integrations │
│ ├── Bose Services (Mirror) ├── Device Discovery │
│ ├── BMX/TuneIn Services └── SSH/Setup Manager │
└─────────────────────────────────────────────────────────────┘
```
### Package Structure
```
pkg/service/
├── account/ # Account management
│ ├── manager.go
│ ├── persistence.go
│ └── validation.go
├── lifecycle/ # Device lifecycle management
│ ├── manager.go
│ ├── states.go
│ ├── transitions.go
│ └── events.go
├── migration/ # Enhanced migration (extends existing)
│ ├── controller.go
│ ├── strategies.go
│ └── progress.go
├── datasource/ # Data source routing
│ ├── router.go
│ ├── preferences.go
│ └── fallback.go
├── events/ # Event processing system
│ ├── processor.go
│ ├── queue.go
│ └── storage.go
├── mirror/ # Enhanced mirroring (extends existing)
│ ├── disparity.go
│ ├── analyzer.go
│ └── logger.go
├── health/ # System monitoring
│ ├── monitor.go
│ ├── metrics.go
│ └── alerts.go
└── export/ # Data export and backup
├── exporter.go
├── formats.go
└── backup.go
```
## Data Models
### Account Model
```go
type Account struct {
ID string `json:"id"`
Name string `json:"name"`
Email string `json:"email,omitempty"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Status AccountStatus `json:"status"`
DeviceCount int `json:"device_count"`
MigrationInfo *MigrationInfo `json:"migration_info,omitempty"`
BoseAccountID string `json:"bose_account_id,omitempty"`
DataSources DataSourceConfig `json:"data_sources"`
Settings AccountSettings `json:"settings"`
}
type AccountStatus string
const (
AccountStatusActive AccountStatus = "active"
AccountStatusMigrating AccountStatus = "migrating"
AccountStatusSuspended AccountStatus = "suspended"
AccountStatusArchived AccountStatus = "archived"
)
type MigrationInfo struct {
StartedAt time.Time `json:"started_at"`
CompletedAt *time.Time `json:"completed_at,omitempty"`
DevicesMigrated int `json:"devices_migrated"`
DevicesPending int `json:"devices_pending"`
MirrorActive bool `json:"mirror_active"`
Strategy string `json:"strategy"`
RollbackData string `json:"rollback_data,omitempty"`
}
type DataSourceConfig struct {
Local bool `json:"local"`
BoseMirror bool `json:"bose_mirror"`
Primary string `json:"primary"` // "local" or "bose"
}
type AccountSettings struct {
AutoMigration bool `json:"auto_migration"`
MirrorEndpoints []string `json:"mirror_endpoints"`
RetentionDays int `json:"retention_days"`
}
```
### Device Lifecycle Model
```go
type DeviceLifecycle struct {
DeviceID string `json:"device_id"`
AccountID string `json:"account_id"`
State DeviceState `json:"state"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
StateHistory []StateTransition `json:"state_history"`
Metadata DeviceMetadata `json:"metadata"`
DataSources DataSourceConfig `json:"data_sources"`
Migration *DeviceMigration `json:"migration,omitempty"`
Health DeviceHealth `json:"health"`
}
type DeviceState string
const (
DeviceStateUnregistered DeviceState = "unregistered"
DeviceStateDiscovered DeviceState = "discovered"
DeviceStateRegistering DeviceState = "registering"
DeviceStateActive DeviceState = "active"
DeviceStateMigrating DeviceState = "migrating"
DeviceStateOffline DeviceState = "offline"
DeviceStateError DeviceState = "error"
DeviceStateRetired DeviceState = "retired"
)
type StateTransition struct {
From DeviceState `json:"from"`
To DeviceState `json:"to"`
Timestamp time.Time `json:"timestamp"`
Reason string `json:"reason"`
Source string `json:"source"`
Context map[string]interface{} `json:"context,omitempty"`
}
type DeviceMetadata struct {
Name string `json:"name"`
Type string `json:"type"`
SerialNumber string `json:"serial_number"`
FirmwareVersion string `json:"firmware_version"`
MACAddress string `json:"mac_address"`
IPAddress string `json:"ip_address"`
LastSeen time.Time `json:"last_seen"`
IsLegacyID bool `json:"is_legacy_id"`
Capabilities []string `json:"capabilities,omitempty"`
}
type DeviceMigration struct {
FromBoseAccount string `json:"from_bose_account,omitempty"`
MigratedAt *time.Time `json:"migrated_at,omitempty"`
Method string `json:"method"`
RollbackAvailable bool `json:"rollback_available"`
DataPreserved []string `json:"data_preserved"`
}
type DeviceHealth struct {
Status string `json:"status"` // "healthy", "warning", "error"
LastCheck time.Time `json:"last_check"`
ResponseTime int `json:"response_time_ms"`
Connectivity string `json:"connectivity"` // "online", "offline", "intermittent"
ErrorCount int `json:"error_count"`
LastError string `json:"last_error,omitempty"`
}
```
### Event Model
```go
type DeviceEvent struct {
ID string `json:"id"`
DeviceID string `json:"device_id"`
AccountID string `json:"account_id"`
Type DeviceEventType `json:"type"`
Data map[string]interface{} `json:"data"`
Timestamp time.Time `json:"timestamp"`
Source EventSource `json:"source"`
Processed bool `json:"processed"`
Context EventContext `json:"context"`
}
type DeviceEventType string
const (
EventTypeNowPlaying DeviceEventType = "now_playing"
EventTypePresetChanged DeviceEventType = "preset_changed"
EventTypeVolumeChanged DeviceEventType = "volume_changed"
EventTypeSourceChanged DeviceEventType = "source_changed"
EventTypeDeviceOnline DeviceEventType = "device_online"
EventTypeDeviceOffline DeviceEventType = "device_offline"
EventTypeZoneChanged DeviceEventType = "zone_changed"
EventTypeDisparityFound DeviceEventType = "disparity_found"
EventTypeMigrationStart DeviceEventType = "migration_start"
EventTypeMigrationEnd DeviceEventType = "migration_end"
EventTypeHealthCheck DeviceEventType = "health_check"
EventTypeErrorOccurred DeviceEventType = "error_occurred"
)
type EventSource string
const (
EventSourceWebSocket EventSource = "websocket"
EventSourceDiscovery EventSource = "discovery"
EventSourceMirror EventSource = "mirror"
EventSourceSystem EventSource = "system"
EventSourceAPI EventSource = "api"
EventSourceUser EventSource = "user"
)
type EventContext struct {
RequestID string `json:"request_id,omitempty"`
UserAgent string `json:"user_agent,omitempty"`
IPAddress string `json:"ip_address,omitempty"`
Endpoint string `json:"endpoint,omitempty"`
Additional map[string]interface{} `json:"additional,omitempty"`
}
```
### Disparity Model
```go
type Disparity struct {
ID string `json:"id"`
Timestamp time.Time `json:"timestamp"`
DeviceID string `json:"device_id"`
AccountID string `json:"account_id"`
Endpoint string `json:"endpoint"`
Type DisparityType `json:"type"`
Severity DisparitySeverity `json:"severity"`
LocalHash string `json:"local_hash"`
UpstreamHash string `json:"upstream_hash"`
Details DisparityDetails `json:"details"`
Context map[string]interface{} `json:"context"`
Resolved bool `json:"resolved"`
}
type DisparityType string
const (
DisparityTypeContentMismatch DisparityType = "content_mismatch"
DisparityTypeStructureDiff DisparityType = "structure_diff"
DisparityTypeTimestampFormat DisparityType = "timestamp_format"
DisparityTypeFieldMissing DisparityType = "field_missing"
DisparityTypeValueMismatch DisparityType = "value_mismatch"
DisparityTypeCountMismatch DisparityType = "count_mismatch"
)
type DisparitySeverity string
const (
DisparitySeverityLow DisparitySeverity = "low"
DisparitySeverityMedium DisparitySeverity = "medium"
DisparitySeverityHigh DisparitySeverity = "high"
DisparitySeverityCritical DisparitySeverity = "critical"
)
type DisparityDetails struct {
FieldPath string `json:"field_path"`
LocalValue interface{} `json:"local_value"`
UpstreamValue interface{} `json:"upstream_value"`
Description string `json:"description"`
}
```
## API Specifications
### Account Management APIs
#### Create Account
```http
POST /api/v1/accounts
Content-Type: application/json
{
"name": "User Account",
"email": "user@example.com",
"settings": {
"auto_migration": false,
"retention_days": 30
}
}
Response: 201 Created
{
"id": "acc_12345",
"name": "User Account",
"email": "user@example.com",
"created_at": "2024-01-20T10:00:00Z",
"status": "active",
"device_count": 0
}
```
#### Get Account
```http
GET /api/v1/accounts/{account_id}
Response: 200 OK
{
"id": "acc_12345",
"name": "User Account",
"status": "active",
"device_count": 2,
"migration_info": {
"started_at": "2024-01-18T09:00:00Z",
"devices_migrated": 1,
"devices_pending": 1,
"mirror_active": true
},
"data_sources": {
"local": true,
"bose_mirror": true,
"primary": "bose"
}
}
```
#### List Accounts
```http
GET /api/v1/accounts?status=active&limit=10&offset=0
Response: 200 OK
{
"accounts": [...],
"total": 5,
"limit": 10,
"offset": 0
}
```
### Device Lifecycle APIs
#### Register Device
```http
POST /api/v1/accounts/{account_id}/devices
Content-Type: application/json
{
"device_id": "A81B6A536A98",
"name": "Living Room Speaker",
"registration_type": "fresh"
}
Response: 201 Created
{
"device_id": "A81B6A536A98",
"account_id": "acc_12345",
"state": "registering",
"created_at": "2024-01-20T10:00:00Z"
}
```
#### Get Device State
```http
GET /api/v1/accounts/{account_id}/devices/{device_id}/state
Response: 200 OK
{
"device_id": "A81B6A536A98",
"account_id": "acc_12345",
"state": "active",
"metadata": {
"name": "Living Room Speaker",
"type": "SoundTouch 30",
"last_seen": "2024-01-20T15:30:00Z"
},
"health": {
"status": "healthy",
"connectivity": "online",
"response_time": 45
}
}
```
#### Migrate Device
```http
POST /api/v1/accounts/{account_id}/devices/{device_id}/migrate
Content-Type: application/json
{
"from_bose_account": "bose-acc-xyz",
"preserve_data": true,
"method": "gradual"
}
Response: 202 Accepted
{
"migration_id": "mig_67890",
"status": "started",
"estimated_completion": "2024-01-20T11:00:00Z"
}
```
### Event APIs
#### Get Device Events
```http
GET /api/v1/accounts/{account_id}/devices/{device_id}/events?since=2024-01-20T00:00:00Z&type=now_playing&limit=50
Response: 200 OK
{
"events": [
{
"id": "evt_12345",
"type": "now_playing",
"timestamp": "2024-01-20T15:30:00Z",
"data": {
"source": "SPOTIFY",
"track": "Song Name",
"artist": "Artist Name"
}
}
],
"total": 125,
"has_more": true
}
```
#### Stream Events
```http
GET /api/v1/accounts/{account_id}/devices/{device_id}/events/stream
Accept: text/event-stream
Response: 200 OK
Content-Type: text/event-stream
data: {"id":"evt_12346","type":"volume_changed","timestamp":"2024-01-20T15:31:00Z","data":{"volume":50}}
data: {"id":"evt_12347","type":"now_playing","timestamp":"2024-01-20T15:32:00Z","data":{"source":"TUNEIN"}}
```
### Monitoring APIs
#### System Health
```http
GET /api/v1/system/health
Response: 200 OK
{
"status": "healthy",
"timestamp": "2024-01-20T15:30:00Z",
"services": {
"account_manager": "healthy",
"lifecycle_manager": "healthy",
"event_processor": "healthy",
"mirror_service": "warning"
},
"statistics": {
"total_accounts": 5,
"total_devices": 12,
"active_devices": 10,
"events_processed_24h": 1547
}
}
```
#### Disparity Analysis
```http
GET /api/v1/system/disparities?since=2024-01-20T00:00:00Z&severity=high
Response: 200 OK
{
"disparities": [
{
"id": "disp_12345",
"timestamp": "2024-01-20T14:30:00Z",
"endpoint": "/v1/presets",
"type": "count_mismatch",
"severity": "high",
"details": {
"field_path": "preset_count",
"local_value": 5,
"upstream_value": 4
}
}
],
"summary": {
"total": 15,
"by_severity": {
"high": 2,
"medium": 8,
"low": 5
}
}
}
```
## File Format Specifications
### Account Metadata (account.json)
```json
{
"version": "1.0",
"id": "acc_12345",
"name": "User Account",
"email": "user@example.com",
"created_at": "2024-01-20T10:00:00Z",
"updated_at": "2024-01-20T15:30:00Z",
"status": "active",
"device_count": 2,
"migration_info": {
"started_at": "2024-01-18T09:00:00Z",
"devices_migrated": 1,
"devices_pending": 1,
"mirror_active": true,
"strategy": "gradual"
},
"bose_account_id": "bose-original-id",
"data_sources": {
"local": true,
"bose_mirror": true,
"primary": "bose"
},
"settings": {
"auto_migration": false,
"mirror_endpoints": ["/v1/presets", "/v1/recents"],
"retention_days": 30
}
}
```
### Device Lifecycle (lifecycle.json)
```json
{
"version": "1.0",
"device_id": "A81B6A536A98",
"account_id": "acc_12345",
"state": "active",
"created_at": "2024-01-20T10:00:00Z",
"updated_at": "2024-01-20T15:30:00Z",
"state_history": [
{
"from": "unregistered",
"to": "discovered",
"timestamp": "2024-01-20T10:00:00Z",
"reason": "mdns_discovery",
"source": "discovery",
"context": {
"ip_address": "192.168.1.100",
"discovery_method": "mdns"
}
},
{
"from": "discovered",
"to": "active",
"timestamp": "2024-01-20T10:05:00Z",
"reason": "registration_complete",
"source": "system"
}
],
"metadata": {
"name": "Living Room Speaker",
"type": "SoundTouch 30",
"serial_number": "I6332527703739342000020",
"firmware_version": "4.8.1.25341.2677643.1597353330",
"mac_address": "A8:1B:6A:53:6A:98",
"ip_address": "192.168.1.100",
"last_seen": "2024-01-20T15:30:00Z",
"is_legacy_id": false,
"capabilities": ["multiroom", "bluetooth", "aux"]
},
"data_sources": {
"presets": "local",
"recents": "mirror_primary",
"sources": "local"
},
"migration": {
"from_bose_account": "bose-acc-xyz",
"migrated_at": "2024-01-18T14:30:00Z",
"method": "gradual",
"rollback_available": true,
"data_preserved": ["presets", "recents", "sources"]
},
"health": {
"status": "healthy",
"last_check": "2024-01-20T15:30:00Z",
"response_time": 45,
"connectivity": "online",
"error_count": 0
}
}
```
### Event Log Format (events.log)
```
# SoundTouch Service Event Log - Device A81B6A536A98
# Format: TIMESTAMP|EVENT_ID|EVENT_TYPE|SOURCE|DATA_JSON
# Version: 1.0
2024-01-20T15:30:00.123Z|evt_12345|now_playing|websocket|{"source":"SPOTIFY","track":"Song Name","artist":"Artist Name","album":"Album Name"}
2024-01-20T15:30:30.456Z|evt_12346|volume_changed|websocket|{"volume":45,"muted":false,"previous_volume":40}
2024-01-20T15:31:00.789Z|evt_12347|preset_selected|websocket|{"preset":1,"source":"SPOTIFY","location":"spotify:track:123abc"}
2024-01-20T15:31:15.012Z|evt_12348|disparity_detected|mirror|{"endpoint":"/v1/presets","local_hash":"abc123","upstream_hash":"def456","severity":"medium"}
2024-01-20T15:32:00.345Z|evt_12349|health_check|system|{"response_time":42,"status":"healthy","connectivity":"online"}
```
### Disparity Log Format (disparities.log)
```
# SoundTouch Service Disparity Log
# Format: TIMESTAMP|DISPARITY_ID|DEVICE_ID|ACCOUNT_ID|ENDPOINT|TYPE|SEVERITY|DETAILS_JSON
# Version: 1.0
2024-01-20T15:31:15.012Z|disp_12345|A81B6A536A98|acc_12345|/v1/presets|count_mismatch|medium|{"field_path":"preset_count","local_value":5,"upstream_value":4,"description":"Local has one additional preset"}
2024-01-20T15:32:45.678Z|disp_12346|A81B6A536A98|acc_12345|/v1/recents|timestamp_format|low|{"field_path":"recent[0].utc_time","local_value":"2024-01-20T15:30:00Z","upstream_value":"1705761000","description":"Timestamp format difference"}
2024-01-20T15:35:20.901Z|disp_12347|B92C7B647B09|acc_12345|/v1/account/full|structure_diff|high|{"field_path":"device[1].ip_address","local_value":"present","upstream_value":"missing","description":"IP address field missing in upstream response"}
```
## State Machine Definitions
### Device State Transitions
```
Unregistered → Discovered (via discovery)
Discovered → Registering (via user action/auto-registration)
Registering → Active (via successful registration)
Registering → Error (via registration failure)
Active → Migrating (via migration start)
Active → Offline (via connectivity loss)
Migrating → Active (via migration success)
Migrating → Error (via migration failure)
Offline → Active (via connectivity restored)
Error → Active (via error resolution)
Any State → Retired (via explicit retirement)
```
### State Transition Rules
```go
var StateTransitionRules = map[DeviceState][]DeviceState{
DeviceStateUnregistered: {DeviceStateDiscovered},
DeviceStateDiscovered: {DeviceStateRegistering, DeviceStateOffline},
DeviceStateRegistering: {DeviceStateActive, DeviceStateError},
DeviceStateActive: {DeviceStateMigrating, DeviceStateOffline, DeviceStateRetired},
DeviceStateMigrating: {DeviceStateActive, DeviceStateError},
DeviceStateOffline: {DeviceStateActive, DeviceStateError, DeviceStateRetired},
DeviceStateError: {DeviceStateActive, DeviceStateOffline, DeviceStateRetired},
DeviceStateRetired: {}, // Terminal state
}
```
### Transition Triggers
```go
type TransitionTrigger struct {
Event DeviceEventType
Condition func(*DeviceLifecycle, *DeviceEvent) bool
Target DeviceState
Reason string
}
var TransitionTriggers = []TransitionTrigger{
{
Event: EventTypeDeviceOnline,
Condition: isOfflineDevice,
Target: DeviceStateActive,
Reason: "connectivity_restored",
},
{
Event: EventTypeDeviceOffline,
Condition: isActiveDevice,
Target: DeviceStateOffline,
Reason: "connectivity_lost",
},
{
Event: EventTypeMigrationStart,
Condition: isActiveDevice,
Target: DeviceStateMigrating,
Reason: "migration_initiated",
},
// ... additional triggers
}
```
## Event Processing
### Event Queue Implementation
```go
type EventQueue struct {
buffer chan DeviceEvent
processors []EventProcessor
storage EventStorage
config EventQueueConfig
}
type EventQueueConfig struct {
BufferSize int `json:"buffer_size"`
ProcessorCount int `json:"processor_count"`
FlushInterval time.Duration `json:"flush_interval"`
RetryAttempts int `json:"retry_attempts"`
DeadLetterQueue bool `json:"dead_letter_queue"`
}
type EventProcessor interface {
ProcessEvent(event DeviceEvent) error
CanHandle(eventType DeviceEventType) bool
}
```
### Event Processing Flow
```
Event Input → Validation → Queue → Processing → Storage → Notification
↓ ↓ ↓ ↓ ↓ ↓
Websocket Schema Buffer Parallel Files Webhooks
Discovery Check Memory Workers Logs SSE
API Call Format Retry DB Metrics
System Enrich DLQ
```
### Event Retention Policy
```go
type RetentionPolicy struct {
EventType DeviceEventType `json:"event_type"`
RetentionDays int `json:"retention_days"`
MaxCount int `json:"max_count"`
Compression bool `json:"compression"`
}
var DefaultRetentionPolicies = []RetentionPolicy{
{EventTypeNowPlaying, 7, 1000, true},
{EventTypeVolumeChanged, 1, 100, false},
{EventTypeDisparityFound, 30, 10000, true},
{EventTypeMigrationStart, 365, -1, false}, // Keep forever
{EventTypeHealthCheck, 7, 1000, true},
}
```
### Development Requirements
#### KISS Principle (Keep It Simple, Stupid)
- Prioritize simplicity and readability over performance optimization
- Use standard Go idioms and patterns
- Avoid premature abstraction and optimization
- Build the simplest thing that works first
#### Quality Gates
Every change must pass these checks:
- `golangci-lint run --fix` - no linting issues
- `go test ./...` - all tests pass with no failures
- Integration tests verify existing functionality intact
- Code coverage maintained or improved
#### Testing Requirements
- Unit tests for all new functions
- Integration tests for modified workflows
- Regression tests for existing functionality
- Mock external dependencies appropriately
### Simplicity-First Performance Approach
| Aspect | Simple Approach | Optimization Only When Needed |
|--------|----------------|-------------------------------|
| Memory Usage | Direct file operations, minimal caching | Add caching if performance issues arise |
| CPU Usage | Synchronous processing initially | Add async processing if bottlenecks occur |
| Storage | Simple append operations | Add rotation/compression when files grow large |
| Networking | Reuse existing patterns | Optimize only if latency becomes problematic |
## Quality Assurance
### Testing Strategy
#### Unit Testing
```go
// Example test structure
func TestAccountManager_CreateAccount(t *testing.T) {
tests := []struct {
name string
input CreateAccountRequest
want *Account
wantErr bool
}{
{
name: "valid account creation",
input: CreateAccountRequest{Name: "Test Account"},
want: &Account{Name: "Test Account", Status: "active"},
wantErr: false,
},
{
name: "empty name should fail",
input: CreateAccountRequest{Name: ""},
want: nil,
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := manager.CreateAccount(tt.input)
if (err != nil) != tt.wantErr {
t.Errorf("CreateAccount() error = %v, wantErr %v", err, tt.wantErr)
return
}
// Additional assertions...
})
}
}
```
#### Integration Testing
- Test with real file operations in temporary directories
- Verify HTTP endpoints work with actual HTTP requests
- Test interaction with existing WebSocket system
- Ensure existing XML endpoints remain functional
#### Quality Gates
```bash
# Required before each commit
golangci-lint run --fix
go test ./...
go test -race ./...
# Required before milestone completion
go test ./... -v -cover
go test -bench=. ./...
```
### Security Considerations
#### Simple Security Model
- Reuse existing authentication mechanisms
- Basic input validation with standard Go validation
- Simple file permissions (0755 for directories, 0644 for files)
- No complex authorization initially - build incrementally
#### Input Validation
```go
// Simple validation approach
func ValidateAccount(account *Account) error {
if account.Name == "" {
return errors.New("account name cannot be empty")
}
if len(account.Name) > 100 {
return errors.New("account name too long")
}
if account.Email != "" && !isValidEmail(account.Email) {
return errors.New("invalid email format")
}
return nil
}
```
## Error Handling
### Error Categories
```go
type ErrorCategory string
const (
ErrorCategoryValidation ErrorCategory = "validation"
ErrorCategorySystem ErrorCategory = "system"
ErrorCategoryNetwork ErrorCategory = "network"
ErrorCategoryStorage ErrorCategory = "storage"
ErrorCategoryTimeout ErrorCategory = "timeout"
ErrorCategoryAuth ErrorCategory = "authentication"
)
type ServiceError struct {
Code string `json:"code"`
Message string `json:"message"`
Category ErrorCategory `json:"category"`
Timestamp time.Time `json:"timestamp"`
Context map[string]interface{} `json:"context"`
Retryable bool `json:"retryable"`
Severity string `json:"severity"`
}
```
### Error Recovery Strategies
1. **Transient Errors**: Exponential backoff retry (3 attempts)
2. **Storage Errors**: Graceful degradation with in-memory fallback
3. **Network Errors**: Circuit breaker pattern with fallback data
4. **Validation Errors**: Immediate response with detailed feedback
5. **System Errors**: Alerting and automatic recovery attempts
### Error Response Format
```json
{
"error": {
"code": "DEVICE_NOT_FOUND",
"message": "Device with ID 'A81B6A536A98' not found in account 'acc_12345'",
"category": "validation",
"timestamp": "2024-01-20T15:30:00Z",
"context": {
"account_id": "acc_12345",
"device_id": "A81B6A536A98",
"request_id": "req_67890"
},
"retryable": false,
"severity": "error"
},
"request_id": "req_67890"
}
```
## Monitoring and Observability
### Simple Monitoring Approach
#### Basic Health Check
```go
// Simple health check implementation
type HealthStatus struct {
Status string `json:"status"` // "healthy", "warning", "error"
Timestamp time.Time `json:"timestamp"`
Version string `json:"version"`
Uptime string `json:"uptime"`
}
func (s *Server) HandleHealthCheck(w http.ResponseWriter, r *http.Request) {
health := HealthStatus{
Status: "healthy",
Timestamp: time.Now(),
Version: version,
Uptime: time.Since(startTime).String(),
}
// Simple checks
if !s.canWriteToDataDir() {
health.Status = "error"
}
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(health)
}
```
#### Leverage Existing Systems
- Extend existing parity mismatch logging for disparity detection
- Reuse existing interaction recording for request/response tracking
- Build upon current discovery and migration event logging
- Use existing WebSocket event system for device state changes
#### Simple Metrics
```go
// Basic counters - no complex metrics initially
type SimpleMetrics struct {
AccountsCreated int `json:"accounts_created"`
DevicesActive int `json:"devices_active"`
EventsProcessed int `json:"events_processed_today"`
LastUpdate time.Time `json:"last_update"`
}
// Update metrics in simple text file
func (m *SimpleMetrics) Save(dataDir string) error {
data, err := json.MarshalIndent(m, "", " ")
if err != nil {
return err
}
return os.WriteFile(filepath.Join(dataDir, "metrics.json"), data, 0644)
}
```
This technical specification provides comprehensive details for implementing the enhanced state management system while maintaining compatibility with existing SoundTouch service functionality and meeting the performance requirements for small hardware deployments.
@@ -0,0 +1,393 @@
# Upstream Bose Service Simulation - State Management Concept
## Overview
This document outlines the concept for simulating and replacing upstream Bose services with enhanced state management capabilities. The goal is to create a comprehensive local replacement that can handle device lifecycles, account management, and state synchronization while maintaining compatibility with existing SoundTouch devices.
## Use Cases
### Case 0: Account Management
- **Explicit Account Creation**: Accounts must be created through deliberate action (web UI, API call)
- **Mirror-Enhanced Creation**: Account creation can be enriched using mirrored data from upstream Bose endpoints when devices make requests
- **Data Recording**: Passively record account information during normal device operations for future use
### Case 1a: Fresh Device Registration
- Initial setup/registration of a factory-reset or new device
- Device has no prior Bose account association
- Full local initialization with default configurations
### Case 1b: Device Migration from Bose Account
- Migrate existing registered device from Bose services to local management
- Preserve existing device data (presets, recents, sources)
- Support gradual migration while maintaining Bose compatibility
- Mirror Bose account data for seamless transition
### Case 2: Device Lifecycle and State Management
- Track and manage device lifecycle states and activities
- Maintain internal state based on incoming events from devices
- Detect disparities between local and upstream behavior
- Provide visibility into state changes and system health
## Architecture Principles
### 1. **Text-Based Storage for Debugging**
- Maintain all state in human-readable text formats (XML, JSON, plain text)
- Use small, focused files for each data aspect
- Enable easy debugging and manual inspection
- Optimize for small hardware deployments (Raspberry Pi Zero 2W)
### 2. **Mirror-First Strategy**
- Keep mirror functionality active as long as possible
- Primary source switches from upstream to local only during:
- Explicit migration
- Sufficient local data accumulation
- Upstream service unavailability
- Record and mirror as much data as possible, even if not immediately used
### 3. **Disparity Detection**
- Track differences between local and upstream responses
- Log discrepancies for analysis and improvement
- Provide visibility into implementation gaps
- Support parity testing and validation
### 4. **Event-Driven State Management**
- Process device events asynchronously
- Track comprehensive event history in text files
- Support event replay and analysis
- Minimize noise while capturing important state changes
## Enhanced Data Structure
### Account Management
```
data/
├── accounts/
│ ├── {account-id}/
│ │ ├── account.json # Account metadata
│ ├── account-events.log # High-level account behavior tracking
│ │ ├── devices/
│ │ │ └── {device-id}/
│ │ │ ├── lifecycle.json # Device state and history
│ │ │ ├── info.xml # Device information
│ │ │ ├── presets.xml # Device presets
│ │ │ ├── recents.xml # Recent plays
│ │ │ ├── sources.xml # Configured sources
│ │ │ └── events.log # Device event history
│ │ └── sessions/
│ │ └── {session-id}/ # Recorded interaction sessions
└── system/
├── discovery.log # Device discovery events
└── migration.log # Migration activities
```
### Account Metadata Format
```json
{
"id": "account-12345",
"name": "User Account",
"email": "user@example.com",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T15:45:00Z",
"status": "active",
"device_count": 3,
"migration_status": {
"started_at": "2024-01-18T09:00:00Z",
"devices_migrated": 1,
"devices_pending": 2,
"mirror_active": true
},
"bose_account_id": "bose-original-id",
"data_sources": {
"local": true,
"bose_mirror": true,
"primary": "bose"
}
}
```
### Device Lifecycle Format
```json
{
"device_id": "A81B6A536A98",
"account_id": "account-12345",
"state": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T16:22:00Z",
"state_history": [
{
"from": "unregistered",
"to": "registering",
"timestamp": "2024-01-15T10:30:00Z",
"reason": "fresh_device_setup",
"source": "discovery"
},
{
"from": "registering",
"to": "active",
"timestamp": "2024-01-15T10:35:00Z",
"reason": "registration_complete",
"source": "system"
}
],
"metadata": {
"name": "Living Room Speaker",
"type": "SoundTouch 30",
"serial_number": "I6332527703739342000020",
"firmware_version": "4.8.1.25341.2677643.1597353330",
"mac_address": "A8:1B:6A:53:6A:98",
"ip_address": "192.168.1.100",
"last_seen": "2024-01-20T16:20:00Z",
"is_legacy_id": false
},
"data_sources": {
"presets": "local",
"recents": "mirror_primary",
"sources": "local"
},
"migration": {
"from_bose_account": "bose-account-xyz",
"migrated_at": "2024-01-18T14:30:00Z",
"method": "gradual",
"rollback_available": true
}
}
```
### Event Log Format
```
# Device Events Log - A81B6A536A98
# Format: TIMESTAMP|EVENT_TYPE|SOURCE|DATA
2024-01-20T16:15:00Z|now_playing|websocket|{"source":"SPOTIFY","track":"Song Name","artist":"Artist Name"}
2024-01-20T16:15:30Z|volume_changed|websocket|{"volume":45,"muted":false}
2024-01-20T16:16:00Z|preset_selected|websocket|{"preset":1,"source":"SPOTIFY","location":"spotify:track:123"}
2024-01-20T16:18:00Z|disparity_detected|mirror|{"endpoint":"/v1/account/full","local_hash":"abc123","upstream_hash":"def456"}
2024-01-20T16:20:00Z|device_online|discovery|{"ip":"192.168.1.100","method":"mdns"}
```
### Disparity Log Format
```
# Parity Analysis Log
# Format: TIMESTAMP|ENDPOINT|DEVICE|ACCOUNT|DISPARITY_TYPE|DETAILS
2024-01-20T16:18:00Z|/v1/account/full|A81B6A536A98|account-12345|content_mismatch|preset_count:local=5,upstream=4
2024-01-20T16:19:15Z|/v1/presets|A81B6A536A98|account-12345|xml_structure|missing_container_art_in_local
2024-01-20T16:20:30Z|/v1/recents|A81B6A536A98|account-12345|timestamp_format|local=RFC3339,upstream=custom
```
## Implementation Strategy
### Phase 1: Enhanced State Tracking
1. **Account Management Service**
- Explicit account creation API
- Mirror-enhanced account initialization
- Account status and migration tracking
2. **Device Lifecycle Manager**
- Comprehensive state machine for device lifecycle
- Event-driven state transitions
- Text-based state persistence
3. **Enhanced Mirror System**
- Extended mirroring with disparity detection
- Selective data source switching
- Parity analysis and logging
### Phase 2: Gradual Migration Support
1. **Migration Controller**
- Device-by-device migration orchestration
- Rollback capability with state preservation
- Migration progress tracking
2. **Dual-Source Data Management**
- Smart routing between local and upstream data
- Graceful fallback mechanisms
- Data source preference management
3. **State Synchronization**
- Bidirectional sync capabilities
- Conflict resolution strategies
- Sync status monitoring
### Phase 3: Advanced Analytics
1. **Disparity Analysis Engine**
- Automated disparity detection and classification
- Trend analysis and reporting
- Implementation gap identification
2. **System Health Monitoring**
- Device connectivity monitoring
- Service availability tracking
- Performance metrics collection
3. **Data Export and Backup**
- Account data export for migration
- Incremental backup strategies
- Data integrity verification
## API Enhancements
### Account Management APIs
```http
# Create account explicitly
POST /api/v1/accounts
Content-Type: application/json
{
"name": "User Account",
"email": "user@example.com"
}
# Get account with migration status
GET /api/v1/accounts/{account-id}
# Initiate account migration from Bose
POST /api/v1/accounts/{account-id}/migrate
Content-Type: application/json
{
"bose_account_id": "bose-original-id",
"strategy": "gradual"
}
```
### Device Lifecycle APIs
```http
# Register fresh device
POST /api/v1/accounts/{account-id}/devices
Content-Type: application/json
{
"device_id": "A81B6A536A98",
"name": "Living Room Speaker",
"registration_type": "fresh"
}
# Get device state and lifecycle
GET /api/v1/accounts/{account-id}/devices/{device-id}/state
# Migrate device from Bose account
POST /api/v1/accounts/{account-id}/devices/{device-id}/migrate
Content-Type: application/json
{
"from_bose_account": "bose-account-xyz",
"preserve_data": true
}
```
### Monitoring and Analysis APIs
```http
# Get disparity analysis
GET /api/v1/system/disparities?since=2024-01-20T00:00:00Z
# Get migration status
GET /api/v1/system/migration/status
# Export account data
GET /api/v1/accounts/{account-id}/export
```
## Integration with Existing Services
### Enhanced Marge Service
- Integrate lifecycle information into account responses
- Add migration status to device listings
- Support dual-source data routing
- Include disparity metadata in responses
### Enhanced BMX Service
- Track content source preferences by account
- Mirror and compare content recommendations
- Log streaming behavior for analysis
- Support gradual source migration
### Discovery Service Integration
- Link discovered devices to lifecycle manager
- Trigger lifecycle state transitions on discovery events
- Support both fresh registration and migration flows
- Handle legacy device ID migration automatically
## Performance Considerations
### Simplicity First (KISS Principle)
- Favor simple, readable code over premature optimization
- Use straightforward algorithms and data structures
- Minimize complexity in favor of maintainability
- Build incrementally with small, testable changes
### Quality Assurance
- Complete test coverage for all new functionality
- Comprehensive linting with `golangci-lint run --fix`
- Full test suite execution `go test ./...` for each milestone
- Integration tests with existing functionality
### File Management
- Simple line-based append operations for logs
- Basic log rotation when needed
- Direct file operations without complex caching
- Straightforward data persistence
## Development Principles
### KISS (Keep It Simple, Stupid)
- Prioritize simplicity and readability over performance optimization
- Use standard Go idioms and patterns
- Avoid premature abstraction and optimization
- Build the simplest thing that works first
### Quality First
- Every milestone must pass `golangci-lint run --fix` without issues
- Complete test suite must pass `go test ./...` before proceeding
- Integration tests ensure existing functionality remains intact
- Code coverage should be maintained or improved
### Incremental Development
- Make small, focused changes that can be easily reviewed
- Each step should be independently testable and valuable
- Maintain backward compatibility throughout development
- Enable rollback at any point in the process
### Leverage Existing Systems
- Reuse existing interaction recording for request/response tracking
- Build upon current parity mismatch detection system
- Extend existing datastore and handler patterns
- Integrate with established discovery and migration workflows
## Future Enhancements
Future improvements should maintain the simplicity-first approach:
1. **Enhanced Web Interface**
- Simple dashboard for account and device management
- Basic migration progress tracking
- Straightforward device health monitoring
2. **Extended Logging**
- Additional high-level behavior tracking
- Simple analytics based on existing parity data
- Enhanced debugging information
3. **Community Integration**
- Standardized data export formats
- Simple reporting mechanisms
- Clear documentation for community contributions
This concept provides a solid, maintainable foundation for replacing Bose's upstream services. The emphasis on simplicity, existing system reuse, and comprehensive testing ensures reliable functionality while maintaining the debugging capabilities needed for small hardware deployments.
@@ -0,0 +1,391 @@
# Device Lifecycle and /power_on Enhancement
## Overview
This document provides a comprehensive analysis of the current SoundTouch device registration and lifecycle management implementation, and proposes enhancements using the `/power_on` endpoint to reduce dependency on local network connectivity.
## Current Implementation Assessment
### Device Information Sources
The current system uses multiple data collection methods to build a complete device profile:
#### 1. UPnP/SSDP Discovery
- **Protocol**: Multicast UDP discovery for `urn:schemas-upnp-org:service:SoundTouch:1`
- **Network Scope**: Limited to same network segment
- **Data Collected**:
```go
type DiscoveredDevice struct {
Name string // From UPnP friendlyName
Host string // IP address
Port int // Usually 8090
ModelID string // From UPnP modelName
SerialNo string // MAC address from UPnP
UPnPLocation string // Device description URL
UPnPUSN string // Unique service name
}
```
#### 2. mDNS/Bonjour Discovery
- **Protocol**: Multicast DNS for `_soundtouch._tcp` services
- **Network Scope**: Limited to same network segment
- **Purpose**: Complements UPnP discovery with hostname resolution
#### 3. `/info` Endpoint Enrichment
- **Protocol**: HTTP GET to `http://device:8090/info`
- **Network Scope**: Requires direct connectivity to device
- **Data Collected**:
```xml
<info deviceID="ABCD1234EFGH">
<name>My SoundTouch Device</name>
<type>SoundTouch 10</type>
<margeAccountUUID>3230304</margeAccountUUID>
<components>
<component>
<componentCategory>SCM</componentCategory>
<softwareVersion>27.0.6.46330.5043500...</softwareVersion>
<serialNumber>I6332527703739342000020</serialNumber>
</component>
</components>
<margeURL>https://streaming.bose.com</margeURL>
<networkInfo type="SCM">
<macAddress>AA:BB:CC:DD:EE:FF</macAddress>
<ipAddress>192.168.1.10</ipAddress>
</networkInfo>
<moduleType>sm2</moduleType>
<variant>rhino</variant>
<countryCode>GB</countryCode>
</info>
```
### Current Data Flow
```mermaid
sequenceDiagram
participant Service as SoundTouch Service
participant UPnP as UPnP Discovery
participant mDNS as mDNS Discovery
participant Device as SoundTouch Device
participant DataStore as Data Store
participant User as User/App
Note over Service,User: Current Device Registration Flow
Service->>UPnP: Start SSDP Discovery
Service->>mDNS: Start mDNS Discovery
UPnP->>UPnP: Send M-SEARCH multicast
Device->>UPnP: Respond with location URL
UPnP->>Device: Fetch device description XML
Device->>UPnP: Return basic device info
mDNS->>mDNS: Query _soundtouch._tcp
Device->>mDNS: Respond with service info
Service->>Service: Merge discovery results
Service->>Device: GET /info (enrich data)
Device->>Service: Return detailed device info
Service->>DataStore: Store discovered device
Note over User,DataStore: User Registration
User->>Service: POST /account/{id}/devices
Note right of User: deviceId + user-friendly name
Service->>DataStore: Link device to account
Note over Service,DataStore: Migration Process
Service->>Device: GET /info (device identification)
Device->>Service: Return device details
Service->>Service: Build migration summary
Service->>Device: Apply configuration changes
```
### Device Registration Points
The system has distinct phases where device information is collected and enhanced:
#### Phase 1: Discovery (Network-Dependent)
**Trigger**: Automatic network scanning
**Data Sources**: UPnP + mDNS + `/info` endpoint
**Limitations**: ❌ Requires same network segment
#### Phase 2: User Registration (User-Controlled)
**Trigger**: User adds device to account
**Endpoint**: `POST /streaming/account/{accountId}/devices`
**Request Format**:
```xml
<device deviceid="08DF1F0BA325">
<name>Living Room Speaker</name>
</device>
```
**Data Added**: ✅ User-friendly name, Account association
#### Phase 3: Ongoing Updates (Mixed)
**Triggers**: Device state changes, firmware updates, network changes
**Methods**: Periodic `/info` polling, Discovery refresh, User configuration
### Current Data Model
The system maintains comprehensive device information:
```go
type ServiceDeviceInfo struct {
DeviceID string `json:"device_id"` // MAC or UUID
Name string `json:"name"` // User-friendly name
ProductCode string `json:"product_code"` // Device model
DeviceSerialNumber string `json:"device_serial_number"` // Hardware serial
ProductSerialNumber string `json:"product_serial_number"` // Product serial
FirmwareVersion string `json:"firmware_version"` // Software version
IPAddress string `json:"ip_address"` // Current IP
MacAddress string `json:"mac_address"` // MAC address
AccountID string `json:"account_id"` // Account association
DiscoveryMethod string `json:"discovery_method"` // How discovered
}
```
## Limitations of Current Approach
### Network Dependency Issues
| Issue | Impact | Affected Operations |
|-------|--------|-------------------|
| **Same Network Requirement** | High | Device discovery, Initial setup |
| **Direct Connectivity Need** | High | Device enrichment, Migration |
| **Firewall/NAT Restrictions** | Medium | Corporate networks, Complex setups |
| **Multi-VLAN Environments** | High | Enterprise deployments |
| **Remote Management** | Critical | Off-site device support |
### Service Architecture Limitations
1. **Geographic Constraints**: Service must be deployed on same network as speakers
2. **Scalability Issues**: Cannot centralize device management across multiple locations
3. **Discovery Reliability**: Multicast protocols can be unreliable in complex networks
4. **Real-time Updates**: No device-initiated communication for state changes
## /power_on Enhancement Proposal
### Current /power_on Request Analysis
The `/power_on` endpoint receives comprehensive device data that could replace many network-dependent operations:
```xml
<device-data>
<device id="A81B6A536A98">
<serialnumber>I6332527703739342000020</serialnumber>
<firmware-version>27.0.6.46330.5043500 epdbuild.trunk.hepdswbld04.2022-08-04T11:20:29</firmware-version>
<product product_code="SoundTouch 10 sm2" type="5">
<serialnumber>069231P63364828AE</serialnumber>
</product>
</device>
<diagnostic-data>
<device-landscape>
<rssi>Excellent</rssi>
<gateway-ip-address>192.168.178.1</gateway-ip-address>
<macaddresses>
<macaddress>A81B6A536A98</macaddress>
<macaddress>A81B6A849D99</macaddress>
</macaddresses>
<ip-address>192.168.178.35</ip-address>
<network-connection-type>Wireless</network-connection-type>
</device-landscape>
<network-landscape>
<network-data xmlns="http://www.Bose.com/Schemas/2012-12/NetworkMonitor/"/>
</network-landscape>
</diagnostic-data>
</device-data>
```
### Data Completeness Comparison
| Data Field | Current `/info` | `/power_on` | Gap Assessment |
|------------|----------------|-------------|----------------|
| **Device ID** | ✅ UUID format | ✅ MAC format | Different format |
| **Device Name** | ✅ Internal name | ❌ Missing | **Critical Gap** |
| **Device Type** | ✅ Model string | ✅ Product code | ✅ Available |
| **Account ID** | ✅ marge UUID | ❌ Missing | **Critical Gap** |
| **Service URL** | ✅ marge URL | ❌ Missing | **Important Gap** |
| **Firmware Version** | ✅ Full version | ✅ Full version | ✅ Available |
| **Serial Numbers** | ✅ Component serials | ✅ Device + Product | ✅ Available |
| **MAC Addresses** | ✅ Interface-specific | ✅ Multiple MACs | ✅ Enhanced |
| **IP Address** | ✅ Interface IPs | ✅ Current IP | ✅ Available |
| **Network Status** | ❌ Basic | ✅ Rich diagnostics | ✅ **Enhanced** |
| **Regional Settings** | ✅ Country/Region | ❌ Missing | **Important Gap** |
### Enhancement Benefits
#### 1. Network Independence
- ✅ Works across internet/WAN connections
- ✅ No multicast/broadcast requirements
- ✅ Firewall/NAT friendly
- ✅ Supports remote device management
#### 2. Real-time Device State
- ✅ Device-initiated communication
- ✅ Power-on event notifications
- ✅ Network status updates
- ✅ Firmware change detection
#### 3. Enhanced Diagnostics
- ✅ Signal strength (RSSI)
- ✅ Gateway information
- ✅ Connection type details
- ✅ Real-time network status
### Implementation Strategy
#### Phase 1: Hybrid Approach
Implement `/power_on` processing while maintaining existing discovery methods:
```go
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, r *http.Request) {
// Parse power_on request
var powerOnData models.CustomerSupportRequest
if err := xml.Unmarshal(body, &powerOnData); err != nil {
// Fallback to existing discovery
return s.fallbackToDiscovery(r.RemoteAddr)
}
// Extract device information
deviceMAC := powerOnData.Device.ID
deviceIP := powerOnData.DiagnosticData.DeviceLandscape.IPAddress
// Lookup existing device data
deviceInfo := s.lookupDeviceByMAC(deviceMAC)
if deviceInfo == nil {
// New device - trigger registration flow
deviceInfo = s.createDeviceFromPowerOn(powerOnData)
}
// Update with power_on data
s.updateDeviceFromPowerOn(deviceInfo, powerOnData)
// Determine response actions
response := s.buildPowerOnResponse(deviceInfo)
s.sendResponse(w, response)
}
```
#### Phase 2: Gap Resolution
Address missing data through complementary mechanisms:
1. **User-Friendly Names**: Maintain registration process for name assignment
2. **Account Association**: Enhance registration to link MAC addresses to accounts
3. **Service URLs**: Implement account-based service URL resolution
4. **Regional Settings**: Use IP geolocation or account preferences
#### Phase 3: Enhanced Device Lifecycle
```mermaid
sequenceDiagram
participant Device as SoundTouch Device
participant Service as SoundTouch Service
participant DataStore as Data Store
participant User as User/App
Note over Device,User: Enhanced Device Lifecycle
rect rgb(248, 255, 248)
Note over Device,DataStore: 1. Power-On Registration
Device->>Service: POST /power_on (rich device data)
Service->>DataStore: Lookup device by MAC
alt Device Unknown
Service->>DataStore: Create device record
Service->>User: Notify new device found
else Device Known
Service->>DataStore: Update device status
end
Service->>Device: Configuration response
end
rect rgb(255, 248, 240)
Note over User,DataStore: 2. User Registration (Optional)
User->>Service: POST /setup/devices (name + preferences)
Service->>DataStore: Add user metadata to device
Service->>Device: Updated configuration (on next power_on)
end
rect rgb(240, 248, 255)
Note over Device,DataStore: 3. Ongoing Updates
Device->>Service: POST /power_on (status changes)
Service->>Service: Detect firmware/network changes
Service->>DataStore: Update device record
alt Migration Needed
Service->>Device: Migration instructions
Device->>Device: Apply configuration
Device->>Service: POST /power_on (confirm changes)
end
end
rect rgb(255, 248, 255)
Note over Service,User: 4. Remote Management
User->>Service: Management request (any location)
Service->>DataStore: Lookup device status
Service->>User: Current device state
Note over Service: No local network required
end
```
### Migration Strategy
#### Current Migration Flow Issues
- Requires `/info` endpoint access for device identification
- Must be on same network for configuration changes
- Limited to devices discoverable via UPnP/mDNS
#### Enhanced Migration with /power_on
1. **Device Identification**: Use MAC address from `/power_on` instead of IP-based `/info`
2. **Configuration Delivery**: Send migration instructions in `/power_on` response
3. **Status Confirmation**: Device confirms changes via subsequent `/power_on` requests
4. **Remote Capability**: Manage devices from any network location
```go
type PowerOnResponse struct {
ConfigurationUpdates []ConfigUpdate `json:"configuration_updates,omitempty"`
MigrationInstructions *Migration `json:"migration,omitempty"`
RegistrationRequired bool `json:"registration_required,omitempty"`
}
type Migration struct {
Method string `json:"method"` // xml, hosts, resolv_conf
TargetURL string `json:"target_url"`
ProxyURL string `json:"proxy_url,omitempty"`
Options map[string]string `json:"options"`
}
```
## Recommendations
### Immediate Actions (Phase 1)
1. **Enhance `/power_on` handler** to extract and store comprehensive device data
2. **Implement device lookup by MAC address** as primary identification method
3. **Create hybrid discovery system** using both `/power_on` and existing methods
4. **Add network-independent device management** capabilities
### Medium-term Improvements (Phase 2)
1. **Implement account-device MAC mapping** for automatic association
2. **Add IP geolocation** for regional settings inference
3. **Create device registration UI** optimized for `/power_on` discovered devices
4. **Enhance migration system** to use `/power_on` response mechanism
### Long-term Enhancements (Phase 3)
1. **Request firmware enhancement** to include missing data in `/power_on`
2. **Implement real-time device monitoring** via `/power_on` events
3. **Create centralized device management** independent of network topology
4. **Add predictive migration** based on device status patterns
### Risk Mitigation
- **Maintain backward compatibility** with existing discovery methods
- **Implement graceful fallbacks** when `/power_on` data is incomplete
- **Preserve existing user workflows** while adding enhanced capabilities
- **Add comprehensive logging** for troubleshooting hybrid approach
## Conclusion
The `/power_on` endpoint provides a significant opportunity to reduce network dependencies while enhancing device management capabilities. By implementing a hybrid approach that leverages `/power_on` data for primary device identification and status updates while maintaining existing registration workflows for user-controlled metadata, the system can achieve:
- **Network independence** for core device management
- **Enhanced real-time capabilities** through device-initiated communication
- **Improved scalability** across diverse network topologies
- **Better user experience** with automatic device discovery and status updates
The proposed implementation strategy provides a clear path to achieve these benefits while maintaining system reliability and user workflow compatibility.
+150
View File
@@ -0,0 +1,150 @@
# Device Lifecycle Analysis - Executive Summary
## Current State Assessment
The SoundTouch service currently relies heavily on local network connectivity for device discovery and management:
### ✅ Strengths
- **Comprehensive device data** through `/info` endpoint
- **Robust discovery** via UPnP/SSDP + mDNS
- **User-controlled registration** with friendly names
- **Complete device lifecycle management**
### ❌ Limitations
- **Network dependency**: Requires same network segment for discovery
- **Geographic constraints**: Service must be co-located with devices
- **Firewall/NAT issues**: Multicast protocols unreliable in complex networks
- **No remote management**: Cannot manage devices from external networks
## /power_on Enhancement Opportunity
The `/power_on` endpoint provides rich device data that could eliminate network dependencies:
### Current /power_on Data
```xml
<device-data>
<device id="A81B6A536A98"> <!-- ✅ Device MAC -->
<serialnumber>I6332527703739342000020</serialnumber> <!-- ✅ Serial -->
<firmware-version>27.0.6.46330.5043500...</firmware-version> <!-- ✅ FW -->
<product product_code="SoundTouch 10 sm2" type="5"> <!-- ✅ Model -->
<serialnumber>069231P63364828AE</serialnumber> <!-- ✅ Product Serial -->
</product>
</device>
<diagnostic-data>
<device-landscape>
<rssi>Excellent</rssi> <!-- ✅ Signal -->
<gateway-ip-address>192.168.178.1</gateway-ip-address> <!-- ✅ Network -->
<macaddresses> <!-- ✅ All MACs -->
<macaddress>A81B6A536A98</macaddress>
<macaddress>A81B6A849D99</macaddress>
</macaddresses>
<ip-address>192.168.178.35</ip-address> <!-- ✅ Current IP -->
<network-connection-type>Wireless</network-connection-type> <!-- ✅ Connection -->
</device-landscape>
</diagnostic-data>
</device-data>
```
### Missing Data Gaps
| Data | Current Source | Available in /power_on | Impact |
|------|----------------|----------------------|---------|
| **User-friendly name** | Registration | ❌ Missing | **High** - UI/UX |
| **Account association** | Registration | ❌ Missing | **Critical** - Authorization |
| **Service URLs** | `/info` | ❌ Missing | **High** - Migration |
| **Regional settings** | `/info` | ❌ Missing | **Medium** - Localization |
## Recommended Implementation Strategy
### Phase 1: Hybrid Enhancement (Immediate)
- **Enhance `/power_on` handler** to process full device data
- **Implement MAC-based device lookup** for identification
- **Maintain existing registration flow** for user metadata
- **Add network-independent capabilities** as primary features
```go
// Enhanced flow
Device -> POST /power_on -> Service identifies by MAC -> Update/Create device record
```
### Phase 2: Gap Resolution (Short-term)
- **Account-device MAC mapping** for automatic association
- **IP geolocation** for regional settings inference
- **Registration UI optimization** for /power_on discovered devices
- **Migration via response payload** instead of direct device access
### Phase 3: Full Network Independence (Medium-term)
- **Centralized device management** across multiple networks
- **Real-time device monitoring** via /power_on events
- **Predictive migration** based on device status patterns
- **Enhanced firmware integration** with additional /power_on data
## Key Benefits
### ✅ Immediate Gains
- **Network independence**: Manage devices from any location
- **Real-time updates**: Device-initiated status reporting
- **Enhanced diagnostics**: Signal strength, connection type, network status
- **Simplified deployment**: No multicast/broadcast requirements
### ✅ Long-term Advantages
- **Scalable architecture**: Centralized management across sites
- **Improved reliability**: Eliminates discovery protocol dependencies
- **Better user experience**: Automatic device detection and status
- **Future-proof design**: Device-driven communication model
## Implementation Approach
### Hybrid Strategy
```mermaid
graph TD
PowerOn[Device /power_on] --> Identify[MAC-based Identification]
Identify --> New{New Device?}
New -->|Yes| Create[Create Device Record]
New -->|No| Update[Update Existing Record]
Create --> CheckAccount{Account Known?}
CheckAccount -->|No| RegisterFlow[Trigger Registration]
CheckAccount -->|Yes| LinkAccount[Link to Account]
Update --> DetectChanges[Detect Changes]
DetectChanges --> Migration{Migration Needed?}
Migration -->|Yes| SendInstructions[Send Migration Instructions]
LinkAccount --> Response[Send Configuration Response]
SendInstructions --> Response
RegisterFlow --> Response
```
### Risk Mitigation
- **Maintain backward compatibility** with existing discovery
- **Graceful fallbacks** when /power_on data incomplete
- **Preserve user workflows** while adding enhanced capabilities
- **Comprehensive logging** for troubleshooting
## Success Metrics
### Technical Metrics
- **Network independence**: % of operations not requiring local network
- **Real-time capability**: Power-on event processing latency < 2s
- **Data completeness**: % of devices with full metadata via /power_on
- **Migration success**: % of successful remote migrations
### User Experience Metrics
- **Discovery reliability**: % of devices automatically detected
- **Setup time**: Time from device power-on to full management
- **Management accessibility**: % of operations available remotely
- **Error reduction**: Decrease in network-related issues
## Conclusion
The `/power_on` enhancement represents a strategic opportunity to:
1. **Eliminate network dependencies** while maintaining full functionality
2. **Enable remote device management** across diverse network topologies
3. **Improve user experience** through automatic device detection
4. **Future-proof the architecture** for scalable device management
**Recommendation**: Proceed with hybrid implementation approach, prioritizing network independence while preserving existing user workflows and system reliability.
**Timeline**: Phase 1 implementation feasible within 2-3 sprints, with Phases 2-3 extending capabilities based on user feedback and firmware enhancement opportunities.
+222
View File
@@ -0,0 +1,222 @@
# Migration Flow Diagrams
This document specifies the diagrams needed for the migration guide, with descriptions that can be used to create actual visual diagrams.
## 1. Overall Migration Process Flow
### Description
A flowchart showing the complete migration journey from start to finish.
### Elements
```
[Start] → [Install SoundTouch Service] → [Create Account] → [Prepare Devices]
[Enable Remote Services] → [Discover Devices] → [Register Devices]
[Start Migration] → [Data Collection Phase] → [Testing Phase] → [Full Local Phase]
[Verify Migration] → [Complete] → [Post-Migration Setup]
```
### Decision Points
- Multiple devices? → Repeat device steps
- Migration issues? → Rollback option
- All devices complete? → Account fully migrated
### Color Coding
- **Blue**: Service setup steps
- **Green**: Successful completion states
- **Orange**: In-progress/testing states
- **Red**: Error handling/rollback paths
- **Gray**: Optional steps
## 2. Network Topology Diagram
### Description
Shows the network layout with Raspberry Pi, router, and SoundTouch devices.
### Components
```
Internet Cloud
↑↓ (Optional - during migration)
Home Router (192.168.1.1)
├── Raspberry Pi (192.168.1.10) [SoundTouch Service]
├── Living Room Speaker (192.168.1.100)
├── Kitchen Speaker (192.168.1.101)
├── Bedroom Speaker (192.168.1.102)
└── Office Speaker (192.168.1.103)
```
### Connections
- **Solid lines**: Active connections
- **Dashed lines**: Migration-phase connections to Bose cloud
- **Thick lines**: Primary data flow to local service
## 3. Device State Lifecycle
### Description
State machine showing device progression through migration phases.
### States and Transitions
```
[Unregistered] → [Discovered] → [Registered] → [Migrating]
[Active - Local Only] ← [Active - Testing] ← [Active - Data Collection]
↑ ↓
[Error/Rollback] ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← ← [Migration Failed]
```
### State Descriptions
- **Unregistered**: Device not known to service
- **Discovered**: Found on network, remote services enabled
- **Registered**: Added to account, ready for migration
- **Migrating - Data Collection**: Building local database
- **Migrating - Testing**: Using local service with fallback
- **Active - Local Only**: Full independence achieved
- **Error/Rollback**: Issues detected, can revert to Bose
## 4. Data Flow During Migration
### Description
Shows how data flows between components during different migration phases.
### Phase 1 - Data Collection
```
SoundTouch Device → Bose Cloud Services
↓ (mirror)
Local Service (collecting data)
```
### Phase 2 - Testing
```
SoundTouch Device ↔ Local Service (primary)
↕ (fallback when needed)
Bose Cloud Services
```
### Phase 3 - Full Local
```
SoundTouch Device ↔ Local Service (only)
Bose Cloud Services (disconnected)
```
### Data Types
- **Presets**: Station favorites and custom sources
- **Recents**: Play history and recently accessed content
- **Sources**: Configured music services (Spotify, etc.)
- **Device Config**: Network settings, capabilities, metadata
## 5. Migration Timeline Visualization
### Description
Gantt-chart style timeline showing typical migration schedule.
### Timeline (7-day example)
```
Day 1-2: Data Collection Phase
████████████████████████████████████████
Day 3-4: Data Validation
████████████████████████████
Day 5-6: Testing Phase
████████████████████████
Day 7+: Full Local Operation
████████████████████████→
```
### Parallel Activities
- Multiple devices can be in different phases
- Service continues operating throughout
- User can interact normally during process
## 6. Service Architecture Overview
### Description
High-level architecture showing enhanced SoundTouch service components.
### Components
```
Web Dashboard ← → HTTP API ← → REST Endpoints
↑ ↑ ↑
└─── User ──────┼──── Devices ─┘
Service Core
├── Account Manager
├── Device Lifecycle
├── Event Processor
├── Migration Controller
└── Data Store
File System Storage
├── accounts/
├── devices/
├── sessions/ (existing)
└── system/
```
### External Integrations
- **Bose Cloud** (during migration)
- **Music Services** (Spotify, TuneIn, etc.)
- **Discovery Services** (mDNS, UPnP)
## 7. Error Handling and Rollback Flow
### Description
Decision tree for handling migration issues and rollback scenarios.
### Error Detection
```
Migration Issue Detected
├── Device Unresponsive → Retry → Success/Rollback
├── Data Corruption → Restore from Backup → Continue/Rollback
├── Service Unavailable → Wait/Restart → Continue/Rollback
└── User Dissatisfaction → Manual Rollback → Restore Bose Config
```
### Rollback Process
```
[Rollback Initiated]
[Disable Local Services]
[Restore Original Device Config]
[Re-enable Bose Services]
[Verify Functionality]
[Rollback Complete]
```
## Implementation Notes
### For Diagram Creation
1. Use consistent colors as specified in main color scheme
2. Include clear labels for all components
3. Show directional flow with appropriate arrows
4. Use standard flowchart symbols where applicable
5. Ensure text is readable at various sizes
### Tools Recommended
- **Lucidchart**: Professional flowcharts and network diagrams
- **Draw.io**: Free online diagram tool
- **Miro**: Collaborative whiteboarding
- **PlantUML**: Code-based diagram generation
### File Naming Convention
- `migration-flow-overview.svg` - Overall process flow
- `network-topology.svg` - Network layout
- `device-lifecycle.svg` - State machine
- `data-flow-phases.svg` - Data flow during migration
- `migration-timeline.svg` - Timeline visualization
- `service-architecture.svg` - System architecture
- `error-rollback-flow.svg` - Error handling
### Accessibility
- Include alt-text descriptions
- Use patterns/textures in addition to colors
- Ensure sufficient contrast
- Provide text-based versions for screen readers
+753
View File
@@ -0,0 +1,753 @@
# IoT Implementation Guide
## Overview
This guide provides technical implementation details for integrating with the Bose SoundTouch IoT configuration system. It covers the AWS IoT Core integration, certificate management, and device shadow operations.
## Prerequisites
- AWS IoT Core account and permissions
- Understanding of MQTT protocol
- Knowledge of X.509 certificate management
- Familiarity with JSON and protobuf serialization
## Architecture Components
### Core System Design
```
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Mobile App │ │ Alexa Voice │ │ Web Interface │
│ │ │ Assistant │ │ │
└─────────┬───────┘ └─────────┬────────┘ └─────────┬───────┘
│ │ │
└──────────────────────┼───────────────────────┘
┌────────────▼──────────────┐
│ AWS IoT Core │
│ (MQTT Broker + │
│ Device Shadows) │
└────────────┬──────────────┘
│ MQTT/TLS
┌────────────▼──────────────┐
│ SoundTouch Device │
│ │
│ ┌─────────────────────┐ │
│ │ IoT Service │ │
│ │ (/opt/Bose/IoT) │ │
│ └─────────────────────┘ │
│ ┌─────────────────────┐ │
│ │ BoseApp Service │ │
│ │ (/opt/Bose/BoseApp) │ │
│ └─────────────────────┘ │
└───────────────────────────┘
```
### Configuration Flow
```
1. Device Boot
2. Read IoT.xml (/mnt/nv/BoseApp-Persistence/1/IoT.xml)
3. Load Certificates (/mnt/nv/IoTCerts/)
4. Establish MQTT/TLS Connection
5. Subscribe to Device Shadow Topics
6. Publish Current Device State
7. Listen for Delta Messages
```
## Implementation Details
### 1. Configuration File Management
#### IoT.xml Structure
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<Configuration
clientID="{device-unique-uuid}"
iotEndpoint="{aws-iot-endpoint}"
deployment="{PROD|DEV|TEST}" />
```
#### Loading Configuration (C++ Implementation)
```cpp
#include <rapidxml/rapidxml.hpp>
#include <fstream>
struct IoTConfig {
std::string clientID;
std::string iotEndpoint;
std::string deployment;
};
IoTConfig loadIoTConfig(const std::string& configPath) {
std::ifstream file(configPath);
std::string content((std::istreambuf_iterator<char>(file)),
std::istreambuf_iterator<char>());
rapidxml::xml_document<> doc;
doc.parse<0>(&content[0]);
auto configNode = doc.first_node("Configuration");
IoTConfig config;
config.clientID = configNode->first_attribute("clientID")->value();
config.iotEndpoint = configNode->first_attribute("iotEndpoint")->value();
config.deployment = configNode->first_attribute("deployment")->value();
return config;
}
```
### 2. Certificate Management
#### Certificate Files Structure
```
/mnt/nv/IoTCerts/
├── iot-cert.pem.crt # Device client certificate
├── iot-private.pem.key # Device private key
└── default.pem # Additional cert data
/var/lib/iot/
└── rootCA.crt # AWS IoT Root CA
```
#### Certificate Registration Process
```cpp
#include <openssl/x509.h>
#include <openssl/rsa.h>
#include <openssl/pem.h>
class IoTCertificateManager {
private:
static const std::string CERT_ENDPOINT;
static const std::string CERT_PATH;
static const std::string KEY_PATH;
public:
bool generateCSR() {
// Generate EC key pair
EC_KEY* eckey = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
EC_KEY_generate_key(eckey);
// Create certificate request
X509_REQ* req = X509_REQ_new();
X509_REQ_set_version(req, 0);
// Set subject name
X509_NAME* name = X509_NAME_new();
X509_NAME_add_entry_by_txt(name, "CN", MBSTRING_ASC,
(unsigned char*)clientID.c_str(), -1, -1, 0);
X509_REQ_set_subject_name(req, name);
// Set public key
EVP_PKEY* pkey = EVP_PKEY_new();
EVP_PKEY_set1_EC_KEY(pkey, eckey);
X509_REQ_set_pubkey(req, pkey);
// Sign request
X509_REQ_sign(req, pkey, EVP_sha256());
return sendCSRToEndpoint(req, pkey);
}
bool sendCSRToEndpoint(X509_REQ* req, EVP_PKEY* pkey) {
// Send CSR to voice.api.bose.io/alexa/certificate
// Receive certificate response
// Store certificate and private key
return true;
}
};
const std::string IoTCertificateManager::CERT_ENDPOINT =
"https://voice.api.bose.io/alexa/certificate";
const std::string IoTCertificateManager::CERT_PATH =
"/mnt/nv/IoTCerts/iot-cert.pem.crt";
const std::string IoTCertificateManager::KEY_PATH =
"/mnt/nv/IoTCerts/iot-private.pem.key";
```
### 3. MQTT Connection Implementation
#### AWS IoT SDK Integration
```cpp
#include <aws/iot/MqttClient.h>
#include <aws/iot/ShadowClient.h>
class IoTConnectionManager {
private:
std::unique_ptr<awsiotsdk::MqttClient> mqttClient;
std::unique_ptr<awsiotsdk::Shadow> shadowClient;
IoTConfig config;
public:
awsiotsdk::ResponseCode connect() {
// Setup connection parameters
std::string endpoint = config.iotEndpoint;
uint16_t port = 8883; // MQTT over SSL
// Load certificates
std::string certPath = "/mnt/nv/IoTCerts/iot-cert.pem.crt";
std::string keyPath = "/mnt/nv/IoTCerts/iot-private.pem.key";
std::string rootCaPath = "/var/lib/iot/rootCA.crt";
// Create network connection
auto networkConnection = std::make_shared<awsiotsdk::network::MbedTLSConnection>(
endpoint, port, rootCaPath, certPath, keyPath
);
// Create MQTT client
mqttClient = awsiotsdk::MqttClient::Create(networkConnection);
if (!mqttClient) {
return awsiotsdk::ResponseCode::FAILURE;
}
// Connect with client ID
auto connectPacket = awsiotsdk::mqtt::ConnectPacket::Create(
config.clientID,
true, // cleanSession
awsiotsdk::mqtt::QoS::QOS0,
nullptr // will options
);
return mqttClient->Connect(std::chrono::milliseconds(5000), connectPacket);
}
awsiotsdk::ResponseCode initializeShadow() {
shadowClient = awsiotsdk::Shadow::Create(mqttClient);
if (!shadowClient) {
return awsiotsdk::ResponseCode::FAILURE;
}
// Subscribe to shadow delta
auto deltaHandler = [this](const std::string& thingName,
const std::string& payload) {
handleShadowDelta(thingName, payload);
};
return shadowClient->PerformUpdateAsync(
config.clientID,
"", // jsonString
deltaHandler,
std::chrono::seconds(10)
);
}
};
```
### 4. Device Shadow Operations
#### Shadow Message Structures
```cpp
#include <rapidjson/document.h>
#include <rapidjson/writer.h>
#include <rapidjson/stringbuffer.h>
struct DeviceState {
std::string deviceState; // "CONNECTED" | "DISCONNECTED"
std::string powerState; // "ON" | "OFF"
std::string zoneState; // Zone configuration
std::string groupState; // Multi-room group info
};
class ShadowMessageBuilder {
public:
static std::string createReportedState(const DeviceState& state) {
rapidjson::Document doc;
doc.SetObject();
auto& allocator = doc.GetAllocator();
// Create state object
rapidjson::Value stateObj(rapidjson::kObjectType);
rapidjson::Value reportedObj(rapidjson::kObjectType);
// Add reported state fields
reportedObj.AddMember("deviceState",
rapidjson::Value(state.deviceState.c_str(), allocator),
allocator);
reportedObj.AddMember("powerState",
rapidjson::Value(state.powerState.c_str(), allocator),
allocator);
reportedObj.AddMember("zoneState",
rapidjson::Value(state.zoneState.c_str(), allocator),
allocator);
reportedObj.AddMember("groupState",
rapidjson::Value(state.groupState.c_str(), allocator),
allocator);
stateObj.AddMember("reported", reportedObj, allocator);
doc.AddMember("state", stateObj, allocator);
// Serialize to string
rapidjson::StringBuffer buffer;
rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
doc.Accept(writer);
return buffer.GetString();
}
static DeviceState parseDesiredState(const std::string& json) {
rapidjson::Document doc;
doc.Parse(json.c_str());
DeviceState state;
if (doc.HasMember("state") && doc["state"].HasMember("desired")) {
auto& desired = doc["state"]["desired"];
if (desired.HasMember("powerState")) {
state.powerState = desired["powerState"].GetString();
}
if (desired.HasMember("zoneState")) {
state.zoneState = desired["zoneState"].GetString();
}
if (desired.HasMember("groupState")) {
state.groupState = desired["groupState"].GetString();
}
}
return state;
}
};
```
#### Shadow Update Implementation
```cpp
class IoTShadowManager {
private:
std::shared_ptr<awsiotsdk::Shadow> shadowClient;
std::string thingName;
DeviceState currentState;
public:
awsiotsdk::ResponseCode updateDeviceState(const DeviceState& newState) {
currentState = newState;
std::string payload = ShadowMessageBuilder::createReportedState(newState);
auto responseHandler = [](const std::string& thingName,
awsiotsdk::ShadowRequestType requestType,
awsiotsdk::ShadowResponseType responseType,
rapidjson::Document& payload) {
if (responseType == awsiotsdk::ShadowResponseType::Accepted) {
// Shadow update successful
std::cout << "Shadow updated successfully" << std::endl;
} else {
// Handle rejection
std::cout << "Shadow update rejected" << std::endl;
}
};
return shadowClient->PerformUpdateAsync(
thingName,
payload,
responseHandler,
std::chrono::seconds(10)
);
}
void handleShadowDelta(const std::string& thingName,
const std::string& payload) {
DeviceState desiredState = ShadowMessageBuilder::parseDesiredState(payload);
// Apply desired state changes to device
if (!desiredState.powerState.empty()) {
applyPowerStateChange(desiredState.powerState);
}
if (!desiredState.zoneState.empty()) {
applyZoneStateChange(desiredState.zoneState);
}
if (!desiredState.groupState.empty()) {
applyGroupStateChange(desiredState.groupState);
}
// Report updated state back to shadow
updateDeviceState(currentState);
}
};
```
### 5. Service Integration
#### Shepherd Service Configuration
```xml
<!-- /opt/Bose/etc/Shepherd-noncore.xml -->
<ShepherdConfig>
<daemon name="STSCertified"/>
<daemon name="IoT">
<env name="IOT_CONFIG_PATH">/mnt/nv/BoseApp-Persistence/1/IoT.xml</env>
<env name="IOT_CERT_PATH">/mnt/nv/IoTCerts</env>
</daemon>
<daemon name="TPDA">
<arg>-c</arg>
<arg>/opt/Bose/etc/Voice.xml</arg>
</daemon>
</ShepherdConfig>
```
#### System Startup Integration
```bash
#!/bin/bash
# /etc/init.d/SoundTouch fragment
# Create IoT directories
mkdir -p /mnt/nv/BoseLog /mnt/nv/IoTCerts /mnt/nv/BoseApp-Persistence/1
mkdir -m 700 -p /mnt/nv/BoseApp-Persistence/1/Keys
# Set proper permissions for certificate storage
chmod 700 /mnt/nv/IoTCerts
chown iot:iot /mnt/nv/IoTCerts
# Start shepherd daemon manager
shepherdd --config-dir /opt/Bose/etc --run-dir /var/run/shepherd
```
## Error Handling and Debugging
### Connection Retry Logic
```cpp
class ConnectionRetryManager {
private:
int maxRetries = 10;
int retryDelaySeconds = 5;
public:
awsiotsdk::ResponseCode connectWithRetry(IoTConnectionManager& manager) {
for (int attempt = 1; attempt <= maxRetries; ++attempt) {
std::cout << "Connection attempt " << attempt
<< " to MQTT port at host " << config.iotEndpoint << std::endl;
auto result = manager.connect();
if (result == awsiotsdk::ResponseCode::SUCCESS) {
std::cout << "Successfully connected to MQTT server" << std::endl;
return result;
}
std::cout << "MQTT port not available. Retrying in "
<< retryDelaySeconds << " seconds" << std::endl;
std::this_thread::sleep_for(std::chrono::seconds(retryDelaySeconds));
retryDelaySeconds *= 2; // Exponential backoff
}
std::cerr << "Failed to connect after " << maxRetries << " attempts" << std::endl;
return awsiotsdk::ResponseCode::FAILURE;
}
};
```
### Logging and Monitoring
```cpp
class IoTLogger {
public:
static void logConnectionStatus(const std::string& status) {
std::cout << "[IoT] Connection status: " << status << std::endl;
}
static void logShadowResponse(awsiotsdk::ShadowResponseType response,
const std::string& payload) {
if (response == awsiotsdk::ShadowResponseType::Accepted) {
std::cout << "[IoT] Shadow response: accepted. Payload: " << payload << std::endl;
} else {
std::cout << "[IoT] Shadow response: rejected" << std::endl;
}
}
static void logCertificateStatus(bool success) {
if (success) {
std::cout << "[IoT] Certificate generated successfully" << std::endl;
} else {
std::cerr << "[IoT] Failed to generate iot certificate" << std::endl;
}
}
};
```
## Testing and Validation
### Unit Test Example
```cpp
#include <gtest/gtest.h>
class IoTConfigTest : public ::testing::Test {
protected:
void SetUp() override {
// Create test configuration file
std::ofstream file("/tmp/test_iot.xml");
file << R"(<?xml version="1.0" encoding="UTF-8" ?>
<Configuration clientID="test-client-id"
iotEndpoint="test.iot.amazonaws.com"
deployment="TEST" />)";
file.close();
}
};
TEST_F(IoTConfigTest, LoadConfiguration) {
auto config = loadIoTConfig("/tmp/test_iot.xml");
EXPECT_EQ(config.clientID, "test-client-id");
EXPECT_EQ(config.iotEndpoint, "test.iot.amazonaws.com");
EXPECT_EQ(config.deployment, "TEST");
}
TEST_F(IoTConfigTest, ShadowMessageBuilder) {
DeviceState state;
state.deviceState = "CONNECTED";
state.powerState = "ON";
std::string json = ShadowMessageBuilder::createReportedState(state);
// Verify JSON contains expected fields
EXPECT_TRUE(json.find("\"deviceState\":\"CONNECTED\"") != std::string::npos);
EXPECT_TRUE(json.find("\"powerState\":\"ON\"") != std::string::npos);
}
```
## Security Best Practices
1. **Certificate Management**
- Store private keys with 600 permissions
- Rotate certificates regularly
- Use hardware security modules when available
2. **Network Security**
- Always use TLS 1.2 or higher
- Validate certificate chains
- Implement certificate pinning
3. **Configuration Security**
- Encrypt sensitive configuration data
- Use secure storage for credentials
- Implement configuration validation
## Troubleshooting Common Issues
### Certificate Problems
```bash
# Check certificate validity
openssl x509 -in /mnt/nv/IoTCerts/iot-cert.pem.crt -text -noout
# Verify private key matches certificate
openssl x509 -noout -modulus -in /mnt/nv/IoTCerts/iot-cert.pem.crt | openssl md5
openssl rsa -noout -modulus -in /mnt/nv/IoTCerts/iot-private.pem.key | openssl md5
```
### Connection Issues
```bash
# Test MQTT connectivity
mosquitto_pub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
-p 8883 --cafile /var/lib/iot/rootCA.crt \
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
--key /mnt/nv/IoTCerts/iot-private.pem.key \
-t '$aws/things/test/shadow/update' \
-m '{"state":{"reported":{"test":"value"}}}'
```
### Service Debugging
```bash
# Check service status
ps aux | grep IoT
# Monitor system logs
tail -f /mnt/nv/BoseLog/IoT.log
# Check Shepherd status
shepherdd --status
```
## MQTT Monitoring and Research
### Direct Device Credential Access
With device certificates and private keys available from firmware backups, it's technically possible to monitor MQTT traffic:
```bash
# Subscribe to your device's shadow events only
CLIENT_ID="577ecfcc-2db3-4989-92c9-76d7704f9fb3" # Your device's UUID
mosquitto_sub -h a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com \
-p 8883 --cafile /var/lib/iot/rootCA.crt \
--cert /mnt/nv/IoTCerts/iot-cert.pem.crt \
--key /mnt/nv/IoTCerts/iot-private.pem.key \
-t "\$aws/things/$CLIENT_ID/shadow/update/accepted"
```
### Security Constraints and Limitations
#### AWS IoT Policy Restrictions
Device certificates are bound to restrictive policies:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "iot:Connect",
"Resource": "arn:aws:iot:us-east-1:*:client/${iot:ClientId}"
},
{
"Effect": "Allow",
"Action": ["iot:Publish", "iot:Subscribe", "iot:Receive"],
"Resource": [
"arn:aws:iot:us-east-1:*:topic/$aws/things/${iot:ClientId}/shadow/*"
]
}
]
}
```
**Limitations:**
- Access only to your specific device topics
- No wildcard subscriptions (`+` or `#`)
- No cross-device monitoring
- Potential IP geolocation restrictions
- Certificate revocation for unusual activity
### Alternative Monitoring Approaches
#### Network Traffic Capture (Recommended)
```bash
# Capture MQTT traffic patterns without authentication
tcpdump -i eth0 -s0 -w soundtouch_iot.pcap host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com
# Monitor connection patterns in real-time
tcpdump -i eth0 -n -A "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com and port 8883"
# Extract timing and packet size information
tcpdump -i eth0 -ttt -s0 "host a2bhvr9c4wn4ya.iot.us-east-1.amazonaws.com"
```
#### Local MQTT Broker for Testing
```bash
# Set up local Mosquitto broker
sudo apt-get install mosquitto mosquitto-clients
# Configure TLS (optional)
cat > /etc/mosquitto/conf.d/tls.conf << EOF
port 8883
cafile /path/to/ca.crt
certfile /path/to/server.crt
keyfile /path/to/server.key
require_certificate true
use_identity_as_username true
EOF
# Test local shadow operations
mosquitto_pub -h localhost -p 8883 \
-t '$aws/things/test-device/shadow/update' \
-m '{"state":{"reported":{"deviceState":"CONNECTED"}}}'
```
### Message Analysis and Documentation
Expected shadow message patterns:
```cpp
// Power state transitions
{
"state": {
"reported": {
"deviceState": "CONNECTED",
"powerState": "ON|OFF"
}
},
"timestamp": 1703875200
}
// Audio control updates
{
"state": {
"reported": {
"volume": 25,
"muted": false,
"source": "SPOTIFY"
}
}
}
// Multi-room coordination
{
"state": {
"reported": {
"zoneState": "master|slave",
"groupMembers": ["device1", "device2"],
"groupName": "Living Room"
}
}
}
```
### Legal and Ethical Guidelines
**Important Warnings:**
- Only monitor devices you personally own
- Using device credentials outside the device may violate Bose Terms of Service
- Accessing Bose's AWS infrastructure could be considered unauthorized
- Certificate abuse may result in device blacklisting
- Service shutdown in May 2026 makes this a temporary research opportunity
**Recommended Usage:**
- Document message formats for local alternative development
- Understand state transition patterns
- Test compatibility with local MQTT brokers
- Prepare migration strategies before cloud shutdown
### Research Implementation Example
```cpp
class IoTResearchMonitor {
private:
std::string deviceClientId;
std::ofstream messageLog;
public:
void captureMessagePatterns() {
// Subscribe only to owned device topics
std::string topic = "$aws/things/" + deviceClientId + "/shadow/update/accepted";
auto messageHandler = [this](const std::string& topic, const std::string& payload) {
// Log message structure for analysis
messageLog << "Topic: " << topic << std::endl;
messageLog << "Payload: " << payload << std::endl;
messageLog << "Timestamp: " << getCurrentTimestamp() << std::endl;
messageLog << "---" << std::endl;
// Parse and document state transitions
documentStateTransition(payload);
};
// WARNING: Only use with your own device certificates
connectToAWSIoT(messageHandler);
}
void documentStateTransition(const std::string& json) {
// Analyze JSON structure for local implementation
rapidjson::Document doc;
doc.Parse(json.c_str());
if (doc.HasMember("state") && doc["state"].HasMember("reported")) {
// Document field types and value ranges
auto& reported = doc["state"]["reported"];
for (auto& field : reported.GetObject()) {
std::cout << "Field: " << field.name.GetString()
<< ", Type: " << getJSONType(field.value) << std::endl;
}
}
}
};
```
This implementation guide provides the foundation for integrating with the Bose SoundTouch IoT system using AWS IoT Core, certificate-based authentication, and device shadow operations. The monitoring capabilities should be used responsibly and only for research purposes to develop local alternatives.
+418
View File
@@ -0,0 +1,418 @@
# THIS IS A PLANNED TO BE THE MIGRATION GUIDE
> This migration guide is not finalized, yet.
> We're using it as an orientation for the required implementation.
---
# Complete Migration Guide - From Bose Cloud to Local SoundTouch Service
## Overview
This guide will walk you through migrating your Bose SoundTouch speakers from Bose's cloud services to AfterTouch, your own local SoundTouch service. By the end of this process, your speakers will be completely independent of Bose's servers while retaining all their functionality.
> **💡 Why Migrate?** Bose announced the shutdown of their SoundTouch cloud services in May 2026. This migration ensures your speakers continue working indefinitely with enhanced local control and monitoring.
## What You'll Need
### Hardware Requirements
- **Raspberry Pi 4 or similar** (minimum: Raspberry Pi Zero 2W)
- **MicroSD card** (16GB or larger)
- **USB drive** (for device preparation)
- **Network connection** for your Raspberry Pi
### Before You Start
- **List all your SoundTouch devices** and their current locations
- **Note your current presets and favorites** (they will be preserved)
- **Ensure devices are on the same network** as your future SoundTouch service
- **Basic computer skills** (following instructions, using a web browser)
### Time Estimate
- **Setup**: 30-60 minutes for the service installation
- **Per Device**: 10-15 minutes for each speaker migration
- **Total**: 1-3 hours depending on number of devices
## Step 1: Install SoundTouch Service
### Option A: Raspberry Pi Installation (Recommended)
#### 1.1 Prepare Your Raspberry Pi
1. **Flash Raspberry Pi OS** to your SD card using Raspberry Pi Imager (see the raspberrypi.com documentation)
2. **Enable SSH** during imaging or create an empty `ssh` file on the boot partition
3. **Boot your Pi** and connect it to your network
4. **Find your Pi's IP address** (check your router or use `ping raspberrypi.local`)
#### 1.2 Install SoundTouch Service
Connect to your Pi via SSH and run:
```bash
# Download and install
curl -sSL https://github.com/gesellix/Bose-SoundTouch/releases/latest/download/install.sh | bash
# Start the service
sudo systemctl enable soundtouch-service
sudo systemctl start soundtouch-service
```
#### 1.3 Verify Installation
1. Open your web browser
2. Go to `http://[PI_IP_ADDRESS]:8000` (replace with your Pi's IP)
3. You should see the **SoundTouch Service Dashboard**
![SoundTouch Service Dashboard](../images/dashboard-home.png)
*Example: SoundTouch Service main dashboard*
### Option B: Docker Installation
If you prefer Docker, run:
```bash
docker run -d \
--name soundtouch-service \
--restart unless-stopped \
-p 8000:8000 \
-p 8443:8443 \
-v soundtouch-data:/data \
gesellix/soundtouch-service:latest
```
## Step 2: Create Your Account
### 2.1 Initial Setup
1. **Open the dashboard** at `http://[SERVICE_IP]:8000`
2. Click **"Create New Account"**
3. **Fill in your details**:
- Account Name: `My Home Audio`
- Email: `your@email.com` (optional, for notifications)
- Migration Strategy: `Gradual` (recommended)
![Account Creation](../images/account-creation.png)
*Example: Account creation form*
### 2.2 Account Configuration
After creation, you'll see your **Account Dashboard**:
- **Account ID**: Unique identifier (e.g., `acc_home_audio_001`)
- **Status**: `Active - Ready for Migration`
- **Device Count**: Initially 0
- **Migration Status**: `Prepared`
![Account Dashboard](../images/account-dashboard.png)
*Example: Fresh account dashboard ready for device migration*
### 2.3 Initial Settings
Once your account is created, configure the global settings:
1. **Settings**:
- Check **Target Domain**: Ensure it's reachable from the speaker (e.g., `soundtouch.fritz.box`).
- **DNS Discovery**: Enable DNS discovery on port `:53`. This is crucial for the DNS hook migration method.
2. **Devices**:
- Go to the **"Device Discovery"** tab.
- Click **"Scan Network"** or manually add a speaker via IP address.
- Your devices should appear with **SSH Status**: `Enabled`.
![Device Discovery](../images/device-discovery.png)
*Example: Discovered devices with remote access enabled*
## Step 3: Prepare Your Devices
> **⚠️ Important**: This step temporarily enables SSH access on your speakers. SSH will be automatically disabled after migration unless you choose to keep it enabled.
### 3.1 Enable Remote Services
For each SoundTouch device:
1. **Prepare a USB drive**:
- Format as FAT32
- Create an empty file named `remote_services` (no extension)
- (Optional) Firmware update/reset, see [Bose SoundTouch USB Update](https://downloads.bose.com/ced/soundtouch/soundtouch_usb/index.html)
2. **Insert USB drive** into your SoundTouch speaker
3. **Power cycle** the device (unplug for 10 seconds, then reconnect)
![USB Preparation](../images/usb-remote-services.png)
*Example: USB drive setup for enabling remote services*
## Step 4: Discover and Register Devices
### 4.1 Automatic Discovery
The service automatically scans for SoundTouch devices every 5 minutes. To trigger immediate discovery:
1. **Dashboard****"Devices"** → **"Discover Devices"**
2. **Wait 30-60 seconds** for scan completion
3. **Review discovered devices** in the list
### 4.2 Register Devices to Your Account
For each discovered device:
1. **Click device name** in the discovery list
2. **Verify device information**:
- Name: `Living Room Speaker`
- Model: `SoundTouch 30`
- MAC Address: `A8:1B:6A:53:6A:98`
- IP Address: `192.168.1.100`
- Status: `Discovered - Ready for Registration`
3. **Click "Register to Account"**
4. **Choose registration type**:
- **Fresh Setup**: For new or factory-reset devices
- **Migrate from Bose**: For devices with existing Bose account (recommended)
![Device Registration](../images/device-registration.png)
*Example: Device registration dialog with migration options*
### 4.3 Device Registration Results
After registration, you'll see:
- **Device Status**: `Registered - Active`
- **Account Association**: Your account name
- **Lifecycle State**: `Active`
- **Data Sources**: `Mirror Primary` (initially uses Bose, falls back to local)
## Step 5: Migrate Individual Devices
### 5.1 Step 3: Data Sync
1. **Dashboard****"Devices"** → Select your device
2. Click **"Data Sync"**
3. This fetches configuration (presets, recents, sources) from the speaker to the SoundTouch service.
### 5.2 Step 4: Migration
Once data is synced, proceed to the migration tab for the device:
1. **Backup XML**: Create an off-device backup of the current configuration.
2. **Enable Persistent Remote Service**: This ensures SSH remains available after reboots.
- *Note*: If you see `'rw: command not found'`, you can safely ignore it.
3. **CA Certificate Configuration**:
- **Test with explicit CA**: Verify the speaker can communicate using the local CA.
- **Trust CA now**: Inject the local Root CA into the speaker's trust store.
- **Test with shared trust store**: Verify general HTTPS communication.
4. **Migration Method**:
- Select **"Redirect via DNS hook"**.
- **Test DNS Redirection**: Ensure the speaker correctly resolves the service domain.
5. **Confirm Migration**: Apply the final changes to the speaker.
#### Example Migration Output:
```text
Successfully created off-device backup of current configuration.
Pre-flight: Write access verified.
Resolved soundtouch.fritz.box to 192.168.1.100
Uploaded /mnt/nv/soundtouch-service/aftertouch.resolv.conf
/mnt/nv/rc.local already contains Aftertouch hook logic
(rw || mount -o remount,rw /): sh: rw: command not found
cp /etc/udhcpc.d/50default /etc/udhcpc.d/50default.original:
Applied patch to /etc/udhcpc.d/50default
Verified patch on /etc/udhcpc.d/50default
cp /opt/Bose/udhcpc.script /opt/Bose/udhcpc.script.original:
Applied patch to /opt/Bose/udhcpc.script
Verified patch on /opt/Bose/udhcpc.script
CA certificate already trusted, skipping injection
```
## Step 7: Complete Account Migration
### 7.1 Migrate All Devices
Repeat the migration process for each of your SoundTouch devices. You can migrate multiple devices simultaneously, but we recommend doing 1-2 at a time to monitor progress.
**Migration Dashboard** shows overall progress:
- **Devices Migrated**: `2 of 4 completed`
- **Currently Migrating**: `Living Room Speaker, Kitchen Speaker`
- **Pending Migration**: `Bedroom Speaker, Office Speaker`
- **Estimated Completion**: `3 days remaining`
![Account Migration Status](../images/account-migration.png)
*Example: Account-wide migration progress*
### 7.2 Verify Complete Migration
When all devices are migrated:
1. **Account Status**: `Active - Fully Migrated`
2. **Bose Dependency**: `None`
3. **Local Control**: `100%`
4. **Device Health**: All devices show `Healthy - Local Only`
![Migration Complete](../images/migration-complete.png)
*Example: Completed migration dashboard*
## Step 8: Post-Migration Tasks
1. **Remove USB stick** from the speaker.
2. **Reboot** the device to apply all changes.
### 8.1 Disable Remote Services (Optional)
For enhanced security, you can disable SSH on migrated devices. However, keeping it enabled allows for easier future maintenance or reverts.
### 8.2 Configure Backups
Set up automatic backups of your device configurations:
1. **Dashboard****"Settings"** → **"Backup"**
2. **Enable Automatic Backups**: ✅
3. **Backup Schedule**: `Daily at 2 AM`
4. **Retention**: `Keep 30 days`
5. **Export Location**: `/data/backups` or external storage
![Backup Configuration](../images/backup-setup.png)
*Example: Backup configuration settings*
### 8.3 Set Up Monitoring Alerts (Optional)
Configure notifications for important events:
1. **Dashboard****"Settings"** → **"Notifications"**
2. **Email Notifications**: Enter your email
3. **Alert Types**:
- ✅ Device goes offline
- ✅ Migration failures
- ✅ Service errors
- ✅ Daily health summary
## Troubleshooting Common Issues
### Device Not Discovered
**Problem**: Device doesn't appear in discovery scan
**Solutions**:
1. **Check network**: Ensure device and service are on same network
2. **Verify USB setup**: Confirm `remote_services` file was processed
3. **Power cycle**: Unplug device for 30 seconds, reconnect
4. **Manual add**: Dashboard → "Devices" → "Add Manually" with IP address
### Migration Stuck
**Problem**: Device stuck in "Migrating" status
**Solutions**:
1. **Check device health**: Dashboard → Device → "Health Status"
2. **Review logs**: Dashboard → Device → "View Logs"
3. **Restart migration**: Device → "Migration" → "Restart Process"
4. **Rollback**: Device → "Migration" → "Rollback to Bose"
### Presets Not Working
**Problem**: Saved presets don't work after migration
**Solutions**:
1. **Verify sources**: Check configured sources are still available
2. **Re-authenticate**: Re-login to music services (Spotify, etc.)
3. **Rebuild presets**: Dashboard → Device → "Presets" → "Rebuild from Backup"
### Service Unreachable
**Problem**: Cannot access SoundTouch Service dashboard
**Solutions**:
1. **Check service status**: `sudo systemctl status soundtouch-service`
2. **Restart service**: `sudo systemctl restart soundtouch-service`
3. **Check network**: Verify Pi is connected and accessible
4. **Check ports**: Ensure ports 8000 and 8443 are not blocked
## Advanced Features
### Multi-Zone Management
After migration, your multi-zone setups work seamlessly:
1. **Dashboard****"Zones"**
2. **Create Zone**: Select primary device and slaves
3. **Zone Control**: Play, pause, volume control for entire zone
4. **Individual Control**: Override individual speakers in zone
### Custom Sources
Add custom streaming sources:
1. **Dashboard****"Sources"** → **"Add Custom"**
2. **Configure**:
- Name: `Local Radio Station`
- Stream URL: `http://stream.example.com:8000`
- Image URL: `http://example.com/logo.png`
3. **Assign to devices**: Select which devices can access this source
### API Access
For developers and advanced users:
- **REST API**: `http://[SERVICE_IP]:8000/api/v1/`
- **Documentation**: `http://[SERVICE_IP]:8000/docs`
- **WebSocket Events**: Real-time device status updates
- **Export Data**: JSON/XML export of all device configurations
## Maintenance and Monitoring
### Daily Monitoring
Check your **Dashboard Summary**:
- **All Devices Online**: ✅ Green indicators
- **Response Times**: < 100ms average
- **Error Rate**: < 1%
- **Storage Usage**: Monitor disk space
### Weekly Tasks
1. **Review Health Reports**: Check weekly device health summaries
2. **Update Service**: Check for SoundTouch service updates
3. **Backup Verification**: Ensure backups are completing successfully
4. **Log Review**: Check for any recurring issues or warnings
### Monthly Tasks
1. **Full System Backup**: Export complete account and device data
2. **Performance Review**: Analyze response times and error patterns
3. **Security Update**: Update Raspberry Pi OS and service
4. **Capacity Planning**: Monitor storage and consider expansion
## Getting Help
### Documentation Resources
- **Technical Reference**: `/docs/reference/` - Detailed API and configuration docs
- **Troubleshooting Guide**: `/docs/guides/TROUBLESHOOTING.md` - Common issues and solutions
- **Community Forum**: GitHub Discussions for community support
### Diagnostic Information
When seeking help, provide:
1. **System Information**: Dashboard → "System" → "Download Diagnostic Report"
2. **Device Logs**: Dashboard → Device → "Export Logs"
3. **Migration History**: Dashboard → "Migration" → "Export Timeline"
4. **Current Status**: Screenshot of main dashboard
### Support Channels
- **GitHub Issues**: Technical bugs and feature requests
- **Community Discussions**: User questions and experiences
- **Documentation Updates**: Corrections and improvements
---
## Summary
Congratulations! 🎉 You've successfully migrated your SoundTouch speakers to local control. Your devices are now:
-**Independent** of Bose cloud services
-**Fully functional** with all original features preserved
-**Enhanced** with better monitoring and control
-**Future-proof** against service shutdowns
**What's Next?**
- **Enjoy your music** with enhanced local control
- **Monitor your system** through the dashboard
- **Share your experience** with the community
- **Explore advanced features** as you become more comfortable
Your SoundTouch speakers will now continue working indefinitely, regardless of external service availability. Welcome to true audio independence! 🔊
+764
View File
@@ -0,0 +1,764 @@
# MQTT Integration Design for SoundTouch Service
## Overview
This document outlines the design for integrating MQTT support into the existing SoundTouch service to simulate AWS IoT Core functionality. The integration will provide real-time device communication, shadow state management, and prepare for the AWS IoT service shutdown in May 2026.
## Current Architecture Analysis
### Existing Service Structure
```
Bose-SoundTouch/
├── cmd/soundtouch-service/main.go # Main service entry point
├── pkg/
│ ├── client/ # HTTP client for devices
│ ├── config/ # Configuration management
│ ├── discovery/ # Device discovery (UPnP, mDNS)
│ ├── models/ # Data structures
│ └── service/
│ ├── handlers/ # HTTP request handlers
│ │ └── server.go # Main server struct
│ ├── datastore/ # Data persistence
│ ├── proxy/ # HTTP proxying
│ └── [other services]
```
### Key Components
- **Server Struct**: Central HTTP handler in `pkg/service/handlers/server.go`
- **Discovery Service**: UPnP/mDNS device discovery in `pkg/discovery/`
- **DataStore**: Device state persistence in `pkg/service/datastore/`
- **Device Models**: Data structures in `pkg/models/`
## MQTT Integration Design
### 1. New Package Structure
```
pkg/service/mqtt/
├── broker.go # MQTT broker implementation
├── shadow.go # AWS IoT Shadow simulation
├── auth.go # Certificate-based authentication
├── topics.go # Topic routing and handlers
├── bridge.go # HTTP ↔ MQTT state bridging
├── config.go # MQTT configuration
└── client.go # MQTT client utilities
```
### 2. Core Components
#### A. MQTT Broker (`pkg/service/mqtt/broker.go`)
```go
package mqtt
import (
"crypto/tls"
"fmt"
"log"
"sync"
"github.com/mochi-co/mqtt/v2"
"github.com/mochi-co/mqtt/v2/hooks/auth"
"github.com/mochi-co/mqtt/v2/listeners"
)
type Broker struct {
server *mqtt.Server
shadowStore *ShadowStore
bridge *HTTPBridge
authHook *AuthHook
config *Config
running bool
mu sync.RWMutex
}
type Config struct {
Enabled bool `json:"enabled"`
Port int `json:"port"`
TLSEnabled bool `json:"tls_enabled"`
CertFile string `json:"cert_file"`
KeyFile string `json:"key_file"`
DeviceCertPath string `json:"device_cert_path"`
ShadowPersist bool `json:"shadow_persist"`
}
func NewBroker(config *Config) (*Broker, error) {
server := mqtt.New(nil)
shadowStore := NewShadowStore()
authHook := NewAuthHook(config.DeviceCertPath)
return &Broker{
server: server,
shadowStore: shadowStore,
authHook: authHook,
config: config,
}, nil
}
func (b *Broker) Start() error {
// Add TLS listener
tlsConfig := &tls.Config{
Certificates: []tls.Certificate{b.loadServerCert()},
ClientAuth: tls.RequireAndVerifyClientCert,
ClientCAs: b.loadDeviceCAs(),
}
tcp := listeners.NewTCP("mqtt-tls", fmt.Sprintf(":%d", b.config.Port), &listeners.Config{
TLSConfig: tlsConfig,
})
b.server.AddListener(tcp)
// Add hooks
b.server.AddHook(b.authHook, nil)
b.server.AddHook(NewShadowHook(b.shadowStore), nil)
return b.server.Serve()
}
```
#### B. Shadow State Management (`pkg/service/mqtt/shadow.go`)
```go
package mqtt
import (
"encoding/json"
"fmt"
"sync"
"time"
)
type ShadowStore struct {
shadows map[string]*DeviceShadow
mu sync.RWMutex
}
type DeviceShadow struct {
State struct {
Desired map[string]interface{} `json:"desired"`
Reported map[string]interface{} `json:"reported"`
Delta map[string]interface{} `json:"delta,omitempty"`
} `json:"state"`
Version int `json:"version"`
Timestamp int64 `json:"timestamp"`
ClientToken string `json:"clientToken,omitempty"`
}
func NewShadowStore() *ShadowStore {
return &ShadowStore{
shadows: make(map[string]*DeviceShadow),
}
}
func (s *ShadowStore) UpdateShadow(clientID string, payload []byte) (*DeviceShadow, error) {
s.mu.Lock()
defer s.mu.Unlock()
var update DeviceShadow
if err := json.Unmarshal(payload, &update); err != nil {
return nil, err
}
shadow := s.shadows[clientID]
if shadow == nil {
shadow = &DeviceShadow{
State: struct {
Desired map[string]interface{} `json:"desired"`
Reported map[string]interface{} `json:"reported"`
Delta map[string]interface{} `json:"delta,omitempty"`
}{
Desired: make(map[string]interface{}),
Reported: make(map[string]interface{}),
Delta: make(map[string]interface{}),
},
}
s.shadows[clientID] = shadow
}
// Update reported state
if update.State.Reported != nil {
for key, value := range update.State.Reported {
shadow.State.Reported[key] = value
}
}
// Update desired state
if update.State.Desired != nil {
for key, value := range update.State.Desired {
shadow.State.Desired[key] = value
}
}
// Calculate delta
shadow.calculateDelta()
shadow.Version++
shadow.Timestamp = time.Now().Unix()
shadow.ClientToken = update.ClientToken
return shadow, nil
}
func (s *DeviceShadow) calculateDelta() {
s.State.Delta = make(map[string]interface{})
for key, desired := range s.State.Desired {
if reported, exists := s.State.Reported[key]; !exists || reported != desired {
s.State.Delta[key] = desired
}
}
if len(s.State.Delta) == 0 {
s.State.Delta = nil
}
}
```
#### C. HTTP ↔ MQTT Bridge (`pkg/service/mqtt/bridge.go`)
```go
package mqtt
import (
"encoding/json"
"fmt"
"log"
"github.com/gesellix/bose-soundtouch/pkg/models"
"github.com/gesellix/bose-soundtouch/pkg/service/datastore"
)
type HTTPBridge struct {
shadowStore *ShadowStore
dataStore *datastore.DataStore
deviceMap map[string]string // clientID -> deviceID mapping
}
func NewHTTPBridge(shadowStore *ShadowStore, dataStore *datastore.DataStore) *HTTPBridge {
return &HTTPBridge{
shadowStore: shadowStore,
dataStore: dataStore,
deviceMap: make(map[string]string),
}
}
// ShadowToHTTP converts MQTT shadow updates to HTTP API calls
func (b *HTTPBridge) ShadowToHTTP(clientID string, shadow *DeviceShadow) error {
deviceID, exists := b.deviceMap[clientID]
if !exists {
log.Printf("Unknown device clientID: %s", clientID)
return fmt.Errorf("unknown device: %s", clientID)
}
// Handle power state changes
if powerState, ok := shadow.State.Reported["powerState"].(string); ok {
if err := b.updateDevicePower(deviceID, powerState == "ON"); err != nil {
return fmt.Errorf("power update failed: %w", err)
}
}
// Handle volume changes
if volume, ok := shadow.State.Reported["volume"].(float64); ok {
if err := b.updateDeviceVolume(deviceID, int(volume)); err != nil {
return fmt.Errorf("volume update failed: %w", err)
}
}
// Handle source changes
if source, ok := shadow.State.Reported["source"].(string); ok {
if err := b.updateDeviceSource(deviceID, source); err != nil {
return fmt.Errorf("source update failed: %w", err)
}
}
return nil
}
// HTTPToShadow converts HTTP device state to MQTT shadow updates
func (b *HTTPBridge) HTTPToShadow(deviceID string, deviceInfo *models.DeviceInfo) error {
clientID, exists := b.getClientIDForDevice(deviceID)
if !exists {
return nil // Device not connected via MQTT
}
// Create shadow state from device info
shadowState := map[string]interface{}{
"deviceState": "CONNECTED",
"deviceID": deviceInfo.DeviceID,
"name": deviceInfo.Name,
"type": deviceInfo.Type,
}
// Add additional state if available
if status := b.getDeviceStatus(deviceID); status != nil {
shadowState["powerState"] = status.PowerState
shadowState["volume"] = status.Volume
shadowState["source"] = status.Source
}
// Update shadow
shadowUpdate := DeviceShadow{
State: struct {
Desired map[string]interface{} `json:"desired"`
Reported map[string]interface{} `json:"reported"`
Delta map[string]interface{} `json:"delta,omitempty"`
}{
Reported: shadowState,
},
}
payload, _ := json.Marshal(shadowUpdate)
_, err := b.shadowStore.UpdateShadow(clientID, payload)
return err
}
```
### 3. Integration with Existing Server
#### A. Extend Server Struct (`pkg/service/handlers/server.go`)
```go
// Add to existing Server struct
type Server struct {
// ... existing fields ...
// New MQTT fields
mqttBroker *mqtt.Broker
mqttEnabled bool
mqttConfig *mqtt.Config
deviceClientIDs map[string]string // deviceID -> clientID mapping
}
// New initialization method
func (s *Server) initMQTTBroker(config *mqtt.Config) error {
if !config.Enabled {
return nil
}
broker, err := mqtt.NewBroker(config)
if err != nil {
return fmt.Errorf("failed to create MQTT broker: %w", err)
}
// Set up HTTP ↔ MQTT bridge
bridge := mqtt.NewHTTPBridge(broker.ShadowStore(), s.ds)
broker.SetBridge(bridge)
s.mqttBroker = broker
s.mqttEnabled = true
s.mqttConfig = config
s.deviceClientIDs = make(map[string]string)
return nil
}
// Start MQTT broker alongside HTTP server
func (s *Server) StartMQTT() error {
if !s.mqttEnabled {
return nil
}
go func() {
if err := s.mqttBroker.Start(); err != nil {
log.Printf("MQTT broker error: %v", err)
}
}()
return nil
}
```
#### B. Configuration Integration (`cmd/soundtouch-service/main.go`)
```go
// Add to serviceConfig struct
type serviceConfig struct {
// ... existing fields ...
// New MQTT configuration fields
mqttEnabled bool `mapstructure:"mqtt_enabled"`
mqttPort int `mapstructure:"mqtt_port"`
mqttTLSCert string `mapstructure:"mqtt_tls_cert"`
mqttTLSKey string `mapstructure:"mqtt_tls_key"`
mqttDeviceCertPath string `mapstructure:"mqtt_device_cert_path"`
mqttShadowPersist bool `mapstructure:"mqtt_shadow_persist"`
}
// Update main function to initialize MQTT
func main() {
// ... existing initialization ...
// Initialize MQTT if enabled
if cfg.mqttEnabled {
mqttConfig := &mqtt.Config{
Enabled: cfg.mqttEnabled,
Port: cfg.mqttPort,
TLSEnabled: true,
CertFile: cfg.mqttTLSCert,
KeyFile: cfg.mqttTLSKey,
DeviceCertPath: cfg.mqttDeviceCertPath,
ShadowPersist: cfg.mqttShadowPersist,
}
if err := server.InitMQTTBroker(mqttConfig); err != nil {
log.Fatalf("Failed to initialize MQTT broker: %v", err)
}
if err := server.StartMQTT(); err != nil {
log.Fatalf("Failed to start MQTT broker: %v", err)
}
log.Printf("MQTT broker started on port %d", cfg.mqttPort)
}
// ... rest of existing main function ...
}
```
### 4. Enhanced Device Discovery
#### A. MQTT Device Discovery (`pkg/service/mqtt/discovery.go`)
```go
package mqtt
import (
"log"
"time"
"github.com/gesellix/bose-soundtouch/pkg/models"
"github.com/mochi-co/mqtt/v2/packets"
)
type DeviceDiscoveryHook struct {
deviceRegistry map[string]*models.Device
onDeviceFound func(*models.Device)
}
func NewDeviceDiscoveryHook() *DeviceDiscoveryHook {
return &DeviceDiscoveryHook{
deviceRegistry: make(map[string]*models.Device),
}
}
func (h *DeviceDiscoveryHook) ID() string {
return "device-discovery"
}
func (h *DeviceDiscoveryHook) OnConnect(cl *packets.Client, pk packets.Packet) error {
clientID := pk.Connect.ClientIdentifier
log.Printf("MQTT device connected: %s", clientID)
// Create device entry
device := &models.Device{
ID: clientID,
ClientID: clientID,
Name: "MQTT Device",
LastSeen: time.Now(),
MQTTOnline: true,
Source: "mqtt",
}
h.deviceRegistry[clientID] = device
if h.onDeviceFound != nil {
h.onDeviceFound(device)
}
return nil
}
func (h *DeviceDiscoveryHook) OnDisconnect(cl *packets.Client, err error) {
clientID := cl.ID
log.Printf("MQTT device disconnected: %s", clientID)
if device, exists := h.deviceRegistry[clientID]; exists {
device.MQTTOnline = false
device.LastSeen = time.Now()
}
}
```
#### B. Integration with Existing Discovery (`pkg/discovery/mqtt.go`)
```go
package discovery
import (
"context"
"time"
"github.com/gesellix/bose-soundtouch/pkg/models"
)
type MQTTDiscovery struct {
deviceRegistry map[string]*models.Device
enabled bool
}
func NewMQTTDiscovery() *MQTTDiscovery {
return &MQTTDiscovery{
deviceRegistry: make(map[string]*models.Device),
enabled: true,
}
}
func (d *MQTTDiscovery) DiscoverDevices(ctx context.Context, timeout time.Duration) ([]*models.Device, error) {
if !d.enabled {
return []*models.Device{}, nil
}
var devices []*models.Device
for _, device := range d.deviceRegistry {
if device.MQTTOnline {
devices = append(devices, device)
}
}
return devices, nil
}
func (d *MQTTDiscovery) AddDevice(device *models.Device) {
d.deviceRegistry[device.ClientID] = device
}
func (d *MQTTDiscovery) RemoveDevice(clientID string) {
delete(d.deviceRegistry, clientID)
}
```
### 5. Configuration File Extensions
#### A. Default Configuration (`config.yaml`)
```yaml
# Existing configuration...
# MQTT Configuration
mqtt:
enabled: false
port: 8883
tls:
cert_file: "/etc/ssl/certs/soundtouch-mqtt.crt"
key_file: "/etc/ssl/private/soundtouch-mqtt.key"
# Device certificate validation
device_certs:
path: "/etc/soundtouch/device-certs"
auto_load: true
# Shadow state management
shadow:
persist: true
ttl: 86400 # 24 hours
# Bridge configuration
bridge:
enabled: true
sync_interval: 30s
```
#### B. Environment Variable Support
```bash
# MQTT configuration via environment variables
SOUNDTOUCH_MQTT_ENABLED=true
SOUNDTOUCH_MQTT_PORT=8883
SOUNDTOUCH_MQTT_TLS_CERT=/path/to/cert.pem
SOUNDTOUCH_MQTT_TLS_KEY=/path/to/key.pem
SOUNDTOUCH_MQTT_DEVICE_CERT_PATH=/path/to/device/certs
SOUNDTOUCH_MQTT_SHADOW_PERSIST=true
```
### 6. API Extensions
#### A. MQTT Status Endpoints
```go
// Add to handlers
func (s *Server) handleMQTTStatus(c *gin.Context) {
if !s.mqttEnabled {
c.JSON(http.StatusNotImplemented, gin.H{
"error": "MQTT not enabled",
})
return
}
status := gin.H{
"enabled": s.mqttEnabled,
"port": s.mqttConfig.Port,
"connected_devices": len(s.deviceClientIDs),
"shadow_count": s.mqttBroker.ShadowStore().Count(),
}
c.JSON(http.StatusOK, status)
}
// Device shadow endpoint
func (s *Server) handleDeviceShadow(c *gin.Context) {
deviceID := c.Param("deviceId")
clientID, exists := s.deviceClientIDs[deviceID]
if !exists {
c.JSON(http.StatusNotFound, gin.H{
"error": "Device not connected via MQTT",
})
return
}
shadow := s.mqttBroker.ShadowStore().GetShadow(clientID)
if shadow == nil {
c.JSON(http.StatusNotFound, gin.H{
"error": "Shadow not found",
})
return
}
c.JSON(http.StatusOK, shadow)
}
```
### 7. Testing Strategy
#### A. Unit Tests
```go
// pkg/service/mqtt/shadow_test.go
func TestShadowStore_UpdateShadow(t *testing.T) {
store := NewShadowStore()
payload := []byte(`{
"state": {
"reported": {
"powerState": "ON",
"volume": 25
}
}
}`)
shadow, err := store.UpdateShadow("test-client", payload)
assert.NoError(t, err)
assert.Equal(t, "ON", shadow.State.Reported["powerState"])
assert.Equal(t, 25.0, shadow.State.Reported["volume"])
assert.Equal(t, 1, shadow.Version)
}
```
#### B. Integration Tests
```go
// pkg/service/mqtt/integration_test.go
func TestMQTTBrokerIntegration(t *testing.T) {
// Start test broker
broker := setupTestBroker(t)
go broker.Start()
defer broker.Stop()
// Connect test client
client := mqtt.NewClient(mqtt.NewClientOptions().
AddBroker("tls://localhost:8883").
SetClientID("test-device"))
// Test shadow operations
testShadowUpdate(t, client)
testShadowGet(t, client)
}
```
### 8. Migration Path
#### A. Gradual Rollout
1. **Phase 1**: Deploy MQTT broker alongside existing HTTP service (disabled by default)
2. **Phase 2**: Enable MQTT for testing with specific devices
3. **Phase 3**: Enable bidirectional HTTP ↔ MQTT bridging
4. **Phase 4**: Full MQTT support for all discovered devices
5. **Phase 5**: Prepare for AWS IoT shutdown (May 2026)
#### B. Backward Compatibility
- All existing HTTP API endpoints continue to work
- MQTT is purely additive functionality
- Devices can be discovered via HTTP even with MQTT enabled
- Configuration remains optional
### 9. Monitoring and Logging
#### A. MQTT Metrics
```go
type MQTTMetrics struct {
ConnectedDevices int64
MessagesReceived int64
MessagesSent int64
ShadowUpdates int64
AuthenticationFails int64
Uptime time.Duration
}
func (b *Broker) GetMetrics() *MQTTMetrics {
return &MQTTMetrics{
ConnectedDevices: int64(len(b.server.Clients)),
MessagesReceived: b.server.Stats.MessagesReceived,
MessagesSent: b.server.Stats.MessagesSent,
ShadowUpdates: b.shadowStore.UpdateCount(),
AuthenticationFails: b.authHook.FailCount(),
Uptime: time.Since(b.startTime),
}
}
```
#### B. Logging Integration
```go
import "github.com/sirupsen/logrus"
func (b *Broker) setupLogging() {
log := logrus.WithFields(logrus.Fields{
"component": "mqtt-broker",
"port": b.config.Port,
})
b.server.AddHook(&LoggingHook{logger: log}, nil)
}
```
### 10. Security Considerations
#### A. Certificate Validation
- Validate device certificates against known device list
- Implement certificate revocation checking
- Support certificate rotation
#### B. Access Control
- Restrict topic access per device certificate
- Implement rate limiting per client
- Monitor for unusual connection patterns
#### C. Data Protection
- Encrypt shadow data at rest
- Implement secure certificate storage
- Audit logging for security events
## Implementation Timeline
### Week 1: Core Infrastructure
- [ ] Create MQTT package structure
- [ ] Implement basic MQTT broker
- [ ] Add TLS configuration
- [ ] Basic shadow state management
### Week 2: Integration & Bridging
- [ ] Integrate with existing Server struct
- [ ] Implement HTTP ↔ MQTT bridge
- [ ] Device discovery integration
- [ ] Configuration management
### Week 3: Testing & Polish
- [ ] Unit test coverage
- [ ] Integration testing
- [ ] Documentation updates
- [ ] Performance optimization
### Week 4: Deployment & Monitoring
- [ ] Docker container updates
- [ ] Monitoring and metrics
- [ ] Security hardening
- [ ] Production readiness
## Success Criteria
1. **Functional**: MQTT broker accepts device connections using extracted certificates
2. **Compatible**: All existing HTTP functionality continues to work unchanged
3. **Performant**: MQTT operations don't impact HTTP API performance
4. **Secure**: Device authentication and authorization properly implemented
5. **Observable**: Comprehensive logging and metrics for MQTT operations
6. **Maintainable**: Clean separation of MQTT code from existing HTTP logic
This design provides a comprehensive path to add MQTT support while maintaining the existing architecture and ensuring smooth integration with current functionality.
+44 -17
View File
@@ -212,23 +212,23 @@ Device migration switches your SoundTouch devices from Bose's cloud services to
```bash
# Get migration summary first
curl http://localhost:8000/setup/migration-summary/192.168.1.100
curl http://localhost:8000/setup/devices/192.168.1.100/summary
# Perform migration
curl -X POST http://localhost:8000/setup/migrate/192.168.1.100
curl -X POST http://localhost:8000/setup/devices/192.168.1.100/migrate
# Verify migration status
curl http://localhost:8000/setup/devices
curl http://localhost:8000/devices
```
#### Advanced Migration Options
```bash
# 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"
curl -X POST "http://localhost:8000/setup/devices/192.168.1.100/migrate?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"
curl -X POST "http://localhost:8000/setup/devices/192.168.1.100/migrate?target_url=https://my-server.com:8000"
```
### Post-Migration Verification
@@ -237,13 +237,13 @@ After migration, verify the device is working correctly:
```bash
# Check device status
curl http://localhost:8000/setup/devices
curl http://localhost:8000/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"
curl "http://localhost:8000/devices/08DF1F0BA325/events"
```
#### ResolvConf Migration (DHCP-Aware DNS Redirection)
@@ -347,7 +347,7 @@ Mirrored requests are also recorded in the **Interaction Log** under the categor
### Discovery & Setup
#### `GET /setup/devices`
#### `GET /devices`
Lists all discovered SoundTouch devices with their current status.
**Response:**
@@ -368,10 +368,10 @@ Lists all discovered SoundTouch devices with their current status.
#### `POST /setup/discover`
Triggers immediate network device discovery.
#### `GET /setup/info/{deviceIP}`
#### `GET /devices/{deviceIP}/info`
Gets detailed device information and configuration.
#### `GET /setup/migration-summary/{deviceIP}`
#### `GET /setup/devices/{deviceIP}/summary`
Analyzes device configuration and provides migration preview.
**Response:**
@@ -388,7 +388,7 @@ Analyzes device configuration and provides migration preview.
}
```
#### `POST /setup/migrate/{deviceIP}`
#### `POST /setup/devices/{deviceIP}/migrate`
Migrates device to use local services.
**Query Parameters:**
@@ -399,6 +399,33 @@ Migrates device to use local services.
- `sw_update`: Set to "original" to proxy update requests (optional)
- `bmx`: Set to "original" to proxy BMX requests (optional)
#### `POST /setup/devices/{deviceIP}/revert`
Reverts device to Bose cloud defaults.
#### `POST /setup/devices/{deviceIP}/trust-ca`
Injects the AfterTouch root CA into the device's trust store.
#### `POST /setup/devices/{deviceIP}/sync`
Syncs presets and recents from the device to local storage.
#### `POST /setup/devices/{deviceIP}/backup`
Creates a backup of the current device configuration.
#### `POST /setup/devices/{deviceIP}/ensure-remote-services`
Enables persistent SSH/remote services on the device.
#### `POST /setup/devices/{deviceIP}/remove-remote-services`
Removes persistent SSH/remote services from the device.
#### `POST /setup/devices/{deviceIP}/test-connection`
Tests HTTPS connection from device to service.
#### `POST /setup/devices/{deviceIP}/test-hosts`
Tests /etc/hosts redirection on the device.
#### `POST /setup/devices/{deviceIP}/test-dns`
Tests DNS redirection on the device.
### BMX Services (Bose Media eXchange)
#### `GET /bmx/registry/v1/services`
@@ -658,13 +685,13 @@ find data/stats/ -name "*.json" -mtime +90 -delete
- **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.
- `GET /devices`: List all known (auto-discovered and manual) devices.
- `POST /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).
- `POST /devices/{deviceIP}/sync`: Fetch presets, recents, and sources from a device.
- `GET /devices/{deviceIP}/summary`: Get a detailed migration readiness summary.
- `POST /devices/{deviceIP}/migrate`: Migrate a device using the specified method (XML/Hosts).
- `GET /setup/ca.crt`: Download the Root CA certificate for manual installation.
#### `GET /setup/interactions`
@@ -811,7 +838,7 @@ soundtouch:
name: "Living Room Speaker"
rest:
- resource: "http://localhost:8000/setup/devices"
- resource: "http://localhost:8000/devices"
scan_interval: 60
sensor:
- name: "SoundTouch Devices"
+90
View File
@@ -0,0 +1,90 @@
# Images for Migration Guide
This directory contains images, screenshots, and diagrams referenced in the migration guide and other documentation.
## Required Images for Migration Guide
The following images need to be created to complete the migration guide:
### Dashboard Screenshots
- **dashboard-home.png** - Main SoundTouch Service dashboard homepage
- **account-creation.png** - Account creation form with fields filled
- **account-dashboard.png** - Fresh account dashboard showing ready state
- **device-discovery.png** - Device discovery page showing found speakers
- **device-registration.png** - Device registration dialog with options
- **migration-setup.png** - Migration configuration dialog
- **migration-progress.png** - Migration progress tracker showing phases
- **migration-health.png** - Migration health monitoring dashboard
- **account-migration.png** - Account-wide migration progress overview
- **migration-complete.png** - Completed migration dashboard view
- **backup-setup.png** - Backup configuration settings page
### Setup and Preparation
- **usb-remote-services.png** - USB drive setup showing file structure
- **raspberry-pi-setup.png** - Raspberry Pi with connected cables (optional)
### Process Diagrams
- **migration-flow-diagram.png** - Flow chart showing migration phases
- **network-topology.png** - Network diagram showing Pi, router, speakers
- **data-flow-diagram.png** - How data flows between components
## Image Requirements
### Technical Specifications
- **Format**: PNG preferred for screenshots, SVG for diagrams
- **Resolution**: Minimum 1200px width for screenshots
- **File Size**: Keep under 500KB when possible for fast loading
- **Naming**: Use descriptive kebab-case names as shown above
### Content Guidelines
- **Clean Interface**: Show realistic but clean interface states
- **Consistent Styling**: Use consistent colors and styling across images
- **Readable Text**: Ensure all text in screenshots is legible
- **Example Data**: Use realistic example data (Living Room Speaker, etc.)
- **Status Indicators**: Show clear success/error states with appropriate colors
### Placeholder Content
Until real screenshots are available, consider:
- **Mockups**: Create simple mockups showing the expected interface
- **Wireframes**: Basic wireframes indicating layout and content
- **Diagrams**: Technical diagrams can be created immediately
- **Text Placeholders**: Use `[Image: Description]` in documentation
## Creating the Images
### For Dashboard Screenshots
1. Set up the enhanced SoundTouch service
2. Create sample account and register devices
3. Take screenshots at key points in the migration process
4. Edit for clarity (highlight important elements, add annotations)
### For Diagrams
1. Use tools like Lucidchart, draw.io, or similar
2. Follow consistent color scheme:
- Blue: SoundTouch Service components
- Green: Healthy/successful states
- Orange: Warning/in-progress states
- Red: Error/problematic states
- Gray: External/third-party components
### For Physical Setup
1. Take photos of actual hardware setup
2. Show USB drive preparation process
3. Demonstrate network connections if helpful
## Alternative Text Requirements
Each image should have appropriate alt text for accessibility:
```markdown
![Alt text describing the image content](../images/image-name.png)
*Caption: Additional context or explanation*
```
## Future Enhancements
Consider adding:
- **Video Walkthroughs**: Screen recordings of key processes
- **Interactive Demos**: Web-based interactive guides
- **Troubleshooting Screenshots**: Common error states and solutions
- **Mobile Views**: How to access from mobile devices
+599
View File
@@ -0,0 +1,599 @@
# /power_on Implementation Guide
## Overview
This guide provides detailed technical specifications for implementing `/power_on` endpoint enhancements to reduce network dependency and improve device lifecycle management in the SoundTouch service.
## Current /power_on Handler Analysis
### Existing Implementation
Located in `pkg/service/handlers/handlers_marge.go`:
```go
func (s *Server) HandleMargePowerOn(w http.ResponseWriter, r *http.Request) {
body, err := io.ReadAll(r.Body)
if err != nil {
log.Printf("[Marge] Failed to read power_on body: %v", err)
w.WriteHeader(http.StatusOK)
return
}
var req models.CustomerSupportRequest
if err := xml.Unmarshal(body, &req); err != nil {
log.Printf("[Marge] Failed to parse power_on body: %v", err)
// Fallback to remote address
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
go s.PrimeDeviceWithSpotify(host)
}
w.WriteHeader(http.StatusOK)
return
}
deviceID := req.Device.ID
deviceIP := req.DiagnosticData.DeviceLandscape.IPAddress
log.Printf("[Marge] Device %s powered on (IP: %s)", deviceID, deviceIP)
if deviceIP != "" {
go s.PrimeDeviceWithSpotify(deviceIP)
} else {
// Fallback to remote address
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
go s.PrimeDeviceWithSpotify(host)
}
}
w.WriteHeader(http.StatusOK)
}
```
**Current Limitations:**
- Only extracts basic device ID and IP
- No device state management
- No data persistence
- No response payload
- Limited to Spotify priming
## Enhanced Implementation Design
### 1. Extended Data Models
#### Enhanced Power-On Request Model
```go
// PowerOnRequest represents the enhanced power_on request structure
type PowerOnRequest struct {
XMLName xml.Name `xml:"device-data"`
Device PowerOnDevice `xml:"device"`
DiagnosticData DiagnosticData `xml:"diagnostic-data"`
}
type PowerOnDevice struct {
ID string `xml:"id,attr"`
SerialNumber string `xml:"serialnumber"`
FirmwareVersion string `xml:"firmware-version"`
Product PowerOnProduct `xml:"product"`
}
type PowerOnProduct struct {
ProductCode string `xml:"product_code,attr"`
Type string `xml:"type,attr"`
SerialNumber string `xml:"serialnumber"`
}
type DiagnosticData struct {
DeviceLandscape DeviceLandscape `xml:"device-landscape"`
NetworkData NetworkData `xml:"network-landscape>network-data"`
}
type DeviceLandscape struct {
RSSI string `xml:"rssi"`
GatewayIP string `xml:"gateway-ip-address"`
MacAddresses []string `xml:"macaddresses>macaddress"`
IPAddress string `xml:"ip-address"`
ConnectionType string `xml:"network-connection-type"`
}
```
#### Enhanced Response Model
```go
// PowerOnResponse represents the response sent back to the device
type PowerOnResponse struct {
XMLName xml.Name `xml:"power-on-response"`
Status string `xml:"status"`
DeviceID string `xml:"device-id"`
ConfigurationUpdates []ConfigurationUpdate `xml:"configuration-updates>update,omitempty"`
MigrationInstructions *MigrationInstruction `xml:"migration,omitempty"`
RegistrationRequired bool `xml:"registration-required,omitempty"`
Timestamp string `xml:"timestamp"`
}
type ConfigurationUpdate struct {
Type string `xml:"type,attr"`
Key string `xml:"key"`
Value string `xml:"value"`
Priority int `xml:"priority,attr"`
}
type MigrationInstruction struct {
Method string `xml:"method,attr"`
TargetURL string `xml:"target-url"`
ProxyURL string `xml:"proxy-url,omitempty"`
Options map[string]string `xml:"options>option"`
}
```
### 2. Enhanced PowerOn Handler
```go
// HandleMargePowerOnEnhanced processes power_on requests with full device lifecycle management
func (s *Server) HandleMargePowerOnEnhanced(w http.ResponseWriter, r *http.Request) {
startTime := time.Now()
// Parse the power_on request
powerOnReq, err := s.parsePowerOnRequest(r)
if err != nil {
s.handlePowerOnError(w, r, "Failed to parse request", err)
return
}
// Process device information
deviceInfo, isNewDevice, err := s.processDeviceFromPowerOn(powerOnReq)
if err != nil {
s.handlePowerOnError(w, r, "Failed to process device", err)
return
}
// Build response based on device state
response := s.buildPowerOnResponse(deviceInfo, isNewDevice, powerOnReq)
// Log the interaction
s.logPowerOnInteraction(deviceInfo, powerOnReq, response, startTime)
// Send response
if err := s.sendPowerOnResponse(w, response); err != nil {
log.Printf("[PowerOn] Failed to send response for device %s: %v", deviceInfo.DeviceID, err)
}
}
```
### 3. Device Processing Logic
```go
// processDeviceFromPowerOn handles device identification and data updates
func (s *Server) processDeviceFromPowerOn(req *PowerOnRequest) (*models.ServiceDeviceInfo, bool, error) {
deviceMAC := req.Device.ID
deviceIP := req.DiagnosticData.DeviceLandscape.IPAddress
// Try to find existing device by MAC address (primary identifier)
existingDevice, err := s.ds.GetDeviceByMAC(deviceMAC)
if err != nil && err != datastore.ErrDeviceNotFound {
return nil, false, fmt.Errorf("failed to lookup device: %w", err)
}
var deviceInfo *models.ServiceDeviceInfo
isNewDevice := existingDevice == nil
if isNewDevice {
// Create new device record from power_on data
deviceInfo = s.createDeviceFromPowerOn(req)
// Store in datastore
if err := s.ds.SaveDeviceInfo("", deviceMAC, deviceInfo); err != nil {
return nil, false, fmt.Errorf("failed to save new device: %w", err)
}
log.Printf("[PowerOn] New device registered: %s (IP: %s, Model: %s)",
deviceMAC, deviceIP, deviceInfo.ProductCode)
} else {
// Update existing device with power_on data
deviceInfo = existingDevice
s.updateDeviceFromPowerOn(deviceInfo, req)
// Detect significant changes
if s.hasSignificantChanges(existingDevice, deviceInfo) {
log.Printf("[PowerOn] Device %s updated: IP %s->%s, FW %s->%s",
deviceMAC, existingDevice.IPAddress, deviceInfo.IPAddress,
existingDevice.FirmwareVersion, deviceInfo.FirmwareVersion)
}
// Save updated device info
if err := s.ds.SaveDeviceInfo(deviceInfo.AccountID, deviceMAC, deviceInfo); err != nil {
return nil, false, fmt.Errorf("failed to update device: %w", err)
}
}
// Update device mappings for lookup optimization
s.ds.UpdateDeviceMappings(*deviceInfo)
return deviceInfo, isNewDevice, nil
}
```
### 4. Device Creation from Power-On Data
```go
// createDeviceFromPowerOn creates a new ServiceDeviceInfo from power_on request
func (s *Server) createDeviceFromPowerOn(req *PowerOnRequest) *models.ServiceDeviceInfo {
now := time.Now()
deviceInfo := &models.ServiceDeviceInfo{
DeviceID: req.Device.ID, // MAC address
ProductCode: req.Device.Product.ProductCode,
DeviceSerialNumber: req.Device.SerialNumber,
ProductSerialNumber: req.Device.Product.SerialNumber,
FirmwareVersion: req.Device.FirmwareVersion,
IPAddress: req.DiagnosticData.DeviceLandscape.IPAddress,
MacAddress: req.Device.ID, // Primary MAC
DiscoveryMethod: "power_on",
LastSeen: now,
CreatedAt: now,
UpdatedAt: now,
}
// Generate default name if not provided
if deviceInfo.Name == "" {
deviceInfo.Name = s.generateDefaultDeviceName(deviceInfo)
}
// Add power_on specific metadata
deviceInfo.Metadata = map[string]string{
"rssi": req.DiagnosticData.DeviceLandscape.RSSI,
"gateway_ip": req.DiagnosticData.DeviceLandscape.GatewayIP,
"connection_type": req.DiagnosticData.DeviceLandscape.ConnectionType,
"power_on_count": "1",
}
// Store additional MAC addresses if available
if len(req.DiagnosticData.DeviceLandscape.MacAddresses) > 1 {
additionalMACs := make([]string, 0, len(req.DiagnosticData.DeviceLandscape.MacAddresses)-1)
for _, mac := range req.DiagnosticData.DeviceLandscape.MacAddresses {
if mac != req.Device.ID {
additionalMACs = append(additionalMACs, mac)
}
}
if len(additionalMACs) > 0 {
deviceInfo.Metadata["additional_macs"] = strings.Join(additionalMACs, ",")
}
}
return deviceInfo
}
```
### 5. Response Generation Logic
```go
// buildPowerOnResponse creates appropriate response based on device state
func (s *Server) buildPowerOnResponse(deviceInfo *models.ServiceDeviceInfo, isNewDevice bool, req *PowerOnRequest) *PowerOnResponse {
response := &PowerOnResponse{
Status: "ok",
DeviceID: deviceInfo.DeviceID,
Timestamp: time.Now().Format(time.RFC3339),
}
// Handle new device registration
if isNewDevice {
response.RegistrationRequired = deviceInfo.AccountID == ""
// Add welcome configuration for new devices
response.ConfigurationUpdates = []ConfigurationUpdate{
{
Type: "welcome",
Key: "device_registered",
Value: "true",
Priority: 1,
},
}
}
// Check if migration is needed
if s.needsMigration(deviceInfo) {
migration := s.getMigrationInstructions(deviceInfo)
response.MigrationInstructions = migration
log.Printf("[PowerOn] Migration required for device %s: %s",
deviceInfo.DeviceID, migration.Method)
}
// Add any pending configuration updates
pendingUpdates := s.getPendingConfigurationUpdates(deviceInfo)
response.ConfigurationUpdates = append(response.ConfigurationUpdates, pendingUpdates...)
return response
}
```
### 6. Device Lookup Enhancements
#### Enhanced DataStore Methods
```go
// GetDeviceByMAC finds a device by MAC address across all accounts
func (ds *DataStore) GetDeviceByMAC(macAddress string) (*models.ServiceDeviceInfo, error) {
normalizedMAC := normalizeMAC(macAddress)
// Check device mappings first (for performance)
ds.idMutex.RLock()
deviceID, exists := ds.deviceMappings[normalizedMAC]
ds.idMutex.RUnlock()
if exists {
// Try to find device by mapped ID
device, err := ds.findDeviceByID(deviceID)
if err == nil {
return device, nil
}
}
// Fallback to full scan
devices, err := ds.ListAllDevices()
if err != nil {
return nil, err
}
for _, device := range devices {
if normalizeMAC(device.MacAddress) == normalizedMAC ||
normalizeMAC(device.DeviceID) == normalizedMAC {
return &device, nil
}
// Check additional MAC addresses in metadata
if additionalMACs, exists := device.Metadata["additional_macs"]; exists {
for _, mac := range strings.Split(additionalMACs, ",") {
if normalizeMAC(mac) == normalizedMAC {
return &device, nil
}
}
}
}
return nil, datastore.ErrDeviceNotFound
}
```
### 7. Migration Integration
```go
// needsMigration determines if device requires configuration migration
func (s *Server) needsMigration(deviceInfo *models.ServiceDeviceInfo) bool {
if deviceInfo.AccountID == "" {
return false // Cannot migrate without account
}
// Check if device is already migrated
if s.sm != nil {
summary, err := s.sm.GetMigrationSummary(deviceInfo.IPAddress, s.ServerURL, "", nil)
if err == nil && summary.IsMigrated {
return false
}
}
return true
}
// getMigrationInstructions creates migration instructions for device
func (s *Server) getMigrationInstructions(deviceInfo *models.ServiceDeviceInfo) *MigrationInstruction {
return &MigrationInstruction{
Method: "xml", // Default to XML-based migration
TargetURL: s.ServerURL,
Options: map[string]string{
"marge": "true",
"stats": "true",
"sw_update": "true",
},
}
}
```
### 8. Error Handling and Fallbacks
```go
// handlePowerOnError provides graceful error handling with fallbacks
func (s *Server) handlePowerOnError(w http.ResponseWriter, r *http.Request, message string, err error) {
log.Printf("[PowerOn] %s: %v", message, err)
// Try to extract IP from request for fallback processing
if host, _, err := net.SplitHostPort(r.RemoteAddr); err == nil {
// Fallback to existing discovery mechanism
go s.PrimeDeviceWithSpotify(host)
log.Printf("[PowerOn] Falling back to legacy processing for IP %s", host)
}
// Always return 200 OK to avoid device retry loops
w.WriteHeader(http.StatusOK)
}
// parsePowerOnRequest safely parses the power_on request with validation
func (s *Server) parsePowerOnRequest(r *http.Request) (*PowerOnRequest, error) {
body, err := io.ReadAll(r.Body)
if err != nil {
return nil, fmt.Errorf("failed to read request body: %w", err)
}
if len(body) == 0 {
return nil, fmt.Errorf("empty request body")
}
var req PowerOnRequest
if err := xml.Unmarshal(body, &req); err != nil {
return nil, fmt.Errorf("failed to parse XML: %w", err)
}
// Validate required fields
if req.Device.ID == "" {
return nil, fmt.Errorf("missing device ID")
}
if req.DiagnosticData.DeviceLandscape.IPAddress == "" {
return nil, fmt.Errorf("missing device IP address")
}
return &req, nil
}
```
### 9. Logging and Monitoring
```go
// logPowerOnInteraction records detailed interaction logs for debugging
func (s *Server) logPowerOnInteraction(deviceInfo *models.ServiceDeviceInfo, req *PowerOnRequest, resp *PowerOnResponse, startTime time.Time) {
duration := time.Since(startTime)
log.Printf("[PowerOn] Device: %s, IP: %s, Duration: %v, Status: %s, NewDevice: %t, Migration: %t",
deviceInfo.DeviceID,
req.DiagnosticData.DeviceLandscape.IPAddress,
duration,
resp.Status,
resp.RegistrationRequired,
resp.MigrationInstructions != nil)
// Store interaction for debugging (if enabled)
if s.config.RecordInteractions {
interaction := models.DeviceInteraction{
Timestamp: startTime,
DeviceID: deviceInfo.DeviceID,
Type: "power_on",
Request: req,
Response: resp,
Duration: duration,
IPAddress: req.DiagnosticData.DeviceLandscape.IPAddress,
UserAgent: r.Header.Get("User-Agent"),
}
if err := s.ds.SaveInteraction(interaction); err != nil {
log.Printf("[PowerOn] Failed to save interaction: %v", err)
}
}
}
```
### 10. Configuration and Feature Flags
```go
// PowerOnConfig controls behavior of enhanced power_on processing
type PowerOnConfig struct {
EnableEnhancedProcessing bool `json:"enable_enhanced_processing"`
AutoMigration bool `json:"auto_migration"`
RecordInteractions bool `json:"record_interactions"`
DefaultResponseTimeout time.Duration `json:"default_response_timeout"`
FallbackToLegacy bool `json:"fallback_to_legacy"`
}
// loadPowerOnConfig loads configuration with defaults
func loadPowerOnConfig() *PowerOnConfig {
return &PowerOnConfig{
EnableEnhancedProcessing: true,
AutoMigration: false, // Conservative default
RecordInteractions: false,
DefaultResponseTimeout: 5 * time.Second,
FallbackToLegacy: true,
}
}
```
## Testing Strategy
### 1. Unit Tests
```go
func TestHandleMargePowerOnEnhanced(t *testing.T) {
tests := []struct {
name string
requestBody string
existingDevice *models.ServiceDeviceInfo
expectedStatus string
expectMigration bool
}{
{
name: "new_device_registration",
requestBody: `<device-data><device id="A81B6A536A98">...</device></device-data>`,
existingDevice: nil,
expectedStatus: "ok",
expectMigration: false,
},
{
name: "existing_device_update",
requestBody: `<device-data><device id="A81B6A536A98">...</device></device-data>`,
existingDevice: &models.ServiceDeviceInfo{DeviceID: "A81B6A536A98"},
expectedStatus: "ok",
expectMigration: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Test implementation
})
}
}
```
### 2. Integration Tests
```go
func TestPowerOnDeviceLifecycle(t *testing.T) {
// Test complete device lifecycle through power_on events
// 1. New device power_on
// 2. Device registration
// 3. Configuration changes
// 4. Migration
// 5. Subsequent power_on events
}
```
### 3. Load Testing
```go
func BenchmarkPowerOnProcessing(b *testing.B) {
// Benchmark power_on processing performance
// Test concurrent device registrations
// Measure response times
}
```
## Deployment Strategy
### Phase 1: Parallel Implementation
- Implement enhanced handler alongside existing handler
- Use feature flag to control which handler processes requests
- Maintain full backward compatibility
### Phase 2: Gradual Rollout
- Enable enhanced processing for subset of devices
- Monitor performance and error rates
- Collect metrics on data completeness
### Phase 3: Full Migration
- Default to enhanced processing for all devices
- Remove legacy fallbacks
- Optimize performance based on production data
## Monitoring and Metrics
### Key Metrics to Track
- Power-on event frequency per device
- New device registration rate via power_on
- Migration success rate via power_on response
- Response time distribution
- Error rates and types
- Data completeness metrics
### Alerting Thresholds
- Power-on processing failures > 5%
- Average response time > 2 seconds
- New device registration failures > 1%
- Migration instruction delivery failures > 2%
## Security Considerations
### Input Validation
- XML parsing security (prevent XXE attacks)
- Device ID format validation
- IP address validation
- Request size limits
### Authentication
- Device authentication via MAC address verification
- Request signing (if available)
- Rate limiting per device/IP
### Data Privacy
- Sensitive data handling in diagnostic information
- Logging data retention policies
- Compliance with data protection regulations
+140
View File
@@ -0,0 +1,140 @@
# SCMUDC Events Analysis
## Overview
SCMUDC (Sound Control Management Usage Data Collection) events are telemetry data sent from SoundTouch devices to `events.api.bosecm.com` via `/v1/scmudc/{deviceId}` endpoints. These events track user interactions and device behaviors for analytics and monitoring.
## Event Origins
Analysis of recorded interactions reveals three distinct origins for device events:
### 1. `"gabbo"` - SoundTouch App (Mobile/Desktop)
- **Source**: Remote control via SoundTouch mobile/desktop applications
- **Frequency**: Highest (primary control method)
- **Event Types**: User-initiated actions through app interface
- **Button Abstraction**: App UI elements (not physical buttons)
**Common Events**:
- `power-pressed` → Power on/off via app
- `play-pressed` → Play control
- `pause-pressed` → Pause control
- `skip-forward-pressed` → Next track
- `stop-pressed` → Stop playback
### 2. `"console"` - Device Hardware Controls
- **Source**: Physical buttons and controls on the speaker device
- **Frequency**: Lower (secondary control method)
- **Event Types**: Direct hardware interaction
- **Physical Controls**: Actual buttons, knobs, or touch interfaces on device
**Common Events**:
- `preset-pressed` → Physical preset buttons (PRESET_1, PRESET_5, etc.)
- `power-pressed` → Hardware power button
### 3. `"device"` - Internal System Actions
- **Source**: Device's internal software systems
- **Frequency**: Automatic responses to user actions
- **Event Types**: System-generated events, content playback
- **Rich Content**: Base64-encoded XML with detailed metadata
**Common Events**:
- `play-item` → Automatic content playback responses
- `preset-assigned` → System preset assignments
## Event Data Structure
### Standard Button Events (gabbo/console)
```json
{
"data": {
"buttonId": "POWER|PLAY|PAUSE|PRESET_5|etc",
"origin": "gabbo|console"
},
"type": "power-pressed|play-pressed|pause-pressed|preset-pressed|etc"
}
```
### Device Content Events
```json
{
"data": {
"contentItem": "PD94bWwgdmVyc2lvbj0...", // Base64-encoded XML
"origin": "device",
"preset": "none|P1|P5|etc"
},
"type": "play-item|preset-assigned"
}
```
## Content Item Structure
Device events include Base64-encoded XML with rich content metadata:
```xml
<ContentItem source="SPOTIFY" type="tracklisturl"
location="/playback/container/c3BvdGlmeTpwbGF5bGlzdDox..."
sourceAccount="gesellix" isPresetable="true">
<itemName>Billie Eilish - bad guy (instrumental version)</itemName>
<containerArt>https://i.scdn.co/image/ab67616d0000b273...</containerArt>
</ContentItem>
```
**Key Fields**:
- `source`: Music service (SPOTIFY, PANDORA, etc.)
- `itemName`: Track/playlist/station name
- `sourceAccount`: User account on the service
- `location`: Service-specific content identifier
- `containerArt`: Album/playlist artwork URL
- `isPresetable`: Whether content can be saved as preset
## Usage Patterns
### Control Method Preferences
1. **Primary**: SoundTouch App (`gabbo`) - Most frequent interactions
2. **Secondary**: Device Hardware (`console`) - Occasional direct control
3. **Automatic**: Internal System (`device`) - Background responses
### Event Flow
1. User triggers action via app or hardware
2. Device processes request and begins playback
3. Device sends content event with full metadata
4. System continues tracking playback state
## Telemetry Insights
### User Behavior Analytics
- **Interface Preference**: App vs. hardware control usage ratios
- **Feature Usage**: Most/least used controls and functions
- **Content Patterns**: Music service preferences, playlist usage
### Device Health Monitoring
- **Interaction Frequency**: Normal vs. abnormal usage patterns
- **Error Detection**: Failed commands or unusual event sequences
- **Performance**: Response times between user action and system response
### Service Integration Analysis
- **Music Services**: Spotify dominance, other service usage
- **Account Mapping**: User accounts across different services
- **Content Types**: Music vs. radio vs. podcast preferences
## Data Quality Notes
- All events include comprehensive device information (deviceID, serialNumber, softwareVersion)
- Timestamps include both UTC time and device monotonic time
- Events are batched and sent with consistent protocol versioning
- Content metadata is rich and includes artwork URLs for UI enhancement
## Security Considerations
- Events include user account information and listening habits
- Device serial numbers and unique identifiers are transmitted
- Content location data could reveal usage patterns
- Data should be handled according to privacy regulations
## Technical Implementation Notes
- Endpoint: `POST /v1/scmudc/{deviceId}`
- Protocol Version: 3.1 (current)
- Encoding: JSON with Base64-encoded XML payloads
- Authentication: Bearer token authorization
- Content-Type: `text/json; charset=utf-8`
+2 -2
View File
@@ -1,8 +1,8 @@
module navigation-station-demo
go 1.25.7
go 1.26.1
require github.com/gesellix/bose-soundtouch v0.0.0
require github.com/gesellix/bose-soundtouch v0.43.0
require github.com/gorilla/websocket v1.5.3 // indirect
+2 -2
View File
@@ -1,8 +1,8 @@
module preset-management-example
go 1.25.7
go 1.26.1
require github.com/gesellix/bose-soundtouch v0.0.0
require github.com/gesellix/bose-soundtouch v0.43.0
require github.com/gorilla/websocket v1.5.3 // indirect
+3 -3
View File
@@ -1,6 +1,6 @@
module github.com/gesellix/bose-soundtouch
go 1.25.7
go 1.26.1
require (
github.com/go-chi/chi/v5 v5.2.5
@@ -14,9 +14,9 @@ require (
require (
github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect
golang.org/x/mod v0.33.0 // indirect
golang.org/x/net v0.50.0 // indirect
golang.org/x/net v0.51.0 // indirect
golang.org/x/sync v0.19.0 // indirect
golang.org/x/sys v0.41.0 // indirect
golang.org/x/tools v0.42.0 // indirect
+4 -4
View File
@@ -15,8 +15,8 @@ github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/urfave/cli/v2 v2.27.7 h1:bH59vdhbjLv3LAvIu6gd0usJHgoTTPhCFib8qqOwXYU=
github.com/urfave/cli/v2 v2.27.7/go.mod h1:CyNAG/xg+iAOg0N4MPGZqVmv2rCoP267496AOXUZjA4=
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAzt5X7s6266i6cSVkkFPS0TuXWbIg=
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
@@ -44,8 +44,8 @@ golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k=
golang.org/x/net v0.50.0 h1:ucWh9eiCGyDR3vtzso0WMQinm2Dnt8cFMuQa9K33J60=
golang.org/x/net v0.50.0/go.mod h1:UgoSli3F/pBgdJBHCTc+tp3gmrU4XswgGRgtnwWTfyM=
golang.org/x/net v0.51.0 h1:94R/GTO7mt3/4wIKpcR5gkGmRLOuE/2hNGeWq/GBIFo=
golang.org/x/net v0.51.0/go.mod h1:aamm+2QF5ogm02fjy5Bb7CQ0WMt1/WVM7FtyaTLlA9Y=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+7
View File
@@ -356,6 +356,13 @@ func (ws *WebSocketClient) attemptReconnect(config *WebSocketConfig) {
}
attempt++
// Check if device is reachable before attempting full WS connection to reduce log noise
if err := ws.client.Ping(); err != nil {
ws.logger.Printf("Reconnection attempt %d skipped: device unreachable (%v)", attempt, err)
continue
}
ws.logger.Printf("Reconnection attempt %d", attempt)
if err := ws.connectWithConfig(config); err != nil {
+15 -17
View File
@@ -875,23 +875,21 @@ func (ds *DataStore) GetETagForAccount(account, device string) int64 {
// Settings represents the global service settings.
type Settings struct {
ServerURL string `json:"server_url"`
SoundcorkURL string `json:"soundcork_url"`
HTTPServerURL string `json:"https_server_url,omitempty"`
RedactLogs bool `json:"redact_logs"`
LogBodies bool `json:"log_bodies"`
RecordInteractions bool `json:"record_interactions"`
DiscoveryInterval string `json:"discovery_interval,omitempty"`
DiscoveryEnabled bool `json:"discovery_enabled"`
EnableSoundcorkProxy bool `json:"enable_soundcork_proxy"`
DNSEnabled bool `json:"dns_enabled"`
DNSUpstream []string `json:"dns_upstream,omitempty"`
DNSBindAddr string `json:"dns_bind_addr,omitempty"`
MirrorEnabled bool `json:"mirror_enabled"`
MirrorEndpoints []string `json:"mirror_endpoints,omitempty"`
PreferredSource string `json:"preferred_source,omitempty"`
InternalPaths []string `json:"internal_paths,omitempty"`
Shortcuts map[string]int `json:"shortcuts,omitempty"`
ServerURL string `json:"server_url"`
HTTPServerURL string `json:"https_server_url,omitempty"`
RedactLogs bool `json:"redact_logs"`
LogBodies bool `json:"log_bodies"`
RecordInteractions bool `json:"record_interactions"`
DiscoveryInterval string `json:"discovery_interval,omitempty"`
DiscoveryEnabled bool `json:"discovery_enabled"`
DNSEnabled bool `json:"dns_enabled"`
DNSUpstream []string `json:"dns_upstream,omitempty"`
DNSBindAddr string `json:"dns_bind_addr,omitempty"`
MirrorEnabled bool `json:"mirror_enabled"`
MirrorEndpoints []string `json:"mirror_endpoints,omitempty"`
PreferredSource string `json:"preferred_source,omitempty"`
InternalPaths []string `json:"internal_paths,omitempty"`
Shortcuts map[string]int `json:"shortcuts,omitempty"`
}
// GetSettings retrieves the global service settings.
-1
View File
@@ -382,7 +382,6 @@ func TestSettingsPersistence(t *testing.T) {
settings := Settings{
ServerURL: "http://myserver:8000",
SoundcorkURL: "http://myproxy:8001",
LogBodies: true,
DiscoveryInterval: "10m",
DiscoveryEnabled: true,
@@ -154,7 +154,7 @@ func TestComprehensiveMigration_MultipleExistingDevices(t *testing.T) {
deviceIP := server.URL[len("http://"):]
sm := setup.NewManager(server.URL, ds, nil)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false, false)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false)
// Simulate device rediscovery
discoveredDevice := models.DiscoveredDevice{
@@ -233,7 +233,7 @@ func TestFindAllExistingDeviceVariants_MatchingCriteria(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
accountID := "testaccount"
// Create devices that should match various criteria
@@ -344,7 +344,7 @@ func TestMigration_EdgeCases(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
accountID := "testaccount"
t.Run("NoExistingDevices", func(t *testing.T) {
+3 -3
View File
@@ -16,7 +16,7 @@ func TestDeviceMigration_DirectoryRename(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, true, false)
srv := NewServer(ds, nil, "http://localhost", false, false, false, true, false)
accountID := "test-account"
macAddress := "A81B6A536A98"
@@ -121,7 +121,7 @@ func TestDeviceMigration_NoExistingTarget(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, true, false)
srv := NewServer(ds, nil, "http://localhost", false, false, false, true, false)
accountID := "test-account"
macAddress := "A81B6A536A98"
@@ -189,7 +189,7 @@ func TestDeviceMigration_ExistingTargetRemoved(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
srv := NewServer(ds, nil, "http://localhost", false, false, false, false, true, false)
srv := NewServer(ds, nil, "http://localhost", false, false, false, true, false)
accountID := "test-account"
macAddress := "A81B6A536A98"
+3 -3
View File
@@ -14,11 +14,11 @@ import (
func TestEventLog(t *testing.T) {
ds := datastore.NewDataStore(t.TempDir())
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
r := chi.NewRouter()
r.Post("/streaming/stats/usage", s.HandleUsageStats)
r.Get("/setup/devices/{deviceId}/events", s.HandleGetDeviceEvents)
r.Get("/devices/{deviceId}/events", s.HandleGetDeviceEvents)
t.Run("Record and Retrieve Events", func(t *testing.T) {
// 1. Post a usage stat
@@ -36,7 +36,7 @@ func TestEventLog(t *testing.T) {
}
// 2. Retrieve events
req, _ = http.NewRequest("GET", "/setup/devices/SPEAKER1/events", nil)
req, _ = http.NewRequest("GET", "/devices/SPEAKER1/events", nil)
w = httptest.NewRecorder()
r.ServeHTTP(w, req)
+1 -1
View File
@@ -20,7 +20,7 @@ type healthResp struct {
func TestHealthEndpoint(t *testing.T) {
r := chi.NewRouter()
srv := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
srv := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
r.Get("/health", srv.HandleHealth)
ts := httptest.NewServer(r)
+1 -1
View File
@@ -11,7 +11,7 @@ import (
//go:embed web/index.html
var indexHTML []byte
//go:embed web/css/* web/js/*
//go:embed web/migration/* web/stockholm-mini/* web/shared/*
var webFS embed.FS
//go:embed static/media/*
+90 -8
View File
@@ -103,32 +103,114 @@ func TestStaticWeb(t *testing.T) {
ts := httptest.NewServer(r)
defer ts.Close()
// 1. Test CSS
res, err := http.Get(ts.URL + "/web/css/style.css")
// 1. Test Migration UI CSS
res, err := http.Get(ts.URL + "/web/migration/style.css")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("CSS: Expected status OK, got %v", res.Status)
t.Errorf("Migration CSS: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "text/css") {
t.Errorf("CSS: Expected text/css content type, got %s", res.Header.Get("Content-Type"))
t.Errorf("Migration CSS: Expected text/css content type, got %s", res.Header.Get("Content-Type"))
}
// 2. Test JS
res, err = http.Get(ts.URL + "/web/js/script.js")
// 2. Test Migration UI JS
res, err = http.Get(ts.URL + "/web/migration/script.js")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("JS: Expected status OK, got %v", res.Status)
t.Errorf("Migration JS: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "application/javascript") &&
!strings.Contains(res.Header.Get("Content-Type"), "text/javascript") {
t.Errorf("JS: Expected javascript content type, got %s", res.Header.Get("Content-Type"))
t.Errorf("Migration JS: Expected javascript content type, got %s", res.Header.Get("Content-Type"))
}
// 3. Test Migration UI Index
res, err = http.Get(ts.URL + "/web/migration/index.html")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Migration Index: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "text/html") {
t.Errorf("Migration Index: Expected text/html content type, got %s", res.Header.Get("Content-Type"))
}
// 4. Test Stockholm Mini
res, err = http.Get(ts.URL + "/web/stockholm-mini/index.html")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Stockholm Mini: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "text/html") {
t.Errorf("Stockholm Mini: Expected text/html content type, got %s", res.Header.Get("Content-Type"))
}
// 5. Test Stockholm Mini CSS
res, err = http.Get(ts.URL + "/web/stockholm-mini/style.css")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Stockholm Mini CSS: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "text/css") {
t.Errorf("Stockholm Mini CSS: Expected text/css content type, got %s", res.Header.Get("Content-Type"))
}
// 6. Test Shared CSS
res, err = http.Get(ts.URL + "/web/shared/common.css")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Shared CSS: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "text/css") {
t.Errorf("Shared CSS: Expected text/css content type, got %s", res.Header.Get("Content-Type"))
}
// 7. Test Shared JS
res, err = http.Get(ts.URL + "/web/shared/common.js")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Shared JS: Expected status OK, got %v", res.Status)
}
if !strings.Contains(res.Header.Get("Content-Type"), "application/javascript") &&
!strings.Contains(res.Header.Get("Content-Type"), "text/javascript") {
t.Errorf("Shared JS: Expected javascript content type, got %s", res.Header.Get("Content-Type"))
}
// 3. Test diff.min.js
res, err = http.Get(ts.URL + "/web/js/diff.min.js")
if err != nil {
t.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
t.Errorf("Diff JS: Expected status OK, got %v", res.Status)
}
}
+5 -5
View File
@@ -13,7 +13,7 @@ import (
)
func TestHandleMgmtSpotifyInit(t *testing.T) {
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
// No spotify service configured
req := httptest.NewRequest("POST", "/mgmt/spotify/init", nil)
w := httptest.NewRecorder()
@@ -45,7 +45,7 @@ func TestHandleMgmtSpotifyInit(t *testing.T) {
}
func TestHandleMgmtSpotifyAccounts(t *testing.T) {
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
s.SetSpotifyService(svc)
@@ -91,7 +91,7 @@ func TestHandleMgmtListSpeakers(t *testing.T) {
}
func TestHandleMgmtSpotifyCallback(t *testing.T) {
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
s.SetSpotifyService(svc)
@@ -150,7 +150,7 @@ func TestHandleMgmtSpotifyCallback(t *testing.T) {
}
func TestHandleMgmtSpotifyConfirm(t *testing.T) {
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
svc := spotify.NewSpotifyService("cid", "secret", "http://localhost/cb", t.TempDir())
s.SetSpotifyService(svc)
@@ -191,7 +191,7 @@ func TestHandleMgmtDeviceEvents(t *testing.T) {
}
func TestBasicAuthMgmt(t *testing.T) {
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(nil, nil, "http://localhost", false, false, false, false, false)
s.SetMgmtConfig("admin", "secret123")
handler := s.BasicAuthMgmt()(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+14 -91
View File
@@ -55,23 +55,21 @@ func (s *Server) ServeProxy(target *url.URL) http.HandlerFunc {
r.Body = io.NopCloser(bytes.NewBuffer(reqBody))
}
rp := httputil.NewSingleHostReverseProxy(target)
rp.Transport = &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
}
rp := &httputil.ReverseProxy{
Rewrite: func(pr *httputil.ProxyRequest) {
pr.SetURL(target)
pr.Out.Host = target.Host
// If target has a path, we should probably append or replace.
// For Bose upstream, it's usually just the domain.
if target.Path != "" && target.Path != "/" {
pr.Out.URL.Path = target.Path
}
// Update director to set the correct host and path
originalDirector := rp.Director
rp.Director = func(req *http.Request) {
originalDirector(req)
req.Host = target.Host
// If target has a path, we should probably append or replace.
// For Bose upstream, it's usually just the domain.
if target.Path != "" && target.Path != "/" {
req.URL.Path = target.Path
}
lp.LogRequest(req)
lp.LogRequest(pr.Out)
},
Transport: &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
},
}
rp.ModifyResponse = func(res *http.Response) error {
@@ -98,84 +96,9 @@ func (s *Server) ServeProxy(target *url.URL) http.HandlerFunc {
// HandleNotFound handles requests that don't match any route.
func (s *Server) HandleNotFound(w http.ResponseWriter, r *http.Request) {
if s.enableSoundcorkProxy {
s.HandleSoundcorkWithFallback(w, r)
return
}
s.HandleBoseProxy(w, r)
}
// HandleSoundcorkWithFallback tries Soundcork first, then Bose if Soundcork returns 404 or fails.
func (s *Server) HandleSoundcorkWithFallback(w http.ResponseWriter, r *http.Request) {
target, _ := url.Parse(s.soundcorkURL)
// Buffer request body if any, to allow multiple proxy attempts
var bodyBytes []byte
if r.Body != nil {
bodyBytes, _ = io.ReadAll(r.Body)
_ = r.Body.Close()
}
// We use a custom response writer to catch 404s
rw := &fallbackResponseWriter{
ResponseWriter: w,
statusCode: http.StatusOK,
buffer: &bytes.Buffer{},
}
// Create a shallow copy of the request to avoid side effects between attempts
r2 := r.Clone(r.Context())
if bodyBytes != nil {
r2.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
} else {
r2.Body = nil
}
// Remove RequestURI as it's not allowed in client requests
r2.RequestURI = ""
s.ServeProxy(target)(rw, r2)
if rw.statusCode == http.StatusNotFound || rw.statusCode == http.StatusBadGateway || rw.statusCode == http.StatusServiceUnavailable {
log.Printf("[PROXY] Soundcork returned %d for %s, falling back to Bose", rw.statusCode, r.URL.Path)
if !rw.wroteHeader {
// Restore original body if any
if bodyBytes != nil {
r.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
}
s.HandleBoseProxy(w, r)
}
}
}
type fallbackResponseWriter struct {
http.ResponseWriter
statusCode int
wroteHeader bool
buffer *bytes.Buffer
}
func (rw *fallbackResponseWriter) WriteHeader(code int) {
rw.statusCode = code
if code != http.StatusNotFound && code != http.StatusBadGateway && code != http.StatusServiceUnavailable {
rw.wroteHeader = true
rw.ResponseWriter.WriteHeader(code)
}
}
func (rw *fallbackResponseWriter) Write(b []byte) (int, error) {
if rw.statusCode == http.StatusNotFound || rw.statusCode == http.StatusBadGateway || rw.statusCode == http.StatusServiceUnavailable {
return len(b), nil // Drop the body
}
rw.wroteHeader = true
return rw.ResponseWriter.Write(b)
}
// HandleBoseProxy proxies the request to the Bose upstream.
func (s *Server) HandleBoseProxy(w http.ResponseWriter, r *http.Request) {
host := r.Host
+1 -1
View File
@@ -33,7 +33,7 @@ func TestHandleProxyRequest_RequestBodyRecording(t *testing.T) {
defer backend.Close()
ds := datastore.NewDataStore(filepath.Join(tmpDir, "test.db"))
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
server.recordEnabled = true
server.proxyLogBody = true
recorder := proxy.NewRecorder(tmpDir)
+61 -75
View File
@@ -148,7 +148,7 @@ func (s *Server) HandleGetSettings(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
s.mu.RLock()
serverURL, soundcorkURL, httpsServerURL := s.serverURL, s.soundcorkURL, s.httpsServerURL
serverURL, httpsServerURL := s.serverURL, s.httpsServerURL
discoveryInterval := s.discoveryInterval.String()
discoveryEnabled := s.discoveryEnabled
dnsEnabled := s.dnsEnabled
@@ -158,7 +158,6 @@ func (s *Server) HandleGetSettings(w http.ResponseWriter, _ *http.Request) {
mirrorEndpoints := s.mirrorEndpoints
preferredSource := s.preferredSource
internalPaths := s.internalPaths
enableSoundcorkProxy := s.enableSoundcorkProxy
redact, logBody, record := s.proxyRedact, s.proxyLogBody, s.recordEnabled
shortcuts := s.shortcuts
spotifyConfigured := s.spotifyService != nil
@@ -167,26 +166,24 @@ func (s *Server) HandleGetSettings(w http.ResponseWriter, _ *http.Request) {
dnsRunning, actualBind := s.GetDNSRunning()
if err := json.NewEncoder(w).Encode(map[string]interface{}{
"server_url": serverURL,
"soundcork_url": soundcorkURL,
"https_server_url": httpsServerURL,
"discovery_interval": discoveryInterval,
"discovery_enabled": discoveryEnabled,
"dns_enabled": dnsEnabled,
"dns_running": dnsRunning,
"dns_actual_bind": actualBind,
"dns_upstream": strings.Join(dnsUpstream, ","),
"dns_bind_addr": dnsBindAddr,
"mirror_enabled": mirrorEnabled,
"mirror_endpoints": mirrorEndpoints,
"preferred_source": preferredSource,
"internal_paths": internalPaths,
"enable_soundcork_proxy": enableSoundcorkProxy,
"redact_logs": redact,
"log_bodies": logBody,
"record_interactions": record,
"shortcuts": shortcuts,
"spotify_configured": spotifyConfigured,
"server_url": serverURL,
"https_server_url": httpsServerURL,
"discovery_interval": discoveryInterval,
"discovery_enabled": discoveryEnabled,
"dns_enabled": dnsEnabled,
"dns_running": dnsRunning,
"dns_actual_bind": actualBind,
"dns_upstream": strings.Join(dnsUpstream, ","),
"dns_bind_addr": dnsBindAddr,
"mirror_enabled": mirrorEnabled,
"mirror_endpoints": mirrorEndpoints,
"preferred_source": preferredSource,
"internal_paths": internalPaths,
"redact_logs": redact,
"log_bodies": logBody,
"record_interactions": record,
"shortcuts": shortcuts,
"spotify_configured": spotifyConfigured,
}); err != nil {
http.Error(w, "Failed to encode response", http.StatusInternalServerError)
return
@@ -196,19 +193,17 @@ func (s *Server) HandleGetSettings(w http.ResponseWriter, _ *http.Request) {
// HandleUpdateSettings updates the service settings.
func (s *Server) HandleUpdateSettings(w http.ResponseWriter, r *http.Request) {
var settings struct {
ServerURL string `json:"server_url"`
SoundcorkURL string `json:"soundcork_url"`
DiscoveryInterval string `json:"discovery_interval"`
DiscoveryEnabled bool `json:"discovery_enabled"`
DNSEnabled bool `json:"dns_enabled"`
DNSUpstream string `json:"dns_upstream"`
DNSBindAddr string `json:"dns_bind_addr"`
MirrorEnabled bool `json:"mirror_enabled"`
MirrorEndpoints []string `json:"mirror_endpoints"`
PreferredSource string `json:"preferred_source"`
InternalPaths []string `json:"internal_paths"`
EnableSoundcorkProxy bool `json:"enable_soundcork_proxy"`
Shortcuts map[string]int `json:"shortcuts"`
ServerURL string `json:"server_url"`
DiscoveryInterval string `json:"discovery_interval"`
DiscoveryEnabled bool `json:"discovery_enabled"`
DNSEnabled bool `json:"dns_enabled"`
DNSUpstream string `json:"dns_upstream"`
DNSBindAddr string `json:"dns_bind_addr"`
MirrorEnabled bool `json:"mirror_enabled"`
MirrorEndpoints []string `json:"mirror_endpoints"`
PreferredSource string `json:"preferred_source"`
InternalPaths []string `json:"internal_paths"`
Shortcuts map[string]int `json:"shortcuts"`
}
if err := json.NewDecoder(r.Body).Decode(&settings); err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
@@ -230,7 +225,6 @@ func (s *Server) HandleUpdateSettings(w http.ResponseWriter, r *http.Request) {
s.mu.Lock()
s.serverURL = settings.ServerURL
s.soundcorkURL = settings.SoundcorkURL
if settings.DiscoveryInterval != "" {
s.discoveryInterval = interval
}
@@ -258,7 +252,6 @@ func (s *Server) HandleUpdateSettings(w http.ResponseWriter, r *http.Request) {
s.preferredSource = settings.PreferredSource
s.internalPaths = settings.InternalPaths
s.enableSoundcorkProxy = settings.EnableSoundcorkProxy
if settings.Shortcuts != nil {
s.shortcuts = settings.Shortcuts
}
@@ -276,23 +269,21 @@ func (s *Server) HandleUpdateSettings(w http.ResponseWriter, r *http.Request) {
log.Printf("Saving updated settings to %s/settings.json", s.ds.DataDir)
err = s.ds.SaveSettings(datastore.Settings{
ServerURL: s.serverURL,
SoundcorkURL: s.soundcorkURL,
HTTPServerURL: currentHTTPS,
RedactLogs: currentRedact,
LogBodies: currentLogBody,
RecordInteractions: currentRecord,
DiscoveryInterval: s.discoveryInterval.String(),
DiscoveryEnabled: s.discoveryEnabled,
DNSEnabled: s.dnsEnabled,
DNSUpstream: s.dnsUpstream,
DNSBindAddr: s.dnsBindAddr,
MirrorEnabled: s.mirrorEnabled,
MirrorEndpoints: s.mirrorEndpoints,
PreferredSource: s.preferredSource,
InternalPaths: s.internalPaths,
EnableSoundcorkProxy: s.enableSoundcorkProxy,
Shortcuts: s.shortcuts,
ServerURL: s.serverURL,
HTTPServerURL: currentHTTPS,
RedactLogs: currentRedact,
LogBodies: currentLogBody,
RecordInteractions: currentRecord,
DiscoveryInterval: s.discoveryInterval.String(),
DiscoveryEnabled: s.discoveryEnabled,
DNSEnabled: s.dnsEnabled,
DNSUpstream: s.dnsUpstream,
DNSBindAddr: s.dnsBindAddr,
MirrorEnabled: s.mirrorEnabled,
MirrorEndpoints: s.mirrorEndpoints,
PreferredSource: s.preferredSource,
InternalPaths: s.internalPaths,
Shortcuts: s.shortcuts,
})
dnsEnabled := s.dnsEnabled
@@ -793,13 +784,12 @@ func (s *Server) HandleBackupConfig(w http.ResponseWriter, r *http.Request) {
func (s *Server) HandleGetProxySettings(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
redact, logBody, record, enableSoundcorkProxy := s.GetProxySettings()
redact, logBody, record := s.GetProxySettings()
if err := json.NewEncoder(w).Encode(map[string]interface{}{
"redact": redact,
"log_body": logBody,
"record": record,
"enable_soundcork_proxy": enableSoundcorkProxy,
"redact": redact,
"log_body": logBody,
"record": record,
}); err != nil {
http.Error(w, "Failed to encode response", http.StatusInternalServerError)
return
@@ -824,10 +814,9 @@ func (s *Server) HandleGetCACert(w http.ResponseWriter, _ *http.Request) {
// HandleUpdateProxySettings updates the proxy settings.
func (s *Server) HandleUpdateProxySettings(w http.ResponseWriter, r *http.Request) {
var settings struct {
Redact bool `json:"redact"`
LogBody bool `json:"log_body"`
Record bool `json:"record"`
EnableSoundcorkProxy bool `json:"enable_soundcork_proxy"`
Redact bool `json:"redact"`
LogBody bool `json:"log_body"`
Record bool `json:"record"`
}
if err := json.NewDecoder(r.Body).Decode(&settings); err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
@@ -838,7 +827,6 @@ func (s *Server) HandleUpdateProxySettings(w http.ResponseWriter, r *http.Reques
s.proxyRedact = settings.Redact
s.proxyLogBody = settings.LogBody
s.recordEnabled = settings.Record
s.enableSoundcorkProxy = settings.EnableSoundcorkProxy
if s.recorder != nil {
s.recorder.Redact = settings.Redact
@@ -846,22 +834,20 @@ func (s *Server) HandleUpdateProxySettings(w http.ResponseWriter, r *http.Reques
// Persist to datastore
// Access fields directly since we already hold the lock
serverURL, soundcorkURL, httpsServerURL := s.serverURL, s.soundcorkURL, s.httpsServerURL
serverURL, httpsServerURL := s.serverURL, s.httpsServerURL
discoveryInterval := s.discoveryInterval.String()
discoveryEnabled := s.discoveryEnabled
log.Printf("Saving updated proxy settings to %s/settings.json", s.ds.DataDir)
err := s.ds.SaveSettings(datastore.Settings{
ServerURL: serverURL,
SoundcorkURL: soundcorkURL,
HTTPServerURL: httpsServerURL,
RedactLogs: s.proxyRedact,
LogBodies: s.proxyLogBody,
RecordInteractions: s.recordEnabled,
DiscoveryInterval: discoveryInterval,
DiscoveryEnabled: discoveryEnabled,
EnableSoundcorkProxy: s.enableSoundcorkProxy,
Shortcuts: s.shortcuts,
ServerURL: serverURL,
HTTPServerURL: httpsServerURL,
RedactLogs: s.proxyRedact,
LogBodies: s.proxyLogBody,
RecordInteractions: s.recordEnabled,
DiscoveryInterval: discoveryInterval,
DiscoveryEnabled: discoveryEnabled,
Shortcuts: s.shortcuts,
})
s.mu.Unlock()
+27 -26
View File
@@ -101,8 +101,7 @@ func TestProxySettingsAPI(t *testing.T) {
// 3. Test System Settings POST
sysUpdate := map[string]string{
"server_url": "http://new-server:8000",
"soundcork_url": "http://new-proxy:8001",
"server_url": "http://new-server:8000",
}
sysBody, err := json.Marshal(sysUpdate)
@@ -122,15 +121,14 @@ func TestProxySettingsAPI(t *testing.T) {
}
// Verify server state
sURL, pURL, _ := server.GetSettings()
if sURL != "http://new-server:8000" || pURL != "http://new-proxy:8001" {
t.Errorf("POST /setup/settings: Server state did not update: serverURL=%s, soundcorkURL=%s", sURL, pURL)
sURL, _ := server.GetSettings()
if sURL != "http://new-server:8000" {
t.Errorf("POST /setup/settings: Server state did not update: serverURL=%s", sURL)
}
// 4. Test Mirror Settings persistence
mirrorUpdate := map[string]interface{}{
"server_url": "http://mirror-test:8000",
"soundcork_url": "http://mirror-test:8001",
"mirror_enabled": true,
"mirror_endpoints": []string{"/test/*"},
"internal_paths": []string{"/setup/*"},
@@ -234,8 +232,8 @@ func TestMigrationAndCA(t *testing.T) {
t.Errorf("CA: Unexpected content type: %s", res.Header.Get("Content-Type"))
}
// 2. Test POST /setup/migrate/{deviceIP}?method=hosts
res, err = http.Post(ts.URL+"/setup/migrate/192.168.1.10?method=hosts&target_url=http://192.168.1.100:8000", "application/json", nil)
// 2. Test POST /setup/devices/{deviceIP}/migrate?method=hosts
res, err = http.Post(ts.URL+"/setup/devices/192.168.1.10/migrate?method=hosts&target_url=http://192.168.1.100:8000", "application/json", nil)
if err != nil {
t.Fatal(err)
}
@@ -256,8 +254,8 @@ func TestMigrationAndCA(t *testing.T) {
t.Errorf("Migrate: Expected output field in response")
}
// 3. Test POST /setup/trust-ca/{deviceIP}
res, err = http.Post(ts.URL+"/setup/trust-ca/192.168.1.10", "application/json", nil)
// 3. Test POST /setup/devices/{deviceIP}/trust-ca
res, err = http.Post(ts.URL+"/setup/devices/192.168.1.10/trust-ca", "application/json", nil)
if err != nil {
t.Fatal(err)
}
@@ -277,8 +275,8 @@ func TestMigrationAndCA(t *testing.T) {
t.Errorf("TrustCA: Expected output field in response")
}
// 4. Test POST /setup/reboot/{deviceIP}
res, err = http.Post(ts.URL+"/setup/reboot/192.168.1.10", "application/json", nil)
// 4. Test POST /devices/{deviceIP}/reboot
res, err = http.Post(ts.URL+"/devices/192.168.1.10/reboot", "application/json", nil)
if err != nil {
t.Fatal(err)
}
@@ -298,8 +296,8 @@ func TestMigrationAndCA(t *testing.T) {
t.Errorf("Reboot: Expected output field in response")
}
// 5. Test POST /setup/remove-remote-services/{deviceIP}
res, err = http.Post(ts.URL+"/setup/remove-remote-services/192.168.1.10", "application/json", nil)
// 5. Test POST /setup/devices/{deviceIP}/remove-remote-services
res, err = http.Post(ts.URL+"/setup/devices/192.168.1.10/remove-remote-services", "application/json", nil)
if err != nil {
t.Fatal(err)
}
@@ -331,17 +329,20 @@ func TestRemoveDevice(t *testing.T) {
_ = ds.Initialize()
// Setup a dummy device in the datastore
account := "test-account"
account := "acc1"
deviceID := "TEST-DEVICE-ID"
deviceDir := filepath.Join(tempDir, "accounts", account, "devices", deviceID)
if err := os.MkdirAll(deviceDir, 0755); err != nil {
t.Fatalf("Failed to create device dir: %v", err)
}
infoFile := filepath.Join(deviceDir, "DeviceInfo.xml")
infoXML := `<?xml version="1.0" encoding="UTF-8" ?><info deviceID="TEST-DEVICE-ID"><name>Test Device</name><type>SoundTouch 10</type></info>`
if err := os.WriteFile(infoFile, []byte(infoXML), 0644); err != nil {
t.Fatalf("Failed to create device info file: %v", err)
// Register device in datastore so HandleRemoveDevice works
_ = ds.SaveDeviceInfo(account, deviceID, &models.ServiceDeviceInfo{
DeviceID: deviceID,
AccountID: account,
IPAddress: "192.168.1.100",
})
// Verify directory exists where datastore expects it
deviceDir := filepath.Join(tempDir, "accounts", account, "devices", deviceID)
if _, err := os.Stat(deviceDir); err != nil {
t.Fatalf("Device directory was not created by SaveDeviceInfo: %v", err)
}
r, _ := setupRouter("http://localhost:8001", ds)
@@ -349,7 +350,7 @@ func TestRemoveDevice(t *testing.T) {
defer ts.Close()
// 1. Verify device exists
res, err := http.Get(ts.URL + "/setup/devices")
res, err := http.Get(ts.URL + "/devices")
if err != nil {
t.Fatal(err)
}
@@ -372,7 +373,7 @@ func TestRemoveDevice(t *testing.T) {
}
// 2. Remove device
req, err := http.NewRequest(http.MethodDelete, ts.URL+"/setup/devices/"+deviceID, nil)
req, err := http.NewRequest(http.MethodDelete, ts.URL+"/devices/"+deviceID, nil)
if err != nil {
t.Fatal(err)
}
@@ -387,7 +388,7 @@ func TestRemoveDevice(t *testing.T) {
}
// 3. Verify device is gone
res, err = http.Get(ts.URL + "/setup/devices")
res, err = http.Get(ts.URL + "/devices")
if err != nil {
t.Fatal(err)
}
+1 -1
View File
@@ -20,7 +20,7 @@ func TestStatsHandlers(t *testing.T) {
defer func() { _ = os.RemoveAll(tempDir) }()
ds := datastore.NewDataStore(tempDir)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
t.Run("HandleUsageStats XML", func(t *testing.T) {
xmlData := `
+124
View File
@@ -0,0 +1,124 @@
package handlers
import (
"encoding/json"
"fmt"
"log"
"net/http"
"strconv"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/service/setup"
"github.com/go-chi/chi/v5"
)
// HandleGetStockholmDeviceInfo returns live information for a device.
func (s *Server) HandleGetStockholmDeviceInfo(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "deviceId")
if deviceID == "" {
http.Error(w, "Device ID is required", http.StatusBadRequest)
return
}
deviceIP, err := s.lookupIP(deviceID)
if err != nil {
http.Error(w, err.Error(), http.StatusNotFound)
return
}
info, err := s.sm.GetLiveDeviceInfo(deviceIP)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
// Include IP address in both snake_case and camelCase for frontend compatibility
type deviceInfoResponse struct {
*setup.DeviceInfoXML `json:",inline"`
IPAddress string `json:"ip_address"`
IPAddressCamel string `json:"ipAddress,omitempty"`
}
resp := deviceInfoResponse{
DeviceInfoXML: info,
IPAddress: deviceIP,
IPAddressCamel: deviceIP,
}
if err := json.NewEncoder(w).Encode(resp); err != nil {
http.Error(w, "Failed to encode response", http.StatusInternalServerError)
return
}
}
// HandleDeviceKey sends a key command to a device.
func (s *Server) HandleDeviceKey(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "deviceId")
key := chi.URLParam(r, "key")
if deviceID == "" || key == "" {
http.Error(w, "Device ID and Key are required", http.StatusBadRequest)
return
}
deviceIP, err := s.lookupIP(deviceID)
if err != nil {
http.Error(w, err.Error(), http.StatusNotFound)
return
}
c := client.NewClientFromHost(deviceIP)
err = c.SendKey(key)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to send key %s to %s: %v", key, deviceIP, err), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(map[string]interface{}{"ok": true, "message": "Key sent"}); err != nil {
log.Printf("Failed to encode JSON response: %v", err)
http.Error(w, "Internal server error", http.StatusInternalServerError)
}
}
// HandleDeviceVolume sets the volume level for a device.
func (s *Server) HandleDeviceVolume(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "deviceId")
levelStr := chi.URLParam(r, "level")
if deviceID == "" || levelStr == "" {
http.Error(w, "Device ID and Level are required", http.StatusBadRequest)
return
}
deviceIP, err := s.lookupIP(deviceID)
if err != nil {
http.Error(w, err.Error(), http.StatusNotFound)
return
}
level, err := strconv.Atoi(levelStr)
if err != nil {
http.Error(w, "Invalid volume level", http.StatusBadRequest)
return
}
c := client.NewClientFromHost(deviceIP)
err = c.SetVolume(level)
if err != nil {
http.Error(w, fmt.Sprintf("Failed to set volume to %d on %s: %v", level, deviceIP, err), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
if err := json.NewEncoder(w).Encode(map[string]interface{}{"ok": true, "message": "Volume set"}); err != nil {
log.Printf("Failed to encode JSON response: %v", err)
http.Error(w, "Internal server error", http.StatusInternalServerError)
}
}
+203
View File
@@ -0,0 +1,203 @@
package handlers
import (
"encoding/json"
"log"
"net/http"
"time"
"github.com/gesellix/bose-soundtouch/pkg/client"
"github.com/gesellix/bose-soundtouch/pkg/models"
"github.com/go-chi/chi/v5"
"github.com/gorilla/websocket"
)
var upgrader = websocket.Upgrader{
CheckOrigin: func(_ *http.Request) bool { return true },
}
const (
pongWait = 40 * time.Second
pingPeriod = 20 * time.Second // must be less than pongWait
)
// HandleDeviceWebSocket upgrades the connection and proxies device WebSocket events to the browser.
func (s *Server) HandleDeviceWebSocket(w http.ResponseWriter, r *http.Request) {
deviceID := chi.URLParam(r, "deviceId")
if deviceID == "" {
http.Error(w, "Device ID is required", http.StatusBadRequest)
return
}
deviceIP, err := s.lookupIP(deviceID)
if err != nil {
http.Error(w, err.Error(), http.StatusNotFound)
return
}
// Upgrade the HTTP connection to a WebSocket for the browser
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
return
}
// Create a SoundTouch WebSocket client for the target device
c := client.NewClientFromHost(deviceIP)
wsClient := c.NewWebSocketClient(client.DefaultWebSocketConfig())
// Channel-based write pump per Gorilla best practices
sendCh := make(chan []byte, 64) // buffer to smooth bursts
closeCh := make(chan struct{})
// Helper to enqueue JSON messages; drop if buffer is full to avoid blocking
enqueue := func(v interface{}) {
b, err := json.Marshal(v)
if err != nil {
return
}
select {
case sendCh <- b:
default:
// drop to protect connection under burst
}
}
// Reader: we don't expect messages from the browser; just keep the
// connection alive by processing control frames and detect close.
_ = conn.SetReadDeadline(time.Now().Add(pongWait))
conn.SetPongHandler(func(string) error {
return conn.SetReadDeadline(time.Now().Add(pongWait))
})
go func() {
defer func() {
close(closeCh)
_ = wsClient.Disconnect()
_ = conn.Close()
}()
for {
mt, _, err := conn.ReadMessage()
if err != nil {
log.Printf("[WebSocket] Browser connection closed for %s: %v", deviceIP, err)
return
}
if mt == websocket.CloseMessage {
return
}
}
}()
// Writer: single writer goroutine handles JSON writes and ping keepalive
go func() {
pingTicker := time.NewTicker(pingPeriod)
defer func() {
pingTicker.Stop()
_ = conn.Close()
}()
for {
select {
case msg, ok := <-sendCh:
_ = conn.SetWriteDeadline(time.Now().Add(10 * time.Second))
if !ok {
_ = conn.WriteMessage(websocket.CloseMessage, []byte{})
return
}
if err := conn.WriteMessage(websocket.TextMessage, msg); err != nil {
return
}
case <-pingTicker.C:
_ = conn.SetWriteDeadline(time.Now().Add(10 * time.Second))
if err := conn.WriteMessage(websocket.PingMessage, nil); err != nil {
return
}
case <-closeCh:
return
}
}
}()
// Forward typed events with a simple envelope into the send queue
wsClient.SetHandlers(&models.WebSocketEventHandlers{
OnNowPlaying: func(e *models.NowPlayingUpdatedEvent) {
enqueue(map[string]interface{}{"type": "nowPlayingUpdated", "payload": e})
},
OnVolumeUpdated: func(e *models.VolumeUpdatedEvent) {
enqueue(map[string]interface{}{"type": "volumeUpdated", "payload": e})
},
OnConnectionState: func(e *models.ConnectionStateUpdatedEvent) {
enqueue(map[string]interface{}{"type": "connectionStateUpdated", "payload": e})
},
OnPresetUpdated: func(e *models.PresetUpdatedEvent) {
enqueue(map[string]interface{}{"type": "presetUpdated", "payload": e})
},
OnZoneUpdated: func(e *models.ZoneUpdatedEvent) {
enqueue(map[string]interface{}{"type": "zoneUpdated", "payload": e})
},
OnBassUpdated: func(e *models.BassUpdatedEvent) {
enqueue(map[string]interface{}{"type": "bassUpdated", "payload": e})
},
OnUnknownEvent: func(event *models.WebSocketEvent) {
bytes, _ := json.Marshal(event)
enqueue(map[string]interface{}{"type": "unknown", "payload": json.RawMessage(bytes)})
},
OnSpecialMessage: func(msg *models.SpecialMessage) {
enqueue(map[string]interface{}{"type": "special", "payload": msg})
},
})
// Add a separate goroutine to monitor the device connection status
go func() {
wsClient.Wait()
log.Printf("[WebSocket] Device %s client terminated", deviceIP)
_ = conn.Close()
}()
// Connect to the device WebSocket
if err := wsClient.Connect(); err != nil {
enqueue(map[string]interface{}{"type": "error", "message": err.Error()})
return
}
// Optional: send an initial snapshot for convenience
go func() {
info, err := s.sm.GetLiveDeviceInfo(deviceIP)
if err != nil {
return
}
// Supplement with volume and now playing
c := client.NewClientFromHost(deviceIP)
payload := map[string]interface{}{
"deviceID": info.DeviceID,
"name": info.Name,
"type": info.Type,
//"maccAddress": info.MaccAddress,
"serialNumber": info.SerialNumber,
"softwareVersion": info.SoftwareVer,
// Provide IP in both styles for frontend robustness
"ip_address": deviceIP,
"ipAddress": deviceIP,
}
if vol, err := c.GetVolume(); err == nil {
payload["volume"] = vol
// Also add at top level for flatter frontend parsing
payload["actualVolume"] = vol.ActualVolume
}
if np, err := c.GetNowPlaying(); err == nil {
payload["nowPlaying"] = np
}
enqueue(map[string]interface{}{"type": "snapshotInfo", "payload": payload})
}()
}
+2 -2
View File
@@ -23,7 +23,7 @@ func TestInteractionHandlers(t *testing.T) {
defer os.RemoveAll(tmpDir)
ds := datastore.NewDataStore(filepath.Join(tmpDir, "test.db"))
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
t.Run("HandleGetInteractionStats_NoRecorder", func(t *testing.T) {
req := httptest.NewRequest("GET", "/setup/interaction-stats", nil)
@@ -151,7 +151,7 @@ func TestRecordMiddleware(t *testing.T) {
defer os.RemoveAll(tmpDir)
ds := datastore.NewDataStore(filepath.Join(tmpDir, "test.db"))
server := NewServer(ds, nil, "http://localhost", false, false, true, false, false, false)
server := NewServer(ds, nil, "http://localhost", false, false, true, false, false)
recorder := proxy.NewRecorder(tmpDir)
server.SetRecorder(recorder)
@@ -74,7 +74,7 @@ func TestMACBasedDeviceDiscovery_Integration(t *testing.T) {
sm := setup.NewManager(server.URL, ds, nil)
// Create server instance
srv := NewServer(ds, sm, "http://localhost", false, false, false, false, false, false)
srv := NewServer(ds, sm, "http://localhost", false, false, false, false, false)
t.Logf("Test scenario:")
t.Logf(" Device IP: %s", deviceIP)
@@ -311,7 +311,7 @@ func TestMACBasedDeviceDiscovery_MigrationScenario(t *testing.T) {
deviceIP := server.URL[len("http://"):]
sm := setup.NewManager(server.URL, ds, nil)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false, false)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false)
// 3. Simulate rediscovery of the same device (now with /info working)
discoveredDevice := models.DiscoveredDevice{
@@ -380,7 +380,7 @@ func TestMACBasedDeviceDiscovery_FallbackScenario(t *testing.T) {
ds := datastore.NewDataStore(tempDir)
sm := setup.NewManager(server.URL, ds, nil)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false, false)
srv := NewServer(ds, sm, server.URL, false, false, false, false, false)
// Simulate device discovery with UPnP providing serial
discoveredDevice := models.DiscoveredDevice{
@@ -97,7 +97,7 @@ func TestMacMappingIntegration_HTTPHandler(t *testing.T) {
t.Fatalf("failed to initialize datastore: %v", err)
}
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
server := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
// Setup router with the exact same route as in production
router := chi.NewRouter()
+46 -4
View File
@@ -6,8 +6,7 @@ import (
)
func setupRouter(targetURL string, ds *datastore.DataStore) (*chi.Mux, *Server) {
server := NewServer(ds, nil, targetURL, false, false, false, false, false, false)
server.SetSoundcorkURL(targetURL)
server := NewServer(ds, nil, targetURL, false, false, false, false, false)
r := chi.NewRouter()
r.Use(server.OriginMiddleware)
@@ -92,12 +91,31 @@ func setupRouter(targetURL string, ds *datastore.DataStore) (*chi.Mux, *Server)
r.Post("/account/{account}/password", server.HandleMargeChangePassword)
})
// Setup Devices for tests
r.Route("/devices", func(r chi.Router) {
r.Get("/", server.HandleListDiscoveredDevices)
r.Post("/", server.HandleAddManualDevice)
r.Route("/{deviceId}", func(r chi.Router) {
r.Delete("/", server.HandleRemoveDevice)
r.Get("/events", server.HandleGetDeviceEvents)
r.Get("/info", server.HandleGetDeviceInfo)
r.Get("/ws", server.HandleDeviceWebSocket)
r.Post("/key/{key}", server.HandleDeviceKey)
r.Post("/volume/{level}", server.HandleDeviceVolume)
r.Post("/reboot", server.HandleRebootDevice)
})
})
r.Get("/version", server.HandleGetVersionInfo)
// Setup Setup for tests
r.Route("/setup", func(r chi.Router) {
r.Get("/devices", server.HandleListDiscoveredDevices)
r.Delete("/devices/{deviceId}", server.HandleRemoveDevice)
r.Post("/discover", server.HandleTriggerDiscovery)
r.Get("/discovery-status", server.HandleGetDiscoveryStatus)
r.Get("/settings", server.HandleGetSettings)
r.Post("/settings", server.HandleUpdateSettings)
r.Get("/ca.crt", server.HandleGetCACert)
r.Get("/proxy-settings", server.HandleGetProxySettings)
r.Post("/proxy-settings", server.HandleUpdateProxySettings)
r.Post("/ensure-remote-services/{deviceId}", server.HandleEnsureRemoteServices)
@@ -109,6 +127,30 @@ func setupRouter(targetURL string, ds *datastore.DataStore) (*chi.Mux, *Server)
r.Post("/test-connection/{deviceId}", server.HandleTestConnection)
r.Post("/test-hosts/{deviceId}", server.HandleTestHostsRedirection)
r.Get("/ca.crt", server.HandleGetCACert)
r.Get("/interaction-stats", server.HandleGetInteractionStats)
r.Get("/interactions", server.HandleListInteractions)
r.Get("/interaction-content", server.HandleGetInteractionContent)
r.Get("/interactions/sessions/{session}/download", server.HandleDownloadSession)
r.Delete("/interactions/sessions/{session}", server.HandleDeleteSession)
r.Delete("/interactions/sessions", server.HandleCleanupSessions)
r.Get("/dns-discoveries", server.HandleGetDNSDiscoveries)
r.Delete("/dns-discoveries", server.HandleClearDNSDiscoveries)
r.Route("/devices/{deviceId}", func(r chi.Router) {
r.Get("/summary", server.HandleGetMigrationSummary)
r.Post("/migrate", server.HandleMigrateDevice)
r.Post("/revert", server.HandleRevertMigration)
r.Post("/trust-ca", server.HandleTrustCACert)
r.Post("/ensure-remote-services", server.HandleEnsureRemoteServices)
r.Post("/remove-remote-services", server.HandleRemoveRemoteServices)
r.Post("/backup", server.HandleBackupConfig)
r.Post("/sync", server.HandleInitialSync)
r.Post("/test-connection", server.HandleTestConnection)
r.Post("/test-hosts", server.HandleTestHostsRedirection)
r.Post("/test-dns", server.HandleTestDNSRedirection)
})
})
r.NotFound(server.HandleNotFound)
+14 -12
View File
@@ -257,17 +257,15 @@ func (s *Server) performMirror(r *http.Request) *mirrorResponseRecorder {
}
// Create a proxy that doesn't write to the original ResponseWriter
proxy := httputil.NewSingleHostReverseProxy(target)
proxy.Transport = &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
}
// Record the mirrored request
originalDirector := proxy.Director
proxy.Director = func(req *http.Request) {
originalDirector(req)
req.Host = target.Host
req.Header.Set("X-Mirror-Request", "true")
proxy := &httputil.ReverseProxy{
Rewrite: func(pr *httputil.ProxyRequest) {
pr.SetURL(target)
pr.Out.Host = target.Host
pr.Out.Header.Set("X-Mirror-Request", "true")
},
Transport: &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
},
}
// Capture response for parity check and recording
@@ -295,6 +293,7 @@ func (s *Server) performMirror(r *http.Request) *mirrorResponseRecorder {
return recorder
}
// checkParity compares local response with upstream response.
func (s *Server) checkParity(req *http.Request, local, upstream *mirrorResponseRecorder) {
if local.status == 0 {
local.status = 200
@@ -324,7 +323,10 @@ func (s *Server) checkParity(req *http.Request, local, upstream *mirrorResponseR
}
// Basic body comparison (could be improved with XML semantic diff)
if !bytes.Equal(local.body.Bytes(), upstream.body.Bytes()) {
localBody := local.body.Bytes()
upstreamBody := upstream.body.Bytes()
if !bytes.Equal(localBody, upstreamBody) {
mismatch = true
reasons = append(reasons, "Body content mismatch")
@@ -39,7 +39,7 @@ func TestMirrorMiddleware_PreferredSource(t *testing.T) {
defer upstreamServer.Close()
// 3. Setup our server with MirrorMiddleware
server := NewServer(ds, nil, "http://localhost:8000", false, false, false, false, false, false)
server := NewServer(ds, nil, "http://localhost:8000", false, false, false, false, false)
server.SetMirrorSettings(true, []string{"/test/local"}, "local")
// We need to trick performMirror to use our mock upstream.
@@ -119,7 +119,7 @@ func TestSettingsAPI_PreferredSource(t *testing.T) {
ds := datastore.NewDataStore(tempDir)
_ = ds.Initialize()
server := NewServer(ds, nil, "http://localhost:8000", false, false, false, false, false, false)
server := NewServer(ds, nil, "http://localhost:8000", false, false, false, false, false)
// Test GET initial
req := httptest.NewRequest("GET", "/setup/settings", nil)
+20 -4
View File
@@ -5,6 +5,7 @@ import (
"bytes"
"fmt"
"io"
"log"
"net"
"net/http"
)
@@ -12,7 +13,7 @@ import (
// RecordMiddleware returns a middleware that records "self" requests and responses.
func (s *Server) RecordMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if s.recorder == nil || !s.recordEnabled {
if s.recorder == nil || !s.recordEnabled || r.Header.Get("Upgrade") == "websocket" {
next.ServeHTTP(w, r)
return
}
@@ -52,6 +53,10 @@ func (s *Server) RecordMiddleware(next http.Handler) http.Handler {
// Create a response object for the recorder
res := rw.getRecordedResponse(r)
if res.StatusCode >= 400 {
log.Printf("[DEBUG_LOG] Recording error response: %d %s %s", res.StatusCode, r.Method, r.URL.Path)
}
if res.Body != nil {
defer func() { _ = res.Body.Close() }()
}
@@ -65,8 +70,9 @@ func (s *Server) RecordMiddleware(next http.Handler) http.Handler {
type responseWriter struct {
http.ResponseWriter
statusCode int
body *bytes.Buffer
statusCode int
body *bytes.Buffer
wroteHeader bool
}
func (rw *responseWriter) Header() http.Header {
@@ -74,18 +80,28 @@ func (rw *responseWriter) Header() http.Header {
}
func (rw *responseWriter) WriteHeader(code int) {
if rw.wroteHeader {
return
}
rw.statusCode = code
rw.wroteHeader = true
rw.ResponseWriter.WriteHeader(code)
}
func (rw *responseWriter) Write(b []byte) (int, error) {
if !rw.wroteHeader {
rw.WriteHeader(http.StatusOK)
}
rw.body.Write(b)
return rw.ResponseWriter.Write(b)
}
func (rw *responseWriter) getRecordedResponse(r *http.Request) *http.Response {
statusCode := rw.statusCode
if statusCode == 0 {
if !rw.wroteHeader && statusCode == 0 {
statusCode = http.StatusOK
}
+323
View File
@@ -0,0 +1,323 @@
package handlers
import (
"encoding/base64"
"encoding/json"
"encoding/xml"
"fmt"
"strings"
"time"
)
// SCMUDCRequest represents the structure of incoming SCMUDC telemetry data
type SCMUDCRequest struct {
Envelope struct {
MonoTime int64 `json:"monoTime"`
PayloadProtocolVersion string `json:"payloadProtocolVersion"`
PayloadType string `json:"payloadType"`
ProtocolVersion string `json:"protocolVersion"`
Time string `json:"time"`
UniqueID string `json:"uniqueId"`
} `json:"envelope"`
Payload struct {
DeviceInfo struct {
BoseID string `json:"boseID"`
DeviceID string `json:"deviceID"`
DeviceType string `json:"deviceType"`
SerialNumber string `json:"serialNumber"`
SoftwareVersion string `json:"softwareVersion"`
SystemSerialNumber string `json:"systemSerialNumber"`
} `json:"deviceInfo"`
Events []SCMUDCEvent `json:"events"`
} `json:"payload"`
}
// SCMUDCEvent represents individual events within SCMUDC payload
type SCMUDCEvent struct {
Data SCMUDCEventData `json:"data"`
MonoTime int64 `json:"monoTime"`
Time string `json:"time"`
Type string `json:"type"`
}
// SCMUDCEventData contains the event-specific data
type SCMUDCEventData struct {
ButtonID string `json:"buttonId,omitempty"`
ContentItem string `json:"contentItem,omitempty"`
Origin string `json:"origin"`
Preset string `json:"preset,omitempty"`
}
// EnrichedSCMUDCEvent contains processed and human-readable event information
type EnrichedSCMUDCEvent struct {
Origin string `json:"origin"`
Action string `json:"action"`
Command string `json:"command"`
Summary string `json:"summary"`
DecodedData *DecodedContent `json:"decoded_data,omitempty"`
Timestamp time.Time `json:"timestamp"`
}
// DecodedContent represents decoded Base64 content from device events
type DecodedContent struct {
ContentType string `json:"content_type"`
ItemName string `json:"item_name"`
SourceAccount string `json:"source_account"`
Location string `json:"location"`
ArtworkURL string `json:"artwork_url,omitempty"`
IsPresetable bool `json:"is_presetable"`
XMLContent string `json:"xml_content"`
}
// ContentItemXML represents the XML structure found in Base64-encoded content
type ContentItemXML struct {
XMLName xml.Name `xml:"ContentItem"`
Source string `xml:"source,attr"`
Type string `xml:"type,attr"`
Location string `xml:"location,attr"`
SourceAccount string `xml:"sourceAccount,attr"`
IsPresetable string `xml:"isPresetable,attr"`
ItemName string `xml:"itemName"`
ContainerArt string `xml:"containerArt"`
}
// SCMUDCEnricher provides functionality to enrich SCMUDC event data
type SCMUDCEnricher struct{}
// NewSCMUDCEnricher creates a new SCMUDC enricher instance
func NewSCMUDCEnricher() *SCMUDCEnricher {
return &SCMUDCEnricher{}
}
// EnrichSCMUDCRequest processes a raw SCMUDC request and returns enriched event data
func (e *SCMUDCEnricher) EnrichSCMUDCRequest(body []byte) (*EnrichedSCMUDCEvent, error) {
var scmudcReq SCMUDCRequest
if err := json.Unmarshal(body, &scmudcReq); err != nil {
return nil, fmt.Errorf("failed to unmarshal SCMUDC request: %w", err)
}
// Process the first event (most requests contain single events)
if len(scmudcReq.Payload.Events) == 0 {
return nil, fmt.Errorf("no events found in SCMUDC request")
}
event := scmudcReq.Payload.Events[0]
// Parse timestamp
timestamp, _ := time.Parse(time.RFC3339, event.Time)
enriched := &EnrichedSCMUDCEvent{
Origin: event.Data.Origin,
Action: event.Type,
Timestamp: timestamp,
}
switch event.Data.Origin {
case "gabbo":
e.enrichAppEvent(enriched, &event)
case "console":
e.enrichConsoleEvent(enriched, &event)
case "device":
e.enrichDeviceEvent(enriched, &event)
default:
enriched.Command = "Unknown"
enriched.Summary = fmt.Sprintf("Unknown origin: %s", event.Data.Origin)
}
return enriched, nil
}
// enrichAppEvent processes events from the SoundTouch app
func (e *SCMUDCEnricher) enrichAppEvent(enriched *EnrichedSCMUDCEvent, event *SCMUDCEvent) {
enriched.Command = event.Data.ButtonID
enriched.Summary = fmt.Sprintf("App: %s", e.formatButton(event.Data.ButtonID))
}
// enrichConsoleEvent processes events from physical device controls
func (e *SCMUDCEnricher) enrichConsoleEvent(enriched *EnrichedSCMUDCEvent, event *SCMUDCEvent) {
enriched.Command = event.Data.ButtonID
enriched.Summary = fmt.Sprintf("Device: %s", e.formatButton(event.Data.ButtonID))
}
// enrichDeviceEvent processes internal device events with content data
func (e *SCMUDCEnricher) enrichDeviceEvent(enriched *EnrichedSCMUDCEvent, event *SCMUDCEvent) {
if event.Data.ContentItem != "" {
if decoded := e.decodeContentItem(event.Data.ContentItem); decoded != nil {
enriched.Command = decoded.ItemName
enriched.Summary = fmt.Sprintf("Device: %s", e.summarizeContent(decoded))
enriched.DecodedData = decoded
return
}
}
// Fallback for device events without content
enriched.Command = "System Action"
enriched.Summary = fmt.Sprintf("Device: %s", enriched.Action)
}
// decodeContentItem decodes Base64-encoded XML content from device events
func (e *SCMUDCEnricher) decodeContentItem(base64Content string) *DecodedContent {
data, err := base64.StdEncoding.DecodeString(base64Content)
if err != nil {
return nil
}
var contentItem ContentItemXML
if err := xml.Unmarshal(data, &contentItem); err != nil {
return nil
}
return &DecodedContent{
ContentType: contentItem.Source,
ItemName: contentItem.ItemName,
SourceAccount: contentItem.SourceAccount,
Location: contentItem.Location,
ArtworkURL: contentItem.ContainerArt,
IsPresetable: strings.EqualFold(contentItem.IsPresetable, "true"),
XMLContent: string(data),
}
}
// formatButton converts button IDs to human-readable names
func (e *SCMUDCEnricher) formatButton(buttonID string) string {
buttonNames := map[string]string{
"POWER": "Power",
"PLAY": "Play",
"PAUSE": "Pause",
"STOP": "Stop",
"NEXT_TRACK": "Skip Forward",
"PREV_TRACK": "Skip Backward",
"VOLUME_UP": "Volume Up",
"VOLUME_DOWN": "Volume Down",
"MUTE": "Mute",
"PRESET_1": "Preset 1",
"PRESET_2": "Preset 2",
"PRESET_3": "Preset 3",
"PRESET_4": "Preset 4",
"PRESET_5": "Preset 5",
"PRESET_6": "Preset 6",
}
if name, exists := buttonNames[buttonID]; exists {
return name
}
return buttonID
}
// summarizeContent creates a short summary of content for UI display
func (e *SCMUDCEnricher) summarizeContent(content *DecodedContent) string {
if content.ItemName != "" {
return fmt.Sprintf("Playing %s", e.truncateString(content.ItemName, 30))
}
if content.ContentType != "" {
return fmt.Sprintf("Playing %s content", content.ContentType)
}
return "Playing content"
}
// truncateString truncates a string to maxLength with ellipsis
func (e *SCMUDCEnricher) truncateString(s string, maxLength int) string {
if len(s) <= maxLength {
return s
}
return s[:maxLength-3] + "..."
}
// GetOriginDescription returns a human-readable description of the event origin
func (e *SCMUDCEnricher) GetOriginDescription(origin string) string {
descriptions := map[string]string{
"gabbo": "SoundTouch App",
"console": "Device Hardware",
"device": "Device Internal",
}
if desc, exists := descriptions[origin]; exists {
return desc
}
return "Unknown Origin"
}
// GenerateEnrichedComments creates comment lines for .http files
func (e *SCMUDCEnricher) GenerateEnrichedComments(enriched *EnrichedSCMUDCEvent) []string {
comments := []string{
fmt.Sprintf("// Origin: %s (%s)", e.GetOriginDescription(enriched.Origin), enriched.Origin),
fmt.Sprintf("// Action: %s", enriched.Action),
fmt.Sprintf("// Command: %s", enriched.Command),
fmt.Sprintf("// Summary: %s", enriched.Summary),
}
if enriched.DecodedData != nil {
comments = append(comments,
"// Decoded Content:",
fmt.Sprintf("// Source: %s", enriched.DecodedData.ContentType),
fmt.Sprintf("// Track: %s", enriched.DecodedData.ItemName),
fmt.Sprintf("// Account: %s", enriched.DecodedData.SourceAccount),
)
if enriched.DecodedData.ArtworkURL != "" {
comments = append(comments, fmt.Sprintf("// Artwork: %s", enriched.DecodedData.ArtworkURL))
}
comments = append(comments,
"//",
"// Full XML:",
)
// Add XML content as comments, line by line
xmlLines := strings.Split(enriched.DecodedData.XMLContent, "\n")
for _, line := range xmlLines {
if strings.TrimSpace(line) != "" {
comments = append(comments, fmt.Sprintf("// %s", strings.TrimSpace(line)))
}
}
}
return comments
}
// IsSCMUDCRequest checks if a request path is a SCMUDC endpoint
func IsSCMUDCRequest(path string) bool {
return strings.Contains(path, "/v1/scmudc/")
}
// GetActionIcon returns an emoji icon for the given action type
func GetActionIcon(action string) string {
icons := map[string]string{
"play-pressed": "▶️",
"pause-pressed": "⏸️",
"power-pressed": "⚡",
"stop-pressed": "⏹️",
"skip-forward-pressed": "⏭️",
"skip-backward-pressed": "⏪",
"preset-pressed": "⭐",
"play-item": "🎵",
"preset-assigned": "🔖",
}
if icon, exists := icons[action]; exists {
return icon
}
return "🔘"
}
// GetOriginIcon returns an emoji icon for the given origin
func GetOriginIcon(origin string) string {
icons := map[string]string{
"gabbo": "📱", // SoundTouch App
"console": "🎛️", // Device Console
"device": "🔄", // Internal System
}
if icon, exists := icons[origin]; exists {
return icon
}
return "❓"
}
+66 -58
View File
@@ -25,40 +25,38 @@ import (
// Server handles HTTP requests for the SoundTouch service.
type Server struct {
ds *datastore.DataStore
sm *setup.Manager
migrationManager *migration.Manager
mu sync.RWMutex
serverURL string
soundcorkURL string
httpsServerURL string
discovering bool
proxyRedact bool
proxyLogBody bool
recordEnabled bool
discoveryInterval time.Duration
discoveryEnabled bool
dnsEnabled bool
dnsUpstream []string
dnsBindAddr string
mirrorEnabled bool
mirrorEndpoints []string
preferredSource string
internalPaths []string
enableSoundcorkProxy bool
shortcuts map[string]int
recorder *proxy.Recorder
dnsDiscovery *discovery.DNSDiscovery
UpstreamProxy http.Handler
Version string
Commit string
Date string
mgmtUsername string
mgmtPassword string
spotifyClientID string
spotifyClientSecret string
spotifyRedirectURI string
spotifyService *spotify.Service
ds *datastore.DataStore
sm *setup.Manager
migrationManager *migration.Manager
mu sync.RWMutex
serverURL string
httpsServerURL string
discovering bool
proxyRedact bool
proxyLogBody bool
recordEnabled bool
discoveryInterval time.Duration
discoveryEnabled bool
dnsEnabled bool
dnsUpstream []string
dnsBindAddr string
mirrorEnabled bool
mirrorEndpoints []string
preferredSource string
internalPaths []string
shortcuts map[string]int
recorder *proxy.Recorder
dnsDiscovery *discovery.DNSDiscovery
UpstreamProxy http.Handler
Version string
Commit string
Date string
mgmtUsername string
mgmtPassword string
spotifyClientID string
spotifyClientSecret string
spotifyRedirectURI string
spotifyService *spotify.Service
}
// RequestSnapshot represents an immutable snapshot of an HTTP request.
@@ -83,7 +81,7 @@ var bufferPool = sync.Pool{
}
// NewServer creates a new SoundTouch service server.
func NewServer(ds *datastore.DataStore, sm *setup.Manager, serverURL string, proxyRedact, proxyLogBody, recordEnabled, enableSoundcorkProxy, migrationEnabled, migrationDryRun bool) *Server {
func NewServer(ds *datastore.DataStore, sm *setup.Manager, serverURL string, proxyRedact, proxyLogBody, recordEnabled, migrationEnabled, migrationDryRun bool) *Server {
// Initialize migration manager
migrationConfig := migration.Config{
Enabled: migrationEnabled,
@@ -91,17 +89,15 @@ func NewServer(ds *datastore.DataStore, sm *setup.Manager, serverURL string, pro
}
s := &Server{
ds: ds,
sm: sm,
migrationManager: migration.NewManager(ds, migrationConfig),
serverURL: serverURL,
soundcorkURL: "http://localhost:8001",
proxyRedact: proxyRedact,
proxyLogBody: proxyLogBody,
recordEnabled: recordEnabled,
enableSoundcorkProxy: enableSoundcorkProxy,
discoveryInterval: 5 * time.Minute,
discoveryEnabled: true,
ds: ds,
sm: sm,
migrationManager: migration.NewManager(ds, migrationConfig),
serverURL: serverURL,
proxyRedact: proxyRedact,
proxyLogBody: proxyLogBody,
recordEnabled: recordEnabled,
discoveryInterval: 5 * time.Minute,
discoveryEnabled: true,
}
return s
@@ -301,14 +297,6 @@ func (s *Server) SetHTTPServerURL(url string) {
s.httpsServerURL = url
}
// SetSoundcorkURL sets the URL for the Soundcork backend.
func (s *Server) SetSoundcorkURL(url string) {
s.mu.Lock()
defer s.mu.Unlock()
s.soundcorkURL = url
}
// SetRecorder sets the recorder for the server.
func (s *Server) SetRecorder(r *proxy.Recorder) {
s.mu.Lock()
@@ -374,11 +362,11 @@ func (s *Server) GetRecordEnabled() bool {
}
// GetSettings returns the current server settings.
func (s *Server) GetSettings() (string, string, string) {
func (s *Server) GetSettings() (string, string) {
s.mu.RLock()
defer s.mu.RUnlock()
return s.serverURL, s.soundcorkURL, s.httpsServerURL
return s.serverURL, s.httpsServerURL
}
// IsSpotifyConfigured returns whether Spotify integration is configured.
@@ -390,11 +378,11 @@ func (s *Server) IsSpotifyConfigured() bool {
}
// GetProxySettings returns the current proxy settings.
func (s *Server) GetProxySettings() (bool, bool, bool, bool) {
func (s *Server) GetProxySettings() (bool, bool, bool) {
s.mu.RLock()
defer s.mu.RUnlock()
return s.proxyRedact, s.proxyLogBody, s.recordEnabled, s.enableSoundcorkProxy
return s.proxyRedact, s.proxyLogBody, s.recordEnabled
}
// DiscoverDevices starts a background device discovery process.
@@ -852,3 +840,23 @@ func (s *Server) resolveDeviceIDToIP(deviceID string) (string, error) {
return "", fmt.Errorf("device not found: %s", deviceID)
}
// lookupIP resolves a deviceId to its last known device IP.
func (s *Server) lookupIP(deviceId string) (string, error) {
devices, err := s.ds.ListAllDevices()
if err != nil {
return "", err
}
for i := range devices {
if devices[i].DeviceID == deviceId {
if devices[i].IPAddress == "" {
return "", fmt.Errorf("no IP known for deviceId %s", deviceId)
}
return devices[i].IPAddress, nil
}
}
return "", fmt.Errorf("deviceId %s not found", deviceId)
}
+2 -2
View File
@@ -16,7 +16,7 @@ func TestMergeOverlappingDevices(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
// Case 1: IP-only entry and Serial-based entry for the same IP
ip := "192.168.1.100"
@@ -74,7 +74,7 @@ func TestFindExistingDeviceID(t *testing.T) {
defer os.RemoveAll(tempDir)
ds := datastore.NewDataStore(tempDir)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false, false)
s := NewServer(ds, nil, "http://localhost", false, false, false, false, false)
ip := "192.168.1.101"
serial := "SERIAL456"
@@ -25,7 +25,7 @@ func TestSnapshotIntegrity_SelfAndMirror(t *testing.T) {
ds := datastore.NewDataStore(tempDir)
recorder := proxy.NewRecorder(tempDir)
s := NewServer(ds, nil, "http://localhost:8000", false, false, true, false, false, false)
s := NewServer(ds, nil, "http://localhost:8000", false, false, true, false, false)
s.SetRecorder(recorder)
s.SetMirrorSettings(true, []string{"/mirror/*"}, "local")
+81 -565
View File
@@ -2,581 +2,97 @@
<html>
<head>
<meta charset="UTF-8">
<title>AfterTouch (SoundTouch Toolkit)</title>
<title>AfterTouch - Select Interface</title>
<link rel="icon" href="/media/favicon-braille.svg" type="image/svg+xml">
<link rel="stylesheet" href="/web/css/style.css">
<link rel="stylesheet" href="/web/shared/common.css">
<style>
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
background: #121212;
color: #e0e0e0;
margin: 0;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
height: 100vh;
}
.container {
text-align: center;
max-width: 600px;
}
h1 { color: #fff; margin-bottom: 30px; }
.choices {
display: flex;
gap: 20px;
justify-content: center;
}
.choice-card {
background: #1e1e1e;
border-radius: 12px;
padding: 30px;
width: 200px;
text-decoration: none;
color: inherit;
transition: all 0.3s;
border: 2px solid transparent;
display: flex;
flex-direction: column;
align-items: center;
box-shadow: 0 10px 20px rgba(0,0,0,0.5);
}
.choice-card:hover {
transform: translateY(-5px);
border-color: #00bcd4;
background: #252525;
}
.icon {
font-size: 3rem;
margin-bottom: 15px;
}
.title {
font-weight: bold;
font-size: 1.2rem;
margin-bottom: 10px;
color: #00bcd4;
}
.desc {
font-size: 0.9rem;
color: #888;
}
footer {
margin-top: 50px;
}
</style>
</head>
<body>
<div class="container">
<h1>AfterTouch</h1>
<p style="margin-top: -10px; font-style: italic; color: #666;">Bose SoundTouch Toolkit</p>
<p style="margin-top: -25px; font-style: italic; color: #666; margin-bottom: 30px;">Bose SoundTouch Toolkit</p>
<p style="margin-bottom: 40px; color: #aaa;">Select an interface to continue.</p>
<div class="tabs">
<div class="tab-buttons">
<button class="tab-btn active" onclick="openTab(event, 'tab-overview')">Overview</button>
<button class="tab-btn" onclick="openTab(event, 'tab-settings')">1. Settings</button>
<button class="tab-btn" onclick="openTab(event, 'tab-devices')">2. Devices</button>
<button class="tab-btn" onclick="openTab(event, 'tab-sync')">3. Data Sync</button>
<button class="tab-btn" onclick="openTab(event, 'tab-migration')">4. Migration</button>
<button class="tab-btn" onclick="openTab(event, 'tab-interactions')">5. Interactions & Events</button>
<button class="tab-btn" onclick="openTab(event, 'tab-parity')">6. Parity & Mirroring</button>
</div>
<div class="choices">
<a href="/web/stockholm-mini/" class="choice-card">
<div class="icon">📻</div>
<div class="title">Stockholm Mini</div>
<div class="desc">Lightweight device controller and player.</div>
</a>
<!-- Tab 0: Overview -->
<div id="tab-overview" class="tab-content active">
<h2>Welcome to AfterTouch</h2>
<p>This toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026. It emulates the necessary cloud services locally on your network.</p>
<h3>Migration Process at a Glance</h3>
<div class="info-box prerequisite-box">
<strong>🔌 Prerequisite: Enable SSH</strong><br>
Migration requires SSH access. To enable it:
<ol style="margin-top: 5px; margin-bottom: 5px;">
<li>Create an empty file named <code>remote_services</code> on a USB stick.</li>
<li>Insert it into the speaker's <strong>SERVICE</strong> port and reboot the speaker.</li>
</ol>
<strong>Verify connection:</strong>
<ul style="margin-top: 5px; margin-bottom: 0; padding-left: 20px;">
<li>Use the <strong>Migration</strong> tab to select your device and verify that <em>SSH Connection</em> shows ✅ Success.</li>
<li>Or manually: <code>ssh -oHostKeyAlgorithms=+ssh-rsa root@&lt;SPEAKER-IP&gt;</code> (no password).</li>
</ul>
</div>
<ol class="guide-steps">
<li>
<strong>Settings:</strong> Review the <strong>Settings</strong> tab. Ensure the "Target Domain" and "Proxy Domain" use an IP address or domain name that is <strong>accessible from your speakers</strong> (usually the IP of this server on your local network).
</li>
<li>
<strong>Discovery:</strong> Go to the <strong>Devices</strong> tab to find your speakers on the network.
Ensure your speakers are powered on and connected to the same network.
</li>
<li>
<strong>Data Sync:</strong> In the <strong>Data Sync</strong> tab, fetch your current presets, recents, and sources.
This step is critical to ensure your local service has all your personalized data before you disconnect from the Bose cloud.
</li>
<li>
<strong>Migration:</strong> In the <strong>Migration</strong> tab, redirect your speaker to this local service.
We recommend the <strong>XML Configuration</strong> method as it is surgical and easily reversible.
</li>
<li>
<strong>Verification:</strong> After migration and reboot, your speaker will communicate with this toolkit instead of Bose servers.
</li>
</ol>
<div class="info-box safety-box">
<strong>⚠️ Safety First:</strong> Before starting any migration, please read our
<a href="https://gesellix.github.io/Bose-SoundTouch/guides/MIGRATION-SAFETY.html" target="_blank">Professional Migration & Safety Guide</a>.
The toolkit automatically creates backups, but understanding the process is key to a smooth transition.
</div>
<h3>Useful Links</h3>
<ul>
<li><a href="https://gesellix.github.io/Bose-SoundTouch/guides/SURVIVAL-GUIDE.html" target="_blank">Cloud Shutdown Survival Guide</a></li>
<li><a href="https://gesellix.github.io/Bose-SoundTouch/guides/CLI-REFERENCE.html" target="_blank">CLI Reference</a></li>
</ul>
</div>
<!-- Tab 1: Settings -->
<div id="tab-settings" class="tab-content">
<h2>System Settings</h2>
<p style="font-size: 0.9em; color: #555; margin-bottom: 20px;">
<strong>Note:</strong> These URLs must be <strong>accessible from your SoundTouch devices</strong>.
Use the IP address of this server on your local network (e.g., <code>http://192.168.1.100:8000</code>)
rather than <code>localhost</code>.
</p>
<div style="margin-bottom: 20px;">
<label for="target-domain">Target Domain:</label>
<input type="text" id="target-domain" placeholder="http://192.168.x.x:8000" style="width: 300px;">
<span style="font-size: 0.8em; color: #666;">(Standard services URL)</span>
</div>
<div style="margin-bottom: 20px;">
<label for="soundcork-url">Soundcork URL:</label>
<input type="text" id="soundcork-url" placeholder="http://192.168.x.x:8001" style="width: 300px;">
<span style="font-size: 0.8em; color: #666;">(Soundcork services URL)</span>
</div>
<div style="margin-bottom: 20px;">
<label for="discovery-interval">Discovery Interval:</label>
<input type="text" id="discovery-interval" placeholder="5m" style="width: 100px;">
<label style="margin-left: 15px;"><input type="checkbox" id="discovery-enabled"> Enable Automated Discovery</label>
</div>
<div style="margin-bottom: 20px;">
<strong>DNS Discovery:</strong>
<div style="margin-top: 5px;">
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="dns-enabled"> Enable DNS Discovery Server
</label>
<div style="margin-left: 20px; margin-bottom: 5px;">
<label for="dns-upstream">Upstream DNS:</label>
<input type="text" id="dns-upstream" placeholder="Default: system nameservers" style="width: 200px;">
<span class="info-toggle" onclick="toggleInfo('dns-upstream-info')"></span>
<div id="dns-upstream-info" class="info-details">
Optional: comma-separated list of DNS servers (e.g., <code>1.1.1.1, 8.8.8.8</code>).<br>
If empty, AfterTouch defaults to the system nameservers (e.g. from <code>/etc/resolv.conf</code>).<br>
<div id="dns-current-upstream" style="margin-top: 5px; font-weight: bold;"></div>
</div>
</div>
<div style="margin-left: 20px;">
<label for="dns-bind">DNS Bind Address:</label>
<input type="text" id="dns-bind" placeholder=":53" style="width: 100px;">
<span style="font-size: 0.8em; color: #666; margin-left: 5px;">(e.g., :53 or 0.0.0.0:53. <strong>Port 53</strong> is required for actual migration)</span>
</div>
</div>
</div>
<div style="margin-bottom: 20px;">
<strong>Endpoint Mirroring:</strong>
<div style="margin-top: 5px;">
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="mirror-enabled"> Enable Background Mirroring to Bose Cloud
</label>
<div style="margin-left: 20px; margin-bottom: 5px;">
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="preferred-source-upstream"> Prefer Upstream Response for Mirrored Endpoints
</label>
<label for="mirror-endpoints">Mirror Endpoints (one per line, supports * wildcards):</label><br>
<textarea id="mirror-endpoints" rows="4" style="width: 100%; max-width: 600px; margin-top: 5px; font-family: monospace;" placeholder="/streaming/account/*/device/*/recent&#10;/accounts/*/devices/*/presets/*"></textarea>
<div class="info-box" style="margin-top: 5px; font-size: 0.85em; padding: 10px;">
<strong>Note:</strong> Mirroring sends matching requests (including full headers) to the official Bose servers for parity comparison.
If <em>Redact Sensitive Data</em> is enabled in Proxy Settings, credentials will be masked in <strong>logs and recordings</strong>, but
full headers are always sent to Bose to ensure service compatibility.
</div>
</div>
</div>
</div>
<div style="margin-bottom: 20px;">
<strong>Spotify Integration:</strong>
<div id="spotify-config-status" style="margin-top: 5px; font-size: 0.9em;">
Checking configuration...
</div>
</div>
<div style="margin-bottom: 20px;">
<strong>Proxy Logging:</strong>
<div style="margin-top: 5px;">
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="proxy-redact" onchange="updateProxySettings()"> Redact Sensitive Headers</label>
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="proxy-log-body" onchange="updateProxySettings()"> Log Bodies</label>
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="enable-soundcork-proxy" onchange="updateProxySettings()"> Enable Soundcork Proxy (Legacy)</label>
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="proxy-record" onchange="updateProxySettings()"> Record Interactions
<span style="font-size: 0.85em; color: #666; margin-left: 5px;">(View in <strong>5. Interactions</strong> tab)</span>
</label>
<div style="margin-left: 20px; margin-top: 10px;">
<label for="internal-paths">Internal Paths (skip recording for these patterns):</label><br>
<textarea id="internal-paths" rows="2" style="width: 100%; max-width: 600px; margin-top: 5px; font-family: monospace;" placeholder="/setup/*&#10;/web/*"></textarea>
<div style="font-size: 0.8em; color: #666; margin-top: 2px;">
Requests matching these patterns will be excluded from recording. Use one pattern per line.
</div>
</div>
</div>
</div>
<div style="margin-bottom: 20px;">
<button onclick="updateSettings()">Save Settings</button>
<span id="settings-status" style="margin-left: 10px; font-size: 0.9em;"></span>
</div>
</div>
<!-- Tab 2: Devices -->
<div id="tab-devices" class="tab-content">
<div style="display: flex; justify-content: space-between; align-items: center;">
<h2>Known Devices <span id="discovery-indicator" style="font-size: 0.5em; vertical-align: middle; display: none;">🔍 Scanning...</span></h2>
<div id="spotify-status-header" style="background: #f0f0f0; padding: 5px 15px; border-radius: 20px; font-size: 0.9em; display: flex; align-items: center; gap: 10px;">
Spotify: <span id="spotify-account-name" style="font-weight: bold;">Not Linked</span>
<button id="link-spotify-btn" onclick="linkSpotify()" style="font-size: 0.8em; padding: 2px 8px; background: #1DB954; color: white; border: none; border-radius: 10px; cursor: pointer;">Link Account</button>
</div>
</div>
<div id="device-list">Loading devices...</div>
<div style="margin-top: 20px;">
<button onclick="triggerDiscovery()">Scan Again</button>
<input type="text" id="add-manual-ip" placeholder="Manual IP (e.g. 192.168.1.100)" style="margin-left: 20px; padding: 4px;">
<button onclick="addManualDevice()">Add Device</button>
</div>
</div>
<!-- Tab 3: Data Sync -->
<div id="tab-sync" class="tab-content">
<h2>Initial Data Sync</h2>
<p>Before migrating, fetch your presets, recents, and configured sources from the device to ensure they are available locally.</p>
<div class="device-selection">
<label for="sync-device-list">Device:</label>
<select id="sync-device-list">
<option value="">-- Select a device --</option>
</select>
<button id="sync-now-btn">Start Sync</button>
</div>
<div id="sync-status" class="status"></div>
<div id="sync-results" style="margin-top: 20px; display: none;">
<h3>Sync Results</h3>
<div id="sync-log" style="font-family: monospace; background: #f4f4f4; padding: 10px; border-radius: 4px; max-height: 300px; overflow-y: auto;"></div>
</div>
</div>
<!-- Tab 4: Migration -->
<div id="tab-migration" class="tab-content">
<h2>Device Migration</h2>
<div class="device-selection">
<label for="migration-device-list">Device:</label>
<select id="migration-device-list" onchange="showSummary(this.value)">
<option value="">-- Select a device --</option>
</select>
</div>
<div id="status" class="status"></div>
<div id="command-output-box" class="summary-box" style="display: none; background-color: #f0f0f0;">
<h3>Command Output</h3>
<div id="command-output" style="font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 300px; overflow-y: auto; padding: 10px; border: 1px solid #ccc; background: #fff;"></div>
</div>
<div id="migration-summary" class="summary-box" style="display: none;">
<h3>Migration Summary for <span id="summary-device-display"></span></h3>
<p>Migration Status: <span id="migration-status"></span></p>
<input type="hidden" id="summary-device-id">
<p>SSH Connection: <span id="ssh-status"></span></p>
<p id="original-config-status" style="display: none;">Backup: ✅ Found .original config at <code>/opt/Bose/etc/SoundTouchSdkPrivateCfg.xml.original</code> <button onclick="toggleOriginalConfig()">Show Original Config</button></p>
<p id="no-original-config-status" style="display: none;">Backup: ❌ Not found <button id="backup-config-btn">Backup Config Now</button></p>
<p>Remote Services Enabled: <span id="remote-services-status"></span> <span id="remote-services-found" style="font-size: 0.8em; color: #666;"></span></p>
<p>AfterTouch Local Root CA Trusted: <span id="ca-trust-status"></span> <button id="trust-ca-btn" style="display: none; background-color: #607D8B; color: white; border: none; padding: 2px 8px; font-size: 0.8em; margin-left: 10px;">Trust CA Now</button></p>
<div id="connection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #eefbff;">
<strong>HTTPS Connection Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device can reach the server over HTTPS.</span>
<div style="margin-top: 10px;">
URL: <code id="test-url"></code>
</div>
<div style="margin-top: 10px;">
<button id="test-connection-explicit-btn" style="background-color: #607D8B; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test with Explicit CA.crt</button>
<button id="test-connection-trusted-btn" style="background-color: #607D8B; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test with Shared Trust Store</button>
</div>
<div id="test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div id="hosts-redirection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #fff4e6; display: none;">
<strong>Preliminary /etc/hosts Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device's /etc/hosts mechanism before full migration.</span>
<div style="margin-top: 10px;">
Domain: <code>custom-test-api.bose.fake</code>
</div>
<div style="margin-top: 10px;">
<button id="test-hosts-btn" style="background-color: #FF9800; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test Hosts Redirection</button>
</div>
<div id="hosts-test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div id="dns-redirection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #e6ffed; display: none;">
<strong>Preliminary DNS Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device can resolve domains via the AfterTouch DNS server.</span>
<div style="margin-top: 10px;">
Domain: <code>aftertouch.test</code>
</div>
<div style="margin-top: 10px;">
<button id="test-dns-btn" style="background-color: #28a745; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test DNS Redirection</button>
</div>
<div id="dns-test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #f9f9f9;">
<label for="migration-method"><strong>Migration Method:</strong></label>
<select id="migration-method" onchange="toggleMigrationMethod()">
<option value="xml">XML Configuration (Recommended - redirects specific services)</option>
<option value="hosts">/etc/hosts + Root CA (Advanced - global redirection)</option>
<option value="resolv">/etc/resolv.conf (DHCP-Aware - Redirect via DNS Hook)</option>
</select>
<div id="dns-port-warning" style="margin-top: 5px; color: #d32f2f; font-weight: bold; font-size: 0.9em; display: none;"></div>
</div>
<div id="current-resolv-pane" style="display: none; margin-bottom: 20px;">
<span class="config-header">Current /etc/resolv.conf</span>
<pre id="current-resolv-content"></pre>
</div>
<div id="original-config-pane" style="display: none; margin-bottom: 20px;">
<span class="config-header">Original Config (Backup)</span>
<pre id="original-config-content"></pre>
</div>
<div id="service-options" style="margin-bottom: 20px; display: none;">
<h4>Service Implementations</h4>
<table>
<tr><th>Service</th><th>Original URL</th><th>Implementation</th></tr>
<tr>
<td>Marge (Streaming)</td>
<td id="orig-marge">loading...</td>
<td>
<select id="opt-marge" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>Stats</td>
<td id="orig-stats">loading...</td>
<td>
<select id="opt-stats" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>Software Update</td>
<td id="orig-sw_update">loading...</td>
<td>
<select id="opt-sw_update" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>BMX (Registry)</td>
<td id="orig-bmx">loading...</td>
<td>
<select id="opt-bmx" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
</table>
</div>
<div class="diff-container">
<div id="xml-diff-pane" class="diff-pane">
<span class="config-header">Current Config (on Speaker)</span>
<pre id="current-config"></pre>
</div>
<div id="planned-xml-pane" class="diff-pane">
<span class="config-header">Planned Config (AfterTouch)</span>
<pre id="planned-config"></pre>
</div>
<div id="planned-hosts-pane" class="diff-pane" style="display: none;">
<span class="config-header">Planned /etc/hosts Entries</span>
<pre id="planned-hosts"></pre>
<div style="margin-top: 10px; font-size: 0.9em; color: #666;">
<strong>Note:</strong> This method also injects the AfterTouch Local Root CA into <code>/etc/pki/tls/certs/ca-bundle.crt</code> to enable secure HTTPS communication.
</div>
</div>
<div id="planned-resolv-pane" class="diff-pane" style="display: none;">
<span class="config-header">Planned /etc/resolv.conf Hook</span>
<pre id="planned-resolv"></pre>
<div id="resolv-note" style="margin-top: 10px; font-size: 0.9em; color: #666;">
<strong>Note:</strong> This method injects a persistent DNS priority hook into the DHCP logic (<code>/etc/udhcpc.d/50default</code>). It preserves your router's search domain and secondary DNS servers. It also injects the Local Root CA.
</div>
</div>
</div>
<div style="margin-top: 15px;">
<button id="confirm-migrate-btn" style="background-color: #4CAF50; color: white; border: none; padding: 10px 20px;">Confirm Migration</button>
<button id="revert-migrate-btn" style="background-color: #FF9800; color: white; border: none; padding: 10px 20px; display: none;">Revert to Defaults</button>
<button id="reboot-speaker-btn" style="background-color: #607D8B; color: white; border: none; padding: 10px 20px;">Reboot Speaker</button>
<button id="ensure-remote-btn" style="background-color: #2196F3; color: white; border: none; padding: 10px 20px;">Enable Persistent Remote Services</button>
<button id="remove-remote-btn" style="background-color: #f44336; color: white; border: none; padding: 10px 20px;">Remove Persistent Remote Services</button>
<button onclick="document.getElementById('migration-summary').style.display='none'" style="padding: 10px 20px;">Cancel</button>
</div>
</div>
</div>
<!-- Tab 5: Interactions & Events -->
<div id="tab-interactions" class="tab-content">
<h2>Recorded Interactions & Device Events</h2>
<p>Analysis of traffic handled by this service (self), proxied to Bose (upstream), and internal device events (telemetry).</p>
<div id="interaction-stats-container" class="summary-box">
<div style="display: flex; gap: 20px; align-items: center; margin-bottom: 15px;">
<p style="margin: 0;">Total Requests: <strong id="total-requests">0</strong></p>
<button onclick="fetchInteractionStats()">Refresh Stats</button>
<div style="margin-left: 10px;">
<button onclick="showDeviceEvents()">View App/Device Events</button>
</div>
<div style="margin-left: auto; text-align: right;">
<button onclick="cleanupSessions()" class="btn-danger">Cleanup old sessions</button>
<div style="font-size: 0.75em; color: #666; margin-top: 3px;">Keeps only the 10 most recent sessions</div>
</div>
</div>
<div style="display: flex; gap: 20px;">
<div style="flex: 1; border-right: 1px solid #eee; padding-right: 20px;">
<h3>By Service</h3>
<ul id="stats-by-service" class="stats-list"></ul>
</div>
<div style="flex: 2;">
<h3>Sessions</h3>
<div id="stats-by-session-container" style="max-height: 200px; overflow-y: auto; border: 1px solid #eee; padding: 5px; border-radius: 4px;">
<ul id="stats-by-session" class="stats-list"></ul>
</div>
</div>
</div>
</div>
<div id="browse-recordings" class="summary-box" style="margin-top: 20px;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">Browse Recordings</h3>
</div>
<div style="margin-bottom: 15px; display: flex; gap: 15px; align-items: center; background: #f9f9f9; padding: 10px; border-radius: 4px;">
<div>
<label for="filter-session">Session:</label>
<select id="filter-session" onchange="fetchInteractions()">
<option value="">All Sessions</option>
</select>
</div>
<div>
<label for="filter-category">Category:</label>
<select id="filter-category" onchange="fetchInteractions()">
<option value="">All Categories</option>
<option value="self">Self (Emulated)</option>
<option value="upstream">Upstream (Bose)</option>
<option value="mirror">Mirror (Bose)</option>
</select>
</div>
<div>
<label for="filter-since">Since (YYYY-MM-DD HH:mm:ss):</label>
<input type="text" id="filter-since" placeholder="e.g. 2026-02-15 15:00:00" size="25" onchange="fetchInteractions()">
</div>
<button onclick="fetchInteractions()">Apply Filters</button>
</div>
<div id="interactions-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">#</th>
<th style="padding: 8px;">Time</th>
<th style="padding: 8px;">Method</th>
<th style="padding: 8px;">Path</th>
<th style="padding: 8px;">Status</th>
<th style="padding: 8px;">Category</th>
<th style="padding: 8px;">Action</th>
</tr>
</thead>
<tbody id="interactions-list">
<tr><td colspan="7" style="padding: 20px; text-align: center; color: #666;">No interactions found.</td></tr>
</tbody>
</table>
</div>
</div>
<div id="dns-discoveries" class="summary-box" style="margin-top: 20px;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">DNS Discoveries</h3>
<div style="display: flex; gap: 10px;">
<button onclick="downloadDNSDiscoveries()" class="btn-info">Download JSON</button>
<button onclick="clearDNSDiscoveries()" class="btn-danger">Clear DNS Logs</button>
</div>
</div>
<p style="font-size: 0.85em; color: #666;">Hosts discovered via the AfterTouch DNS server. "Self" means the domain was intercepted and redirected to this service.</p>
<div id="dns-discoveries-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">Hostname</th>
<th style="padding: 8px;">Last Seen</th>
<th style="padding: 8px; text-align: center;">Queries</th>
<th style="padding: 8px; text-align: center;">Bose?</th>
<th style="padding: 8px;">Category</th>
<th style="padding: 8px;">Last Client IP</th>
</tr>
</thead>
<tbody id="dns-discoveries-list">
<tr><td colspan="6" style="padding: 20px; text-align: center; color: #666;">No DNS discoveries found.</td></tr>
</tbody>
</table>
</div>
</div>
<div id="interaction-viewer" class="summary-box" style="margin-top: 20px; display: none; background: #2b2b2b; color: #a9b7c6;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 10px;">
<h3 style="margin: 0; color: #fff;">Recording Viewer: <span id="viewer-filename" style="font-weight: normal; font-size: 0.8em;"></span></h3>
<button onclick="document.getElementById('interaction-viewer').style.display='none'" style="background: #444; color: #fff; border: 1px solid #666;">Close</button>
</div>
<pre id="interaction-content" style="white-space: pre-wrap; font-family: 'Courier New', Courier, monospace; font-size: 0.9em; margin: 0; padding: 10px; overflow-x: auto; max-height: 600px;"></pre>
</div>
<!-- Device Events Overlay -->
<div id="device-events-overlay" class="summary-box" style="margin-top: 20px; display: none; background: #fdfdfd; border: 1px solid #ddd;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 10px;">
<h3 style="margin: 0;">App & Device Events</h3>
<div>
<select id="event-device-selector" onchange="fetchDeviceEvents(this.value)">
<option value="">-- Select Device --</option>
</select>
<button onclick="document.getElementById('device-events-overlay').style.display='none'" style="margin-left: 10px;">Close</button>
</div>
</div>
<div id="events-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">Time</th>
<th style="padding: 8px;">Type</th>
<th style="padding: 8px;">Data</th>
</tr>
</thead>
<tbody id="events-list">
<tr><td colspan="3" style="padding: 20px; text-align: center; color: #666;">Select a device to view events.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
<!-- Tab 6: Parity & Mirroring -->
<div id="tab-parity" class="tab-content">
<h2>Parity Analysis</h2>
<p>Detection of discrepancies between AfterTouch local responses and official Bose Cloud responses for mirrored endpoints.</p>
<div class="summary-box">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">Parity Mismatches</h3>
<div style="display: flex; gap: 10px;">
<button onclick="fetchParityMismatches()">Refresh Mismatches</button>
<button onclick="clearParityMismatches()" class="btn-danger">Clear All Records</button>
</div>
</div>
<div id="parity-list-container" style="max-height: 500px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">Time</th>
<th style="padding: 8px;">Method</th>
<th style="padding: 8px;">Path</th>
<th style="padding: 8px;">Reasons</th>
<th style="padding: 8px;">Action</th>
</tr>
</thead>
<tbody id="parity-mismatches-list">
<tr><td colspan="5" style="padding: 20px; text-align: center; color: #666;">Loading mismatches...</td></tr>
</tbody>
</table>
</div>
</div>
<div id="parity-diff-view" class="summary-box" style="display: none; margin-top: 20px;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">Mismatch Detail: <span id="diff-path-display"></span></h3>
<button onclick="document.getElementById('parity-diff-view').style.display='none'">Close Detail</button>
</div>
<div style="margin-bottom: 15px; padding: 10px; background: #fff4f4; border: 1px solid #f5c6cb; border-radius: 4px; color: #721c24;">
<strong>Detection Reasons:</strong>
<ul id="diff-reasons-list" style="margin: 5px 0 0 0; padding-left: 20px;"></ul>
</div>
<div class="diff-container" style="margin-top: 15px;">
<div class="diff-pane">
<span class="config-header" style="background: #eefbff; color: #0056b3;">Local Response (AfterTouch)</span>
<div id="diff-local-meta" style="font-size: 0.8em; margin-bottom: 5px; color: #666;"></div>
<pre id="diff-local-body" style="background: #f8f9fa; border: 1px solid #eee; padding: 10px; font-size: 0.85em; overflow-x: auto;"></pre>
</div>
<div class="diff-pane">
<span class="config-header" style="background: #fff4e6; color: #856404;">Upstream Response (Bose)</span>
<div id="diff-upstream-meta" style="font-size: 0.8em; margin-bottom: 5px; color: #666;"></div>
<pre id="diff-upstream-body" style="background: #f8f9fa; border: 1px solid #eee; padding: 10px; font-size: 0.85em; overflow-x: auto;"></pre>
</div>
</div>
</div>
<a href="/web/migration/" class="choice-card">
<div class="icon">⚙️</div>
<div class="title">Migration</div>
<div class="desc">Setup, data sync, and cloud migration toolkit.</div>
</a>
</div>
</div>
<script src="/web/js/script.js"></script>
<footer style="margin-top: 50px; padding: 20px; border-top: 1px solid #eee; font-size: 0.8em; color: #888; text-align: center;">
<footer>
<span id="version-info">AfterTouch</span>
</footer>
<script src="/web/shared/common.js"></script>
<script>
fetchVersion();
</script>
</body>
</html>
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
@@ -0,0 +1,476 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>AfterTouch (SoundTouch Toolkit)</title>
<link rel="icon" href="/media/favicon-braille.svg" type="image/svg+xml">
<link rel="stylesheet" href="../shared/common.css">
<link rel="stylesheet" href="style.css">
</head>
<body>
<h1>AfterTouch</h1>
<p style="margin-top: -10px; font-style: italic; color: #666;">Bose SoundTouch Toolkit</p>
<p style="margin-bottom: 20px;"><a href="/">&larr; Back to selection</a></p>
<div class="tabs">
<div class="tab-buttons">
<button class="tab-btn active" onclick="openTab(event, 'tab-overview')">Overview</button>
<button class="tab-btn" onclick="openTab(event, 'tab-settings')">1. Settings</button>
<button class="tab-btn" onclick="openTab(event, 'tab-devices')">2. Devices</button>
<button class="tab-btn" onclick="openTab(event, 'tab-sync')">3. Data Sync</button>
<button class="tab-btn" onclick="openTab(event, 'tab-migration')">4. Migration</button>
<button class="tab-btn" onclick="openTab(event, 'tab-interactions')">5. Interactions & Events</button>
</div>
<!-- Tab 0: Overview -->
<div id="tab-overview" class="tab-content active">
<h2>Welcome to AfterTouch</h2>
<p>This toolkit helps you keep your Bose SoundTouch speakers functional even after the Bose Cloud shutdown in May 2026. It emulates the necessary cloud services locally on your network.</p>
<h3>Migration Process at a Glance</h3>
<div class="info-box prerequisite-box">
<strong>🔌 Prerequisite: Enable SSH</strong><br>
Migration requires SSH access. To enable it:
<ol style="margin-top: 5px; margin-bottom: 5px;">
<li>Create an empty file named <code>remote_services</code> on a USB stick.</li>
<li>Insert it into the speaker's <strong>SERVICE</strong> port and reboot the speaker.</li>
</ol>
<strong>Verify connection:</strong>
<ul style="margin-top: 5px; margin-bottom: 0; padding-left: 20px;">
<li>Use the <strong>Migration</strong> tab to select your device and verify that <em>SSH Connection</em> shows ✅ Success.</li>
<li>Or manually: <code>ssh -oHostKeyAlgorithms=+ssh-rsa root@&lt;SPEAKER-IP&gt;</code> (no password).</li>
</ul>
</div>
<ol class="guide-steps">
<li>
<strong>Settings:</strong> Review the <strong>Settings</strong> tab. Ensure the "Target Domain" and "Proxy Domain" use an IP address or domain name that is <strong>accessible from your speakers</strong> (usually the IP of this server on your local network).
</li>
<li>
<strong>Discovery:</strong> Go to the <strong>Devices</strong> tab to find your speakers on the network.
Ensure your speakers are powered on and connected to the same network.
</li>
<li>
<strong>Data Sync:</strong> In the <strong>Data Sync</strong> tab, fetch your current presets, recents, and sources.
This step is critical to ensure your local service has all your personalized data before you disconnect from the Bose cloud.
</li>
<li>
<strong>Migration:</strong> In the <strong>Migration</strong> tab, redirect your speaker to this local service.
We recommend the <strong>XML Configuration</strong> method as it is surgical and easily reversible.
</li>
<li>
<strong>Verification:</strong> After migration and reboot, your speaker will communicate with this toolkit instead of Bose servers.
</li>
</ol>
<div class="info-box safety-box">
<strong>⚠️ Safety First:</strong> Before starting any migration, please read our
<a href="https://gesellix.github.io/Bose-SoundTouch/guides/MIGRATION-SAFETY.html" target="_blank">Professional Migration & Safety Guide</a>.
The toolkit automatically creates backups, but understanding the process is key to a smooth transition.
</div>
<h3>Useful Links</h3>
<ul>
<li><a href="https://gesellix.github.io/Bose-SoundTouch/guides/SURVIVAL-GUIDE.html" target="_blank">Cloud Shutdown Survival Guide</a></li>
<li><a href="https://gesellix.github.io/Bose-SoundTouch/guides/CLI-REFERENCE.html" target="_blank">CLI Reference</a></li>
</ul>
</div>
<!-- Tab 1: Settings -->
<div id="tab-settings" class="tab-content">
<h2>System Settings</h2>
<p style="font-size: 0.9em; color: #555; margin-bottom: 20px;">
<strong>Note:</strong> These URLs must be <strong>accessible from your SoundTouch devices</strong>.
Use the IP address of this server on your local network (e.g., <code>http://192.168.1.100:8000</code>)
rather than <code>localhost</code>.
</p>
<div style="margin-bottom: 20px;">
<label for="target-domain">Target Domain:</label>
<input type="text" id="target-domain" placeholder="http://192.168.x.x:8000" style="width: 300px;">
<span style="font-size: 0.8em; color: #666;">(Standard services URL)</span>
</div>
<div style="margin-bottom: 20px;">
<label for="soundcork-url">Soundcork URL:</label>
<input type="text" id="soundcork-url" placeholder="http://192.168.x.x:8001" style="width: 300px;">
<span style="font-size: 0.8em; color: #666;">(Soundcork services URL)</span>
</div>
<div style="margin-bottom: 20px;">
<label for="discovery-interval">Discovery Interval:</label>
<input type="text" id="discovery-interval" placeholder="5m" style="width: 100px;">
<label style="margin-left: 15px;"><input type="checkbox" id="discovery-enabled"> Enable Automated Discovery</label>
</div>
<div style="margin-bottom: 20px;">
<button onclick="updateSettings()">Save Settings</button>
<span id="settings-status" style="margin-left: 10px; font-size: 0.9em;"></span>
</div>
<div style="margin-bottom: 20px;">
<strong>DNS Discovery:</strong>
<div style="margin-top: 5px;">
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="dns-enabled"> Enable DNS Discovery Server
</label>
<div style="margin-left: 20px; margin-bottom: 5px;">
<label for="dns-upstream">Upstream DNS:</label>
<input type="text" id="dns-upstream" placeholder="8.8.8.8" style="width: 150px;">
<span style="font-size: 0.8em; color: #666; margin-left: 5px;">(For non-intercepted queries)</span>
</div>
<div style="margin-left: 20px;">
<label for="dns-bind">DNS Bind Address:</label>
<input type="text" id="dns-bind" placeholder=":53" style="width: 100px;">
<span style="font-size: 0.8em; color: #666; margin-left: 5px;">(e.g., :53 or 0.0.0.0:53. <strong>Port 53</strong> is required for actual migration)</span>
</div>
</div>
</div>
<div style="margin-bottom: 20px;">
<strong>Proxy Logging:</strong>
<div style="margin-top: 5px;">
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="proxy-redact" onchange="updateProxySettings()"> Redact Sensitive Headers</label>
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="proxy-log-body" onchange="updateProxySettings()"> Log Bodies</label>
<label style="display: block; margin-bottom: 5px;"><input type="checkbox" id="enable-soundcork-proxy" onchange="updateProxySettings()"> Enable Soundcork Proxy (Legacy)</label>
<label style="display: block; margin-bottom: 5px;">
<input type="checkbox" id="proxy-record" onchange="updateProxySettings()"> Record Interactions
<span style="font-size: 0.85em; color: #666; margin-left: 5px;">(View in <strong>5. Interactions</strong> tab)</span>
</label>
</div>
</div>
</div>
<!-- Tab 2: Devices -->
<div id="tab-devices" class="tab-content">
<h2>Known Devices <span id="discovery-indicator" style="font-size: 0.5em; vertical-align: middle; display: none;">🔍 Scanning...</span></h2>
<div id="device-list">Loading devices...</div>
<div style="margin-top: 20px;">
<button onclick="triggerDiscovery()">Scan Again</button>
<input type="text" id="add-manual-ip" placeholder="Manual IP (e.g. 192.168.1.100)" style="margin-left: 20px; padding: 4px;">
<button onclick="addManualDevice()">Add Device</button>
</div>
</div>
<!-- Tab 3: Data Sync -->
<div id="tab-sync" class="tab-content">
<h2>Initial Data Sync</h2>
<p>Before migrating, fetch your presets, recents, and configured sources from the device to ensure they are available locally.</p>
<div class="device-selection">
<label for="sync-device-list">Device:</label>
<select id="sync-device-list">
<option value="">-- Select a device --</option>
</select>
<button id="sync-now-btn">Start Sync</button>
</div>
<div id="sync-status" class="status"></div>
<div id="sync-results" style="margin-top: 20px; display: none;">
<h3>Sync Results</h3>
<div id="sync-log" style="font-family: monospace; background: #f4f4f4; padding: 10px; border-radius: 4px; max-height: 300px; overflow-y: auto;"></div>
</div>
</div>
<!-- Tab 4: Migration -->
<div id="tab-migration" class="tab-content">
<h2>Device Migration</h2>
<div class="device-selection">
<label for="migration-device-list">Device:</label>
<select id="migration-device-list" onchange="showSummary(this.value)">
<option value="">-- Select a device --</option>
</select>
</div>
<div id="status" class="status"></div>
<div id="command-output-box" class="summary-box" style="display: none; background-color: #f0f0f0;">
<h3>Command Output</h3>
<div id="command-output" style="font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 300px; overflow-y: auto; padding: 10px; border: 1px solid #ccc; background: #fff;"></div>
</div>
<div id="migration-summary" class="summary-box" style="display: none;">
<h3>Migration Summary for <span id="summary-ip"></span></h3>
<p>Migration Status: <span id="migration-status"></span></p>
<p>SSH Connection: <span id="ssh-status"></span></p>
<p id="original-config-status" style="display: none;">Backup: ✅ Found .original config at <code>/opt/Bose/etc/SoundTouchSdkPrivateCfg.xml.original</code> <button onclick="toggleOriginalConfig()">Show Original Config</button></p>
<p id="no-original-config-status" style="display: none;">Backup: ❌ Not found <button id="backup-config-btn">Backup Config Now</button></p>
<p>Remote Services Enabled: <span id="remote-services-status"></span> <span id="remote-services-found" style="font-size: 0.8em; color: #666;"></span></p>
<p>AfterTouch Local Root CA Trusted: <span id="ca-trust-status"></span> <button id="trust-ca-btn" style="display: none; background-color: #607D8B; color: white; border: none; padding: 2px 8px; font-size: 0.8em; margin-left: 10px;">Trust CA Now</button></p>
<div id="connection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #eefbff;">
<strong>HTTPS Connection Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device can reach the server over HTTPS.</span>
<div style="margin-top: 10px;">
URL: <code id="test-url"></code>
</div>
<div style="margin-top: 10px;">
<button id="test-connection-explicit-btn" style="background-color: #607D8B; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test with Explicit CA.crt</button>
<button id="test-connection-trusted-btn" style="background-color: #607D8B; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test with Shared Trust Store</button>
</div>
<div id="test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div id="hosts-redirection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #fff4e6; display: none;">
<strong>Preliminary /etc/hosts Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device's /etc/hosts mechanism before full migration.</span>
<div style="margin-top: 10px;">
Domain: <code>custom-test-api.bose.fake</code>
</div>
<div style="margin-top: 10px;">
<button id="test-hosts-btn" style="background-color: #FF9800; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test Hosts Redirection</button>
</div>
<div id="hosts-test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div id="dns-redirection-test" style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #e6ffed; display: none;">
<strong>Preliminary DNS Test:</strong><br>
<span style="font-size: 0.85em; color: #555;">Verify the device can resolve domains via the AfterTouch DNS server.</span>
<div style="margin-top: 10px;">
Domain: <code>aftertouch.test</code>
</div>
<div style="margin-top: 10px;">
<button id="test-dns-btn" style="background-color: #28a745; color: white; border: none; padding: 5px 10px; font-size: 0.9em;">Test DNS Redirection</button>
</div>
<div id="dns-test-result" style="margin-top: 10px; display: none; padding: 10px; border-radius: 4px; font-family: monospace; white-space: pre-wrap; font-size: 0.85em; max-height: 200px; overflow-y: auto;"></div>
</div>
<div style="margin: 15px 0; padding: 10px; border: 1px solid #ddd; background-color: #f9f9f9;">
<label for="migration-method"><strong>Migration Method:</strong></label>
<select id="migration-method" onchange="toggleMigrationMethod()">
<option value="xml">XML Configuration (Recommended - redirects specific services)</option>
<option value="hosts">/etc/hosts + Root CA (Advanced - global redirection)</option>
<option value="resolv">/etc/resolv.conf (DHCP-Aware - Most flexible)</option>
</select>
<div id="dns-port-warning" style="margin-top: 5px; color: #d32f2f; font-weight: bold; font-size: 0.9em; display: none;"></div>
</div>
<div id="current-resolv-pane" style="display: none; margin-bottom: 20px;">
<span class="config-header">Current /etc/resolv.conf</span>
<pre id="current-resolv-content"></pre>
</div>
<div id="original-config-pane" style="display: none; margin-bottom: 20px;">
<span class="config-header">Original Config (Backup)</span>
<pre id="original-config-content"></pre>
</div>
<div id="service-options" style="margin-bottom: 20px; display: none;">
<h4>Service Implementations</h4>
<table>
<tr><th>Service</th><th>Original URL</th><th>Implementation</th></tr>
<tr>
<td>Marge (Streaming)</td>
<td id="orig-marge">loading...</td>
<td>
<select id="opt-marge" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>Stats</td>
<td id="orig-stats">loading...</td>
<td>
<select id="opt-stats" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>Software Update</td>
<td id="orig-sw_update">loading...</td>
<td>
<select id="opt-sw_update" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
<tr>
<td>BMX (Registry)</td>
<td id="orig-bmx">loading...</td>
<td>
<select id="opt-bmx" onchange="refreshSummary()">
<option value="self">AfterTouch (Local Service)</option>
<option value="upstream">Upstream (Proxy via local service)</option>
</select>
</td>
</tr>
</table>
</div>
<div class="diff-container">
<div id="xml-diff-pane" class="diff-pane">
<span class="config-header">Current Config (on Speaker)</span>
<pre id="current-config"></pre>
</div>
<div id="planned-xml-pane" class="diff-pane">
<span class="config-header">Planned Config (AfterTouch)</span>
<pre id="planned-config"></pre>
</div>
<div id="planned-hosts-pane" class="diff-pane" style="display: none;">
<span class="config-header">Planned /etc/hosts Entries</span>
<pre id="planned-hosts"></pre>
<div style="margin-top: 10px; font-size: 0.9em; color: #666;">
<strong>Note:</strong> This method also injects the AfterTouch Local Root CA into <code>/etc/pki/tls/certs/ca-bundle.crt</code> to enable secure HTTPS communication.
</div>
</div>
<div id="planned-resolv-pane" class="diff-pane" style="display: none;">
<span class="config-header">Planned /etc/resolv.conf Hook</span>
<pre id="planned-resolv"></pre>
<div id="resolv-note" style="margin-top: 10px; font-size: 0.9em; color: #666;">
<strong>Note:</strong> This method injects a persistent DNS priority hook into the DHCP logic (<code>/etc/udhcpc.d/50default</code>). It preserves your router's search domain and secondary DNS servers. It also injects the Local Root CA.
</div>
</div>
</div>
<div style="margin-top: 15px;">
<button id="confirm-migrate-btn" style="background-color: #4CAF50; color: white; border: none; padding: 10px 20px;">Confirm Migration</button>
<button id="revert-migrate-btn" style="background-color: #FF9800; color: white; border: none; padding: 10px 20px; display: none;">Revert to Defaults</button>
<button id="reboot-speaker-btn" style="background-color: #607D8B; color: white; border: none; padding: 10px 20px;">Reboot Speaker</button>
<button id="ensure-remote-btn" style="background-color: #2196F3; color: white; border: none; padding: 10px 20px;">Enable Persistent Remote Services</button>
<button id="remove-remote-btn" style="background-color: #f44336; color: white; border: none; padding: 10px 20px;">Remove Persistent Remote Services</button>
<button onclick="document.getElementById('migration-summary').style.display='none'" style="padding: 10px 20px;">Cancel</button>
</div>
</div>
</div>
<!-- Tab 5: Interactions & Events -->
<div id="tab-interactions" class="tab-content">
<h2>Recorded Interactions & Device Events</h2>
<p>Analysis of traffic handled by this service (self), proxied to Bose (upstream), and internal device events (telemetry).</p>
<div id="interaction-stats-container" class="summary-box">
<div style="display: flex; gap: 20px; align-items: center; margin-bottom: 15px;">
<p style="margin: 0;">Total Requests: <strong id="total-requests">0</strong></p>
<button onclick="fetchInteractionStats()">Refresh Stats</button>
<div style="margin-left: 10px;">
<button onclick="showDeviceEvents()">View App/Device Events</button>
</div>
<div style="margin-left: auto; text-align: right;">
<button onclick="cleanupSessions()" class="btn-danger">Cleanup old sessions</button>
<div style="font-size: 0.75em; color: #666; margin-top: 3px;">Keeps only the 10 most recent sessions</div>
</div>
</div>
<div style="display: flex; gap: 20px;">
<div style="flex: 1; border-right: 1px solid #eee; padding-right: 20px;">
<h3>By Service</h3>
<ul id="stats-by-service" class="stats-list"></ul>
</div>
<div style="flex: 2;">
<h3>Sessions</h3>
<div id="stats-by-session-container" style="max-height: 200px; overflow-y: auto; border: 1px solid #eee; padding: 5px; border-radius: 4px;">
<ul id="stats-by-session" class="stats-list"></ul>
</div>
</div>
</div>
</div>
<div id="browse-recordings" class="summary-box" style="margin-top: 20px;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">Browse Recordings</h3>
</div>
<div style="margin-bottom: 15px; display: flex; gap: 15px; align-items: center; background: #f9f9f9; padding: 10px; border-radius: 4px;">
<div>
<label for="filter-session">Session:</label>
<select id="filter-session" onchange="fetchInteractions()">
<option value="">All Sessions</option>
</select>
</div>
<div>
<label for="filter-category">Category:</label>
<select id="filter-category" onchange="fetchInteractions()">
<option value="">All Categories</option>
<option value="self">Self (Emulated)</option>
<option value="upstream">Upstream (Bose)</option>
</select>
</div>
<div>
<label for="filter-since">Since (YYYY-MM-DD HH:mm:ss):</label>
<input type="text" id="filter-since" placeholder="e.g. 2026-02-15 15:00:00" size="25" onchange="fetchInteractions()">
</div>
<button onclick="fetchInteractions()">Apply Filters</button>
</div>
<div id="interactions-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">#</th>
<th style="padding: 8px;">Time</th>
<th style="padding: 8px;">Method</th>
<th style="padding: 8px;">Path</th>
<th style="padding: 8px;">Status</th>
<th style="padding: 8px;">Category</th>
<th style="padding: 8px;">Action</th>
</tr>
</thead>
<tbody id="interactions-list">
<tr><td colspan="7" style="padding: 20px; text-align: center; color: #666;">No interactions found.</td></tr>
</tbody>
</table>
</div>
</div>
<div id="dns-discoveries" class="summary-box" style="margin-top: 20px;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 15px;">
<h3 style="margin: 0;">DNS Discoveries</h3>
<button onclick="clearDNSDiscoveries()" class="btn-danger">Clear DNS Logs</button>
</div>
<p style="font-size: 0.85em; color: #666;">Hosts discovered via the AfterTouch DNS server. "Self" means the domain was intercepted and redirected to this service.</p>
<div id="dns-discoveries-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">Hostname</th>
<th style="padding: 8px;">Last Seen</th>
<th style="padding: 8px; text-align: center;">Queries</th>
<th style="padding: 8px; text-align: center;">Bose?</th>
<th style="padding: 8px;">Category</th>
<th style="padding: 8px;">Last Client IP</th>
</tr>
</thead>
<tbody id="dns-discoveries-list">
<tr><td colspan="6" style="padding: 20px; text-align: center; color: #666;">No DNS discoveries found.</td></tr>
</tbody>
</table>
</div>
</div>
<div id="interaction-viewer" class="summary-box" style="margin-top: 20px; display: none; background: #2b2b2b; color: #a9b7c6;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 10px;">
<h3 style="margin: 0; color: #fff;">Recording Viewer: <span id="viewer-filename" style="font-weight: normal; font-size: 0.8em;"></span></h3>
<button onclick="document.getElementById('interaction-viewer').style.display='none'" style="background: #444; color: #fff; border: 1px solid #666;">Close</button>
</div>
<pre id="interaction-content" style="white-space: pre-wrap; font-family: 'Courier New', Courier, monospace; font-size: 0.9em; margin: 0; padding: 10px; overflow-x: auto; max-height: 600px;"></pre>
</div>
<!-- Device Events Overlay -->
<div id="device-events-overlay" class="summary-box" style="margin-top: 20px; display: none; background: #fdfdfd; border: 1px solid #ddd;">
<div style="display: flex; justify-content: space-between; align-items: center; margin-bottom: 10px;">
<h3 style="margin: 0;">App & Device Events</h3>
<div>
<select id="event-device-selector" onchange="fetchDeviceEvents(this.value)">
<option value="">-- Select Device --</option>
</select>
<button onclick="document.getElementById('device-events-overlay').style.display='none'" style="margin-left: 10px;">Close</button>
</div>
</div>
<div id="events-list-container" style="max-height: 400px; overflow-y: auto;">
<table style="width: 100%; border-collapse: collapse;">
<thead>
<tr style="text-align: left; border-bottom: 2px solid #eee;">
<th style="padding: 8px;">Time</th>
<th style="padding: 8px;">Type</th>
<th style="padding: 8px;">Data</th>
</tr>
</thead>
<tbody id="events-list">
<tr><td colspan="3" style="padding: 20px; text-align: center; color: #666;">Select a device to view events.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<script src="../shared/common.js"></script>
<script src="script.js"></script>
<footer style="margin-top: 50px;">
<span id="version-info">AfterTouch</span>
</footer>
</body>
</html>
File diff suppressed because it is too large Load Diff
@@ -7,7 +7,25 @@ button { padding: 5px 10px; cursor: pointer; }
.summary-box { margin-top: 20px; padding: 15px; border: 1px solid #aaa; background-color: #f9f9f9; }
pre { background-color: #eee; padding: 10px; overflow-x: auto; font-size: 12px; }
.diff-container { display: flex; gap: 10px; }
.diff-pane { flex: 1; min-width: 0; }
.diff-pane pre {
background: #f8f9fa;
border: 1px solid #eee;
padding: 10px;
font-size: 0.85em;
overflow-x: auto;
white-space: pre-wrap;
word-break: break-all;
}
.diff-added {
background-color: #e6ffed !important;
text-decoration: none;
}
.diff-removed {
background-color: #ffeef0 !important;
text-decoration: line-through;
}
.config-header { font-weight: bold; margin-bottom: 5px; display: block; }
/* Tabs */
@@ -0,0 +1,16 @@
footer {
margin-top: 50px;
padding: 20px;
font-size: 0.8em;
color: #666;
text-align: center;
}
#version-info a {
color: inherit;
text-decoration: none;
}
#version-info a:hover {
text-decoration: underline;
}
+23
View File
@@ -0,0 +1,23 @@
async function fetchVersion() {
try {
const response = await fetch('/version');
const data = await response.json();
const info = document.getElementById('version-info');
if (info && data.version) {
const version = data.version;
const commit = data.commit;
const isDirty = version.includes('dirty');
const releaseUrl = isDirty
? 'https://github.com/gesellix/Bose-SoundTouch/releases'
: `https://github.com/gesellix/Bose-SoundTouch/releases/tag/v${version}`;
const commitUrl = `https://github.com/gesellix/Bose-SoundTouch/commit/${commit}`;
const projectUrl = 'https://gesellix.github.io/Bose-SoundTouch/';
info.innerHTML = `<a href="${projectUrl}" target="_blank" style="color: inherit; text-decoration: none;">AfterTouch</a> ` +
`<a href="${releaseUrl}" target="_blank" style="color: inherit;">${version}</a> ` +
`(<a href="${commitUrl}" target="_blank" style="color: inherit;">${commit}</a>) - ${data.date}`;
}
} catch (error) {
console.error('Failed to fetch version info', error);
}
}
@@ -0,0 +1,456 @@
async function fetchDevices() {
try {
const response = await fetch('/devices');
const devices = await response.json();
const container = document.getElementById('device-list');
const seen = new Set();
if (devices.length === 0) {
container.innerHTML = '<p>No devices found. Ensure they are on the same network.</p>';
return;
}
devices.forEach(device => {
seen.add(device.device_id);
const existing = document.getElementById(`device-${device.device_id}`);
if (existing) {
// Update product code/IP if changed, but keep title if we already have a better name
const title = existing.querySelector('.device-title');
if (title && (!title.textContent || title.textContent === 'Unknown Device' || title.textContent.startsWith('SoundTouch-'))) {
title.textContent = device.name || 'Unknown Device';
}
const subtitle = existing.querySelector('.device-subtitle span');
if (subtitle) {
const currentSubtitle = subtitle.textContent || '';
const parts = currentSubtitle.split(' | ');
const currentType = parts.length > 1 ? parts[1].trim() : '';
const newType = device.product_code || 'Unknown';
// Don't downgrade type if we already have a specific one
const isGeneric = !currentType || currentType === 'Unknown' || currentType === 'N/A';
const displayType = isGeneric ? newType : currentType;
subtitle.textContent = `${device.ip_address} | ${displayType}`;
}
const details = existing.querySelector(`#details-${device.device_id}`);
if (details) {
const idField = details.querySelector('p:nth-child(1) code');
if (idField) {
const currentId = idField.textContent;
// Don't overwrite with serial if we have a real deviceID (usually hex)
if (!currentId || currentId === 'N/A' || currentId === device.device_serial_number) {
idField.textContent = device.device_id || 'N/A';
}
}
const firmwareField = details.querySelector('p:nth-child(2) code');
if (firmwareField) {
const cur = firmwareField.textContent;
if (!cur || cur === 'N/A' || cur === '0.0.0') {
firmwareField.textContent = device.firmware_version || 'N/A';
}
}
const serialField = details.querySelector('p:nth-child(3) code');
if (serialField && (!serialField.textContent || serialField.textContent === 'N/A')) {
serialField.textContent = device.device_serial_number || 'N/A';
}
}
// Ensure WS is open
openDeviceWebSocket(device.device_id);
return;
}
const card = document.createElement('div');
card.className = 'device-card';
card.id = `device-${device.device_id}`;
card.innerHTML = `
<div class="device-info">
<div class="device-header">
<div>
<div class="device-title-row">
<h2 class="device-title">${device.name || 'Unknown Device'}</h2>
<button class="info-toggle" title="More info" onclick="toggleDetails('${device.device_id}')">i</button>
</div>
<p class="device-subtitle">
<span>${device.ip_address} | ${device.product_code}</span>
</p>
</div>
<button class="power-icon" title="Power" aria-label="Power" onclick="control('${device.device_id}', 'POWER')">&#xE17E;</button>
</div>
<div class="device-details" id="details-${device.device_id}">
<p>ID: <code>${device.device_id}</code></p>
<p>Firmware: <code>${device.firmware_version || 'N/A'}</code></p>
<p>Serial: <code>${device.device_serial_number || 'N/A'}</code></p>
<p>Discovery: <code>${device.discovery_method || 'N/A'}</code></p>
</div>
</div>
<div class="now-playing" id="np-${device.device_id}">
<p><em>Loading playback status...</em></p>
</div>
<div class="controls">
<button class="primary" onclick="control('${device.device_id}', 'PLAY')">Play</button>
<button class="primary" onclick="control('${device.device_id}', 'PAUSE')">Pause</button>
<button onclick="control('${device.device_id}', 'PREV_TRACK')">Prev</button>
<button onclick="control('${device.device_id}', 'NEXT_TRACK')">Next</button>
</div>
<div class="volume-container">
<span>Vol:</span>
<input id="vol-${device.device_id}" type="range" min="0" max="100"
oninput="onVolumeInput('${device.device_id}', this)"
onmousedown="startAdjust('${device.device_id}')" ontouchstart="startAdjust('${device.device_id}')"
onmouseup="endAdjust('${device.device_id}')" ontouchend="endAdjust('${device.device_id}')">
</div>
`;
container.appendChild(card);
updateNowPlaying(device.device_id);
updateVolume(device.device_id);
openDeviceWebSocket(device.device_id);
});
// Remove cards for devices that no longer exist
Array.from(container.children).forEach(child => {
const id = child.id?.replace('device-', '');
if (id && !seen.has(id)) {
container.removeChild(child);
}
});
} catch (error) {
console.error('Failed to fetch devices', error);
document.getElementById('device-list').innerHTML = '<p>Error loading devices.</p>';
}
}
async function updateNowPlaying(deviceId) {
try {
const response = await fetch(`/devices/${deviceId}/info`);
if (!response.ok) return;
const info = await response.json();
// Update device name and type if available (live info is more accurate than discovery)
const title = document.querySelector(`#device-${deviceId} .device-title`);
if (title && info.name) {
title.textContent = info.name;
}
const subtitle = document.querySelector(`#device-${deviceId} .device-subtitle span`);
if (subtitle && info.type) {
subtitle.textContent = `${info.ipAddress || info.ip_address || 'N/A'} | ${info.type}`;
}
// Update firmware version if available
const details = document.getElementById(`details-${deviceId}`);
if (details) {
if (info.deviceID) {
const idField = details.querySelector('p:nth-child(1) code');
if (idField) idField.textContent = info.deviceID;
}
if (info.softwareVersion) {
const firmwareField = details.querySelector('p:nth-child(2) code');
if (firmwareField) firmwareField.textContent = info.softwareVersion;
}
if (info.serialNumber) {
const serialField = details.querySelector('p:nth-child(3) code');
if (serialField) serialField.textContent = info.serialNumber;
}
}
const npContainer = document.getElementById(`np-${deviceId}`);
if (npContainer && info.nowPlaying) {
const np = info.nowPlaying;
const source = np.source || np.Source;
const powerIcon = document.querySelector(`#device-${deviceId} .power-icon`);
if (powerIcon) {
if (source === 'STANDBY') {
powerIcon.classList.add('off');
powerIcon.classList.remove('on');
} else {
powerIcon.classList.remove('off');
powerIcon.classList.add('on');
}
}
if (source === 'STANDBY') {
npContainer.innerHTML = '<div class="now-playing-info"><p><em>Standby</em></p></div>';
} else {
const track = np.track || np.Track || np.stationName || np.StationName || 'Unknown Track';
const artist = np.artist || np.Artist || 'Unknown Artist';
const album = np.album || np.Album || 'Unknown Album';
const art = np.Art || np.art || {};
const artStatus = art.ArtImageStatus || art.artImageStatus;
const artUrl = artStatus === 'IMAGE_PRESENT' ? (art.URL || art.url || '') : '';
npContainer.innerHTML = `
<img class="album-art" src="${artUrl}" alt="Artwork">
<div class="now-playing-info">
<strong>${track}</strong><br>
${artist} - ${album}
</div>
`;
}
}
} catch (error) {
console.warn('Failed to fetch now playing for ' + deviceId, error);
}
}
async function updateVolume(deviceId) {
try {
const response = await fetch(`/devices/${deviceId}/info`);
if (!response.ok) return;
const info = await response.json();
const slider = document.getElementById(`vol-${deviceId}`);
if (slider && info.volume && typeof info.volume.actualvolume === 'number' && !adjusting[deviceId]) {
slider.value = String(info.volume.actualvolume);
}
} catch (error) {
console.warn('Failed to fetch volume for ' + deviceId, error);
}
}
async function control(deviceId, key) {
let deviceName = deviceId;
const title = document.querySelector(`#device-${deviceId} .device-title`);
if (title && title.textContent) {
deviceName = title.textContent;
}
try {
const res = await fetch(`/devices/${encodeURIComponent(deviceId)}/key/${encodeURIComponent(key)}`, {
method: 'POST'
});
if (!res.ok) {
const text = await res.text();
throw new Error(text || `HTTP ${res.status}`);
}
} catch (error) {
console.error('Control failed', error);
alert(`Failed to send ${key} to ${deviceName}: ${error.message}`);
}
}
async function setVolume(deviceId, level) {
let deviceName = deviceId;
const title = document.querySelector(`#device-${deviceId} .device-title`);
if (title && title.textContent) {
deviceName = title.textContent;
}
try {
const res = await fetch(`/devices/${encodeURIComponent(deviceId)}/volume/${encodeURIComponent(level)}`, {
method: 'POST'
});
if (!res.ok) {
const text = await res.text();
throw new Error(text || `HTTP ${res.status}`);
}
} catch (error) {
console.error('Set volume failed', error);
alert(`Failed to set volume on ${deviceName} to ${level}: ${error.message}`);
}
}
// Volume interaction helpers to avoid UI jumping while dragging
const adjusting = {};
const volumeTimers = {};
function startAdjust(deviceId) {
adjusting[deviceId] = true;
}
function endAdjust(deviceId) {
// Small delay to let the device send back its volume update
setTimeout(() => { adjusting[deviceId] = false; }, 300);
}
function onVolumeInput(deviceId, el) {
startAdjust(deviceId);
const level = el.value;
// Debounce network calls per device
if (volumeTimers[deviceId]) {
clearTimeout(volumeTimers[deviceId]);
}
volumeTimers[deviceId] = setTimeout(() => {
setVolume(deviceId, level);
endAdjust(deviceId);
}, 150);
}
let deviceSockets = {};
function openDeviceWebSocket(deviceId) {
const key = `${deviceId}`;
try {
const existing = deviceSockets[key];
if (existing) {
// Reuse an already healthy connection instead of tearing it down every refresh
if (existing.readyState === WebSocket.OPEN || existing.readyState === WebSocket.CONNECTING) {
return;
}
try { existing.close(); } catch (_) {}
}
const proto = location.protocol === 'https:' ? 'wss' : 'ws';
const wsUrl = `${proto}://${location.host}/devices/${encodeURIComponent(deviceId)}/ws`;
const ws = new WebSocket(wsUrl);
deviceSockets[key] = ws;
ws.onopen = () => {
// console.log('WS connected for', deviceId);
};
ws.onmessage = (ev) => {
try {
const msg = JSON.parse(ev.data);
const type = msg.type;
const payload = msg.payload || {};
if (type === 'nowPlayingUpdated') {
const e = payload;
const np = e.NowPlaying || e.nowPlaying || {};
const source = np.source || np.Source;
// Also try to update name/type if they are present in the event (sometimes events carry device info)
const title = document.querySelector(`#device-${deviceId} .device-title`);
if (title && e.name) {
title.textContent = e.name;
}
const subtitle = document.querySelector(`#device-${deviceId} .device-subtitle span`);
if (subtitle && e.type) {
subtitle.textContent = `${e.ipAddress || e.ip_address || 'N/A'} | ${e.type}`;
}
const powerIcon = document.querySelector(`#device-${deviceId} .power-icon`);
if (powerIcon) {
if (source === 'STANDBY') {
powerIcon.classList.add('off');
powerIcon.classList.remove('on');
} else {
powerIcon.classList.remove('off');
powerIcon.classList.add('on');
}
}
const npContainer = document.getElementById(`np-${deviceId}`);
if (npContainer) {
if (source === 'STANDBY') {
npContainer.innerHTML = '<div class="now-playing-info"><p><em>Standby</em></p></div>';
} else {
const track = np.track || np.Track || np.stationName || np.StationName || 'Unknown Track';
const artist = np.artist || np.Artist || 'Unknown Artist';
const album = np.album || np.Album || 'Unknown Album';
const art = np.Art || np.art || {};
const artStatus = art.ArtImageStatus || art.artImageStatus;
const artUrl = artStatus === 'IMAGE_PRESENT' ? (art.URL || art.url || '') : '';
npContainer.innerHTML = `
<img class="album-art" src="${artUrl}" alt="Artwork">
<div class="now-playing-info">
<strong>${track}</strong><br>
${artist} - ${album}
</div>
`;
}
}
} else if (type === 'volumeUpdated') {
const e = payload;
const vol = (e.Volume && (typeof e.Volume.actualvolume === 'number' ? e.Volume.actualvolume : (typeof e.Volume.actual === 'number' ? e.Volume.actual : e.Volume.target))) ||
(e.volume && (typeof e.volume.actualvolume === 'number' ? e.volume.actualvolume : (typeof e.volume.actual === 'number' ? e.volume.actual : e.volume.target)));
const slider = document.getElementById(`vol-${deviceId}`);
if (slider && typeof vol === 'number' && !adjusting[deviceId]) {
slider.value = String(vol);
}
} else if (type === 'snapshotInfo') {
const info = payload || {};
// Update name and type from snapshot
const title = document.querySelector(`#device-${deviceId} .device-title`);
if (title && info.name) {
title.textContent = info.name;
}
const subtitle = document.querySelector(`#device-${deviceId} .device-subtitle span`);
if (subtitle && info.type) {
subtitle.textContent = `${info.ipAddress || info.ip_address || 'N/A'} | ${info.type}`;
}
// Update firmware and ID from snapshot if available
const details = document.getElementById(`details-${deviceId}`);
if (details) {
if (info.deviceID) {
const idField = details.querySelector('p:nth-child(1) code');
if (idField) idField.textContent = info.deviceID;
}
if (info.softwareVersion) {
const firmwareField = details.querySelector('p:nth-child(2) code');
if (firmwareField) firmwareField.textContent = info.softwareVersion;
}
if (info.serialNumber) {
const serialField = details.querySelector('p:nth-child(3) code');
if (serialField) serialField.textContent = info.serialNumber;
}
}
if (info.nowPlaying) {
const np = info.nowPlaying;
const source = np.source || np.Source;
const powerIcon = document.querySelector(`#device-${deviceId} .power-icon`);
if (powerIcon) {
if (source === 'STANDBY') {
powerIcon.classList.add('off');
powerIcon.classList.remove('on');
} else {
powerIcon.classList.remove('off');
powerIcon.classList.add('on');
}
}
const npContainer = document.getElementById(`np-${deviceId}`);
if (npContainer) {
if (source === 'STANDBY') {
npContainer.innerHTML = '<div class="now-playing-info"><p><em>Standby</em></p></div>';
} else {
const track = np.track || np.Track || np.stationName || np.StationName || 'Unknown Track';
const artist = np.artist || np.Artist || 'Unknown Artist';
const album = np.album || np.Album || 'Unknown Album';
const art = np.Art || np.art || {};
const artStatus = art.ArtImageStatus || art.artImageStatus;
const artUrl = artStatus === 'IMAGE_PRESENT' ? (art.URL || art.url || '') : '';
npContainer.innerHTML = `
<img class="album-art" src="${artUrl}" alt="Artwork">
<div class="now-playing-info">
<strong>${track}</strong><br>
${artist} - ${album}
</div>
`;
}
}
}
const vol = info.actualVolume || (info.volume && (typeof info.volume.actualvolume === 'number' ? info.volume.actualvolume : (typeof info.volume.actual === 'number' ? info.volume.actual : null)));
const slider = document.getElementById(`vol-${deviceId}`);
if (slider && typeof vol === 'number' && !adjusting[deviceId]) slider.value = String(vol);
}
} catch (err) {
// console.warn('Bad WS message', err);
}
};
ws.onerror = () => {
// console.warn('WS error for', ip);
};
ws.onclose = () => {
// Try to reconnect after a delay
setTimeout(() => {
if (deviceSockets[key] === ws) {
delete deviceSockets[key];
}
openDeviceWebSocket(deviceId);
}, 3000);
};
} catch (e) {
// console.warn('Failed to open WS for', deviceId, e);
}
}
function toggleDetails(deviceId) {
const el = document.getElementById(`details-${deviceId}`);
if (el) {
el.classList.toggle('visible');
}
}
document.addEventListener('DOMContentLoaded', () => {
fetchDevices();
fetchVersion();
setInterval(fetchDevices, 30000);
});
Binary file not shown.
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Stockholm Mini - Reverse Engineered</title>
<link rel="stylesheet" href="../shared/common.css">
<link rel="stylesheet" href="style.css">
</head>
<body>
<div class="container">
<h1>Stockholm Mini</h1>
<p style="margin-top: -10px; font-style: italic; color: #666; font-size: 0.9rem;">A minimal reverse-engineered SoundTouch controller.</p>
<p style="margin-bottom: 20px;"><a href="/" style="color: #00bcd4; text-decoration: none; font-size: 0.9rem;">&larr; Back to selection</a></p>
<div id="device-list"></div>
</div>
<footer style="margin-top: 50px;">
<span id="version-info">AfterTouch</span>
</footer>
<script src="../shared/common.js"></script>
<script src="app.js"></script>
</body>
</html>
@@ -0,0 +1,40 @@
@font-face {
font-family: 'bose';
src: url('bose.ttf') format('truetype');
font-weight: normal;
font-style: normal;
font-display: swap;
}
body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; background: #121212; color: #e0e0e0; margin: 0; padding: 20px; }
.container { max-width: 800px; margin: 0 auto; }
h1 { color: #fff; border-bottom: 1px solid #333; padding-bottom: 10px; }
.device-card { background: #1e1e1e; border-radius: 8px; padding: 20px; margin-bottom: 20px; box-shadow: 0 4px 6px rgba(0,0,0,0.3); }
.device-info h2 { margin-top: 0; color: #00bcd4; margin-bottom: 0; }
.device-header { display: flex; align-items: flex-start; justify-content: space-between; gap: 12px; }
.device-title-row { display: flex; align-items: center; gap: 10px; margin-bottom: 4px; }
.device-title { margin: 0; font-size: 1.5rem; line-height: 1.2; }
.device-subtitle { color: #888; font-size: 0.85rem; margin: 0; display: flex; align-items: center; }
.info-toggle { background: none; color: #555; padding: 0; width: 1.15rem; height: 1.15rem; display: inline-flex; align-items: center; justify-content: center; border: 1px solid #444; border-radius: 50%; font-size: 0.7rem; font-style: italic; cursor: pointer; line-height: 1; transition: all 0.2s; flex-shrink: 0; }
.info-toggle:hover { color: #aaa; border-color: #666; background: #2a2a2a; }
.device-details { display: none; margin-top: 10px; font-size: 0.8rem; background: #252525; padding: 10px; border-radius: 4px; color: #aaa; border-left: 2px solid #00bcd4; }
.device-details.visible { display: block; }
.device-details p { margin: 4px 0; }
.device-details code { color: #ccc; }
.controls { display: flex; gap: 10px; margin-top: 20px; }
button { background: #333; color: #fff; border: none; padding: 10px 20px; border-radius: 4px; cursor: pointer; transition: background 0.2s; }
button:hover { background: #444; }
button.primary { background: #00bcd4; color: #000; font-weight: bold; }
button.primary:hover { background: #00acc1; }
.power-icon { font-family: bose, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; font-size: 1.25rem; line-height: 1; height: 2.25rem; width: 2.25rem; padding: 0; display: inline-flex; align-items: center; justify-content: center; background: #2a2a2a; border-radius: 50%; color: #00bcd4; border: 1px solid #00bcd4; }
.power-icon:hover { background: #3a3a3a; }
.power-icon.off { color: #666; border-color: #444; background: #1a1a1a; }
.power-icon.on { background: #00bcd4; color: #000; border-color: #00bcd4; }
.power-icon.on:hover { background: #00acc1; }
.status-badge { display: inline-block; padding: 2px 8px; border-radius: 12px; font-size: 0.8em; background: #333; margin-left: 10px; }
.now-playing { margin-top: 20px; padding-top: 20px; border-top: 1px solid #333; display: flex; gap: 15px; align-items: center; min-height: 80px; }
.now-playing-info { flex-grow: 1; }
.album-art { width: 80px; height: 80px; border-radius: 4px; background: #2a2a2a; flex-shrink: 0; object-fit: cover; box-shadow: 0 2px 4px rgba(0,0,0,0.5); }
.album-art[src=""] { display: none; }
.volume-container { margin-top: 15px; display: flex; align-items: center; gap: 10px; }
input[type=range] { flex-grow: 1; }
#device-list:empty::after { content: "Searching for devices..."; color: #666; font-style: italic; }
+175 -18
View File
@@ -49,15 +49,16 @@ type InteractionStats struct {
// Interaction represents a single recorded HTTP interaction.
type Interaction struct {
ID string `json:"id"`
Session string `json:"session"`
Category string `json:"category"`
Method string `json:"method"`
Path string `json:"path"`
File string `json:"file"`
Counter int `json:"counter"`
Status int `json:"status"`
Timestamp string `json:"timestamp"`
ID string `json:"id"`
Session string `json:"session"`
Category string `json:"category"`
Method string `json:"method"`
Path string `json:"path"`
File string `json:"file"`
Counter int `json:"counter"`
Status int `json:"status"`
Timestamp string `json:"timestamp"`
SCMUDCData *EnrichedSCMUDCEvent `json:"scmudc_data,omitempty"`
}
// NewRecorder creates a new HTTP interaction recorder.
@@ -181,11 +182,25 @@ func (r *Recorder) Record(category string, req *http.Request, res *http.Response
}
func (r *Recorder) save(task recordingTask) {
var buf bytes.Buffer
r.writeRequest(&buf, task.req, task.replacements)
var (
buf bytes.Buffer
enriched *EnrichedSCMUDCEvent
)
// Check if this is a SCMUDC request and enrich it
if strings.Contains(task.req.URL.Path, "/v1/scmudc/") && task.req.Body != nil {
bodyBytes, err := io.ReadAll(task.req.Body)
if err == nil {
task.req.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
enriched = enrichSCMUDCRequest(bodyBytes)
}
}
r.writeRequestWithEnrichment(&buf, task.req, task.replacements, enriched)
if task.res != nil {
r.writeResponse(&buf, task.res)
r.writeResponseWithEnrichment(&buf, task.res, enriched)
}
if err := os.WriteFile(task.path, buf.Bytes(), 0644); err != nil {
@@ -239,7 +254,7 @@ func (r *Recorder) getRecordingPath(dir, method string) string {
return filepath.Join(dir, filename)
}
func (r *Recorder) writeRequest(buf *bytes.Buffer, req *http.Request, replacements map[string]string) {
func (r *Recorder) writeRequestWithEnrichment(buf *bytes.Buffer, req *http.Request, replacements map[string]string, enriched *EnrichedSCMUDCEvent) {
displayURL := req.URL.String()
for orig, repl := range replacements {
displayURL = strings.ReplaceAll(displayURL, orig, "{{"+strings.Trim(repl, "{}")+"}}")
@@ -252,6 +267,14 @@ func (r *Recorder) writeRequest(buf *bytes.Buffer, req *http.Request, replacemen
fmt.Fprintf(buf, "// %s: %s\n", key, orig)
}
// Add SCMUDC enriched comments
if enriched != nil {
enrichedComments := generateSCMUDCComments(enriched)
for _, comment := range enrichedComments {
fmt.Fprintf(buf, "%s\n", comment)
}
}
fmt.Fprintf(buf, "%s %s\n", req.Method, displayURL)
fmt.Fprintf(buf, "Host: %s\n", req.Host)
@@ -283,10 +306,29 @@ func (r *Recorder) writeRequest(buf *bytes.Buffer, req *http.Request, replacemen
}
}
func (r *Recorder) writeResponse(buf *bytes.Buffer, res *http.Response) {
func (r *Recorder) writeResponseWithEnrichment(buf *bytes.Buffer, res *http.Response, enriched *EnrichedSCMUDCEvent) {
buf.WriteString("\n")
buf.WriteString("> {% \n")
fmt.Fprintf(buf, " // Response: %d %s\n", res.StatusCode, http.StatusText(res.StatusCode))
// Add SCMUDC enrichment summary in response
if enriched != nil {
buf.WriteString(" //\n")
buf.WriteString(" // SCMUDC Event Analysis:\n")
fmt.Fprintf(buf, " // - Origin: %s (%s)\n", getOriginDescription(enriched.Origin), enriched.Origin)
fmt.Fprintf(buf, " // - Action: %s\n", enriched.Action)
fmt.Fprintf(buf, " // - Summary: %s\n", enriched.Summary)
if enriched.DecodedData != nil {
fmt.Fprintf(buf, " // - Content: %s\n", enriched.DecodedData.ItemName)
if enriched.DecodedData.SourceAccount != "" {
fmt.Fprintf(buf, " // - Account: %s\n", enriched.DecodedData.SourceAccount)
}
}
}
buf.WriteString(" //\n")
buf.WriteString(" // Headers:\n")
for k, vv := range res.Header {
@@ -312,8 +354,8 @@ func (r *Recorder) writeResponse(buf *bytes.Buffer, res *http.Response) {
buf.WriteString("\n/*\n")
buf.Write(bodyBytes)
buf.WriteString("\n*/\n")
} else {
fmt.Fprintf(buf, "\n// [Binary response body: %d bytes]\n", len(bodyBytes))
} else if len(bodyBytes) > 0 {
fmt.Fprintf(buf, "\n[Binary response body: %d bytes]\n", len(bodyBytes))
}
}
}
@@ -503,7 +545,7 @@ func (r *Recorder) parseInteractionFile(rel, path string, parts []string) (Inter
requestPath = "/"
}
return Interaction{
interaction := Interaction{
ID: filename,
Session: sessionID,
Category: category,
@@ -513,7 +555,122 @@ func (r *Recorder) parseInteractionFile(rel, path string, parts []string) (Inter
Counter: counter,
Status: r.peekStatus(path),
Timestamp: timestamp,
}, true
}
// Extract SCMUDC enrichment data if this is a SCMUDC request
if strings.Contains(requestPath, "/v1/scmudc/") {
interaction.SCMUDCData = r.extractSCMUDCFromFile(path)
}
return interaction, true
}
// extractSCMUDCFromFile parses SCMUDC enrichment data from a .http file
func (r *Recorder) extractSCMUDCFromFile(path string) *EnrichedSCMUDCEvent {
content, err := os.ReadFile(path)
if err != nil {
return nil
}
lines := strings.Split(string(content), "\n")
var (
enriched EnrichedSCMUDCEvent
foundSCMUDC bool
bodyStart int
)
// Look for SCMUDC enrichment comments
for i, line := range lines {
line = strings.TrimSpace(line)
switch {
case strings.HasPrefix(line, "// Origin: "):
parts := strings.Split(line, " (")
if len(parts) >= 2 {
enriched.Origin = strings.TrimSuffix(parts[1], ")")
foundSCMUDC = true
}
case strings.HasPrefix(line, "// Action: "):
enriched.Action = strings.TrimPrefix(line, "// Action: ")
case strings.HasPrefix(line, "// Command: "):
enriched.Command = strings.TrimPrefix(line, "// Command: ")
case strings.HasPrefix(line, "// Summary: "):
enriched.Summary = strings.TrimPrefix(line, "// Summary: ")
case strings.HasPrefix(line, "// - Source: "):
r.ensureDecodedData(&enriched)
enriched.DecodedData.ContentType = strings.TrimPrefix(line, "// - Source: ")
case strings.HasPrefix(line, "// - Item: "):
r.ensureDecodedData(&enriched)
enriched.DecodedData.ItemName = strings.TrimPrefix(line, "// - Item: ")
case strings.HasPrefix(line, "// - Account: "):
r.ensureDecodedData(&enriched)
enriched.DecodedData.SourceAccount = strings.TrimPrefix(line, "// - Account: ")
case strings.HasPrefix(line, "// - Artwork: "):
r.ensureDecodedData(&enriched)
enriched.DecodedData.ArtworkURL = strings.TrimPrefix(line, "// - Artwork: ")
case line == "// - Presetable: Yes":
r.ensureDecodedData(&enriched)
enriched.DecodedData.IsPresetable = true
case line == "{" && i > 0:
// Found start of JSON body
bodyStart = i
goto endLoop
}
}
endLoop:
// If we didn't find enrichment comments but this is a SCMUDC request,
// try to parse the JSON body directly
if !foundSCMUDC && bodyStart > 0 {
if parsed := r.parseSCMUDBody(lines, bodyStart); parsed != nil {
return parsed
}
}
if !foundSCMUDC {
return nil
}
return &enriched
}
func (r *Recorder) ensureDecodedData(enriched *EnrichedSCMUDCEvent) {
if enriched.DecodedData == nil {
enriched.DecodedData = &DecodedContent{}
}
}
func (r *Recorder) parseSCMUDBody(lines []string, bodyStart int) *EnrichedSCMUDCEvent {
var bodyLines []string
inBody := false
braceCount := 0
for i := bodyStart; i < len(lines); i++ {
line := lines[i]
if strings.TrimSpace(line) == "{" && !inBody {
inBody = true
bodyLines = append(bodyLines, line)
braceCount = 1
} else if inBody {
bodyLines = append(bodyLines, line)
braceCount += strings.Count(line, "{") - strings.Count(line, "}")
if braceCount == 0 {
break
}
}
}
if len(bodyLines) > 0 {
bodyJSON := strings.Join(bodyLines, "\n")
return enrichSCMUDCRequest([]byte(bodyJSON))
}
return nil
}
func (r *Recorder) getFullTimestamp(sessionID, filename string) string {
+257
View File
@@ -0,0 +1,257 @@
package proxy
import (
"encoding/base64"
"encoding/json"
"encoding/xml"
"fmt"
"strings"
)
// SCMUDCRequest represents the structure of SCMUDC telemetry requests
type SCMUDCRequest struct {
Envelope struct {
MonoTime int64 `json:"monoTime"`
PayloadProtocolVersion string `json:"payloadProtocolVersion"`
PayloadType string `json:"payloadType"`
ProtocolVersion string `json:"protocolVersion"`
Time string `json:"time"`
UniqueID string `json:"uniqueId"`
} `json:"envelope"`
Payload struct {
DeviceInfo struct {
BoseID string `json:"boseID"`
DeviceID string `json:"deviceID"`
DeviceType string `json:"deviceType"`
SerialNumber string `json:"serialNumber"`
SoftwareVersion string `json:"softwareVersion"`
SystemSerialNumber string `json:"systemSerialNumber"`
} `json:"deviceInfo"`
Events []SCMUDCEvent `json:"events"`
} `json:"payload"`
}
// SCMUDCEvent represents individual events within SCMUDC requests
type SCMUDCEvent struct {
Type string `json:"type"`
Data struct {
ButtonID string `json:"buttonId,omitempty"`
Origin string `json:"origin"`
ContentItem string `json:"contentItem,omitempty"`
Preset string `json:"preset,omitempty"`
} `json:"data"`
}
// EnrichedSCMUDCEvent contains human-readable analysis of SCMUDC events
type EnrichedSCMUDCEvent struct {
Origin string `json:"origin"`
Action string `json:"action"`
Command string `json:"command"`
Summary string `json:"summary"`
DecodedData *DecodedContent `json:"decoded_data,omitempty"`
}
// DecodedContent represents decoded ContentItem XML data
type DecodedContent struct {
ContentType string `json:"content_type"`
ItemName string `json:"item_name"`
SourceAccount string `json:"source_account,omitempty"`
Location string `json:"location,omitempty"`
ArtworkURL string `json:"artwork_url,omitempty"`
IsPresetable bool `json:"is_presetable,omitempty"`
XMLContent string `json:"xml_content,omitempty"`
}
// ContentItem represents the XML structure within Base64-encoded content
type ContentItem struct {
XMLName xml.Name `xml:"ContentItem"`
Source string `xml:"source,attr"`
Type string `xml:"type,attr"`
Location string `xml:"location,attr"`
SourceAccount string `xml:"sourceAccount,attr"`
IsPresetable string `xml:"isPresetable,attr"`
ItemName string `xml:"itemName"`
ContainerArt string `xml:"containerArt"`
}
// enrichSCMUDCRequest analyzes and enriches SCMUDC request data
func enrichSCMUDCRequest(body []byte) *EnrichedSCMUDCEvent {
var scmudcReq SCMUDCRequest
if err := json.Unmarshal(body, &scmudcReq); err != nil {
return nil
}
// Process the first event (most requests contain single events)
if len(scmudcReq.Payload.Events) == 0 {
return nil
}
event := scmudcReq.Payload.Events[0]
enriched := &EnrichedSCMUDCEvent{
Origin: event.Data.Origin,
Action: event.Type,
}
switch event.Data.Origin {
case "gabbo":
enriched.Command = event.Data.ButtonID
enriched.Summary = fmt.Sprintf("App: %s", formatButton(event.Data.ButtonID))
case "console":
enriched.Command = event.Data.ButtonID
enriched.Summary = fmt.Sprintf("Device: %s", formatButton(event.Data.ButtonID))
case "device":
if event.Data.ContentItem != "" {
if decoded := decodeContentItem(event.Data.ContentItem); decoded != nil {
enriched.Command = decoded.ItemName
enriched.Summary = fmt.Sprintf("Device: %s", summarizeContent(decoded))
enriched.DecodedData = decoded
} else {
enriched.Command = "Content Item"
enriched.Summary = "Device: Content Action"
}
} else {
enriched.Command = "System Action"
enriched.Summary = "Device: Internal Action"
}
}
return enriched
}
// decodeContentItem decodes Base64-encoded XML content
func decodeContentItem(base64Content string) *DecodedContent {
data, err := base64.StdEncoding.DecodeString(base64Content)
if err != nil {
return nil
}
var contentItem ContentItem
if err := xml.Unmarshal(data, &contentItem); err != nil {
return nil
}
decoded := &DecodedContent{
ContentType: contentItem.Source,
ItemName: contentItem.ItemName,
SourceAccount: contentItem.SourceAccount,
Location: contentItem.Location,
ArtworkURL: contentItem.ContainerArt,
XMLContent: string(data),
}
if contentItem.IsPresetable == "true" {
decoded.IsPresetable = true
}
return decoded
}
// formatButton converts button IDs to human-readable names
func formatButton(buttonID string) string {
switch buttonID {
case "POWER":
return "Power Button"
case "PLAY":
return "Play Button"
case "PAUSE":
return "Pause Button"
case "STOP":
return "Stop Button"
case "NEXT_TRACK":
return "Next Track"
case "PREV_TRACK":
return "Previous Track"
case "PRESET_1", "PRESET_2", "PRESET_3", "PRESET_4", "PRESET_5", "PRESET_6":
return fmt.Sprintf("Preset %s", strings.TrimPrefix(buttonID, "PRESET_"))
default:
return buttonID
}
}
// summarizeContent creates a brief summary of content items
func summarizeContent(decoded *DecodedContent) string {
switch decoded.ContentType {
case "SPOTIFY":
return fmt.Sprintf("Spotify: %s", decoded.ItemName)
case "PANDORA":
return fmt.Sprintf("Pandora: %s", decoded.ItemName)
case "INTERNET_RADIO":
return fmt.Sprintf("Radio: %s", decoded.ItemName)
case "STORED_MUSIC":
return fmt.Sprintf("Library: %s", decoded.ItemName)
default:
if decoded.ItemName != "" {
return fmt.Sprintf("%s: %s", decoded.ContentType, decoded.ItemName)
}
return fmt.Sprintf("%s Content", decoded.ContentType)
}
}
// getOriginDescription returns human-readable origin descriptions
func getOriginDescription(origin string) string {
switch origin {
case "gabbo":
return "SoundTouch App"
case "console":
return "Device Hardware"
case "device":
return "Internal System"
default:
return origin
}
}
// generateSCMUDCComments creates enriched comments for .http files
func generateSCMUDCComments(enriched *EnrichedSCMUDCEvent) []string {
if enriched == nil {
return nil
}
comments := []string{
fmt.Sprintf("// Origin: %s (%s)", getOriginDescription(enriched.Origin), enriched.Origin),
fmt.Sprintf("// Action: %s", enriched.Action),
fmt.Sprintf("// Command: %s", enriched.Command),
fmt.Sprintf("// Summary: %s", enriched.Summary),
}
if enriched.DecodedData != nil {
comments = append(comments,
"//",
"// Decoded Content:",
fmt.Sprintf("// - Source: %s", enriched.DecodedData.ContentType),
fmt.Sprintf("// - Item: %s", enriched.DecodedData.ItemName),
)
if enriched.DecodedData.SourceAccount != "" {
comments = append(comments, fmt.Sprintf("// - Account: %s", enriched.DecodedData.SourceAccount))
}
if enriched.DecodedData.ArtworkURL != "" {
comments = append(comments, fmt.Sprintf("// - Artwork: %s", enriched.DecodedData.ArtworkURL))
}
if enriched.DecodedData.IsPresetable {
comments = append(comments, "// - Presetable: Yes")
}
if enriched.DecodedData.XMLContent != "" {
comments = append(comments,
"//",
"// Full XML Content:",
)
// Add XML content as comments, line by line
lines := strings.Split(enriched.DecodedData.XMLContent, "\n")
for _, line := range lines {
if strings.TrimSpace(line) != "" {
comments = append(comments, fmt.Sprintf("// %s", strings.TrimSpace(line)))
}
}
}
}
return comments
}
+14
View File
@@ -139,6 +139,10 @@ type DeviceInfoXML struct {
} `xml:"networkInfo" json:"networkInfo"`
SoftwareVer string `xml:"-" json:"softwareVersion"`
SerialNumber string `xml:"-" json:"serialNumber"`
// Enriched fields (not part of device /info XML)
NowPlaying *models.NowPlaying `json:"nowPlaying,omitempty"`
Volume *models.Volume `json:"volume,omitempty"`
}
// GetLiveDeviceInfo fetches live information from the speaker's :8090/info endpoint.
@@ -186,6 +190,16 @@ func (m *Manager) parseDeviceInfoXML(reader io.Reader, infoXML *DeviceInfoXML) e
}
}
// Enrich with live now playing and volume via device API (best-effort)
//c := client.NewClientFromHost(deviceIP)
//if vol, err := c.GetVolume(); err == nil {
// infoXML.Volume = vol
//}
//
//if np, err := c.GetNowPlaying(); err == nil {
// infoXML.NowPlaying = np
//}
return nil
}