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/integration/mqtt-led.md
+77 -70
View File
@@ -1,35 +1,35 @@
# MQTT LED Control
# MQTT LED Управление
Integration guide for ReSpeaker LED control via MQTT and Home Assistant.
Руководство по интеграции LED управления ReSpeaker через MQTT и Home Assistant.
## Overview
## Обзор
The LED service (`examples/wyoming-led.py`) provides:
LED сервис (`examples/wyoming-led.py`) предоставляет:
- **Light entity** — Control LED brightness and color
- **Sensor entity** — Satellite state (idle, listening, speaking)
- **Number entities** — 7 sliders for fine-grained control
- **MQTT Discovery** — Auto-configuration in Home Assistant
- **Light сущность** — Управление яркостью и цветом LED
- **Sensor сущность** — Состояние спутника (ожидание, слушание, говорение)
- **Number сущности** — 7 слайдеров для точной настройки
- **MQTT Discovery** — Авто-конфигурация в Home Assistant
## Architecture
## Архитектура
```
┌──────────────────┐ MQTT ┌──────────────────┐
│ Home Assistant │◄─────────────►│ wyoming-led.py │
│ │ │ (port 10501) │
│ │ │ (порт 10501) │
└──────────────────┘ └────────┬─────────┘
│
│ Wyoming Events
│ (port 10500)
│ (порт 10500)
┌────────▼─────────┐
│ Satellite │
│ (port 10700) │
│ (порт 10700) │
└──────────────────┘
```
## Installation
## Установка
### 1. Install Dependencies
### 1. Установка зависимостей
```bash
cd ~/projects/Satellite
@@ -37,18 +37,18 @@ source ~/.venv_satellite/bin/activate
pip install paho-mqtt
```
### 2. Configure MQTT Settings
### 2. Настройка MQTT
Edit `examples/wyoming-led.py`:
Отредактируйте `examples/wyoming-led.py`:
```python
MQTT_BROKER = "192.168.200.100" # Your MQTT broker
MQTT_BROKER = "192.168.200.100" # Ваш MQTT брокер
MQTT_PORT = 1883
MQTT_USER = "mqtt"
MQTT_PASS = "mqtt"
```
### 3. Create systemd Service
### 3. Создание systemd сервиса
```bash
sudo nano /etc/systemd/system/wyoming-led.service
@@ -56,7 +56,7 @@ sudo nano /etc/systemd/system/wyoming-led.service
```ini
[Unit]
Description=Wyoming LED Service with MQTT
Description=Wyoming LED Service с MQTT
After=network.target mosquitto.service
[Service]
@@ -71,46 +71,46 @@ Restart=always
WantedBy=multi-user.target
```
### 4. Enable Service
### 4. Включение сервиса
```bash
sudo systemctl daemon-reload
sudo systemctl enable --now wyoming-led.service
```
## MQTT Topics
## MQTT топики
| Topic | Direction | Description |
|-------|-----------|-------------|
| `wyoming/led/command` | HA → Script | Light commands (on/off, color, brightness) |
| `wyoming/led/brightness/set` | HA → Script | Set brightness (0-255) |
| `wyoming/led/brightness/state` | Script → HA | Current brightness |
| `wyoming/led/state` | Script → HA | LED state (on/off) |
| `wyoming/led/availability` | Script → HA | Online/offline |
| `wyoming/satellite/state` | Script → HA | Satellite state |
| Топик | Направление | Описание |
|-------|-------------|----------|
| `wyoming/led/command` | HA → Скрипт | Команды света (вкл/выкл, цвет, яркость) |
| `wyoming/led/brightness/set` | HA → Скрипт | Установка яркости (0-255) |
| `wyoming/led/brightness/state` | Скрипт → HA | Текущая яркость |
| `wyoming/led/state` | Скрипт → HA | Состояние LED (вкл/выкл) |
| `wyoming/led/availability` | Скрипт → HA | Онлайн/офлайн статус |
| `wyoming/satellite/state` | Скрипт → HA | Состояние спутника |
## Home Assistant Entities
## Сущности Home Assistant
After discovery, you'll see:
После discovery вы увидите:
- **Light:** `light.wyoming_led` — RGB control
- **Sensor:** `sensor.wyoming_satellite_state` — Current state
- **Number:** `number.wyoming_led_brightness` — Brightness slider
- **Number:** `number.wyoming_led_red/green/blue` — Color sliders
- **Number:** `number.wyoming_led_idle/listening/speaking` — State colors
- **Light:** `light.wyoming_led` — RGB управление
- **Sensor:** `sensor.wyoming_satellite_state` — Текущее состояние
- **Number:** `number.wyoming_led_brightness` — Слайдер яркости
- **Number:** `number.wyoming_led_red/green/blue` — Слайдеры цвета
- **Number:** `number.wyoming_led_idle/listening/speaking` — Цвета состояний
## LED States
## Состояния LED
| State | Color | Behavior |
|-------|-------|----------|
| Idle | Blue (dim) | Breathing effect |
| Listening | Cyan | Solid |
| Speaking | Green | Solid |
| Error | Red | Blinking |
| Состояние | Цвет | Поведение |
|-----------|------|-----------|
| Ожидание (Idle) | Синий (тусклый) | Дыхательный эффект |
| Слушание (Listening) | Голубой | Постоянный |
| Говорение (Speaking) | Зелёный | Постоянный |
| Ошибка (Error) | Красный | Мигание |
## Brightness Configuration
## Настройка яркости
LED brightness is stored in `examples/led_brightness_config.json`:
Яркость LED хранится в `examples/led_brightness_config.json`:
```json
{
@@ -121,55 +121,62 @@ LED brightness is stored in `examples/led_brightness_config.json`:
}
```
This file is auto-created and should be excluded from git tracking:
Этот файл создаётся автоматически и должен быть исключён из git tracking:
```bash
git update-index --assume-unchanged examples/led_brightness_config.json
```
## Troubleshooting
## Диагностика
### LEDs not responding
### LED не реагирует
```bash
# Check service status
# Проверка статуса сервиса
sudo systemctl status wyoming-led.service
# View logs
# Просмотр логов
journalctl -u wyoming-led.service -f
# Test manually
# Тест вручную
python3 examples/wyoming-led.py --debug
```
### MQTT connection failed
### MQTT подключение не удалось
- Verify broker is running: `sudo systemctl status mosquitto`
- Check credentials in `wyoming-led.py`
- Test connection: `mosquitto_sub -t 'wyoming/led/#' -v`
- Проверьте, что брокер запущен: `sudo systemctl status mosquitto`
- Проверьте учётные данные в `wyoming-led.py`
- Тест подключения: `mosquitto_sub -t 'wyoming/led/#' -v`
### ReSpeaker not detected
### ReSpeaker не обнаружен
```bash
# Check USB devices
# Проверка USB устройств
lsusb | grep -i respeaker
# Test xvf_host.py
# Тест xvf_host.py
python3 examples/xvf_host.py --help
```
## Hardware Support
## Поддерживаемое оборудование
| Device | Support | Notes |
|--------|---------|-------|
| ReSpeaker XVF3800 (USB 4-MIC) | ✅ Full | Recommended |
| ReSpeaker 2-MIC HAT | ✅ Full | Requires GPIO |
| ReSpeaker 4-MIC HAT | ✅ Full | Requires GPIO |
| Generic USB mic | ⚠️ Partial | No LED control |
| Устройство | Поддержка | Примечания |
|------------|-----------|------------|
| ReSpeaker XVF3800 (USB 4-MIC) | ✅ Полная | Рекомендуется |
| ReSpeaker 2-MIC HAT | ✅ Полная | Требуется GPIO |
| ReSpeaker 4-MIC HAT | ✅ Полная | Требуется GPIO |
| Обычный USB микрофон | ⚠️ Частичная | Без LED управления |
## Related Files
## Связанные файлы
- `examples/wyoming-led.py` — Main LED control script
- `examples/xvf_host.py` — ReSpeaker XVF3800 driver
- `examples/led_brightness_config.json` — Brightness settings
- `services/wyoming-event.service` — Event service (alternative)
- `examples/wyoming-led.py` — Основной скрипт LED управления
- `examples/xvf_host.py` — Драйвер ReSpeaker XVF3800
- `examples/led_brightness_config.json` — Настройки яркости
- `services/wyoming-event.service` — Сервис событий (альтернатива)
---
## 🔗 Связанное
- [Руководство по развёртыванию](../../DEPLOY.md)
- [Настройка systemd сервисов](deployment/systemd-services.md)