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

docs: replace personal LAN IPs and device names with placeholders

Browse Source 
Public-repo hygiene: docs and READMEs carried the maintainer's home
LAN range (192.168.178.x) and personal speaker names ("Sound
Machinechen", "A Sound Machine"). Swapped to RFC-5737 documentation
IPs (192.0.2.x — reserved for examples, won't collide with anyone's
real network) and generic names ("Living Room SoundTouch",
"Kitchen SoundTouch").

12 files touched, all .md / .txt documentation. No code or tests
changed in this commit; subsequent commits will address the
docs/analysis/ANONYMIZATION-SUMMARY.md mapping log and the wider
real-MAC/real-account-ID footprint surfaced by the audit at
_/RFC-5737-cleanup/assessment.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Tobias Gesellchen
2026-05-17 22:05:13 +02:00
co-authored by Claude Opus 4.7
parent 598f69133e
commit 51d196dd03
12 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/soundtouch-backup/README.md
+2 -2
View File
@@ -107,10 +107,10 @@ Backs up each speaker over its HTTP API on port 8090. With `--ssh`, also capture
soundtouch-backup local
# Specific speaker
soundtouch-backup local --host 192.168.178.28
soundtouch-backup local --host 192.0.2.11
# Multiple speakers
soundtouch-backup local --host 192.168.178.28 --host 192.168.178.35
soundtouch-backup local --host 192.0.2.11 --host 192.0.2.10
# Include SSH filesystem backup
soundtouch-backup local --ssh
docs/CLAUDE.md
+2 -2
View File
@@ -73,8 +73,8 @@ For web components:
When creating test data for API endpoints, prefer real device responses over hypothetical examples:
- **Available test endpoints**:
- `http://192.168.178.28:8090/now_playing` - Different response type 1
- `http://192.168.178.35:8090/now_playing` - Different response type 2
- `http://192.0.2.11:8090/now_playing` - Different response type 1
- `http://192.0.2.10:8090/now_playing` - Different response type 2
- **Usage**: Fetch real responses to create accurate test fixtures
- **Privacy**: Anonymize any personal data (account names, personal playlists, etc.)
- **Coverage**: Use multiple real devices to cover different response variations
docs/DEVICE-CUSTOMIZATION-SETUP.md
+2 -2
View File
@@ -46,7 +46,7 @@ usb0 Link encap:Ethernet HWaddr CA:FE:BA:BE:1E:47
Sun Feb 1 20:35:24 CET 2026
Device name: "A Sound Machine"
Device name: "Kitchen SoundTouch"
Country EU, Region (not set)
Module type: scm
root@spotty:~#
@@ -83,7 +83,7 @@ usb0 Link encap:Ethernet HWaddr CA:FE:BA:BE:1E:47
Sun Feb 1 19:12:47 CET 2026
Device name: "A Sound Machine"
Device name: "Kitchen SoundTouch"
Country EU, Region (not set)
Module type: scm
root@spotty:~#
docs/HOST-PORT-PARSING.md
+4 -4
View File
@@ -12,7 +12,7 @@ The SoundTouch CLI now supports parsing host and port combinations in the `-host
```bash
# Specify host and port together
soundtouch-cli -host 192.168.1.100:8090 -info
soundtouch-cli -host 192.168.178.35:8090 -play
soundtouch-cli -host 192.0.2.10:8090 -play
soundtouch-cli -host soundtouch.local:8090 -pause
```
@@ -20,7 +20,7 @@ soundtouch-cli -host soundtouch.local:8090 -pause
```bash
# Traditional separate host and port flags
soundtouch-cli -host 192.168.1.100 -port 8090 -info
soundtouch-cli -host 192.168.178.35 -port 8090 -play
soundtouch-cli -host 192.0.2.10 -port 8090 -play
```
### Precedence Rules
@@ -99,8 +99,8 @@ Comprehensive test coverage in `cmd/soundtouch-cli/main_test.go`:
### Integration Tests
Tested with real SoundTouch devices:
- ✅ SoundTouch 10 (192.168.178.28:8090)
- ✅ SoundTouch 20 (192.168.178.35:8090)
- ✅ SoundTouch 10 (192.0.2.11:8090)
- ✅ SoundTouch 20 (192.0.2.10:8090)
## Benefits
docs/analysis/BOSE-LAB-RUNBOOK.md
+2 -2
View File
@@ -236,11 +236,11 @@ If you cannot see the `Bose-Lab` SSID on your phone:
```bash
sudo nmcli device set wlan0 managed no
```
7. **Ghost IP Conflict:** If `ip addr show wlan0` shows both `192.168.10.1` and another IP (like `192.168.178.x`), `hostapd` will fail. This is usually caused by NetworkManager managing the interface. Ensure you've run:
7. **Ghost IP Conflict:** If `ip addr show wlan0` shows both `192.168.10.1` and another IP (like `192.0.2.x`), `hostapd` will fail. This is usually caused by NetworkManager managing the interface. Ensure you've run:
```bash
sudo nmcli device set wlan0 managed no
# If the ghost IP is still there, remove it manually:
sudo ip addr del 192.168.178.X/24 dev wlan0
sudo ip addr del 192.0.2.0/24 dev wlan0
```
---
docs/analysis/SETUP-WEBSOCKET-EXPERIMENT.md
+1 -1
View File
@@ -196,7 +196,7 @@ Post-experiment we compared the device-written `/mnt/nv/BoseApp-Persistence/1/Sy
| Field | Bare-paired (1111111) | Real-Bose-paired (3230304) | Set by |
|--------------------------|--------------------------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------|
| `DeviceName` | `Bose SoundTouch 536A98` (factory default) | `Sound Machinechen` | `name` WS message — only sent in `--mode=full` |
| `DeviceName` | `Bose SoundTouch 536A98` (factory default) | `Living Room SoundTouch` | `name` WS message — only sent in `--mode=full` |
| `AccountAssociatedEMail` | empty | **empty** | Never populated, even by real Bose |
| `AccountUUID` | `1111111` | `3230304` | `setMargeAccount` — both paths set it |
| `Locale` | empty | **empty** | Never populated, even by real Bose |
docs/analysis/SUPPORTED-URLS.md
+2 -2
View File
@@ -5,8 +5,8 @@ This document provides a comprehensive analysis of the `/supportedURLs` endpoint
## Discovery Summary
**Test Devices:**
- Device 1: `192.168.178.28:8090` (deviceID: `08DF1F0BA325`)
- Device 2: `192.168.178.35:8090` (deviceID: `A81B6A536A98`)
- Device 1: `192.0.2.11:8090` (deviceID: `08DF1F0BA325`)
- Device 2: `192.0.2.10:8090` (deviceID: `A81B6A536A98`)
**Key Findings:**
- Both devices return identical endpoint lists
docs/device-lifecycle-and-power-on-enhancement.md
+2 -2
View File
@@ -179,12 +179,12 @@ The `/power_on` endpoint receives comprehensive device data that could replace m
<diagnostic-data>
<device-landscape>
<rssi>Excellent</rssi>
<gateway-ip-address>192.168.178.1</gateway-ip-address>
<gateway-ip-address>192.0.2.1</gateway-ip-address>
<macaddresses>
<macaddress>A81B6A536A98</macaddress>
<macaddress>A81B6A849D99</macaddress>
</macaddresses>
<ip-address>192.168.178.35</ip-address>
<ip-address>192.0.2.10</ip-address>
<network-connection-type>Wireless</network-connection-type>
</device-landscape>
<network-landscape>
docs/device-lifecycle-summary.md
+2 -2
View File
@@ -33,12 +33,12 @@ The `/power_on` endpoint provides rich device data that could eliminate network
<diagnostic-data>
<device-landscape>
<rssi>Excellent</rssi> <!-- ✅ Signal -->
<gateway-ip-address>192.168.178.1</gateway-ip-address> <!-- ✅ Network -->
<gateway-ip-address>192.0.2.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 -->
<ip-address>192.0.2.10</ip-address> <!-- ✅ Current IP -->
<network-connection-type>Wireless</network-connection-type> <!-- ✅ Connection -->
</device-landscape>
</diagnostic-data>
docs/guides/MAC-ADDRESS-MAPPING.md
+1 -1
View File
@@ -97,7 +97,7 @@ Ensure the MAC address is present:
<info deviceID="I6332527703739342000020">
<networkInfo type="SCM">
<macAddress>A81B6A536A98</macAddress> <!-- Must be present -->
<ipAddress>192.168.178.35</ipAddress>
<ipAddress>192.0.2.10</ipAddress>
</networkInfo>
</info>
```
docs/guides/TROUBLESHOOTING.md
+4 -4
View File
@@ -546,8 +546,8 @@ client.SetBalanceSafe(10) // Falls back gracefully
**Symptoms:**
```bash
$ go run ./cmd/soundtouch-cli --host 192.168.178.35 sp beep
Playing notification beep from 192.168.178.35:8090...
$ go run ./cmd/soundtouch-cli --host 192.0.2.10 sp beep
Playing notification beep from 192.0.2.10:8090...
✗ Failed to play notification beep: API request failed with status 400
```
@@ -569,10 +569,10 @@ func (c *Client) PlayNotificationBeep() error {
Both commands should now work identically:
```bash
# CLI command
go run ./cmd/soundtouch-cli --host 192.168.178.35 sp beep
go run ./cmd/soundtouch-cli --host 192.0.2.10 sp beep
# Direct curl (for comparison)
curl http://192.168.178.35:8090/playNotification
curl http://192.0.2.10:8090/playNotification
```
### ❌ "speaker" commands not supported
docs/reference/API-ENDPOINTS.md
+1 -1
View File
@@ -784,7 +784,7 @@ Retrieves all supported endpoints for the specific device with comprehensive fea
**Notes on Endpoint Discovery:**
- Total discovered endpoints: **103**
- Both test devices (192.168.178.28 and 192.168.178.35) support identical endpoint lists
- Both test devices (192.0.2.11 and 192.0.2.10) support identical endpoint lists
- Many endpoints are undocumented in official API v1.0 but functional on real hardware
- Some endpoints may require specific device types or firmware versions
- Endpoints marked ✅ are currently implemented in this Go library