mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-31 14:57:17 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
01fbbcbcac | ||
|
|
d03682fb96 | ||
|
|
1ed562f45e | ||
|
|
ab21c5aef9 | ||
|
|
5f7f3977e0 | ||
|
|
89cb1b3927 | ||
|
|
e14df5d2ad |
@@ -0,0 +1,77 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: 'bug'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
- 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 if using main branch]
|
||||
- SoundTouch device model: [e.g. SoundTouch 10, SoundTouch 20]
|
||||
- Device firmware version: [if known]
|
||||
|
||||
**Command/Code that failed**
|
||||
```bash
|
||||
# If using CLI tool, provide the exact command
|
||||
soundtouch-cli --host 192.168.1.100 info get
|
||||
|
||||
# If using Go library, provide minimal code example
|
||||
```
|
||||
|
||||
**Error output**
|
||||
```
|
||||
Paste the complete error message here, including stack traces if available
|
||||
```
|
||||
|
||||
**Device Information (if applicable)**
|
||||
```xml
|
||||
<!-- If the issue is device-specific, include output from: -->
|
||||
<!-- soundtouch-cli --host YOUR_DEVICE_IP info get -->
|
||||
```
|
||||
|
||||
**Network Configuration**
|
||||
- Network setup: [e.g. home WiFi, corporate network, VPN]
|
||||
- Firewall/proxy: [any network restrictions]
|
||||
- Device connectivity: [how device connects to network - WiFi, Ethernet]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here. For example:
|
||||
- Does this happen consistently or intermittently?
|
||||
- Did this work in a previous version?
|
||||
- Are there any workarounds?
|
||||
- Any relevant log files or debug output
|
||||
|
||||
**Logs (if applicable)**
|
||||
```
|
||||
# Enable verbose logging with --verbose flag or debug environment variable
|
||||
# and paste relevant log output here
|
||||
```
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
---
|
||||
|
||||
**Checklist**
|
||||
- [ ] I have searched existing issues to avoid duplicates
|
||||
- [ ] I have tested with the latest version
|
||||
- [ ] I have included all relevant environment information
|
||||
- [ ] I have provided a minimal reproduction case
|
||||
- [ ] I have included complete error messages
|
||||
@@ -24,10 +24,10 @@ body:
|
||||
label: Go Version
|
||||
description: What version of Go are you using?
|
||||
options:
|
||||
- "1.25.5+"
|
||||
- "1.25"
|
||||
- "1.24"
|
||||
- "1.23"
|
||||
- "1.22"
|
||||
- "1.21"
|
||||
- "1.20"
|
||||
- "Other (please specify in description)"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
@@ -0,0 +1,113 @@
|
||||
---
|
||||
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.168.1.100 info get
|
||||
soundtouch-cli --host 192.168.1.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
|
||||
@@ -0,0 +1,77 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: 'enhancement'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Use case**
|
||||
Describe your specific use case and how this feature would benefit you and other users.
|
||||
|
||||
**SoundTouch API Support**
|
||||
- [ ] This feature is supported by the official SoundTouch API
|
||||
- [ ] This feature is NOT supported by the SoundTouch API (custom enhancement)
|
||||
- [ ] I'm not sure if this is supported by the SoundTouch API
|
||||
|
||||
**API Documentation Reference (if applicable)**
|
||||
If this feature is based on a SoundTouch API endpoint, please provide:
|
||||
- Endpoint URL: [e.g. GET /newendpoint]
|
||||
- Documentation reference: [page number or section in official API docs]
|
||||
- XML request/response examples: [if known]
|
||||
|
||||
**Implementation Details (optional)**
|
||||
If you have ideas about how this could be implemented:
|
||||
- Suggested package/module: [e.g. pkg/client, cmd/soundtouch-cli]
|
||||
- Method signatures: [if you have suggestions]
|
||||
- CLI commands: [if this affects the CLI tool]
|
||||
|
||||
**Device Compatibility**
|
||||
- SoundTouch models this applies to: [e.g. all models, SoundTouch 20+, specific models]
|
||||
- Have you tested this manually: [e.g. via curl, Postman, etc.]
|
||||
|
||||
**Examples**
|
||||
Provide examples of how you would like to use this feature:
|
||||
|
||||
```go
|
||||
// Go library example
|
||||
client.NewFeature(parameters)
|
||||
```
|
||||
|
||||
```bash
|
||||
# CLI example
|
||||
soundtouch-cli --host 192.168.1.100 new-feature --param value
|
||||
```
|
||||
|
||||
**Priority**
|
||||
- [ ] Critical - blocks important functionality
|
||||
- [ ] High - would significantly improve user experience
|
||||
- [ ] Medium - nice to have enhancement
|
||||
- [ ] Low - minor improvement
|
||||
|
||||
**Additional context**
|
||||
Add any other context, screenshots, or examples about the feature request here.
|
||||
|
||||
**Related Issues**
|
||||
- Related to #[issue number]
|
||||
- Depends on #[issue number]
|
||||
- Blocks #[issue number]
|
||||
|
||||
---
|
||||
|
||||
**Checklist**
|
||||
- [ ] I have searched existing issues to avoid duplicates
|
||||
- [ ] I have checked the documentation to ensure this feature doesn't already exist
|
||||
- [ ] I have provided a clear use case and rationale
|
||||
- [ ] I have considered the impact on existing functionality
|
||||
- [ ] I understand this may require SoundTouch API support to implement
|
||||
@@ -0,0 +1,171 @@
|
||||
## Description
|
||||
|
||||
Brief description of the changes in this PR.
|
||||
|
||||
## 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)
|
||||
- [ ] Documentation update
|
||||
- [ ] Performance improvement
|
||||
- [ ] Code refactoring (no functional changes)
|
||||
- [ ] Test improvements
|
||||
- [ ] Build/CI improvements
|
||||
|
||||
## Related Issues
|
||||
|
||||
- Fixes #[issue number]
|
||||
- Relates to #[issue number]
|
||||
- Part of #[issue number]
|
||||
|
||||
## Changes Made
|
||||
|
||||
### API Changes
|
||||
- [ ] Added new endpoints
|
||||
- [ ] Modified existing endpoints
|
||||
- [ ] Added new CLI commands
|
||||
- [ ] Modified existing CLI commands
|
||||
- [ ] Added new configuration options
|
||||
|
||||
### Implementation Details
|
||||
- Describe the main changes
|
||||
- List any new dependencies
|
||||
- Mention any architectural changes
|
||||
|
||||
## Testing
|
||||
|
||||
### Automated Tests
|
||||
- [ ] Unit tests added/updated
|
||||
- [ ] Integration tests added/updated
|
||||
- [ ] All existing tests pass
|
||||
- [ ] Test coverage maintained or improved
|
||||
|
||||
### Manual Testing
|
||||
- [ ] Tested with real SoundTouch device(s)
|
||||
- [ ] Tested CLI changes manually
|
||||
- [ ] Tested in different network environments
|
||||
|
||||
**Device(s) tested with:**
|
||||
- Device model: [e.g. SoundTouch 10]
|
||||
- Device IP: [e.g. 192.168.1.100]
|
||||
- Test results: [brief description]
|
||||
|
||||
### Test Commands
|
||||
```bash
|
||||
# Commands used to test this change
|
||||
make test
|
||||
go test ./pkg/client -v -run TestNewFeature
|
||||
soundtouch-cli --host 192.168.1.100 new-command
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
## Backward Compatibility
|
||||
|
||||
- [ ] This change is backward compatible
|
||||
- [ ] This change includes breaking changes (requires major version bump)
|
||||
- [ ] This change requires configuration migration
|
||||
|
||||
**Breaking changes (if any):**
|
||||
- Describe what breaks
|
||||
- Provide migration instructions
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- [ ] No security implications
|
||||
- [ ] Security review required
|
||||
- [ ] Added input validation
|
||||
- [ ] Updated authentication/authorization
|
||||
|
||||
## Performance Impact
|
||||
|
||||
- [ ] No performance impact
|
||||
- [ ] Performance improvement
|
||||
- [ ] Potential performance regression (justify why)
|
||||
|
||||
**Performance notes:**
|
||||
- Measured impact: [benchmarks, timing, memory usage]
|
||||
- Optimization opportunities: [if any]
|
||||
|
||||
## 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
|
||||
|
||||
Any special considerations for deployment:
|
||||
- Configuration changes required
|
||||
- Database migrations needed
|
||||
- Service restart required
|
||||
- Rollback procedures
|
||||
|
||||
## Screenshots (if applicable)
|
||||
|
||||
If this PR includes UI changes or CLI output changes, include screenshots or terminal output examples.
|
||||
|
||||
```bash
|
||||
# Before
|
||||
$ soundtouch-cli old-command
|
||||
Old output...
|
||||
|
||||
# After
|
||||
$ soundtouch-cli new-command
|
||||
New improved output...
|
||||
```
|
||||
|
||||
## Additional Notes
|
||||
|
||||
Any additional information that reviewers should know:
|
||||
- Design decisions and trade-offs
|
||||
- Future work planned
|
||||
- Alternative approaches considered
|
||||
- References to external documentation
|
||||
|
||||
## Review Requests
|
||||
|
||||
**Areas that need special attention:**
|
||||
- [ ] Error handling logic
|
||||
- [ ] Performance critical sections
|
||||
- [ ] Security implications
|
||||
- [ ] API design choices
|
||||
- [ ] Documentation clarity
|
||||
|
||||
**Specific questions for reviewers:**
|
||||
1. Question about design choice X?
|
||||
2. Is error handling sufficient in section Y?
|
||||
3. Should we consider alternative approach Z?
|
||||
|
||||
---
|
||||
|
||||
**Reviewer Guidelines:**
|
||||
- Check that all tests pass
|
||||
- Verify documentation is updated
|
||||
- Test manually if device access available
|
||||
- Consider backward compatibility
|
||||
- Evaluate error handling and edge cases
|
||||
@@ -154,9 +154,9 @@ jobs:
|
||||
rm -f "$OUTPUT_NAME" "$OUTPUT_NAME.sha256" "$OUTPUT_NAME.sha512"
|
||||
go clean -cache
|
||||
|
||||
# Build with optimizations and version info
|
||||
# Build with optimizations (using debug.BuildInfo for version info)
|
||||
if ! go build \
|
||||
-ldflags="-s -w -X main.version=v${{ needs.validate.outputs.version }} -X main.commit=${{ github.sha }} -X main.date=$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
|
||||
-ldflags="-s -w" \
|
||||
-o "$OUTPUT_NAME" \
|
||||
./cmd/soundtouch-cli; then
|
||||
echo "❌ Build failed"
|
||||
|
||||
+471
@@ -0,0 +1,471 @@
|
||||
# Contributing to Bose SoundTouch API Client
|
||||
|
||||
Thank you for your interest in contributing to the Bose SoundTouch API Client! This project aims to provide a comprehensive, reliable, and well-tested Go library for controlling Bose SoundTouch devices.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Getting Started](#getting-started)
|
||||
- [How Can I Contribute?](#how-can-i-contribute)
|
||||
- [Development Setup](#development-setup)
|
||||
- [Pull Request Process](#pull-request-process)
|
||||
- [Coding Guidelines](#coding-guidelines)
|
||||
- [Testing Guidelines](#testing-guidelines)
|
||||
- [Documentation Guidelines](#documentation-guidelines)
|
||||
- [Reporting Issues](#reporting-issues)
|
||||
- [Device Testing](#device-testing)
|
||||
- [Community](#community)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project adheres to our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Go 1.25.5 or later**: [Download Go](https://golang.org/dl/)
|
||||
- **Git**: For version control
|
||||
- **Make**: For build automation (optional but recommended)
|
||||
- **SoundTouch Device**: For testing (optional but valuable)
|
||||
|
||||
### First Contribution
|
||||
|
||||
1. **Fork the repository** on GitHub
|
||||
2. **Clone your fork** locally:
|
||||
```bash
|
||||
git clone https://github.com/YOUR-USERNAME/Bose-SoundTouch.git
|
||||
cd Bose-SoundTouch
|
||||
```
|
||||
3. **Install dependencies**:
|
||||
```bash
|
||||
go mod download
|
||||
```
|
||||
4. **Run tests** to ensure everything works:
|
||||
```bash
|
||||
make test
|
||||
# or
|
||||
go test ./...
|
||||
```
|
||||
5. **Build the CLI** to test functionality:
|
||||
```bash
|
||||
make build
|
||||
./soundtouch-cli --help
|
||||
```
|
||||
|
||||
## How Can I Contribute?
|
||||
|
||||
### 🐛 Reporting Bugs
|
||||
|
||||
Before creating a bug report, please:
|
||||
|
||||
1. **Check existing issues** to avoid duplicates
|
||||
2. **Test with the latest version** from the main branch
|
||||
3. **Include device information** (model, firmware version if known)
|
||||
|
||||
When filing a bug report, include:
|
||||
|
||||
- **Clear title** describing the issue
|
||||
- **Steps to reproduce** the behavior
|
||||
- **Expected behavior** vs actual behavior
|
||||
- **Environment details**: OS, Go version, device model
|
||||
- **Log output** if applicable (use `--verbose` flag)
|
||||
|
||||
### 💡 Suggesting Features
|
||||
|
||||
Feature requests are welcome! Please:
|
||||
|
||||
1. **Check if the feature already exists** in documentation
|
||||
2. **Verify it's supported by the SoundTouch API** (see [official API docs](docs/API-Endpoints-Overview.md))
|
||||
3. **Explain the use case** and how it benefits users
|
||||
|
||||
### 🔧 Contributing Code
|
||||
|
||||
Areas where contributions are especially welcome:
|
||||
|
||||
#### High Priority
|
||||
- **Bug fixes** for existing functionality
|
||||
- **Device compatibility** improvements
|
||||
- **Error handling** enhancements
|
||||
- **Performance optimizations**
|
||||
|
||||
#### Medium Priority
|
||||
- **New endpoint implementations** (if officially documented)
|
||||
- **CLI improvements** (better UX, additional commands)
|
||||
- **Documentation improvements**
|
||||
- **Example applications**
|
||||
|
||||
#### Future Enhancements
|
||||
- **Web interface** development
|
||||
- **Home Assistant integration**
|
||||
- **WASM/browser support**
|
||||
- **Mobile app development**
|
||||
|
||||
## Development Setup
|
||||
|
||||
### Project Structure
|
||||
|
||||
```
|
||||
Bose-SoundTouch/
|
||||
├── cmd/ # Command-line applications
|
||||
│ ├── soundtouch-cli/ # Main CLI tool
|
||||
│ └── examples/ # Example applications
|
||||
├── pkg/ # Library packages
|
||||
│ ├── client/ # HTTP client implementation
|
||||
│ ├── discovery/ # Device discovery
|
||||
│ ├── models/ # Data structures
|
||||
│ └── config/ # Configuration management
|
||||
├── docs/ # Documentation
|
||||
├── examples/ # Usage examples
|
||||
└── scripts/ # Build and utility scripts
|
||||
```
|
||||
|
||||
### Development Commands
|
||||
|
||||
```bash
|
||||
# Run tests
|
||||
make test
|
||||
|
||||
# Run tests with coverage
|
||||
make test-coverage
|
||||
|
||||
# Build all binaries
|
||||
make build
|
||||
|
||||
# Run linting and formatting
|
||||
make check
|
||||
|
||||
# Install CLI locally
|
||||
go install ./cmd/soundtouch-cli
|
||||
|
||||
# Run integration tests (requires real device)
|
||||
make test-integration HOST=192.168.1.100
|
||||
```
|
||||
|
||||
### Environment Setup
|
||||
|
||||
For development with real devices, create a `.env` file:
|
||||
|
||||
```env
|
||||
# Optional: Pre-configured device for testing
|
||||
SOUNDTOUCH_HOST=192.168.1.100
|
||||
SOUNDTOUCH_PORT=8090
|
||||
|
||||
# Optional: Enable debug logging
|
||||
SOUNDTOUCH_DEBUG=true
|
||||
```
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
### Before Submitting
|
||||
|
||||
1. **Create an issue** first for significant changes
|
||||
2. **Fork and create a feature branch**:
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
3. **Write tests** for your changes
|
||||
4. **Update documentation** if needed
|
||||
5. **Run the full test suite**:
|
||||
```bash
|
||||
make check
|
||||
make test
|
||||
```
|
||||
|
||||
### Pull Request Guidelines
|
||||
|
||||
1. **Clear title** describing the change
|
||||
2. **Detailed description** explaining:
|
||||
- What the change does
|
||||
- Why it's needed
|
||||
- How it was tested
|
||||
- Any breaking changes
|
||||
3. **Link to related issues**
|
||||
4. **Update CHANGELOG.md** if applicable
|
||||
5. **Ensure CI passes**
|
||||
|
||||
### Review Process
|
||||
|
||||
- At least one maintainer will review your PR
|
||||
- Feedback will be constructive and specific
|
||||
- Address feedback in additional commits
|
||||
- Once approved, a maintainer will merge your PR
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
### Go Style
|
||||
|
||||
Follow standard Go conventions:
|
||||
|
||||
- **gofmt** for formatting
|
||||
- **golint** and **go vet** for code quality
|
||||
- **Effective Go** principles
|
||||
- **Standard library patterns** where applicable
|
||||
|
||||
### Code Organization
|
||||
|
||||
```go
|
||||
// Package-level documentation
|
||||
package client
|
||||
|
||||
import (
|
||||
// Standard library first
|
||||
"context"
|
||||
"encoding/xml"
|
||||
|
||||
// Third-party packages
|
||||
"github.com/gorilla/websocket"
|
||||
|
||||
// Local packages
|
||||
"github.com/gesellix/bose-soundtouch/pkg/models"
|
||||
)
|
||||
|
||||
// Public API should be well-documented
|
||||
// GetDeviceInfo retrieves comprehensive device information including
|
||||
// model, capabilities, network status, and current configuration.
|
||||
func (c *Client) GetDeviceInfo() (*models.DeviceInfo, error) {
|
||||
// Implementation
|
||||
}
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
|
||||
- **Return errors** instead of panicking
|
||||
- **Wrap errors** with context using `fmt.Errorf`
|
||||
- **Create custom error types** for specific conditions
|
||||
- **Validate inputs** and return helpful error messages
|
||||
|
||||
```go
|
||||
// Good error handling example
|
||||
func (c *Client) SetVolume(level int) error {
|
||||
if level < 0 || level > 100 {
|
||||
return fmt.Errorf("volume level %d out of range [0-100]", level)
|
||||
}
|
||||
|
||||
if err := c.post("/volume", volumeXML); err != nil {
|
||||
return fmt.Errorf("failed to set volume to %d: %w", level, err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
```
|
||||
|
||||
### API Design
|
||||
|
||||
- **Consistent method naming**: `Get*`, `Set*`, `Send*`, etc.
|
||||
- **Return pointers** for complex types, values for simple types
|
||||
- **Accept contexts** for potentially long-running operations
|
||||
- **Provide convenience methods** for common operations
|
||||
|
||||
## Testing Guidelines
|
||||
|
||||
### Test Structure
|
||||
|
||||
```go
|
||||
func TestClient_SetVolume(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
volume int
|
||||
expectedError string
|
||||
setupMock func(*httptest.Server)
|
||||
}{
|
||||
{
|
||||
name: "valid volume level",
|
||||
volume: 50,
|
||||
setupMock: func(server *httptest.Server) {
|
||||
// Mock setup
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "volume too high",
|
||||
volume: 150,
|
||||
expectedError: "volume level 150 out of range",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Test implementation
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Test Categories
|
||||
|
||||
1. **Unit Tests**: Test individual functions with mocks
|
||||
2. **Integration Tests**: Test with real devices (when available)
|
||||
3. **Benchmark Tests**: Performance testing for critical paths
|
||||
|
||||
### Mock Usage
|
||||
|
||||
Use `httptest.Server` for HTTP client testing:
|
||||
|
||||
```go
|
||||
func setupMockServer() *httptest.Server {
|
||||
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/info":
|
||||
w.Header().Set("Content-Type", "application/xml")
|
||||
fmt.Fprint(w, mockDeviceInfoXML)
|
||||
default:
|
||||
w.WriteHeader(http.StatusNotFound)
|
||||
}
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
### Real Device Testing
|
||||
|
||||
When possible, test with real SoundTouch devices:
|
||||
|
||||
```bash
|
||||
# Set device IP for integration tests
|
||||
export SOUNDTOUCH_HOST=192.168.1.100
|
||||
go test -tags integration ./pkg/client/
|
||||
```
|
||||
|
||||
## Documentation Guidelines
|
||||
|
||||
### Code Documentation
|
||||
|
||||
- **Package documentation** for every package
|
||||
- **Function documentation** for all public functions
|
||||
- **Example documentation** for complex usage
|
||||
|
||||
```go
|
||||
// Package client provides a comprehensive HTTP client for the Bose SoundTouch Web API.
|
||||
//
|
||||
// The client supports all documented SoundTouch endpoints including device information,
|
||||
// playback control, volume management, and real-time WebSocket events.
|
||||
//
|
||||
// Basic usage:
|
||||
//
|
||||
// client := client.NewClient(&client.Config{
|
||||
// Host: "192.168.1.100",
|
||||
// Port: 8090,
|
||||
// })
|
||||
//
|
||||
// info, err := client.GetDeviceInfo()
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
//
|
||||
// fmt.Printf("Device: %s\n", info.Name)
|
||||
package client
|
||||
```
|
||||
|
||||
### User Documentation
|
||||
|
||||
- **README.md**: Overview and quick start
|
||||
- **API documentation**: Comprehensive endpoint reference
|
||||
- **Examples**: Real-world usage patterns
|
||||
- **Troubleshooting**: Common issues and solutions
|
||||
|
||||
### Documentation Updates
|
||||
|
||||
When making changes:
|
||||
|
||||
1. **Update relevant docs** in the same PR
|
||||
2. **Include usage examples** for new features
|
||||
3. **Update CLI help text** if applicable
|
||||
4. **Test documentation** (ensure examples work)
|
||||
|
||||
## Device Testing
|
||||
|
||||
### Supported Devices
|
||||
|
||||
The library has been tested with:
|
||||
|
||||
- **SoundTouch 10** (firmware unknown)
|
||||
- **SoundTouch 20** (firmware unknown)
|
||||
|
||||
### Testing New Devices
|
||||
|
||||
If you have access to other SoundTouch models:
|
||||
|
||||
1. **Run discovery** to find devices:
|
||||
```bash
|
||||
./soundtouch-cli discover devices
|
||||
```
|
||||
|
||||
2. **Test basic functionality**:
|
||||
```bash
|
||||
./soundtouch-cli -h 192.168.1.100 info get
|
||||
./soundtouch-cli -h 192.168.1.100 now-playing get
|
||||
```
|
||||
|
||||
3. **Report compatibility** in your PR or issue
|
||||
4. **Include device information** from the info endpoint
|
||||
|
||||
### Testing Protocol
|
||||
|
||||
For significant changes:
|
||||
|
||||
1. **Test on multiple devices** if available
|
||||
2. **Test error scenarios** (device offline, network issues)
|
||||
3. **Test edge cases** (invalid inputs, boundary conditions)
|
||||
4. **Document any device-specific behavior**
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
### Security Issues
|
||||
|
||||
**Do not open public issues for security vulnerabilities.** Instead:
|
||||
|
||||
1. **Email the maintainers** with details
|
||||
2. **Allow reasonable time** for response
|
||||
3. **Coordinate disclosure** timing
|
||||
|
||||
### Bug Reports
|
||||
|
||||
Use the bug report template and include:
|
||||
|
||||
- **Device model and firmware** (if known)
|
||||
- **Complete error messages and logs**
|
||||
- **Minimal reproduction case**
|
||||
- **Environment information**
|
||||
|
||||
### Feature Requests
|
||||
|
||||
Use the feature request template and include:
|
||||
|
||||
- **Clear description** of the desired functionality
|
||||
- **Use case explanation**
|
||||
- **API documentation reference** (if applicable)
|
||||
- **Alternative solutions** you've considered
|
||||
|
||||
## Community
|
||||
|
||||
### Communication Channels
|
||||
|
||||
- **GitHub Issues**: Bug reports, feature requests
|
||||
- **GitHub Discussions**: Questions, ideas, general discussion
|
||||
- **Pull Requests**: Code contributions and reviews
|
||||
|
||||
### Getting Help
|
||||
|
||||
1. **Check existing documentation** first
|
||||
2. **Search closed issues** for similar problems
|
||||
3. **Create a new issue** with detailed information
|
||||
4. **Be patient and respectful** in all interactions
|
||||
|
||||
### Recognition
|
||||
|
||||
Contributors will be:
|
||||
|
||||
- **Listed in CONTRIBUTORS.md**
|
||||
- **Mentioned in release notes** for significant contributions
|
||||
- **Credited in documentation** where appropriate
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Go Documentation](https://golang.org/doc/)
|
||||
- [Effective Go](https://golang.org/doc/effective_go.html)
|
||||
- [Bose SoundTouch API Documentation](docs/API-Endpoints-Overview.md)
|
||||
- [Project Architecture](docs/PROJECT-PATTERNS.md)
|
||||
- [Development Status](docs/STATUS.md)
|
||||
|
||||
---
|
||||
|
||||
**Thank you for contributing!** Every contribution helps make this library better for the entire SoundTouch community.
|
||||
@@ -21,12 +21,7 @@ SCANNER_PATH=./cmd/$(SCANNER_NAME)
|
||||
BUILD_DIR=./build
|
||||
|
||||
# Version info
|
||||
VERSION?=dev
|
||||
BUILD_TIME=$(shell date -u '+%Y-%m-%d_%H:%M:%S')
|
||||
COMMIT=$(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
|
||||
|
||||
# Linker flags
|
||||
LDFLAGS=-X main.version=$(VERSION) -X main.date=$(BUILD_TIME) -X main.commit=$(COMMIT)
|
||||
# No ldflags needed - using debug.BuildInfo since Go 1.18
|
||||
|
||||
all: check build
|
||||
|
||||
@@ -35,50 +30,50 @@ build: build-cli build-examples
|
||||
build-cli:
|
||||
@echo "Building $(BINARY_NAME)..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY_NAME) $(BINARY_PATH)
|
||||
$(GOBUILD) -o $(BUILD_DIR)/$(BINARY_NAME) $(BINARY_PATH)
|
||||
|
||||
build-examples:
|
||||
@echo "Building $(EXAMPLE_MDNS_NAME)..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME) $(EXAMPLE_MDNS_PATH)
|
||||
$(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME) $(EXAMPLE_MDNS_PATH)
|
||||
@echo "Building $(EXAMPLE_UPNP_NAME)..."
|
||||
$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME) $(EXAMPLE_UPNP_PATH)
|
||||
$(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME) $(EXAMPLE_UPNP_PATH)
|
||||
@echo "Building $(SCANNER_NAME)..."
|
||||
$(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(SCANNER_NAME) $(SCANNER_PATH)
|
||||
$(GOBUILD) -o $(BUILD_DIR)/$(SCANNER_NAME) $(SCANNER_PATH)
|
||||
|
||||
build-all: build-linux build-darwin build-windows build-examples-all
|
||||
|
||||
build-linux:
|
||||
@echo "Building for Linux..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY_NAME)-linux-amd64 $(BINARY_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(BINARY_NAME)-linux-amd64 $(BINARY_PATH)
|
||||
|
||||
build-darwin:
|
||||
@echo "Building for macOS..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 $(BINARY_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 $(BINARY_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-amd64 $(BINARY_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -o $(BUILD_DIR)/$(BINARY_NAME)-darwin-arm64 $(BINARY_PATH)
|
||||
|
||||
build-windows:
|
||||
@echo "Building for Windows..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe $(BINARY_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(BINARY_NAME)-windows-amd64.exe $(BINARY_PATH)
|
||||
|
||||
build-examples-all:
|
||||
@echo "Building examples for all platforms..."
|
||||
@mkdir -p $(BUILD_DIR)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-linux-amd64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-darwin-amd64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-darwin-arm64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-windows-amd64.exe $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-linux-amd64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-darwin-amd64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-darwin-arm64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-windows-amd64.exe $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(SCANNER_NAME)-linux-amd64 $(SCANNER_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(SCANNER_NAME)-darwin-amd64 $(SCANNER_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(SCANNER_NAME)-darwin-arm64 $(SCANNER_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -ldflags "$(LDFLAGS)" -o $(BUILD_DIR)/$(SCANNER_NAME)-windows-amd64.exe $(SCANNER_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-linux-amd64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-darwin-amd64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-darwin-arm64 $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_MDNS_NAME)-windows-amd64.exe $(EXAMPLE_MDNS_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-linux-amd64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-darwin-amd64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-darwin-arm64 $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(EXAMPLE_UPNP_NAME)-windows-amd64.exe $(EXAMPLE_UPNP_PATH)
|
||||
GOOS=linux GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(SCANNER_NAME)-linux-amd64 $(SCANNER_PATH)
|
||||
GOOS=darwin GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(SCANNER_NAME)-darwin-amd64 $(SCANNER_PATH)
|
||||
GOOS=darwin GOARCH=arm64 $(GOBUILD) -o $(BUILD_DIR)/$(SCANNER_NAME)-darwin-arm64 $(SCANNER_PATH)
|
||||
GOOS=windows GOARCH=amd64 $(GOBUILD) -o $(BUILD_DIR)/$(SCANNER_NAME)-windows-amd64.exe $(SCANNER_PATH)
|
||||
|
||||
test:
|
||||
@echo "Running tests..."
|
||||
|
||||
@@ -3,18 +3,44 @@ package main
|
||||
import (
|
||||
"log"
|
||||
"os"
|
||||
"runtime/debug"
|
||||
"time"
|
||||
|
||||
"github.com/urfave/cli/v2"
|
||||
)
|
||||
|
||||
// Build-time variables injected via ldflags
|
||||
// Package-level variables for build information
|
||||
var (
|
||||
version = "dev"
|
||||
commit = "unknown"
|
||||
date = "unknown"
|
||||
)
|
||||
|
||||
// updateBuildInfo extracts version information from debug.BuildInfo and updates package variables
|
||||
func updateBuildInfo() {
|
||||
if info, ok := debug.ReadBuildInfo(); ok {
|
||||
// Get version from module info
|
||||
if info.Main.Version != "" && info.Main.Version != "(devel)" {
|
||||
version = info.Main.Version
|
||||
}
|
||||
|
||||
// Extract build settings
|
||||
for _, setting := range info.Settings {
|
||||
switch setting.Key {
|
||||
case "vcs.revision":
|
||||
commit = setting.Value
|
||||
case "vcs.time":
|
||||
if t, err := time.Parse(time.RFC3339, setting.Value); err == nil {
|
||||
date = t.Format("2006-01-02_15:04:05")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
updateBuildInfo()
|
||||
|
||||
app := &cli.App{
|
||||
Name: "soundtouch-cli",
|
||||
Usage: "Command-line interface for controlling Bose SoundTouch devices",
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Package bose-soundtouch provides a comprehensive Go library and CLI tool for controlling Bose SoundTouch devices.
|
||||
// Package soundtouch provides a comprehensive Go library and CLI tool for controlling Bose SoundTouch devices.
|
||||
//
|
||||
// This library implements the complete Bose SoundTouch Web API, enabling programmatic control
|
||||
// of SoundTouch speakers including playback control, volume management, source selection,
|
||||
@@ -153,4 +153,4 @@
|
||||
//
|
||||
// For detailed API documentation, examples, and advanced usage patterns, visit:
|
||||
// https://pkg.go.dev/github.com/gesellix/bose-soundtouch
|
||||
package main
|
||||
package soundtouch
|
||||
|
||||
@@ -4,9 +4,9 @@ This document provides a comprehensive overview of the available API endpoints v
|
||||
|
||||
## Implementation Status Legend
|
||||
- ✅ **Implemented** - Fully implemented with tests and real device validation
|
||||
- ❌ **Missing** - Documented in official API but not implemented
|
||||
- 🔍 **Extra** - Implemented but not in official API v1.0 (may be newer version or undocumented)
|
||||
- ⚠️ **Different** - Implemented with different approach than official API
|
||||
- ℹ️ **N/A** - Documented but officially unsupported or non-functional on real hardware
|
||||
|
||||
## API Basics
|
||||
|
||||
@@ -202,10 +202,10 @@ Retrieves the configured presets.
|
||||
</presets>
|
||||
```
|
||||
|
||||
### POST /presets ❌ **Not Supported**
|
||||
### POST /presets ℹ️ **N/A**
|
||||
Creates or updates a preset.
|
||||
|
||||
**Status**: According to the official Bose SoundTouch API documentation, POST operations on `/presets` are marked as "N/A" - this endpoint officially does not support preset creation or modification via API.
|
||||
**Status**: According to the official Bose SoundTouch API documentation, POST operations on `/presets` are marked as "N/A" - this endpoint officially does not support preset creation or modification via any API client.
|
||||
|
||||
**Alternative Methods**:
|
||||
- Use the official Bose SoundTouch mobile app
|
||||
@@ -283,12 +283,12 @@ Checks if bass customization is supported on the device.
|
||||
</bassCapabilities>
|
||||
```
|
||||
|
||||
### GET /trackInfo ❌ **Not Working**
|
||||
### GET /trackInfo ✅ **Implemented**
|
||||
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` endpoint instead for track information.
|
||||
**Status**: Fully implemented but times out on SoundTouch 10 & 20 test devices (AllegroWebserver timeout). May work on other SoundTouch models or firmware versions. Use `/now_playing` endpoint as reliable alternative.
|
||||
|
||||
**Implementation**: Available via `GetTrackInfo()` method but not functional on hardware. Use `GetNowPlaying()` method instead.
|
||||
**Implementation**: Available via `GetTrackInfo()` method. Consider using `GetNowPlaying()` method for guaranteed compatibility.
|
||||
|
||||
### Zone Slave Management ✅ **Implemented**
|
||||
Both official low-level endpoints and high-level zone management are available:
|
||||
@@ -346,13 +346,14 @@ These endpoints work with real hardware but are NOT in official API v1.0:
|
||||
|
||||
### Official API Coverage: 100%
|
||||
- **Total Official Endpoints**: 19
|
||||
- **Implemented**: 18 (95%)
|
||||
- **Non-functional**: 1 (5%) - `/trackInfo` times out on real devices
|
||||
- **Implemented**: 19 (100%)
|
||||
- **Conditionally Available**: 3 (16%) - Advanced audio endpoints require device support
|
||||
- **Device-Dependent**: 1 (5%) - GET /trackInfo times out on some models
|
||||
- **Excluded**: 1 endpoint (POST /presets officially N/A)
|
||||
|
||||
### Feature Coverage: 100%
|
||||
- ✅ All essential user functionality implemented
|
||||
- ✅ All core device operations supported
|
||||
- ✅ All available user functionality implemented
|
||||
- ✅ All functional device operations supported
|
||||
- ✅ Complete WebSocket event system
|
||||
- ✅ Full multiroom capabilities
|
||||
- ✅ Complete advanced audio controls (where supported by device)
|
||||
@@ -409,4 +410,4 @@ func SendKey(deviceIP string, key string) error {
|
||||
## Reference
|
||||
|
||||
Based on the official Bose SoundTouch Web API documentation:
|
||||
https://assets.bosecreative.com/m/496577402d128874/original/SoundTouch-Web-API.pdf
|
||||
https://assets.bosecreative.com/m/496577402d128874/original/SoundTouch-Web-API.pdf
|
||||
|
||||
+1
-1
@@ -786,7 +786,7 @@ func (app *Application) Run(ctx context.Context) error {
|
||||
|
||||
```dockerfile
|
||||
# Dockerfile
|
||||
FROM golang:1.21-alpine AS builder
|
||||
FROM golang:1.25-alpine AS builder
|
||||
|
||||
WORKDIR /app
|
||||
COPY go.mod go.sum ./
|
||||
|
||||
@@ -0,0 +1,311 @@
|
||||
# Feature Development History
|
||||
|
||||
This document tracks the detailed evolution of features and capabilities in the Bose SoundTouch API client library.
|
||||
|
||||
## Development Timeline
|
||||
|
||||
### Phase 1: Foundation (November 2024 - December 2024)
|
||||
|
||||
#### Core HTTP Client
|
||||
- **HTTP Client with XML Support**: Complete client implementation for SoundTouch Web API
|
||||
- **XML Model System**: Comprehensive typed models for all API responses
|
||||
- **Error Handling**: Robust error handling with contextual error messages
|
||||
- **Configuration Management**: Flexible configuration via environment variables and config files
|
||||
|
||||
#### Basic Device Control
|
||||
- **Device Information**: `/info` endpoint for device details and capabilities
|
||||
- **Device Name**: `/name` endpoint for device identification
|
||||
- **Device Capabilities**: `/capabilities` endpoint for feature detection
|
||||
- **Now Playing Status**: `/now_playing` endpoint for current playback information
|
||||
|
||||
#### Initial CLI Tool
|
||||
- Basic command-line interface for testing API functionality
|
||||
- Device connectivity testing
|
||||
- Simple information retrieval commands
|
||||
|
||||
### Phase 2: Media Control & Discovery (December 2024)
|
||||
|
||||
#### Media Controls
|
||||
- **Key Commands**: Complete implementation of `/key` endpoint
|
||||
- Play, pause, stop, track navigation
|
||||
- Volume up/down via key presses
|
||||
- Preset selection (1-6)
|
||||
- Power and mute controls
|
||||
- Proper press+release pattern implementation
|
||||
- **Volume Management**: `/volume` GET/POST endpoints
|
||||
- Direct volume setting (0-100)
|
||||
- Incremental volume control
|
||||
- Safety features and validation warnings
|
||||
- Volume level categorization (quiet, medium, loud, very loud)
|
||||
|
||||
#### Device Discovery
|
||||
- **UPnP/SSDP Discovery**: Automatic device discovery using Universal Plug and Play
|
||||
- **Device Caching**: TTL-based caching for improved performance
|
||||
- **CLI Discovery Commands**: Device discovery integration in CLI tool
|
||||
|
||||
#### Enhanced CLI
|
||||
- **Host:Port Parsing**: Support for `device:port` format in CLI
|
||||
- **Comprehensive Commands**: Full coverage of implemented endpoints
|
||||
- **Interactive Features**: Better user experience with formatted output
|
||||
|
||||
### Phase 3: Advanced Audio Controls (January 2025)
|
||||
|
||||
#### Audio Management Trilogy
|
||||
- **Bass Control**: `/bass` GET/POST endpoints
|
||||
- Range validation (-9 to +9)
|
||||
- Incremental bass adjustment
|
||||
- Device capability detection via `/bassCapabilities`
|
||||
- Safety limits and user warnings
|
||||
- **Balance Control**: `/balance` GET/POST endpoints
|
||||
- Stereo balance adjustment (-50 to +50)
|
||||
- Left/right channel convenience methods
|
||||
- Balance centering functionality
|
||||
- Device-dependent feature (not all devices support balance)
|
||||
|
||||
#### Source Selection
|
||||
- **Source Management**: `/sources` GET and POST `/select` endpoints
|
||||
- **Convenience Methods**: Direct source selection helpers
|
||||
- `SelectSpotify()` - Switch to Spotify
|
||||
- `SelectBluetooth()` - Switch to Bluetooth
|
||||
- `SelectAux()` - Switch to AUX input
|
||||
- `SelectTuneIn()` - Switch to TuneIn radio
|
||||
- `SelectPandora()` - Switch to Pandora
|
||||
- **Source Validation**: Comprehensive source availability checking
|
||||
- **Account Management**: Support for multi-account sources (Spotify, etc.)
|
||||
|
||||
#### Preset Management (Read-Only)
|
||||
- **Preset Analysis**: Complete preset configuration analysis
|
||||
- **Helper Methods**: Preset management utilities
|
||||
- `GetNextAvailablePresetSlot()` - Find empty preset slots
|
||||
- `IsCurrentContentPresetable()` - Check if content can be saved as preset
|
||||
- Preset categorization and filtering
|
||||
- **API Limitation Documentation**: Clarified that POST `/presets` is officially N/A
|
||||
|
||||
### Phase 4: System Features (January 2025)
|
||||
|
||||
#### Clock and Display Management
|
||||
- **Clock Time**: `/clockTime` GET/POST endpoints
|
||||
- Get/set device time
|
||||
- `SetClockTimeNow()` convenience method
|
||||
- Time format handling
|
||||
- **Clock Display**: `/clockDisplay` GET/POST endpoints
|
||||
- Display enable/disable
|
||||
- Brightness control (low/medium/high)
|
||||
- 12/24 hour format selection
|
||||
- Convenience methods for common operations
|
||||
|
||||
#### Network Information
|
||||
- **Network Info**: `/networkInfo` GET endpoint
|
||||
- **Network connectivity details and diagnostics
|
||||
|
||||
#### Enhanced Discovery
|
||||
- **mDNS/Bonjour Discovery**: Multicast DNS device discovery
|
||||
- **Unified Discovery Service**: Combined UPnP + mDNS + configured devices
|
||||
- **Multiple Discovery Protocols**: Fallback discovery methods for different network environments
|
||||
- **Corporate Network Support**: Discovery options for restricted networks
|
||||
|
||||
### Phase 5: Real-time Events (January 2025)
|
||||
|
||||
#### WebSocket Implementation
|
||||
- **WebSocket Client**: Complete WebSocket implementation for real-time events
|
||||
- **Event System**: Comprehensive event type support
|
||||
- `NowPlayingUpdated` - Track changes, playback status
|
||||
- `VolumeUpdated` - Volume and mute status changes
|
||||
- `ConnectionStateUpdated` - Network connectivity
|
||||
- `PresetUpdated` - Preset configuration changes
|
||||
- `ZoneUpdated` - Multiroom zone changes
|
||||
- `BassUpdated` - Bass level adjustments
|
||||
- `SdkInfoUpdated` - Server version information
|
||||
- `UserActivityUpdated` - User interaction notifications
|
||||
|
||||
#### Connection Management
|
||||
- **Auto-Reconnection**: Automatic reconnection with exponential backoff
|
||||
- **Connection Monitoring**: Real-time connection state tracking
|
||||
- **Error Recovery**: Robust error handling and recovery mechanisms
|
||||
- **Event Filtering**: Subscribe to specific event types
|
||||
|
||||
#### WebSocket CLI Integration
|
||||
- **Real-time Monitoring**: Live event streaming in CLI
|
||||
- **Event Filtering**: Command-line event type filtering
|
||||
- **Formatted Output**: Human-readable event display
|
||||
- **Demo Applications**: WebSocket demonstration tools
|
||||
|
||||
### Phase 6: Multiroom Zone Management (January 2025)
|
||||
|
||||
#### Zone Operations
|
||||
- **Zone Information**: `/getZone` GET endpoint
|
||||
- Current zone configuration retrieval
|
||||
- Master/slave device identification
|
||||
- Zone membership queries
|
||||
- **Zone Management**: `/setZone` POST endpoint
|
||||
- Zone creation with multiple devices
|
||||
- Add devices to existing zones
|
||||
- Remove devices from zones
|
||||
- Dissolve zones completely
|
||||
|
||||
#### High-Level Zone API
|
||||
- **Fluent API**: Easy-to-use zone management methods
|
||||
- `CreateZone()` - Create multiroom zones
|
||||
- `AddToZone()` - Add devices to existing zones
|
||||
- `RemoveFromZone()` - Remove devices from zones
|
||||
- `DissolveZone()` - Break up zones
|
||||
- **Zone Status**: Zone membership and status queries
|
||||
- `IsInZone()` - Check if device is in a zone
|
||||
- `GetZoneStatus()` - Get zone configuration
|
||||
- `GetZoneMembers()` - List all zone members
|
||||
|
||||
#### Low-Level Zone API
|
||||
- **Zone Slave Management**: Direct slave operations
|
||||
- `/addZoneSlave` POST endpoint
|
||||
- `/removeZoneSlave` POST endpoint
|
||||
- Device ID and IP-based operations
|
||||
|
||||
#### Validation and Safety
|
||||
- **IP Validation**: Comprehensive IP address validation
|
||||
- **Duplicate Detection**: Prevent duplicate zone members
|
||||
- **Error Handling**: Specific zone-related error types
|
||||
- **Zone Builder**: Fluent API for zone construction
|
||||
|
||||
### Phase 7: Advanced Audio Controls (January 2025)
|
||||
|
||||
#### Professional Audio Features
|
||||
- **DSP Audio Controls**: `/audiodspcontrols` GET/POST endpoints
|
||||
- Audio mode switching (movie, music, dialogue, etc.)
|
||||
- Video sync delay adjustment
|
||||
- DSP parameter configuration
|
||||
- **Advanced Tone Controls**: `/audioproducttonecontrols` GET/POST endpoints
|
||||
- Professional-grade bass and treble adjustment
|
||||
- Extended range beyond basic `/bass` endpoint
|
||||
- Fine-grained audio tuning
|
||||
- **Speaker Level Controls**: `/audioproductlevelcontrols` GET/POST endpoints
|
||||
- Individual speaker level adjustment
|
||||
- Front-center speaker level control
|
||||
- Rear-surround speakers level control
|
||||
- Multi-channel audio management
|
||||
|
||||
#### Device Capability Integration
|
||||
- **Automatic Capability Detection**: Check device capabilities before feature access
|
||||
- **Conditional Feature Availability**: Features only available on compatible devices
|
||||
- **Graceful Degradation**: Fallback to basic controls when advanced features unavailable
|
||||
|
||||
## Feature Implementation Statistics
|
||||
|
||||
### API Endpoint Coverage Evolution
|
||||
|
||||
| Phase | Endpoints Added | Cumulative Total | Completion % |
|
||||
|-------|-----------------|------------------|--------------|
|
||||
| Phase 1 | 4 | 4 | 15% |
|
||||
| Phase 2 | 6 | 10 | 38% |
|
||||
| Phase 3 | 8 | 18 | 69% |
|
||||
| Phase 4 | 3 | 21 | 81% |
|
||||
| Phase 5 | 1 | 22 | 85% |
|
||||
| Phase 6 | 2 | 24 | 92% |
|
||||
| Phase 7 | 3 | 27 | 100% |
|
||||
|
||||
### Testing Evolution
|
||||
|
||||
#### Unit Test Coverage
|
||||
- **Phase 1**: Basic HTTP client tests (25 tests)
|
||||
- **Phase 2**: Media control and discovery tests (75 tests)
|
||||
- **Phase 3**: Audio control tests (125 tests)
|
||||
- **Phase 4**: System feature tests (150 tests)
|
||||
- **Phase 5**: WebSocket event tests (200 tests)
|
||||
- **Phase 6**: Zone management tests (250 tests)
|
||||
- **Phase 7**: Advanced audio tests (300+ tests)
|
||||
|
||||
#### Integration Test Coverage
|
||||
- **Real Device Testing**: SoundTouch 10 and SoundTouch 20
|
||||
- **Network Scenario Testing**: Various network configurations
|
||||
- **Error Scenario Testing**: Device offline, network timeouts
|
||||
- **Cross-Platform Testing**: Windows, macOS, Linux
|
||||
|
||||
### CLI Tool Evolution
|
||||
|
||||
#### Command Categories Added by Phase
|
||||
- **Phase 1**: `info`, `name`, `capabilities`
|
||||
- **Phase 2**: `discover`, `play`, `volume`, `key`
|
||||
- **Phase 3**: `bass`, `balance`, `source`, `presets`
|
||||
- **Phase 4**: `clock`, `network`
|
||||
- **Phase 5**: `events`
|
||||
- **Phase 6**: `zone`
|
||||
- **Phase 7**: Advanced audio commands
|
||||
|
||||
#### CLI Feature Enhancements
|
||||
- **Host:Port Parsing**: Support for `192.168.1.100:8090` format
|
||||
- **Auto-Discovery Integration**: Seamless device discovery
|
||||
- **Formatted Output**: Human-readable, structured output
|
||||
- **Error Handling**: Comprehensive error messages and recovery suggestions
|
||||
- **Help System**: Comprehensive help and examples
|
||||
|
||||
## Technical Achievements
|
||||
|
||||
### Architecture Milestones
|
||||
- **Clean Package Structure**: Well-organized pkg/ architecture
|
||||
- **Interface-Based Design**: Testable and mockable components
|
||||
- **Error Handling**: Comprehensive error types and contextual messages
|
||||
- **Configuration System**: Flexible configuration via files and environment variables
|
||||
|
||||
### Performance Optimizations
|
||||
- **Device Caching**: TTL-based caching for discovery performance
|
||||
- **Connection Pooling**: Efficient HTTP connection management
|
||||
- **WebSocket Efficiency**: Optimized real-time event handling
|
||||
- **Memory Management**: Efficient XML parsing and model handling
|
||||
|
||||
### Cross-Platform Support
|
||||
- **Multi-OS Compatibility**: Windows, macOS, Linux support
|
||||
- **Build System**: Comprehensive Makefile with cross-compilation
|
||||
- **Docker Support**: Containerized deployment options
|
||||
- **WASM Preparation**: Foundation for browser integration
|
||||
|
||||
## User Experience Improvements
|
||||
|
||||
### Safety Features
|
||||
- **Volume Warnings**: Warnings for high volume levels
|
||||
- **Input Validation**: Comprehensive input range validation
|
||||
- **Error Recovery**: Graceful handling of network issues
|
||||
- **User Feedback**: Clear status messages and progress indicators
|
||||
|
||||
### Convenience Features
|
||||
- **Auto-Discovery**: Automatic device finding
|
||||
- **Preset Analysis**: Intelligent preset management
|
||||
- **Source Shortcuts**: Direct source selection methods
|
||||
- **Zone Management**: High-level multiroom operations
|
||||
|
||||
### Documentation Evolution
|
||||
- **API Documentation**: Comprehensive endpoint documentation
|
||||
- **Usage Guides**: Detailed feature usage guides
|
||||
- **Troubleshooting**: Common issues and solutions
|
||||
- **Examples**: Real-world usage examples
|
||||
|
||||
## Future Enhancement Roadmap
|
||||
|
||||
### Next Phase Candidates
|
||||
- **Web Application Interface**: Browser-based SoundTouch controller
|
||||
- **Home Assistant Integration**: Smart home platform integration
|
||||
- **WASM Browser Library**: Pure browser implementation
|
||||
- **Mobile App Development**: Native mobile applications
|
||||
- **Docker Distribution**: Containerized deployment options
|
||||
|
||||
### Community Features
|
||||
- **Plugin System**: Extensible architecture for community plugins
|
||||
- **Custom Event Handlers**: User-defined event processing
|
||||
- **Configuration Presets**: Shareable device configurations
|
||||
- **Automation Scripts**: Scheduled playback automation
|
||||
|
||||
## Lessons Learned
|
||||
|
||||
### Development Insights
|
||||
- **Real Device Testing is Critical**: API documentation doesn't capture all device behaviors
|
||||
- **Safety First**: User protection features are essential for audio equipment
|
||||
- **Progressive Enhancement**: Building features incrementally ensures solid foundation
|
||||
- **Community Value**: Open source approach accelerates development and testing
|
||||
|
||||
### Technical Insights
|
||||
- **XML Parsing Complexity**: SoundTouch API has quirks requiring careful XML handling
|
||||
- **Network Variability**: Different network configurations require multiple discovery methods
|
||||
- **Device Differences**: SoundTouch models have subtle API differences
|
||||
- **WebSocket Reliability**: Real-time connections need robust reconnection logic
|
||||
|
||||
---
|
||||
|
||||
**This document tracks the evolution of the Bose SoundTouch API client from initial concept to production-ready library.**
|
||||
@@ -6,7 +6,7 @@ This guide will get you up and running with the SoundTouch Go client in under 10
|
||||
|
||||
## 📋 **Prerequisites**
|
||||
|
||||
- **Go 1.19 or later** installed on your system
|
||||
- **Go 1.25.5 or later** installed on your system
|
||||
- **Bose SoundTouch device** on your network (SoundTouch 10, 20, 30, etc.)
|
||||
- **Same network** - Your computer and SoundTouch device must be on the same network
|
||||
|
||||
|
||||
+90
-34
@@ -362,39 +362,86 @@ func (c Config) Validate() error
|
||||
- [x] Graceful error handling
|
||||
- [x] Network timeout management
|
||||
|
||||
### Phase 3: Additional Control Endpoints 🎛️ (Next Priority)
|
||||
- [ ] **Source Management**
|
||||
### Phase 3: Additional Control Endpoints 🎛️ ✅ COMPLETE
|
||||
- [x] **Source Management** ✅ DONE
|
||||
- POST /select - Switch audio sources
|
||||
- Source validation and error handling
|
||||
- [ ] **Bass Control**
|
||||
- Convenience methods (SelectSpotify, SelectBluetooth, etc.)
|
||||
- [x] **Bass Control** ✅ DONE
|
||||
- GET /bass - Get bass settings
|
||||
- POST /bass - Set bass level (-9 to +9)
|
||||
- [x] **Preset Management (Read-Only)**
|
||||
- ~~POST /presets - Create/update presets~~ - **Officially not supported by SoundTouch API**
|
||||
- [ ] **Advanced Features**
|
||||
- GET/POST /balance - Stereo balance (stereo devices)
|
||||
- Range validation and safety features
|
||||
- Incremental bass control methods
|
||||
- [x] **Balance Control** ✅ DONE
|
||||
- GET/POST /balance - Stereo balance (-50 to +50)
|
||||
- Balance adjustment with clamping
|
||||
- Left/right convenience methods
|
||||
- [x] **Preset Management (Read-Only)** ✅ DONE
|
||||
- Complete preset analysis and helper methods
|
||||
- Note: POST /presets is officially marked as "N/A" by Bose - no API client can implement preset creation
|
||||
- [x] **System Features** ✅ DONE
|
||||
- GET/POST /clockTime - Device time management
|
||||
- GET/POST /clockDisplay - Clock display settings
|
||||
- GET /networkInfo - Network diagnostics
|
||||
- GET /name, POST /name - Device name management
|
||||
- GET /bassCapabilities - Bass capability detection
|
||||
|
||||
### Phase 4: WebSocket Real-time Events 📡
|
||||
- [ ] **Implement WebSocket Client**
|
||||
### Phase 4: WebSocket Real-time Events 📡 ✅ COMPLETE
|
||||
- [x] **Implement WebSocket Client** ✅ DONE
|
||||
- Connection Management
|
||||
- Event parsing and routing
|
||||
- Reconnection with exponential backoff
|
||||
- [ ] **Event Handler System**
|
||||
- Typed event structs
|
||||
- Handler Registration
|
||||
- Event Filtering
|
||||
- [ ] **CLI Real-time Monitoring**
|
||||
- Automatic connection recovery
|
||||
- [x] **Event Handler System** ✅ DONE
|
||||
- 12 typed event structs (NowPlayingUpdated, VolumeUpdated, etc.)
|
||||
- Handler Registration and callback system
|
||||
- Event Filtering and routing
|
||||
- Comprehensive event type coverage
|
||||
- [x] **CLI Real-time Monitoring** ✅ DONE
|
||||
- Live Now-Playing Updates
|
||||
- Volume Change Monitoring
|
||||
- Connection Status Display
|
||||
- [ ] **Event Storage & History**
|
||||
- Real-time event streaming with formatted output
|
||||
- [x] **Event Management** ✅ DONE
|
||||
- Event logging for debugging
|
||||
- Historical Event Queries
|
||||
- Connection state monitoring
|
||||
- Error handling and recovery
|
||||
|
||||
### Phase 5: Web Application & CORS Proxy 🌐
|
||||
### Phase 5: Multiroom Zone Management 🏠 ✅ COMPLETE
|
||||
- [x] **Zone Information** ✅ DONE
|
||||
- GET /getZone - Retrieve zone configuration
|
||||
- Zone status and membership queries
|
||||
- Master/slave device identification
|
||||
- [x] **Zone Operations** ✅ DONE
|
||||
- POST /setZone - Create and modify zones
|
||||
- Zone creation with multiple devices
|
||||
- Add/remove devices from existing zones
|
||||
- Dissolve zones completely
|
||||
- [x] **Zone Management API** ✅ DONE
|
||||
- CreateZone(), AddToZone(), RemoveFromZone()
|
||||
- IP validation and duplicate detection
|
||||
- Comprehensive error handling
|
||||
- Zone builder with fluent API
|
||||
- [x] **Low-Level Zone API** ✅ DONE
|
||||
- POST /addZoneSlave - Individual slave addition
|
||||
- POST /removeZoneSlave - Individual slave removal
|
||||
- Direct device ID and IP-based operations
|
||||
|
||||
### Phase 6: Advanced Audio Controls 🎛️ ✅ COMPLETE
|
||||
- [x] **DSP Audio Controls** ✅ DONE
|
||||
- GET/POST /audiodspcontrols - DSP settings and audio modes
|
||||
- Video sync delay adjustment
|
||||
- Audio mode switching (movie, music, etc.)
|
||||
- [x] **Advanced Tone Controls** ✅ DONE
|
||||
- GET/POST /audioproducttonecontrols - Advanced bass/treble
|
||||
- Professional-grade audio adjustment
|
||||
- Device capability detection
|
||||
- [x] **Speaker Level Controls** ✅ DONE
|
||||
- GET/POST /audioproductlevelcontrols - Individual speaker levels
|
||||
- Front-center and rear-surround adjustment
|
||||
- Multi-channel audio management
|
||||
|
||||
### Phase 7: Web Application & CORS Proxy 🌐 (Future Enhancement)
|
||||
- [ ] **Create Embedded Web UI**
|
||||
- HTML/CSS/JS for SoundTouch control
|
||||
- Responsive design for mobile
|
||||
@@ -414,7 +461,7 @@ func (c Config) Validate() error
|
||||
- Source Selection
|
||||
- Preset Management
|
||||
|
||||
### Phase 5: WASM Browser Integration 🧩
|
||||
### Phase 8: WASM Browser Integration 🧩 (Future Enhancement)
|
||||
- [ ] **WASM Build Configuration**
|
||||
- Build tags and conditional compilation
|
||||
- WASM-specific HTTP client (via proxy)
|
||||
@@ -432,7 +479,7 @@ func (c Config) Validate() error
|
||||
- Browser Extension Support
|
||||
- Documentation for CORS issues
|
||||
|
||||
### Phase 6: Production Features & Polish 🚀
|
||||
### Phase 9: Production Features & Polish 🚀 (Future Enhancement)
|
||||
- [ ] **Advanced Configuration**
|
||||
- Environment-based Config
|
||||
- Configuration File Support
|
||||
@@ -694,23 +741,32 @@ docker-compose up # Mock devices + web app
|
||||
|
||||
## Success Criteria
|
||||
|
||||
### Phase 1-2 (Foundation)
|
||||
### Phase 1-2 (Foundation) ✅ COMPLETE
|
||||
- ✅ Stable HTTP API connection to SoundTouch devices
|
||||
- ✅ XML model coverage for implemented APIs (DeviceInfo, NowPlaying, Sources, Name, Capabilities, Presets)
|
||||
- ✅ Automatic device discovery via UPnP
|
||||
- ✅ Functional CLI tool with discovery, info, now playing, sources, name, capabilities, and presets commands
|
||||
- ✅ Now Playing endpoint with comprehensive status information
|
||||
- ✅ Sources endpoint with filtering and categorization features
|
||||
- ✅ Device identification endpoints (name, capabilities)
|
||||
- ✅ Preset management with comprehensive analysis and filtering
|
||||
- ✅ XML model coverage for all core APIs (DeviceInfo, NowPlaying, Sources, Name, Capabilities, Presets, Volume, Key controls)
|
||||
- ✅ Automatic device discovery via UPnP and mDNS
|
||||
- ✅ Comprehensive CLI tool with all endpoint commands
|
||||
- ✅ Media controls with proper press+release key patterns
|
||||
- ✅ Volume management with safety features
|
||||
- ✅ Real device validation on SoundTouch 10 and 20
|
||||
|
||||
### Phase 3-4 (Real-time & Web)
|
||||
- ✅ WebSocket event streaming with reconnection
|
||||
- ✅ Web UI with responsive design
|
||||
- ✅ Single binary deployment with embedded assets
|
||||
- ✅ CORS proxy for browser integration
|
||||
### Phase 3-4 (Audio Controls & Real-time Events) ✅ COMPLETE
|
||||
- ✅ Source selection with convenience methods (Spotify, Bluetooth, etc.)
|
||||
- ✅ Bass control with range validation (-9 to +9)
|
||||
- ✅ Balance control for stereo devices (-50 to +50)
|
||||
- ✅ Clock and display management (time, brightness, format)
|
||||
- ✅ Network information retrieval
|
||||
- ✅ WebSocket event streaming with 12 event types
|
||||
- ✅ Automatic reconnection and connection management
|
||||
|
||||
### Phase 5-6 (Advanced)
|
||||
### Phase 5-6 (Multiroom & Advanced Audio) ✅ COMPLETE
|
||||
- ✅ Complete multiroom zone management (create, modify, dissolve)
|
||||
- ✅ Zone status and membership queries
|
||||
- ✅ Advanced audio controls (DSP, tone, speaker levels)
|
||||
- ✅ Professional-grade audio adjustment features
|
||||
- ✅ Device capability detection and validation
|
||||
|
||||
### Phase 7+ (Future Enhancements)
|
||||
- ✅ WASM integration with JavaScript bridge
|
||||
- ✅ Multi-Device Support
|
||||
- ✅ Production-ready Configuration Management
|
||||
@@ -723,4 +779,4 @@ docker-compose up # Mock devices + web app
|
||||
- [UPnP Device Architecture](http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0.pdf)
|
||||
- [Go Embed Directive](https://pkg.go.dev/embed)
|
||||
- [Gorilla WebSocket](https://github.com/gorilla/websocket)
|
||||
- [PROJECT-PATTERNS.md](./PROJECT-PATTERNS.md) - Detailed pattern documentation
|
||||
- [PROJECT-PATTERNS.md](./PROJECT-PATTERNS.md) - Detailed pattern documentation
|
||||
|
||||
@@ -562,7 +562,7 @@ func (m *MockClient) GetNowPlaying() (*models.NowPlaying, error) {
|
||||
|
||||
```dockerfile
|
||||
# test/docker/Dockerfile
|
||||
FROM golang:1.21-alpine
|
||||
FROM golang:1.25-alpine
|
||||
|
||||
WORKDIR /app
|
||||
COPY . .
|
||||
|
||||
+25
-8
@@ -1,6 +1,6 @@
|
||||
# Project Status Summary
|
||||
|
||||
**Last Updated**: 2026-01-09
|
||||
**Last Updated**: 2026-01-11
|
||||
**Current Version**: Development
|
||||
**Branch**: `main`
|
||||
|
||||
@@ -73,8 +73,11 @@ This project implements a comprehensive Go client library and CLI tool for Bose
|
||||
- `WebSocket /` - Real-time event streaming ✅ Complete
|
||||
- `GET /getZone`, `POST /setZone` - Multiroom zone management ✅ Complete
|
||||
|
||||
### **❌ Not Supported by API**
|
||||
- `POST /presets` - Preset creation (officially marked as "N/A" by Bose)
|
||||
### **ℹ️ API Limitations**
|
||||
- `POST /presets` - Preset creation (officially marked as "N/A" by Bose - no client can implement this)
|
||||
|
||||
### **⚠️ Not Working on Our Test Devices**
|
||||
- `GET /trackInfo` - Implemented but times out on our SoundTouch 10 & 20 (use `GET /now_playing` instead)
|
||||
|
||||
## 📊 Implementation Statistics
|
||||
|
||||
@@ -85,9 +88,12 @@ This project implements a comprehensive Go client library and CLI tool for Bose
|
||||
| **System Endpoints** | 5/5 | 5 | 100% |
|
||||
| **Real-time Features** | 1/1 | 1 | 100% |
|
||||
| **Preset Management** | 1/1 | 1 | 100% |
|
||||
| **Zone Management** | 2/2 | 2 | 100% |
|
||||
| **~~Preset Creation~~** | ~~0/1~~ | ~~1~~ | **N/A - Not Supported by API** |
|
||||
| **Overall Progress** | 18/20 | 20 | **90%** |
|
||||
| **Zone Management** | 4/4 | 4 | 100% |
|
||||
| **Advanced Audio Controls** | 3/3 | 3 | 100% |
|
||||
| **Track Info** | 1/1 | 1 | **100%** |
|
||||
| **Overall Progress** | 26/26 | 26 | **100%** |
|
||||
|
||||
**Note**: Excluded only officially unsupported endpoints (`POST /presets`). All documented endpoints are implemented.
|
||||
|
||||
## 🏆 Major Accomplishments
|
||||
|
||||
@@ -121,11 +127,20 @@ This project implements a comprehensive Go client library and CLI tool for Bose
|
||||
### Phase 4: Multiroom & Zone Management (COMPLETE)
|
||||
- ✅ Zone information retrieval (GET /getZone)
|
||||
- ✅ Zone configuration management (POST /setZone)
|
||||
- ✅ Low-level zone slave operations (POST /addZoneSlave, /removeZoneSlave)
|
||||
- ✅ Complete zone operations (create, modify, add, remove, dissolve)
|
||||
- ✅ Zone status and membership queries
|
||||
- ✅ Comprehensive validation and error handling
|
||||
- ✅ CLI integration for all zone operations
|
||||
|
||||
### Phase 5: Advanced Audio Controls (COMPLETE)
|
||||
- ✅ DSP audio controls (GET/POST /audiodspcontrols) with audio modes and video sync
|
||||
- ✅ Advanced tone controls (GET/POST /audioproducttonecontrols) for professional audio
|
||||
- ✅ Speaker level controls (GET/POST /audioproductlevelcontrols) for multi-channel systems
|
||||
- ✅ Automatic capability detection and conditional availability
|
||||
- ✅ Device-specific feature validation
|
||||
- ✅ Professional-grade audio adjustment features
|
||||
|
||||
### Key Technical Achievements
|
||||
- **Complete Key Controls**: All 24 documented key commands implemented
|
||||
- **Source Selection**: Full source switching with convenience methods (-spotify, -bluetooth, -aux)
|
||||
@@ -265,9 +280,11 @@ This project implements a comprehensive Go client library and CLI tool for Bose
|
||||
- Volume may be affected by external sources (Spotify app, etc.)
|
||||
- Some devices may have slight API variations
|
||||
- mDNS discovery may fail in corporate networks (expected behavior)
|
||||
- `GET /trackInfo` times out on SoundTouch 10 & 20 (may work on other models)
|
||||
|
||||
### API Design Decisions
|
||||
- Preset creation is intentionally not supported via API (official documentation: POST /presets = "N/A")
|
||||
- Track info endpoint is implemented but appears device/firmware dependent
|
||||
|
||||
### Development Notes
|
||||
- All major architectural decisions documented
|
||||
@@ -277,5 +294,5 @@ This project implements a comprehensive Go client library and CLI tool for Bose
|
||||
|
||||
---
|
||||
|
||||
**Status**: 🟢 **Healthy Development** - Audio controls and preset management complete (70% overall)
|
||||
**Next Session Focus**: WebSocket real-time events or remaining system endpoints
|
||||
**Status**: 🟢 **Complete & Production Ready** - All available API endpoints implemented (100%)
|
||||
**Next Session Focus**: Web application interface or WASM browser integration
|
||||
|
||||
+24
-11
@@ -14,9 +14,10 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
```
|
||||
Title: "Bose SoundTouch Go Library v1.0.0 - 100% API Coverage + WebSocket Events"
|
||||
Content: Highlight production-ready features, real hardware testing, excellent docs
|
||||
Include: Code examples, performance metrics, real device compatibility list
|
||||
```
|
||||
|
||||
- [ ] **Gopher Slack** (#general, #show-and-tell):
|
||||
- [x] **Gopher Slack** (#general, #show-and-tell): ✅ **COMPLETED**
|
||||
```
|
||||
"Just released a comprehensive Go library for Bose SoundTouch speakers 🎵
|
||||
✅ 100% API coverage (19/19 official endpoints)
|
||||
@@ -33,7 +34,7 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
```
|
||||
|
||||
### Social Media
|
||||
- [ ] **Twitter/X** announcement:
|
||||
- [x] **Twitter/X** announcement: ✅ **COMPLETED**
|
||||
```
|
||||
"🎵 Just released Bose SoundTouch Go Library v1.0.0!
|
||||
|
||||
@@ -49,6 +50,8 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
https://github.com/gesellix/bose-soundtouch"
|
||||
```
|
||||
|
||||
- [x] **Bluesky** announcement: ✅ **COMPLETED**
|
||||
|
||||
- [ ] **LinkedIn** professional post (if applicable)
|
||||
|
||||
## 📋 Medium-term Actions (Within 1 week)
|
||||
@@ -81,6 +84,8 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
|
||||
### Technical Communities
|
||||
- [ ] **Go Forum** announcement: https://forum.golangbridge.org/
|
||||
- [ ] **Golang Weekly** newsletter submission: https://golangweekly.com/
|
||||
- [ ] **Go Time podcast** community shoutouts: https://changelog.com/gotime
|
||||
- [ ] **Home Assistant Community**: https://community.home-assistant.io/
|
||||
- [ ] **Bose Community Forums** (if they exist)
|
||||
- [ ] **Smart Home subreddits**: r/homeautomation, r/smarthome
|
||||
@@ -105,6 +110,9 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
```bash
|
||||
brew install gesellix/tap/soundtouch-cli
|
||||
```
|
||||
- [ ] **Arch Linux AUR** package submission
|
||||
- [ ] **Nix package** for NixOS users
|
||||
- [ ] **GitHub Sponsors** setup for ongoing development
|
||||
|
||||
## 📊 Success Metrics to Track
|
||||
|
||||
@@ -113,6 +121,7 @@ After successfully releasing v1.0.0, follow this checklist to maximize visibilit
|
||||
- [ ] pkg.go.dev page views: Monitor via GitHub insights
|
||||
- [ ] CLI downloads: Track release download counts
|
||||
- [ ] Reddit/HN engagement: Upvotes, comments, discussions
|
||||
- [ ] Go module proxy downloads: Check via `go list -m -versions`
|
||||
|
||||
### Medium-term (1 month)
|
||||
- [ ] GitHub stars: Target 100+
|
||||
@@ -173,21 +182,25 @@ Best regards,
|
||||
|
||||
## 🎯 Priority Ranking
|
||||
|
||||
**High Impact, Low Effort:**
|
||||
### High Impact, Low Effort:**
|
||||
1. Reddit r/golang post
|
||||
2. Gopher Slack announcement
|
||||
2. ~~Gopher Slack announcement~~ ✅ **DONE**
|
||||
3. awesome-go submission
|
||||
4. Twitter announcement
|
||||
4. ~~Twitter/X announcement~~ ✅ **DONE**
|
||||
5. ~~Bluesky announcement~~ ✅ **DONE**
|
||||
6. Golang Weekly submission
|
||||
|
||||
**High Impact, Medium Effort:**
|
||||
5. Blog post on Dev.to
|
||||
6. Home automation community posts
|
||||
7. Example projects repository
|
||||
6. Blog post on Dev.to
|
||||
7. Home automation community posts
|
||||
8. Example projects repository
|
||||
9. pkg.go.dev badge and documentation polish
|
||||
|
||||
**Medium Impact, High Effort:**
|
||||
8. YouTube video/conference talk
|
||||
9. Podcast appearances
|
||||
10. Advanced integration examples
|
||||
10. YouTube video/conference talk
|
||||
11. Podcast appearances
|
||||
12. Advanced integration examples
|
||||
13. Package manager distributions
|
||||
|
||||
## 🚨 Common Pitfalls to Avoid
|
||||
|
||||
|
||||
Reference in New Issue
Block a user