docs: перевод документации на русский язык

Полностью переведена вся документация в docs/:

- docs/architecture/overview.md — Архитектура Wyoming Satellite
- docs/settings-cheatsheet.md — Шпаргалка по настройкам (CLI флаги)
- docs/deployment/systemd-services.md — Настройка systemd сервисов
- docs/integration/mqtt-led.md — MQTT LED управление
- docs/integration/vad-wakeword.md — Уже был на русском
- docs/tutorials/2mic-hat.md — Tutorial для 2-MIC HAT
- docs/tutorials/installer.md — Интерактивный установщик
- docs/README.md — Индекс документации

Обновлены корневые файлы:
- README.md — Полностью на русском
- DEPLOY.md — Полностью на русском

Вся документация теперь на русском языке для удобства
русскоязычных пользователей.

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
2026-05-19 23:25:34 +03:00
co-authored by Qwen-Coder
parent d38719ad53
commit 61b1532757
10 changed files with 609 additions and 522 deletions
+75 -31
View File
@@ -1,73 +1,117 @@
# Deployment Guide
# Руководство по развёртыванию
Quick start guide for deploying Wyoming Satellite.
Быстрый старт для развёртывания Wyoming Satellite.
## Quick Start
## Быстрый старт
### 1. Clone and Install
### 1. Клонирование и установка
```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
### 2. Установка systemd сервисов
```bash
sudo ./install_systemd_services.sh
```
### 3. Start Services
### 3. Запуск сервисов
```bash
# LED control (optional, requires ReSpeaker)
# LED управление (опционально, требуется ReSpeaker)
sudo systemctl enable --now wyoming-event.service
# Wyoming Satellite
sudo systemctl enable --now wyoming-satelite-vosk.service
# Wake word detection (Vosk)
# Детекция wake word (Vosk)
sudo systemctl enable --now wyoming-wakeword-vosk.service
```
### 4. Verify
### 4. Проверка
```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
В Home Assistant: **Настройки → Устройства и сервисы → Найдено → Wyoming Satellite → Настроить**
---
## 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 |
| Руководство | Описание |
|-------------|----------|
| [**systemd сервисы**](docs/deployment/systemd-services.md) | Детальная настройка сервисов |
| [**Tutorials**](docs/tutorials/) | Пошаговые руководства для разного оборудования |
| [**Архитектура**](docs/architecture/overview.md) | Как работает Wyoming Satellite |
| [**MQTT LED**](docs/integration/mqtt-led.md) | LED управление с Home Assistant |
| [**Настройки**](docs/settings-cheatsheet.md) | Шпаргалка по всем CLI флагам |
## Configuration
### Tutorials
Service files use placeholders that are auto-replaced during installation:
- [**2-MIC HAT**](docs/tutorials/2mic-hat.md) — Raspberry Pi + ReSpeaker 2-MIC HAT
- [**Установщик**](docs/tutorials/installer.md) — Руководство по интерактивному установщику
| Placeholder | Description |
|-------------|-------------|
| `__SAT_BASE_DIR__` | Path to Satellite repository |
| `__SAT_VENV__` | Path to virtual environment |
| `__CURRENT_USER__` | Current username |
| `__HOME_DIR__` | User home directory |
---
## Требования
- **Python 3.9+**
- **Linux** (протестировано на Raspberry Pi OS)
- **Микрофон** (USB или HAT)
- **Опционально:** ReSpeaker XVF3800 USB 4-MIC Array (для LED управления)
---
## Обзор сервисов
| Сервис | Порт | Описание |
|--------|------|----------|
| `wyoming-satelite-vosk.service` | 10700 | Основной Wyoming спутник |
| `wyoming-wakeword-vosk.service` | 10400 | Детекция wake word (Vosk) |
| `wyoming-event.service` | 10500 | LED управление + MQTT события |
---
## Конфигурация
Файлы сервисов используют плейсхолдеры, которые автоматически заменяются при установке:
| Плейсхолдер | Описание |
|-------------|----------|
| `__SAT_BASE_DIR__` | Путь к репозиторию Satellite |
| `__SAT_VENV__` | Путь к виртуальному окружению |
| `__CURRENT_USER__` | Имя текущего пользователя |
| `__HOME_DIR__` | Домашняя директория пользователя |
---
## Wake words (русские)
Отредактируйте `start_satellite.sh`:
```bash
--wake-word-name "привет дроид"
--wake-word-name "привет придурок"
--wake-word-name "привет жопа с ушами"
```
---
## Внешние ресурсы
- [Wyoming Protocol](https://github.com/rhasspy/wyoming)
- [Home Assistant Integration](https://www.home-assistant.io/integrations/wyoming)
- [Vosk](https://alphacephei.com/vosk/)
- [ReSpeaker 4-MIC Array](https://github.com/respeaker/usb_4mic_array)