mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-19 09:06:14 +00:00

Files

T

chrisandGitHub 6d462191d9 docs: add SoundTouch 30 factory reset sequence (#305 )

## Description

Add missing factory reset sequence for SoundTouch 30 (non-Series III).
The current table only lists SoundTouch 30 Series III. The SoundTouch 30
uses a different sequence: power on, then hold Preset 1 + Volume − for
10 s. The display counts down from 10 to 1 and shows "Hold to restore
factory settings" before restarting.

## Type of Change

Please check the type of change your PR introduces:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)
- [ ] Test improvements
- [ ] Build/CI improvements

## Related Issues

## Changes Made

### API Changes
- [ ] Added new endpoints
- [ ] Modified existing endpoints
- [ ] Added new CLI commands
- [ ] Modified existing CLI commands
- [ ] Added new configuration options

### Implementation Details
- Added missing table row for SoundTouch 30 (non-Series III) in the
factory reset sequences table. No new dependencies.

## Testing

### Automated Tests
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] All existing tests pass
- [ ] Test coverage maintained or improved

### Manual Testing
- [x] Tested with real SoundTouch device(s)
- [ ] Tested CLI changes manually
- [ ] Tested in different network environments

**Device(s) tested with:**
- Device model: SoundTouch 30
- Firmware: 27.0.6.46330
- Test results: Factory reset sequence verified on real device

### Test Commands

## Documentation

- [ ] Updated relevant documentation
- [ ] Added code comments for complex logic
- [ ] Updated CLI help text
- [ ] Added usage examples
- [ ] Updated API documentation

**Documentation files updated:**
- [ ] README.md
- [ ] docs/API-Endpoints-Overview.md
- [ ] docs/CLI-REFERENCE.md
- [ ] Code documentation (godoc)

docs/DEVICE-INITIAL-SETUP.md

## Backward Compatibility

- [x] This change is backward compatible
- [ ] This change includes breaking changes (requires major version
bump)
- [ ] This change requires configuration migration

**Breaking changes (if any):**

## Security Considerations

- [x] No security implications
- [ ] Security review required
- [ ] Added input validation
- [ ] Updated authentication/authorization

## Performance Impact

- [x] No performance impact
- [ ] Performance improvement
- [ ] Potential performance regression (justify why)

**Performance notes:**

## Code Quality

- [ ] Code follows project style guidelines
- [ ] No linting errors
- [ ] No security warnings
- [ ] Memory leaks checked (if applicable)

### Pre-submission Checklist

- [ ] `make check` passes (format, lint, vet)
- [ ] `make test` passes
- [ ] No TODO comments left in production code
- [ ] Error handling is comprehensive
- [ ] Logging is appropriate (not too verbose, not too quiet)

## Deployment Notes

## Screenshots (if applicable)

## Additional Notes

## Review Requests

2026-05-17 10:15:10 +02:00

_includes

docs: render mermaid diagrams on the GitHub Pages site

2026-05-16 23:54:39 +02:00

analysis

docs(telnet): document Docker fallback when telnet is not installed

2026-05-14 22:15:53 +02:00

README.md

Bose SoundTouch Toolkit Documentation

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.

🚀 Start Here

For New Users

Complete Migration Guide - Step-by-step guide from Bose Cloud to local control
Getting Started - Quick introduction to the toolkit

For Existing Users

Cloud Shutdown Survival Guide - Prepare for the May 2026 shutdown
Backup Tool - Back up your cloud account and speaker data before shutdown
SoundTouch Service Guide - 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

Migration & Setup

Complete Migration Guide - 📖 Main guide for migrating from Bose Cloud
Cloud Shutdown Survival Guide - Prepare for service shutdown
Migration & Safety Guide - Advanced migration strategies
Initial Device Setup - First-time device configuration
Raspberry Pi Setup - Installing on Raspberry Pi

Daily Management

SoundTouch Service Guide - Service operation and maintenance
Troubleshooting - Common issues and solutions
HTTPS Setup - Secure connections
Deployment Guide - Production deployments

Advanced Features

MAC Address Mapping - Device identification
CLI Reference - Command-line tools
Backup Tool - Cloud account and speaker data backup
IoT Implementation Guide - IoT integrations
MQTT Integration Design - MQTT setup

📚 Technical Reference

API Documentation

API Endpoints - REST API reference
Spotify Account Addition - Technical requests for Spotify
WebSocket Events - Real-time events
Zone Management - Multi-room control
Preset Management - Preset operations

Analysis & Research

Upstream URLs - Bose service endpoints
Device Redirect Methods - Migration techniques
IoT Configuration Analysis - Device configurations
IoT Config Summary - Configuration summaries

Device Lifecycle & Network Independence

Device Lifecycle and /power_on Enhancement - Complete analysis of device registration and network independence improvements
/power_on Implementation Guide - Technical implementation details for enhanced device management

🏗 Concept Documentation

Enhanced Service Architecture

Concept Overview - High-level architecture vision
Upstream Service Simulation - Complete concept design
Implementation Plan - Development roadmap
Technical Specification - Detailed specifications

Development Planning

Implementation Roadmap - Project phases and milestones

💡 Quick Reference

Common Tasks

Migrate first device: Follow Migration Guide Step 5
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
Questions & Discussion: GitHub Discussions
Documentation: Check troubleshooting guides first
Community: Share experiences and help others

For a complete list of all documents, see the Summary.