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/tutorials/2mic-hat.md
+102 -94
View File
@@ -1,24 +1,24 @@
# 2-MIC HAT Tutorial
Create a voice satellite using a [Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/) and a [ReSpeaker 2Mic HAT](https://wiki.keyestudio.com/Ks0314_keyestudio_ReSpeaker_2-Mic_Pi_HAT_V1.0).
Создание голосового спутника на [Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/) и [ReSpeaker 2Mic HAT](https://wiki.keyestudio.com/Ks0314_keyestudio_ReSpeaker_2-Mic_Pi_HAT_V1.0).
**Prerequisites:** See [Deployment Guide](../../DEPLOY.md) for base installation.
**Предварительные требования:** См. [Руководство по развёртыванию](../../DEPLOY.md) для базовой установки.
## Install OS
## Установка ОС
Follow instructions to [install Raspberry Pi OS](https://www.raspberrypi.com/software/). Under "Choose OS", pick "Raspberry Pi OS (other)" and "Raspberry Pi OS (**64-bit**) Lite".
Следуйте инструкциям по [установке Raspberry Pi OS](https://www.raspberrypi.com/software/). В разделе "Choose OS" выберите "Raspberry Pi OS (other)" и "Raspberry Pi OS (**64-bit**) Lite".
When asking if you'd like to apply customization settings, choose "Edit Settings" and:
Когда спросят о применении настроек кастомизации, выберите "Edit Settings" и:
* Set a username/password
* Configure the wireless LAN
* Under the Services tab, enable SSH and use password authentication
* Установите имя пользователя/пароль
* Настройте беспроводную LAN
* На вкладке Services включите SSH и используйте аутентификацию по паролю
## Install Software
## Установка ПО
After flashing and booting the satellite, connect to it over SSH using the username/password you configured during flashing.
После прошивки и загрузки спутника, подключитесь к нему по SSH, используя имя пользователя/пароль, настроенные при прошивке.
**On the satellite**, make sure system dependencies are installed:
**На спутнике**, убедитесь, что системные зависимости установлены:
```sh
sudo apt-get update
@@ -27,26 +27,26 @@ sudo apt-get install --no-install-recommends \
python3-venv
```
Clone the `wyoming-satellite` repository:
Склонируйте репозиторий `wyoming-satellite`:
```sh
git clone https://github.com/rhasspy/wyoming-satellite.git
```
If you have the ReSpeaker 2Mic or 4Mic HAT, recompile and install the drivers (this will take really long time):
Если у вас ReSpeaker 2Mic или 4Mic HAT, перекомпилируйте и установите драйверы (это займёт много времени):
```sh
cd wyoming-satellite/
sudo bash etc/install-respeaker-drivers.sh
```
After install the drivers, you must reboot the satellite:
После установки драйверов необходимо перезагрузить спутник:
```sh
sudo reboot
```
Once the satellite has rebooted, reconnect over SSH and continue the installation:
После перезагрузки подключитесь снова по SSH и продолжите установку:
```sh
cd wyoming-satellite/
@@ -58,23 +58,23 @@ python3 -m venv .venv
-e '.[all]'
```
If the installation was successful, you should be able to run:
Если установка прошла успешно, вы сможете запустить:
```sh
script/run --help
```
## Determine Audio Devices
## Определение аудиоустройств
Picking the correct microphone/speaker devices is critical for the satellite to work. We'll do a test recording and playback in this section.
Правильный выбор устройств микрофона/динамика критически важен для работы спутника. В этом разделе мы сделаем тестовую запись и воспроизведение.
List your available microphones with:
Список доступных микрофонов:
```sh
arecord -L
```
If you have the ReSpeaker 2Mic HAT, you should see:
Если у вас ReSpeaker 2Mic HAT, вы увидите:
```
plughw:CARD=seeed2micvoicec,DEV=0
@@ -82,23 +82,23 @@ plughw:CARD=seeed2micvoicec,DEV=0
Hardware device with all software conversions
```
For other microphones, prefer ones that start with `plughw:` or just use `default` if you don't know what to use.
Для других микрофонов предпочитайте устройства, начинающиеся с `plughw:` или используйте `default`, если не знаете, что выбрать.
Record a 5 second sample from your chosen microphone:
Запишите 5-секундный образец с выбранного микрофона:
```sh
arecord -D plughw:CARD=seeed2micvoicec,DEV=0 -r 16000 -c 1 -f S16_LE -t wav -d 5 test.wav
```
Say something while `arecord` is running. If you get errors, try a different microphone device by changing `-D <device>`.
Скажите что-нибудь во время работы `arecord`. Если получили ошибки, попробуйте другое устройство микрофона, изменив `-D <device>`.
List your available speakers with:
Список доступных динамиков:
```sh
aplay -L
```
If you have the ReSpeaker 2Mic HAT, you should see:
Если у вас ReSpeaker 2Mic HAT, вы увидите:
```
plughw:CARD=seeed2micvoicec,DEV=0
@@ -106,21 +106,21 @@ plughw:CARD=seeed2micvoicec,DEV=0
Hardware device with all software conversions
```
For other speakers, prefer ones that start with `plughw:` or just use `default` if you don't know what to use.
Для других динамиков предпочитайте устройства, начинающиеся с `plughw:` или используйте `default`, если не знаете, что выбрать.
Play back your recorded sample WAV:
Воспроизведите записанный образец WAV:
```sh
aplay -D plughw:CARD=seeed2micvoicec,DEV=0 test.wav
```
You should hear your recorded sample. If there are problems, try a different speaker device by changing `-D <device>`.
Вы должны услышать записанный образец. Если есть проблемы, попробуйте другое устройство динамика, изменив `-D <device>`.
Make note of your microphone and speaker devices for the next step.
Запомните устройства микрофона и динамика для следующего шага.
## Running the Satellite
## Запуск спутника
In the `wyoming-satellite` directory, run:
В директории `wyoming-satellite` выполните:
```sh
script/run \
@@ -131,22 +131,23 @@ script/run \
--snd-command 'aplay -D plughw:CARD=seeed2micvoicec,DEV=0 -r 22050 -c 1 -f S16_LE -t raw'
```
Change the `-D <device>` for `arecord` and `aplay` to match the audio devices from the previous section.
You can set `--name <NAME>` to whatever you want, but it should stay the same every time you run the satellite.
Измените `-D <device>` для `arecord` и `aplay` в соответствии с аудиоустройствами из предыдущего раздела.
In Home Assistant, check the "Devices & services" section in Settings. After some time, you should see your satellite show up as "Discovered" (Wyoming Protocol). Click the "Configure" button and "Submit". Choose the area that your satellite is located, and click "Finish".
Вы можете установить `--name <NAME>` на любое значение, но оно должно оставаться одинаковым при каждом запуске спутника.
Your satellite should say "Streaming audio", and you can use the wake word of your preferred pipeline.
В Home Assistant проверьте раздел "Devices & services" в настройках. Через некоторое время вы увидите ваш спутник как "Discovered" (Wyoming Protocol). Нажмите кнопку "Configure" и "Submit". Выберите зону, где расположен ваш спутник, и нажмите "Finish".
## Create Services
Ваш спутник должен сказать "Streaming audio", и вы можете использовать wake word предпочитаемого пайплайна.
You can run wyoming-satellite as a systemd service by first creating a service file:
## Создание сервисов
``` sh
Вы можете запустить wyoming-satellite как systemd сервис, создав файл сервиса:
```sh
sudo systemctl edit --force --full wyoming-satellite.service
```
Paste in the following template, and change both `/home/pi` and the `script/run` arguments to match your set up:
Вставьте следующий шаблон и измените `/home/pi` и аргументы `script/run` в соответствии с вашей настройкой:
```text
[Unit]
@@ -165,45 +166,45 @@ RestartSec=1
WantedBy=default.target
```
Save the file and exit your editor. Next, enable the service to start at boot and run it:
Сохраните файл и выйдите из редактора. Далее включите сервис для автозагрузки и запустите:
``` sh
```sh
sudo systemctl enable --now wyoming-satellite.service
```
(you may need to hit CTRL+C to get back to a shell prompt)
(возможно, вам придётся нажать CTRL+C, чтобы вернуться к командной оболочке)
With the service running, you can view logs in real-time with:
После запуска сервиса вы можете просматривать логи в реальном времени:
``` sh
```sh
journalctl -u wyoming-satellite.service -f
```
If needed, disable and stop the service with:
При необходимости отключите и остановите сервис:
``` sh
```sh
sudo systemctl disable --now wyoming-satellite.service
```
## Audio Enhancements
## Аудио улучшения
You can run the satellite with automatic gain control and noise suppression:
Вы можете запустить спутник с автоматическим усилением и шумоподавлением:
``` sh
```sh
script/run \
... \
--mic-auto-gain 5 \
--mic-noise-suppression 2
```
Automatic gain control is between 0-31 dbFS, which 31 being the loudest.
Noise suppression is from 0-4, with 4 being maximum suppression (may cause audio distortion).
Автоматическое усиление от 0 до 31 dbFS, где 31 — самое громкое.
Шумоподавление от 0 до 4, где 4 — максимальное подавление (может вызывать искажения аудио).
You can also use `--mic-volume-multiplier X` to multiply all audio samples by `X`. For example, using 2 for `X` will double the microphone volume (but may cause audio distortion). The corresponding `--snd-volume-multiplier` does the same for audio playback.
Вы также можете использовать `--mic-volume-multiplier X` для умножения всех аудиосэмплов на `X`. Например, использование 2 для `X` удвоит громкость микрофона (но может вызвать искажения). Соответствующий `--snd-volume-multiplier` делает то же самое для воспроизведения аудио.
## Local Wake Word Detection
## Локальная детекция Wake Word
Install the necessary system dependencies:
Установите необходимые системные зависимости:
```sh
sudo apt-get update
@@ -211,7 +212,7 @@ sudo apt-get install --no-install-recommends \
libopenblas-dev
```
From your home directory, install the openWakeWord Wyoming service:
Из домашней директории установите Wyoming сервис openWakeWord:
```sh
git clone https://github.com/rhasspy/wyoming-openwakeword.git
@@ -219,13 +220,13 @@ cd wyoming-openwakeword
script/setup
```
Create a systemd service for it:
Создайте systemd сервис для него:
``` sh
```sh
sudo systemctl edit --force --full wyoming-openwakeword.service
```
Paste in the following template, and change both `/home/pi` and the `script/run` arguments to match your set up:
Вставьте следующий шаблон и измените `/home/pi` и аргументы `script/run` в соответствии с вашей настройкой:
```text
[Unit]
@@ -242,15 +243,15 @@ RestartSec=1
WantedBy=default.target
```
Save the file and exit your editor.
Сохраните файл и выйдите из редактора.
You can now update your satellite service:
Теперь вы можете обновить сервис спутника:
``` sh
```sh
sudo systemctl edit --force --full wyoming-satellite.service
```
Update just the parts below:
Обновите только следующие части:
```text
[Unit]
@@ -266,34 +267,34 @@ ExecStart=/home/pi/wyoming-satellite/script/run ... --wake-uri 'tcp://127.0.0.1:
...
```
Reload and restart the satellite service:
Перезагрузите и перезапустите сервис спутника:
``` sh
```sh
sudo systemctl daemon-reload
sudo systemctl restart wyoming-satellite.service
```
You should see the wake service get automatically loaded:
Вы должны увидеть, что сервис wake загрузился автоматически:
``` sh
```sh
sudo systemctl status wyoming-satellite.service wyoming-openwakeword.service
```
They should all be "active (running)" and green.
Все они должны быть "active (running)" и зелёные.
Test out your satellite by saying "ok, nabu" and a voice command. Use `journalctl` to check the logs of services for errors:
Протестируйте спутник, сказав "ok, nabu" и голосовую команду. Используйте `journalctl` для проверки логов сервисов на наличие ошибок:
``` sh
```sh
journalctl -u wyoming-openwakeword.service -f
```
Make sure to run `sudo systemctl daemon-reload` every time you make changes to the service.
Убедитесь, что запускаете `sudo systemctl daemon-reload` каждый раз при внесении изменений в сервис.
## LED Service
## LED сервис
Example event services for the ReSpeaker 2Mic and 4Mic HATs are included in `wyoming-satellite/examples` that will change the LED color depending on the satellite state. The example below is for the 2Mic HAT, using `2mic_service.py`. If you're using the 4Mic HAT, use `4mic_service.py` instead as the LEDs and GPIO pins are slightly different.
Примеры сервисов событий для ReSpeaker 2Mic и 4Mic HAT включены в `wyoming-satellite/examples`, они изменяют цвет LED в зависимости от состояния спутника. Пример ниже для 2Mic HAT с использованием `2mic_service.py`. Если вы используете 4Mic HAT, используйте `4mic_service.py`, так как светодиоды и GPIO пины немного отличаются.
Install it from your home directory:
Установите его из домашней директории:
```sh
cd wyoming-satellite/examples
@@ -303,32 +304,31 @@ python3 -m venv --system-site-packages .venv
.venv/bin/pip3 install 'wyoming==1.5.2'
```
In case you use a ReSpeaker USB 4mic array v2.0, additionally install pixel-ring:
Если вы используете ReSpeaker USB 4mic array v2.0, дополнительно установите pixel-ring:
```sh
.venv/bin/pip3 install 'pixel-ring'
```
The `--system-site-packages` argument is used to access the pre-installed `gpiozero` and `spidev` Python packages. If these are **not already installed** in your system, run:
Аргумент `--system-site-packages` используется для доступа к предустановленным пакетам `gpiozero` и `spidev`. Если они **ещё не установлены** в вашей системе, выполните:
```sh
sudo apt-get install python3-spidev python3-gpiozero
```
Test the service with:
Протестируйте сервис:
```sh
.venv/bin/python3 2mic_service.py --help
```
Create a systemd service for it:
Создайте systemd сервис:
``` sh
```sh
sudo systemctl edit --force --full 2mic_leds.service
```
Paste in the following template, and change both `/home/pi` and the `script/run` arguments to match your set up:
Вставьте следующий шаблон и измените `/home/pi` и аргументы `script/run` в соответствии с вашей настройкой:
```text
[Unit]
@@ -345,15 +345,15 @@ RestartSec=1
WantedBy=default.target
```
Save the file and exit your editor.
Сохраните файл и выйдите из редактора.
You can now update your satellite service:
Теперь вы можете обновить сервис спутника:
``` sh
```sh
sudo systemctl edit --force --full wyoming-satellite.service
```
Update just the parts below:
Обновите только следующие части:
```text
[Unit]
@@ -369,28 +369,36 @@ ExecStart=/home/pi/wyoming-satellite/script/run ... --event-uri 'tcp://127.0.0.1
...
```
Reload and restart the satellite service:
Перезагрузите и перезапустите сервис спутника:
``` sh
```sh
sudo systemctl daemon-reload
sudo systemctl restart wyoming-satellite.service
```
You should see the service get automatically loaded:
Вы должны увидеть, что сервис загрузился автоматически:
``` sh
```sh
sudo systemctl status wyoming-satellite.service 2mic_leds.service
```
They should all be "active (running)" and green.
Все они должны быть "active (running)" и зелёные.
Try a voice command and see if the LEDs change. Use `journalctl` to check the logs of services for errors:
Попробуйте голосовую команду и посмотрите, реагируют ли светодиоды. Используйте `journalctl` для проверки логов сервисов на наличие ошибок:
``` sh
```sh
journalctl -u 2mic_leds.service -f
```
If you encounter any issues, you can add the `--debug` argument to the command line to increase the log level.
To control the brightness of the LEDS, use the `--led-brightness ` argument, which accepts integer numbers from 1 to 31.
Если возникли проблемы, добавьте аргумент `--debug` в командную строку для увеличения уровня логирования.
Make sure to run `sudo systemctl daemon-reload` every time you make changes to the service.
Для управления яркостью светодиодов используйте аргумент `--led-brightness`, который принимает целые числа от 1 до 31.
Убедитесь, что запускаете `sudo systemctl daemon-reload` каждый раз при внесении изменений в сервис.
---
## 🔗 Связанное
- [Руководство по развёртыванию](../../DEPLOY.md)
- [Интерактивный установщик](installer.md)