mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-24 03:26:15 +00:00
Tobias GesellchenandClaude Opus 4.7
1b21e0eaa8
Phase 4 of the docs portion of the rfc-5737-cleanup. Replaces all 192.168.1.x example IPs in tracked .md / .txt files with the equivalent last-octet under 192.0.2.x. 192.168.1.x is RFC-1918 private space and routes on real networks, which leaves readers guessing whether a documented IP is a placeholder or a documented LAN. 192.0.2.0/24 is reserved by RFC 5737 exclusively for documentation — readers know on sight that they're examples. 58 files touched, 551 line pairs. Includes .github issue/PR templates, all docs/ references, example READMEs, and one script doc. No code changes, no test changes; test files still carry the 192.168.1.x placeholder pending Phase 2 in _/RFC-5737-cleanup/assessment.md. Also fixed a small fallout in docs/analysis/ANONYMIZATION-SUMMARY.md where the explanatory sentence "a reader can't tell whether 192.168.1.10 is a placeholder or a documented LAN address" had itself been swept by the regex (inverting the point); restored the literal example and noted the sweep progress inline. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
113 lines
3.7 KiB
Markdown
113 lines
3.7 KiB
Markdown
---
|
|
name: Device compatibility report
|
|
about: Report compatibility with a new SoundTouch device model
|
|
title: 'Device Compatibility: [Device Model]'
|
|
labels: 'compatibility, documentation'
|
|
assignees: ''
|
|
|
|
---
|
|
|
|
**Device Information**
|
|
- **Model**: [e.g. SoundTouch 30, Wave SoundTouch IV, SoundTouch Portable]
|
|
- **Model Number**: [e.g. 738102-2100, found on device label]
|
|
- **Firmware Version**: [if known, from device settings or API response]
|
|
- **Purchase Date**: [approximate, helps identify firmware generation]
|
|
|
|
**Testing Results**
|
|
|
|
### Basic Functionality
|
|
- [ ] Device discovery (UPnP/mDNS)
|
|
- [ ] Basic device info (`GET /info`)
|
|
- [ ] Now playing status (`GET /now_playing`)
|
|
- [ ] Media controls (play/pause/stop)
|
|
- [ ] Volume control
|
|
- [ ] Source listing (`GET /sources`)
|
|
|
|
### Advanced Features
|
|
- [ ] Bass control (`GET/POST /bass`)
|
|
- [ ] Balance control (`GET/POST /balance`) - if stereo device
|
|
- [ ] Clock/time management (`GET/POST /clockTime`)
|
|
- [ ] Network information (`GET /networkInfo`)
|
|
- [ ] WebSocket events
|
|
- [ ] Multiroom zones (master)
|
|
- [ ] Multiroom zones (slave)
|
|
|
|
### Advanced Audio Controls (Professional/High-end Models)
|
|
- [ ] DSP controls (`GET/POST /audiodspcontrols`)
|
|
- [ ] Tone controls (`GET/POST /audioproducttonecontrols`)
|
|
- [ ] Level controls (`GET/POST /audioproductlevelcontrols`)
|
|
|
|
### Known Issues
|
|
List any features that don't work or behave unexpectedly:
|
|
- Feature name: Description of issue
|
|
- Command that fails: `soundtouch-cli command that doesn't work`
|
|
|
|
**Device Info Output**
|
|
```xml
|
|
<!-- Paste output from: soundtouch-cli --host YOUR_DEVICE_IP info get -->
|
|
<!-- This helps us understand device capabilities and variants -->
|
|
```
|
|
|
|
**Device Capabilities Output**
|
|
```xml
|
|
<!-- Paste output from: soundtouch-cli --host YOUR_DEVICE_IP capabilities -->
|
|
<!-- This shows what features the device reports as available -->
|
|
```
|
|
|
|
**Bass Capabilities (if supported)**
|
|
```xml
|
|
<!-- Paste output from: soundtouch-cli --host YOUR_DEVICE_IP bass capabilities -->
|
|
<!-- Only if the device supports bass control -->
|
|
```
|
|
|
|
**Available Sources**
|
|
```xml
|
|
<!-- Paste output from: soundtouch-cli --host YOUR_DEVICE_IP source list -->
|
|
<!-- Shows what audio sources this device supports -->
|
|
```
|
|
|
|
**Testing Commands Used**
|
|
```bash
|
|
# List the specific commands you used for testing
|
|
soundtouch-cli --host 192.0.2.100 info get
|
|
soundtouch-cli --host 192.0.2.100 play start
|
|
# ... etc
|
|
```
|
|
|
|
**Environment**
|
|
- **OS**: [e.g. macOS 14.0, Windows 11, Ubuntu 22.04]
|
|
- **Go version**: [e.g. 1.25.5]
|
|
- **Library version**: [e.g. v1.0.0, commit hash]
|
|
- **Network setup**: [home WiFi, corporate, etc.]
|
|
|
|
**Performance Notes**
|
|
- Response times: [normal, slow, timeouts]
|
|
- Specific timeouts: [any endpoints that timeout]
|
|
- WebSocket stability: [connects reliably, frequent disconnects, etc.]
|
|
|
|
**Comparison with Tested Models**
|
|
If you have experience with other SoundTouch models:
|
|
- **Similar to**: [e.g. works like SoundTouch 20]
|
|
- **Differences from**: [e.g. missing balance control compared to SoundTouch 30]
|
|
|
|
**Additional Notes**
|
|
Any other observations about device behavior, quirks, or special considerations:
|
|
- Does the device have unique features not seen in other models?
|
|
- Are there any setup requirements or configuration notes?
|
|
- Does it work differently in different network environments?
|
|
|
|
**Documentation Impact**
|
|
- [ ] Update supported devices list
|
|
- [ ] Add device-specific notes to documentation
|
|
- [ ] Update compatibility matrix
|
|
- [ ] Add to integration test suite
|
|
|
|
---
|
|
|
|
**Checklist**
|
|
- [ ] I have tested basic functionality (info, play, volume)
|
|
- [ ] I have tested advanced features available on this device
|
|
- [ ] I have provided complete device information output
|
|
- [ ] I have noted any issues or limitations
|
|
- [ ] I have tested in a typical network environment
|
|
- [ ] I understand this helps improve compatibility for all users |