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

docs: Mark /trackInfo endpoint as non-functional on real devices

Browse Source 
Based on real device testing, the /trackInfo endpoint returns
'AllegroWebserver timeout' errors despite being documented in the
official Bose SoundTouch Web API v1.0 specification.

## Changes

- Updated API coverage from 89% to 84% (16/19 functional endpoints)
- Marked /trackInfo as ❌ Non-functional in all documentation
- Added warning comments to GetTrackInfo() method
- Updated CLI command with warning message
- Recommend using /now_playing instead for track information

## Real Device Evidence

- Device: SoundTouch at 192.168.178.28:8090
- Error: 'AllegroWebserver timeout: /trackInfo'
- Status: Endpoint documented but not working on hardware

This reflects the reality that some officially documented endpoints
may not function properly on actual devices, emphasizing the importance
of real hardware testing in API implementation.
This commit is contained in:
Tobias Gesellchen
2026-01-11 00:16:07 +01:00
parent ddd78bbde5
commit 0e6dffead0
6 changed files with 34 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API-Endpoints-Overview.md
+7 -4
View File
@@ -283,10 +283,12 @@ Checks if bass customization is supported on the device.
</bassCapabilities>
```
### GET /trackInfo ✅ **Implemented**
### GET /trackInfo ❌ **Not Working**
Gets track information (duplicate of `/now_playing` per official API).
**Implementation**: Available via `GetTrackInfo()` method with identical response format to `/now_playing`.
**Status**: Documented in official API but times out on real devices (AllegroWebserver timeout). Use `/now_playing` instead.
**Implementation**: Available via `GetTrackInfo()` method but not functional on hardware.
### Zone Slave Management ✅ **Implemented**
Both official low-level endpoints and high-level zone management are available:
@@ -330,9 +332,10 @@ These endpoints work with real hardware but are NOT in official API v1.0:
## Coverage Summary
### Official API Coverage: 89%
### Official API Coverage: 84%
- **Total Official Endpoints**: 19
- **Implemented**: 17 (89%)
- **Implemented**: 16 (84%)
- **Non-functional**: 1 (5%) - `/trackInfo` times out on real devices
- **Missing Low-Impact**: 2 (11%)
### Feature Coverage: 100%