sirmrakandQwen-Coder
d38719ad53
- docs/settings-cheatsheet.md — полный справочник всех CLI флагов - Обновлён docs/README.md — добавлена ссылка на cheat sheet Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
README — VoskWyoming Satellite
Remote voice satellite using the Wyoming protocol for Home Assistant.
Features
- 🏠 Home Assistant integration — Native Wyoming protocol support
- 🎤 Local wake word detection — Vosk-based Russian wake words ("привет дроид", etc.)
- 🔇 Audio enhancements — WebRTC noise suppression and automatic gain control
- 💡 MQTT LED control — ReSpeaker XVF3800 4-MIC array support with HA discovery
- 🎯 Voice Activity Detection — Silero or WebRTC VAD for privacy-focused operation
Quick Start
1. Install
git clone <repository-url> ~/projects/Satellite
cd ~/projects/Satellite
python3 -m venv ~/.venv_satellite
source ~/.venv_satellite/bin/activate
pip install -r requirements.txt
2. Install systemd Services
sudo ./install_systemd_services.sh
3. Start
sudo systemctl enable --now wyoming-satelite-vosk.service
sudo systemctl status wyoming-satelite-vosk.service
In Home Assistant: Settings → Devices & Services → Discovered → Wyoming Satellite → Configure
Documentation
| Guide | Description |
|---|---|
| Deployment | Full deployment guide with systemd services |
| Tutorials | Step-by-step setup for different hardware |
| Architecture | How Wyoming Satellite works |
| MQTT LED | LED control with Home Assistant |
| VAD Integration | Technical integration guide |
Tutorials
Requirements
- Python 3.9+
- Linux (tested on Raspberry Pi OS)
- Microphone (USB or HAT)
- Optional: ReSpeaker XVF3800 USB 4-MIC Array (for LED control)
Project Structure
Satellite/
├── wyoming_satellite/ # Main Python package
├── examples/ # Example scripts (LED, MQTT, configs)
├── services/ # systemd service files
├── docs/ # Documentation
│ ├── tutorials/ # Hardware-specific guides
│ ├── integration/ # Technical integration guides
│ ├── deployment/ # Deployment guides
│ └── architecture/ # Architecture documentation
├── sounds/ # Audio files (awake.wav, etc.)
├── scripts/ # Helper scripts
└── tests/ # Unit tests
Configuration
Wake Words (Russian)
Edit start_satellite.sh:
--wake-word-name "привет дроид"
--wake-word-name "привет придурок"
--wake-word-name "привет жопа с ушами"
Audio Settings
--mic-noise-suppression 2
--mic-auto-gain 5
VAD Settings
--vad
--vad-system webrtc
--vad-threshold 0.5
Development
# Linting
pylint wyoming_satellite/
mypy wyoming_satellite/
# Tests
pytest tests/
# Format
black wyoming_satellite/
isort wyoming_satellite/
Video Tutorials
External Resources
License
This project is part of the Open Home Foundation ecosystem.