Files
linux-voice-assistant/docs/linux-voice-assistant-2mic-install.md
T
2025-09-27 08:56:53 -07:00

9.5 KiB
Raw Blame History

Linux Voice Assistant on RaspberryPi with ReSpeaker 2‑Mic — Installation & Configuration Guide

Created using ChatGPT 5 with the following prompt:

      Using the following github document as a guide
      https://github.com/rhasspy/wyoming-satellite/blob/master/docs/tutorial_2mic.md,
      take the attached bash history of commands and create a similar document
      detailing the installation and configuration of this linux-voice-assistant project.

Modeled after the Wyoming Satellite two‑mic tutorial, adapted from actual shell history.

This guide reproduces a working setup of the linux-voice-assistant project with Wyoming OpenWakeWord or MicroWakeWord on a Raspberry PI Zero 2W and a Respeaker 2‑mic HAT (e.g., seeed-2mic-voicecard). It assumes a fresh system with sudo access and the default "pi" user. Included is the option to use PipeWire or PulseAudio instead of ALSA.

Prerequisites

  • Raspberry Pi OS Lite (64-bit)
    • Linux 6.12.34+rpt-rpi-v8 #1 SMP PREEMPT Debian 1:6.12.34-1+rpt1~bookworm
    • (2025-06-26) aarch64 GNU/Linux
  • Default Python 3.11+ recommended
  • A ReSpeaker 2‑mic sound card or compatable
  • Network access to your Home Assistant instance

1. Install system packages

sudo apt update
sudo apt upgrade
sudo apt install libportaudio2 build-essential git \
      libmpv-dev mpv python3.11-dev avahi-daemon avahi-utils
sudo reboot

2. Get the code

git clone https://github.com/imonlinux/linux-voice-assistant.git

3. Install ReSpeaker drivers

chmod +x ~/linux-voice-assistant/respeaker2mic/install-respeaker-drivers.sh
sudo ~/linux-voice-assistant/respeaker2mic/install-respeaker-drivers.sh 
sudo reboot

4. Wyoming OpenWakeWord (OWW), skip to step 5. if using MicroWakeWord (MWW)

git clone https://github.com/rhasspy/wyoming-openwakeword.git
cp ~/linux-voice-assistant/wyoming-openwakeword/requirements.txt ~/wyoming-openwakeword/requirements.txt
cd wyoming-openwakeword/
script/setup

5. Linux Voice Assistant (LVA)

cd ~/linux-voice-assistant/
script/setup

6. Choose your install option "Choose your Adventure!"

Pick one of the following install paths. Expand a section to see the exact steps.

Tip: PipeWire options run services in user mode (requires loginctl enable-linger); PulseAudio/ALSA options run services in system mode.

PipeWire + OpenWakeWord (user-mode services)

Prep (PipeWire): Follow the PipeWire tutorial first: the tutorial.

Enable linger (required for user services to start after reboot):

sudo loginctl enable-linger pi

Install user-mode services:

mkdir -p ~/.config/systemd/user

# LVA
cp ~/linux-voice-assistant/service/user-pw-oww-linux-voice-assistant.service.service    ~/.config/systemd/user/linux-voice-assistant.service

# OWW
cp ~/linux-voice-assistant/service/user-wyoming-openwakeword.service.service    ~/.config/systemd/user/wyoming-openwakeword.service

Enable & start:

systemctl --user daemon-reload
systemctl --user enable --now wyoming-openwakeword.service
systemctl --user enable --now linux-voice-assistant.service

Verify:

systemctl --user status linux-voice-assistant wyoming-openwakeword --no-pager -l
PipeWire + MicroWakeWord (user-mode services)

Prep (PipeWire): Follow the PipeWire tutorial first: the tutorial.

Enable linger:

sudo loginctl enable-linger pi

Install user-mode service:

mkdir -p ~/.config/systemd/user
cp ~/linux-voice-assistant/service/user-pw-mww-linux-voice-assistant.service.service    ~/.config/systemd/user/linux-voice-assistant.service

Enable & start:

systemctl --user daemon-reload
systemctl --user enable --now linux-voice-assistant.service

Verify:

systemctl --user status linux-voice-assistant --no-pager -l
PulseAudio + OpenWakeWord (system services)

Prep (PulseAudio): Follow the PulseAudio tutorial first: the tutorial.

Install LVA (system) + tuning drop-in:

sudo cp ~/linux-voice-assistant/service/pa-oww-linux-voice-assistant.service         /etc/systemd/system/linux-voice-assistant.service

sudo mkdir -p /etc/systemd/system/linux-voice-assistant.service.d
sudo cp ~/linux-voice-assistant/service/10-tuning.conf         /etc/systemd/system/linux-voice-assistant.service.d/10-tuning.conf

Install OWW (system):

sudo cp ~/linux-voice-assistant/service/wyoming-openwakeword.service         /etc/systemd/system/wyoming-openwakeword.service

Enable & start:

sudo systemctl daemon-reload
sudo systemctl enable --now wyoming-openwakeword linux-voice-assistant
sudo systemctl status linux-voice-assistant wyoming-openwakeword --no-pager -l
PulseAudio + MicroWakeWord (system services)

Prep (PulseAudio): Follow the PulseAudio tutorial first: the tutorial.

Install LVA (system) + tuning drop-in:

sudo cp ~/linux-voice-assistant/service/pa-mww-linux-voice-assistant.service         /etc/systemd/system/linux-voice-assistant.service

sudo mkdir -p /etc/systemd/system/linux-voice-assistant.service.d
sudo cp ~/linux-voice-assistant/service/10-tuning.conf         /etc/systemd/system/linux-voice-assistant.service.d/10-tuning.conf

Enable & start:

sudo systemctl daemon-reload
sudo systemctl enable --now linux-voice-assistant
sudo systemctl status linux-voice-assistant --no-pager -l
ALSA + OpenWakeWord (system services)

No extra audio stack needed. If you’re using a different sound card/driver, confirm device names:

arecord -l
aplay -l

Install LVA (system):

sudo cp ~/linux-voice-assistant/service/alsa-oww-linux-voice-assistant.service         /etc/systemd/system/linux-voice-assistant.service

Install OWW (system):

sudo cp ~/linux-voice-assistant/service/wyoming-openwakeword.service         /etc/systemd/system/wyoming-openwakeword.service

Enable & start:

sudo systemctl daemon-reload
sudo systemctl enable --now wyoming-openwakeword linux-voice-assistant
sudo systemctl status linux-voice-assistant wyoming-openwakeword --no-pager -l
ALSA + MicroWakeWord (system services)

No extra audio stack needed. If you’re using a different sound card/driver, confirm device names:

arecord -l
aplay -l

Install LVA (system):

sudo cp ~/linux-voice-assistant/service/alsa-mww-linux-voice-assistant.service         /etc/systemd/system/linux-voice-assistant.service

Enable & start:

sudo systemctl daemon-reload
sudo systemctl enable --now linux-voice-assistant
sudo systemctl status linux-voice-assistant --no-pager -l
Optional: Advertise LVA to Home Assistant via Avahi

Generate & install ESPHome-style mDNS service:

chmod +x ~/linux-voice-assistant/script/gen-esphome-avahi.sh
sudo ~/linux-voice-assistant/script/gen-esphome-avahi.sh
sudo systemctl restart avahi-daemon.service

7. Connect to Home Assistant

If HA does not discover the new LVA:

  1. In Home Assistant, go to "Settings" -> "Device & services"
  2. Click the "Add integration" button
  3. Choose "ESPHome" and then "Set up another instance of ESPHome"
  4. Enter the IP address of your voice satellite with port 6053
  5. Click "Submit"
  6. During the registration process, use the wake word that you configured in your linux-voice-assistant.service file. Default is "alexa".

8. Verification

  • Use "journalctl -u linux-voice-assistant.service -f" to check for errors for ALSA and PluseAudio. Debugging is enabled.

  • Use "journalctl --user -u linux-voice-assistant.service -f" to check for errors when using PipeWire. Debugging is enabled.

  • Expect logs like Connected to Home Assistant

  • Look for [OWW] Detection: name=... followed by re-arming/cycling

  • Ask: “What time is it?” and confirm TTS reply

  • If you do not get a voice response, check the Voice Assistant that you choose during registration has a voice assigned to it.

    Settings -> Voice assistants -> Assist (the assistant you configured) -> Text-to-speech -> Voice

9. Change OWW detection model

After the LVA is registered with HA, you can change the Wake Word model used in the ESPHome Voice Assistant entity.

Project OWW models include:

alexa_v0.1.tflite       -> Alexa
hey_jarvis_v0.1.tflite  -> Hey Jarvis
hey_mycroft_v0.1.tflite -> Hey Mycroft
hey_rhasspy_v0.1.tflite -> Hey Rhasspy
ok_nabu_v0.1.tflite     -> OK Nabo **(I had to say OK Nobu)**

Additional community provided OWW models available from this repository: https://github.com/fwartner/home-assistant-wakewords-collection

You just copy the ones you want into the ~/wyoming-openwakeword/wyoming-openwakeword/models directory. If a model is currupted, the wyoming-openwakeword.service will fail to start.

Word of warning. I have had problems with some of the community provided wake words. YMMV

10. Switching between OWW and MWW. Or ALSA and PA see section 7.

If you intend to switch from PA to ALSA, you must first stop the pusleaudio.service.

sudo systemctl stop pulseaudio.service
sudo systemctl disable pulseaudio.service