From fb6e67cd8670bdb4d832dd86169a8e67a47a87f5 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sun, 11 Jan 2026 00:17:45 +0100 Subject: [PATCH] docs: Clarify alternative to non-functional /trackInfo endpoint - Specify that '/now_playing' endpoint is the API alternative - Clarify that CLI 'now' command (playback status) is the CLI alternative - Distinguish between the two 'now' CLI commands (playback vs clock) - Update warning messages to be more specific about alternatives --- cmd/soundtouch-cli/cmd_info.go | 3 ++- cmd/soundtouch-cli/main.go | 2 +- docs/API-Endpoints-Overview.md | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/cmd/soundtouch-cli/cmd_info.go b/cmd/soundtouch-cli/cmd_info.go index 448d3e3..d325743 100644 --- a/cmd/soundtouch-cli/cmd_info.go +++ b/cmd/soundtouch-cli/cmd_info.go @@ -235,7 +235,8 @@ func getTrackInfo(c *cli.Context) error { clientConfig := GetClientConfig(c) PrintDeviceHeader("Getting track information", clientConfig.Host, clientConfig.Port) - fmt.Println("⚠️ WARNING: /trackInfo endpoint times out on real devices. Use 'now' command instead.") + fmt.Println("⚠️ WARNING: /trackInfo endpoint times out on real devices.") + fmt.Println(" Use 'soundtouch-cli now' (playback status) command instead for track information.") client, err := CreateSoundTouchClient(clientConfig) if err != nil { diff --git a/cmd/soundtouch-cli/main.go b/cmd/soundtouch-cli/main.go index e3fc315..1543d5c 100644 --- a/cmd/soundtouch-cli/main.go +++ b/cmd/soundtouch-cli/main.go @@ -223,7 +223,7 @@ func main() { // Track info { Name: "track", - Usage: "Get track information (WARNING: times out on real devices, use 'now' instead)", + Usage: "Get track information (WARNING: times out on real devices, use playback 'now' command instead)", Action: getTrackInfo, Before: RequireHost, }, diff --git a/docs/API-Endpoints-Overview.md b/docs/API-Endpoints-Overview.md index 3b87966..e30e385 100644 --- a/docs/API-Endpoints-Overview.md +++ b/docs/API-Endpoints-Overview.md @@ -286,9 +286,9 @@ Checks if bass customization is supported on the device. ### GET /trackInfo ❌ **Not Working** Gets track information (duplicate of `/now_playing` per official API). -**Status**: Documented in official API but times out on real devices (AllegroWebserver timeout). Use `/now_playing` instead. +**Status**: Documented in official API but times out on real devices (AllegroWebserver timeout). Use `/now_playing` endpoint instead for track information. -**Implementation**: Available via `GetTrackInfo()` method but not functional on hardware. +**Implementation**: Available via `GetTrackInfo()` method but not functional on hardware. Use `GetNowPlaying()` method instead. ### Zone Slave Management ✅ **Implemented** Both official low-level endpoints and high-level zone management are available: