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
+69 -62
View File
@@ -1,140 +1,147 @@
# systemd Services Configuration
# Настройка systemd сервисов
Detailed guide for configuring and managing Wyoming Satellite systemd services.
Подробное руководство по настройке и управлению systemd сервисами Wyoming Satellite.
## Service Files Location
## Расположение файлов сервисов
Service files are in the `services/` directory:
Файлы сервисов находятся в директории `services/`:
```
services/
├── wyoming-event.service # LED control + MQTT
├── wyoming-satelite-vosk.service # Main satellite
└── wyoming-wakeword-vosk.service # Wake word detection
├── wyoming-event.service # LED управление + MQTT
├── wyoming-satelite-vosk.service # Основной спутник
└── wyoming-wakeword-vosk.service # Детекция wake word
```
## Installation Script
## Скрипт установки
The `install_systemd_services.sh` script automatically:
Скрипт `install_systemd_services.sh` автоматически:
1. Detects your virtual environment path
2. Determines the current user
3. Substitutes placeholders in service files
4. Copies services to `/etc/systemd/system/`
5. Installs the `satellite-python` wrapper to `/usr/local/bin/`
1. Определяет путь к виртуальному окружению
2. Определяет текущего пользователя
3. Подставляет плейсхолдеры в файлы сервисов
4. Копирует сервисы в `/etc/systemd/system/`
5. Устанавливает wrapper `satellite-python` в `/usr/local/bin/`
### Manual Installation
### Ручная установка
If the script doesn't work, install manually:
Если скрипт не работает, установите вручную:
```bash
# 1. Edit service files, replacing placeholders:
# 1. Отредактируйте файлы сервисов, заменив плейсхолдеры:
# __SAT_BASE_DIR__ → /home/sirmrak/projects/Satellite
# __SAT_VENV__ → /home/sirmrak/.venv_satellite
# __CURRENT_USER__ → sirmrak
# 2. Copy to systemd directory
# 2. Скопируйте в директорию systemd
sudo cp services/*.service /etc/systemd/system/
# 3. Reload systemd
# 3. Перезагрузите systemd
sudo systemctl daemon-reload
# 4. Enable and start
# 4. Включите и запустите
sudo systemctl enable --now wyoming-satelite-vosk.service
```
## Service Details
## Детали сервисов
### wyoming-satelite-vosk.service
Main Wyoming satellite service. Connects to:
- Microphone (arecord)
- Speaker (aplay)
- Wake word service (optional, port 10400)
- Event service (optional, port 10500)
Основной сервис Wyoming Satellite. Подключается к:
- Микрофону (arecord)
- Динамику (aplay)
- Сервису wake word (опционально, порт 10400)
- Сервису событий (опционально, порт 10500)
**Ports:** 10700 (Wyoming protocol)
**Порты:** 10700 (Wyoming protocol)
**Dependencies:** network.target
**Зависимости:** network.target
### wyoming-wakeword-vosk.service
Vosk-based wake word detection service. Listens for Russian wake words:
Сервис детекции wake word на основе Vosk. Слушает русские фразы:
- "привет дроид"
- "привет придурок"
- "привет жопа с ушами"
**Ports:** 10400 (Wyoming protocol)
**Порты:** 10400 (Wyoming protocol)
**Configuration:** `local/vosk-wake-dev/wyoming_vosk_wake/config.yaml`
**Конфигурация:** `local/vosk-wake-dev/wyoming_vosk_wake/config.yaml`
### wyoming-event.service
LED control and MQTT integration for ReSpeaker XVF3800.
LED управление и MQTT интеграция для ReSpeaker XVF3800.
**Ports:** 10500 (Wyoming event protocol)
**Порты:** 10500 (Wyoming event protocol)
**MQTT Topics:**
- `wyoming/led/command` — Commands from Home Assistant
- `wyoming/led/brightness/set` — Set brightness (0-255)
- `wyoming/led/brightness/state` — Current brightness state
- `wyoming/led/state` — LED state
- `wyoming/led/availability` — Online/offline status
**MQTT топики:**
- `wyoming/led/command` — Команды от Home Assistant
- `wyoming/led/brightness/set` — Установка яркости (0-255)
- `wyoming/led/brightness/state` — Текущая яркость
- `wyoming/led/state` — Состояние LED
- `wyoming/led/availability` — Статус онлайн/офлайн
## Management Commands
## Команды управления
```bash
# Check status
# Проверка статуса
sudo systemctl status wyoming-satelite-vosk.service
# View logs (real-time)
# Просмотр логов (реальное время)
journalctl -u wyoming-satelite-vosk.service -f
# Restart service
# Перезапуск сервиса
sudo systemctl restart wyoming-satelite-vosk.service
# Disable service
# Отключение сервиса
sudo systemctl disable --now wyoming-satelite-vosk.service
# Reload systemd after changes
# Перезагрузка systemd после изменений
sudo systemctl daemon-reload
```
## Troubleshooting
## Диагностика
### Service won't start
### Сервис не запускается
```bash
# Check status and recent errors
# Проверка статуса и последних ошибок
sudo systemctl status wyoming-satelite-vosk.service
# View full logs
# Просмотр полных логов
journalctl -u wyoming-satelite-vosk.service -n 100
# Check Python path
# Проверка пути к Python
which satellite-python
satellite-python --version
```
### Common Issues
### Частые проблемы
| Issue | Solution |
|-------|----------|
| `ModuleNotFoundError` | Check venv path in service file |
| `arecord: command not found` | Install `alsa-utils` |
| Permission denied | Check `User=` directive matches your username |
| Port already in use | Check if another instance is running |
| Проблема | Решение |
|----------|---------|
| `ModuleNotFoundError` | Проверьте путь к venv в файле сервиса |
| `arecord: command not found` | Установите `alsa-utils` |
| Permission denied | Проверьте директиву `User=` |
| Порт уже используется | Проверьте, не запущен ли другой экземпляр |
## Wrapper Script
## Wrapper скрипт
The `satellite-python` wrapper allows running Python from venv without full path:
Wrapper `satellite-python` позволяет запускать Python из venv без указания полного пути:
```bash
# Installed to /usr/local/bin/satellite-python
satellite-python --version # Uses venv Python
# Установлен в /usr/local/bin/satellite-python
satellite-python --version # Использует Python из venv
```
Used in service files:
Используется в файлах сервисов:
```ini
ExecStart=satellite-python -m wyoming_satellite ...
```
---
## 🔗 Связанное
- [Руководство по развёртыванию](../../DEPLOY.md)
- [MQTT LED интеграция](integration/mqtt-led.md)