sirmrak/satellite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

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

Browse Source 
Полностью переведена вся документация в 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:
sirmrak
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/settings-cheatsheet.md
+104 -104
View File
@@ -1,27 +1,27 @@
# Wyoming Satellite — Settings Cheat Sheet
# Wyoming Satellite — Шпаргалка по настройкам
Quick reference for all CLI flags and settings.
Быстрый справочник всех CLI флагов и настроек.
---
## 🎤 Microphone (`--mic-*`)
## 🎤 Микрофон (`--mic-*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--mic-uri` | — | Wyoming microphone service URI (`tcp://ip:port`) |
| `--mic-command` | — | Command for microphone input (`arecord ...`) |
| `--mic-command-rate` | 16000 | Sample rate (Hz) |
| `--mic-command-width` | 2 | Sample width (bytes) |
| `--mic-command-channels` | 1 | Channels (1=mono) |
| `--mic-command-samples-per-chunk` | 1024 | Samples per read |
| `--mic-volume-multiplier` | 1.0 | Volume multiplier |
| `--mic-noise-suppression` | 0 | Noise suppression (0-4) |
| `--mic-auto-gain` | 0 | Auto gain (0-31 dbFS) |
| `--mic-channel-index` | None | Channel index to use |
| `--mic-seconds-to-mute-after-awake-wav` | 0.5 | Mute after awake WAV |
| `--mic-no-mute-during-awake-wav` | false | Don't mute during awake WAV |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--mic-uri` | — | Wyoming microphone сервис URI (`tcp://ip:port`) |
| `--mic-command` | — | Команда для записи с микрофона (`arecord ...`) |
| `--mic-command-rate` | 16000 | Частота дискретизации (Гц) |
| `--mic-command-width` | 2 | Разрядность (байт) |
| `--mic-command-channels` | 1 | Каналы (1=моно) |
| `--mic-command-samples-per-chunk` | 1024 | Сэмплов за чтение |
| `--mic-volume-multiplier` | 1.0 | Множитель громкости |
| `--mic-noise-suppression` | 0 | Шумоподавление (0-4) |
| `--mic-auto-gain` | 0 | Автоусиление (0-31 dbFS) |
| `--mic-channel-index` | None | Индекс канала |
| `--mic-seconds-to-mute-after-awake-wav` | 0.5 | Глушить после awake WAV |
| `--mic-no-mute-during-awake-wav` | false | Не глушить во время awake WAV |
**Example:**
**Пример:**
```bash
--mic-command 'arecord -D plughw:CARD=Array,DEV=0 -r 16000 -c 1 -f S16_LE -t raw' \
--mic-noise-suppression 2 \
@@ -30,20 +30,20 @@ Quick reference for all CLI flags and settings.
---
## 🔊 Sound Output (`--snd-*`)
## 🔊 Звук (`--snd-*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--snd-uri` | — | Wyoming sound service URI |
| `--snd-command` | — | Command for sound output (`aplay ...`) |
| `--snd-command-rate` | 22050 | Sample rate (Hz) |
| `--snd-command-width` | 2 | Sample width (bytes) |
| `--snd-command-channels` | 1 | Channels |
| `--snd-volume-multiplier` | 1.0 | Volume multiplier |
| `--awake-wav` | — | WAV played after wake word |
| `--done-wav` | — | WAV played after command |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--snd-uri` | — | Wyoming sound сервис URI |
| `--snd-command` | — | Команда для вывода звука (`aplay ...`) |
| `--snd-command-rate` | 22050 | Частота дискретизации (Гц) |
| `--snd-command-width` | 2 | Разрядность (байт) |
| `--snd-command-channels` | 1 | Каналы |
| `--snd-volume-multiplier` | 1.0 | Множитель громкости |
| `--awake-wav` | — | WAV после wake word |
| `--done-wav` | — | WAV после команды |
**Example:**
**Пример:**
```bash
--snd-command 'aplay -D plughw:CARD=Array,DEV=0 -r 22050 -c 1 -f S16_LE -t raw' \
--awake-wav /home/sirmrak/projects/Satellite/sounds/awake.wav
@@ -53,14 +53,14 @@ Quick reference for all CLI flags and settings.
## 🎯 Wake Word (`--wake-*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--wake-uri` | — | Wyoming wake word service URI |
| `--wake-command` | — | Local wake word command |
| `--wake-word-name` | — | Wake word phrase (can be repeated) |
| `--wake-refractory-seconds` | 5.0 | Delay between detections |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--wake-uri` | — | Wyoming wake word сервис URI |
| `--wake-command` | — | Локальная команда wake word |
| `--wake-word-name` | — | Фраза wake word (можно повторять) |
| `--wake-refractory-seconds` | 5.0 | Задержка между детекциями |
**Example:**
**Пример:**
```bash
--wake-uri tcp://127.0.0.1:10400 \
--wake-word-name "привет дроид" \
@@ -71,17 +71,17 @@ Quick reference for all CLI flags and settings.
## 🎤 Voice Activity Detection (`--vad*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--vad` | false | Enable VAD |
| `--vad-system` | silero | `silero` or `webrtc` |
| `--vad-threshold` | 0.5 | Threshold (0-1) |
| `--vad-trigger-level` | 1 | Chunks to activate |
| `--vad-energy-threshold` | None | Energy for webrtc (int16) |
| `--vad-buffer-seconds` | 2.0 | Pre-roll buffer (seconds) |
| `--vad-wake-word-timeout` | 5.0 | Wake word timeout |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--vad` | false | Включить VAD |
| `--vad-system` | silero | `silero` или `webrtc` |
| `--vad-threshold` | 0.5 | Порог (0-1) |
| `--vad-trigger-level` | 1 | Чанков для активации |
| `--vad-energy-threshold` | None | Энергия для webrtc (int16) |
| `--vad-buffer-seconds` | 2.0 | Пре-буфер (секунды) |
| `--vad-wake-word-timeout` | 5.0 | Таймаут wake word |
**Example:**
**Пример:**
```bash
--vad \
--vad-system webrtc \
@@ -94,26 +94,26 @@ Quick reference for all CLI flags and settings.
## 📡 Event Service (`--event-uri`, `--*-command`)
| Flag | Event |
|------|-------|
| `--event-uri` | Wyoming event service URI |
| `--startup-command` | Satellite started |
| `--streaming-start-command` | Streaming started |
| `--streaming-stop-command` | Streaming stopped |
| `--detect-command` | Wake detection started |
| `--detection-command` | Wake word detected |
| `--tts-played-command` | Audio played |
| `--transcript-command` | STT transcript |
| `--stt-start-command` | STT started |
| `--stt-stop-command` | STT stopped |
| `--synthesize-command` | TTS text received |
| `--tts-start-command` | TTS started |
| `--tts-stop-command` | TTS stopped |
| `--error-command` | Error occurred |
| `--connected-command` | Connected to server |
| `--disconnected-command` | Disconnected from server |
| Флаг | Событие |
|------|---------|
| `--event-uri` | Wyoming event сервис URI |
| `--startup-command` | Спутник запущен |
| `--streaming-start-command` | Стриминг начался |
| `--streaming-stop-command` | Стриминг остановлен |
| `--detect-command` | Начало детекции wake |
| `--detection-command` | Wake word обнаружен |
| `--tts-played-command` | Аудио воспроизведено |
| `--transcript-command` | STT текст |
| `--stt-start-command` | STT начался |
| `--stt-stop-command` | STT завершён |
| `--synthesize-command` | TTS текст получен |
| `--tts-start-command` | TTS начался |
| `--tts-stop-command` | TTS завершён |
| `--error-command` | Ошибка |
| `--connected-command` | Подключен к серверу |
| `--disconnected-command` | Отключен от сервера |
**Example:**
**Пример:**
```bash
--event-uri tcp://127.0.0.1:10500 \
--detection-command 'examples/commands/detection.sh' \
@@ -123,18 +123,18 @@ Quick reference for all CLI flags and settings.
---
## ⏱️ Timers (`--timer-*`)
## ⏱️ Таймеры (`--timer-*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--timer-started-command` | — | Timer started |
| `--timer-updated-command` | — | Timer paused/resumed/changed |
| `--timer-cancelled-command` | — | Timer cancelled |
| `--timer-finished-command` | — | Timer finished |
| `--timer-finished-wav` | — | WAV file to play |
| `--timer-finished-wav-repeat` | `1 0` | `<plays> <delay_seconds>` |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--timer-started-command` | — | Таймер запущен |
| `--timer-updated-command` | — | Таймер изменён/пауза/возобновление |
| `--timer-cancelled-command` | — | Таймер отменён |
| `--timer-finished-command` | — | Таймер завершён |
| `--timer-finished-wav` | — | WAV файл для воспроизведения |
| `--timer-finished-wav-repeat` | `1 0` | `<повторы> <задержка_сек>` |
**Example:**
**Пример:**
```bash
--timer-finished-wav /path/to/timer.wav \
--timer-finished-wav-repeat 3 1.0
@@ -142,32 +142,32 @@ Quick reference for all CLI flags and settings.
---
## 🛰️ Satellite (`--uri`, `--name`, `--area`)
## 🛰️ Спутник (`--uri`, `--name`, `--area`)
| Flag | Default | Description |
|------|---------|-------------|
| `--uri` | **required** | Satellite URI (`tcp://0.0.0.0:10700`) |
| `--name` | Wyoming Satellite | Satellite name |
| `--area` | — | Area name (for Home Assistant) |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--uri` | **требуется** | URI спутника (`tcp://0.0.0.0:10700`) |
| `--name` | Wyoming Satellite | Имя спутника |
| `--area` | — | Имя зоны (для Home Assistant) |
---
## 🔧 Debug & Discovery (`--debug*`, `--zeroconf*`)
## 🔧 Отладка и обнаружение (`--debug*`, `--zeroconf*`)
| Flag | Default | Description |
|------|---------|-------------|
| `--debug` | false | Enable DEBUG logging |
| `--debug-recording-dir` | None | Directory for audio recording |
| `--no-zeroconf` | false | Disable Zeroconf discovery |
| `--zeroconf-name` | MAC address | Name for Zeroconf |
| `--zeroconf-host` | Auto | Host for Zeroconf |
| `--log-format` | BASIC | Log format string |
| Флаг | По умолчанию | Описание |
|------|--------------|----------|
| `--debug` | false | DEBUG логирование |
| `--debug-recording-dir` | None | Папка для записи аудио |
| `--no-zeroconf` | false | Отключить Zeroconf |
| `--zeroconf-name` | MAC address | Имя для Zeroconf |
| `--zeroconf-host` | Авто | Хост для Zeroconf |
| `--log-format` | BASIC | Формат логов |
---
## 📊 Operating Modes
## 📊 Режимы работы
### Mode 1: Always Streaming (no VAD, no wake)
### Режим 1: Always Streaming (без VAD, без wake)
```bash
python3 -m wyoming_satellite \
@@ -177,11 +177,11 @@ python3 -m wyoming_satellite \
--snd-command 'aplay -r 22050 -c 1 -f S16_LE -t raw'
```
**Use case:** Lowest latency, always streaming to HA.
**Применение:** Минимальная задержка, постоянный стриминг в HA.
---
### Mode 2: VAD Streaming (stream after speech detected)
### Режим 2: VAD Streaming (стрим после обнаружения речи)
```bash
python3 -m wyoming_satellite \
@@ -195,11 +195,11 @@ python3 -m wyoming_satellite \
--vad-energy-threshold 200
```
**Use case:** Privacy-focused, stream only when speaking.
**Применение:** Приватность, стрим только при разговоре.
---
### Mode 3: Wake Streaming (local wake word detection)
### Режим 3: Wake Streaming (локальная детекция wake word)
```bash
python3 -m wyoming_satellite \
@@ -212,11 +212,11 @@ python3 -m wyoming_satellite \
--wake-word-name "привет придурок"
```
**Use case:** "Hey Google" style, full local wake word.
**Применение:** Стиль "Hey Google", полная локальная активация.
---
### Mode 4: With Event Service (LED, MQTT, notifications)
### Режим 4: С Event Service (LED, MQTT, уведомления)
```bash
python3 -m wyoming_satellite \
@@ -231,12 +231,12 @@ python3 -m wyoming_satellite \
--transcript-command 'examples/commands/transcript.sh'
```
**Use case:** Full integration with LED, MQTT, external scripts.
**Применение:** Полная интеграция с LED, MQTT, внешними скриптами.
---
## 🔗 Related
## 🔗 Связанное
- [Architecture Overview](architecture/overview.md)
- [Deployment Guide](../../DEPLOY.md)
- [MQTT LED Integration](integration/mqtt-led.md)
- [Архитектура](architecture/overview.md)
- [Руководство по развёртыванию](../../DEPLOY.md)
- [MQTT LED интеграция](integration/mqtt-led.md)