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:
@@ -1,20 +1,20 @@
|
||||
# README — VoskWyoming Satellite
|
||||
|
||||
Remote voice satellite using the [Wyoming protocol](https://github.com/rhasspy/wyoming) for Home Assistant.
|
||||
Удалённый голосовой спутник, использующий [Wyoming protocol](https://github.com/rhasspy/wyoming) для Home Assistant.
|
||||
|
||||
[](https://www.openhomefoundation.org/)
|
||||
|
||||
## 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
|
||||
- 🏠 **Интеграция с Home Assistant** — Нативная поддержка Wyoming протокола
|
||||
- 🎤 **Локальная детекция wake word** — Vosk, русские фразы ("привет дроид" и др.)
|
||||
- 🔇 **Аудио улучшения** — Шумоподавление WebRTC и автоматическое усиление
|
||||
- 💡 **MQTT LED управление** — ReSpeaker XVF3800 4-MIC с авто-обнаружением HA
|
||||
- 🎯 **Voice Activity Detection** — Silero или WebRTC VAD для приватной работы
|
||||
|
||||
## Quick Start
|
||||
## Быстрый старт
|
||||
|
||||
### 1. Install
|
||||
### 1. Установка
|
||||
|
||||
```bash
|
||||
git clone <repository-url> ~/projects/Satellite
|
||||
@@ -25,73 +25,74 @@ source ~/.venv_satellite/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 2. Install systemd Services
|
||||
### 2. Установка systemd сервисов
|
||||
|
||||
```bash
|
||||
sudo ./install_systemd_services.sh
|
||||
```
|
||||
|
||||
### 3. Start
|
||||
### 3. Запуск
|
||||
|
||||
```bash
|
||||
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**
|
||||
В Home Assistant: **Настройки → Устройства и сервисы → Найдено → Wyoming Satellite → Настроить**
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
## Документация
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| [**Deployment**](DEPLOY.md) | Full deployment guide with systemd services |
|
||||
| [**Tutorials**](docs/tutorials/) | Step-by-step setup for different hardware |
|
||||
| [**Architecture**](docs/architecture/overview.md) | How Wyoming Satellite works |
|
||||
| [**MQTT LED**](docs/integration/mqtt-led.md) | LED control with Home Assistant |
|
||||
| [**VAD Integration**](docs/integration/vad-wakeword.md) | Technical integration guide |
|
||||
| Руководство | Описание |
|
||||
|-------------|----------|
|
||||
| [**Развёртывание**](DEPLOY.md) | Полное руководство по развёртыванию |
|
||||
| [**Tutorials**](docs/tutorials/) | Пошаговые руководства для разного оборудования |
|
||||
| [**Архитектура**](docs/architecture/overview.md) | Как работает Wyoming Satellite |
|
||||
| [**MQTT LED**](docs/integration/mqtt-led.md) | LED управление с Home Assistant |
|
||||
| [**VAD/Wake интеграция**](docs/integration/vad-wakeword.md) | Техническое руководство |
|
||||
| [**Настройки**](docs/settings-cheatsheet.md) | Шпаргалка по CLI флагам |
|
||||
|
||||
### Tutorials
|
||||
|
||||
- [**2-MIC HAT**](docs/tutorials/2mic-hat.md) — Raspberry Pi + ReSpeaker 2-MIC HAT
|
||||
- [**Installer**](docs/tutorials/installer.md) — Interactive installer guide
|
||||
- [**Установщик**](docs/tutorials/installer.md) — Интерактивный установщик
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
## Требования
|
||||
|
||||
- **Python 3.9+**
|
||||
- **Linux** (tested on Raspberry Pi OS)
|
||||
- **Microphone** (USB or HAT)
|
||||
- **Optional:** ReSpeaker XVF3800 USB 4-MIC Array (for LED control)
|
||||
- **Linux** (протестировано на Raspberry Pi OS)
|
||||
- **Микрофон** (USB или HAT)
|
||||
- **Опционально:** ReSpeaker XVF3800 USB 4-MIC Array (для LED управления)
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
├── wyoming_satellite/ # Основной Python пакет
|
||||
├── examples/ # Примеры скриптов (LED, MQTT, конфиги)
|
||||
├── services/ # systemd сервис файлы
|
||||
├── docs/ # Документация
|
||||
│ ├── tutorials/ # Руководства по оборудованию
|
||||
│ ├── integration/ # Технические руководства
|
||||
│ ├── deployment/ # Руководства по развёртыванию
|
||||
│ └── architecture/ # Документация по архитектуре
|
||||
├── sounds/ # Аудио файлы (awake.wav и др.)
|
||||
├── scripts/ # Вспомогательные скрипты
|
||||
└── tests/ # Юнит тесты
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
## Конфигурация
|
||||
|
||||
### Wake Words (Russian)
|
||||
### Wake words (русские)
|
||||
|
||||
Edit `start_satellite.sh`:
|
||||
Отредактируйте `start_satellite.sh`:
|
||||
|
||||
```bash
|
||||
--wake-word-name "привет дроид"
|
||||
@@ -99,14 +100,14 @@ Edit `start_satellite.sh`:
|
||||
--wake-word-name "привет жопа с ушами"
|
||||
```
|
||||
|
||||
### Audio Settings
|
||||
### Аудио настройки
|
||||
|
||||
```bash
|
||||
--mic-noise-suppression 2
|
||||
--mic-auto-gain 5
|
||||
```
|
||||
|
||||
### VAD Settings
|
||||
### VAD настройки
|
||||
|
||||
```bash
|
||||
--vad
|
||||
@@ -116,31 +117,31 @@ Edit `start_satellite.sh`:
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
## Разработка
|
||||
|
||||
```bash
|
||||
# Linting
|
||||
# Линтинг
|
||||
pylint wyoming_satellite/
|
||||
mypy wyoming_satellite/
|
||||
|
||||
# Tests
|
||||
# Тесты
|
||||
pytest tests/
|
||||
|
||||
# Format
|
||||
# Форматирование
|
||||
black wyoming_satellite/
|
||||
isort wyoming_satellite/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Video Tutorials
|
||||
## Видео уроки
|
||||
|
||||
- [Wyoming Voice Satellite with ChatGPT](https://www.youtube.com/watch?v=eTKgc0YDCwE)
|
||||
- [Local ChatGPT Voice Assistant](https://www.youtube.com/watch?v=pAKqKTkx5X4)
|
||||
- [Wyoming Voice Satellite с ChatGPT](https://www.youtube.com/watch?v=eTKgc0YDCwE)
|
||||
- [Локальный голосовой ассистент с ChatGPT](https://www.youtube.com/watch?v=pAKqKTkx5X4)
|
||||
|
||||
---
|
||||
|
||||
## External Resources
|
||||
## Внешние ресурсы
|
||||
|
||||
- [Wyoming Protocol](https://github.com/rhasspy/wyoming)
|
||||
- [Home Assistant Integration](https://www.home-assistant.io/integrations/wyoming)
|
||||
@@ -151,6 +152,6 @@ isort wyoming_satellite/
|
||||
|
||||
## License
|
||||
|
||||
This project is part of the Open Home Foundation ecosystem.
|
||||
Этот проект является частью экосистемы Open Home Foundation.
|
||||
|
||||
[](https://www.openhomefoundation.org/)
|
||||
|
||||
Reference in New Issue
Block a user