sirmrakandQwen-Coder
adac79e765
- Перемещена документация в docs/ с четкой структурой: - tutorials/ — пошаговые руководства (2mic-hat, installer) - integration/ — техническая интеграция (vad-wakeword, mqtt-led) - deployment/ — развёртывание (systemd-services) - architecture/ — архитектура проекта (overview) - Обновлён README.md с навигацией по документации - DEPLOY.md сокращён до quick start с ссылками на docs/ - Добавлен docs/README.md — индекс документации - Создан QWEN.md — контекст для ИИ-ассистента - Удалён мусор: - wyoming_satellite.zip (build artifact) - wyoming-led.service, wyoming-satellite.service (дубликаты) - .qwen/settings.json.orig (бэкап) - .lgd-nfy0 (пустой файл) - docker/run (заглушка) - Обновлён .gitignore: - examples/led_brightness_config.json (автогенерируемый конфиг) - *.old, *.bak, *~ (бэкапы) - *.zip (архивы) - .qwen/settings.json.orig - *.lgd-* (пустые файлы) - led_brightness_config.json исключён из отслеживания (assume-unchanged) Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
74 lines
1.7 KiB
Markdown
74 lines
1.7 KiB
Markdown
# Deployment Guide
|
|
|
|
Quick start guide for deploying Wyoming Satellite.
|
|
|
|
## Quick Start
|
|
|
|
### 1. Clone and Install
|
|
|
|
```bash
|
|
git clone <repository-url> ~/projects/Satellite
|
|
cd ~/projects/Satellite
|
|
|
|
# Create virtual environment
|
|
python3 -m venv ~/.venv_satellite
|
|
source ~/.venv_satellite/bin/activate
|
|
|
|
# Install dependencies
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### 2. Install systemd Services
|
|
|
|
```bash
|
|
sudo ./install_systemd_services.sh
|
|
```
|
|
|
|
### 3. Start Services
|
|
|
|
```bash
|
|
# LED control (optional, requires ReSpeaker)
|
|
sudo systemctl enable --now wyoming-event.service
|
|
|
|
# Wyoming Satellite
|
|
sudo systemctl enable --now wyoming-satelite-vosk.service
|
|
|
|
# Wake word detection (Vosk)
|
|
sudo systemctl enable --now wyoming-wakeword-vosk.service
|
|
```
|
|
|
|
### 4. Verify
|
|
|
|
```bash
|
|
sudo systemctl status wyoming-satelite-vosk.service
|
|
journalctl -u wyoming-satelite-vosk.service -f
|
|
```
|
|
|
|
---
|
|
|
|
## Full Documentation
|
|
|
|
- [**systemd Services**](deployment/systemd-services.md) — Detailed service configuration
|
|
- [**Tutorials**](tutorials/installer.md) — Step-by-step installation guides
|
|
|
|
---
|
|
|
|
## Service Overview
|
|
|
|
| Service | Port | Description |
|
|
|---------|------|-------------|
|
|
| `wyoming-satelite-vosk.service` | 10700 | Main Wyoming satellite |
|
|
| `wyoming-wakeword-vosk.service` | 10400 | Vosk wake word detection |
|
|
| `wyoming-event.service` | 10500 | LED control + MQTT events |
|
|
|
|
## Configuration
|
|
|
|
Service files use placeholders that are auto-replaced during installation:
|
|
|
|
| Placeholder | Description |
|
|
|-------------|-------------|
|
|
| `__SAT_BASE_DIR__` | Path to Satellite repository |
|
|
| `__SAT_VENV__` | Path to virtual environment |
|
|
| `__CURRENT_USER__` | Current username |
|
|
| `__HOME_DIR__` | User home directory |
|