From ab8f09048ecb9be945d5baacc84f298c1a76f958 Mon Sep 17 00:00:00 2001 From: imonlinux <39863321+imonlinux@users.noreply.github.com> Date: Fri, 10 Oct 2025 18:42:44 -0700 Subject: [PATCH] Delete linux_voice_assistant/docs directory --- .../docs/install_pipewire.md | 92 ------ .../docs/install_pulseaudio.md | 239 -------------- .../linux-voice-assistant-2mic-install.md | 302 ------------------ 3 files changed, 633 deletions(-) delete mode 100644 linux_voice_assistant/docs/install_pipewire.md delete mode 100644 linux_voice_assistant/docs/install_pulseaudio.md delete mode 100644 linux_voice_assistant/docs/linux-voice-assistant-2mic-install.md diff --git a/linux_voice_assistant/docs/install_pipewire.md b/linux_voice_assistant/docs/install_pipewire.md deleted file mode 100644 index a5d8541..0000000 --- a/linux_voice_assistant/docs/install_pipewire.md +++ /dev/null @@ -1,92 +0,0 @@ -> -> Install Pipewire On Your Linux Voice Satellite -> - - -## 1. Connect to your Pi over SSH using the username/password you configured during flashing: - -```sh -ssh @ -``` - - -## 2. If already installed Disable/Stop the entire the Linux Voice Assistant service. If not installed, proceed to step (3.): - -```sh -sudo systemctl disable --now linux-voice-assistant.service -sudo rm /etc/systemd/system/linux-voice-assistant.service -``` - - -## 3. Install Pipewire packages and necessary PulseAudio utilities: - -```sh -sudo apt-get update -sudo apt-get install \ - pulseaudio-utils \ - pipewire wireplumber \ - pipewire-audio libspa-0.2-modules -``` - - -## 4. Reboot your Pi: - -```sh -sudo reboot -h now -``` - - -## 5. SSH back in to your Pi. (See step 1.) - - -## 6. Ensure Pipewire is runnining in user mode. - -```sh -systemctl --user status pipewire.service -systemctl --user status pipewire-pulse.service - -``` - - -## 7. (OPTIONAL) If plugging speakers into the headphone jack of the ReSpeaker, set the correct PulseAudio Sink Port: - -Run `pactl list sinks` and scroll to the bottom and notice your Active Port is probably "analog-output-speaker". Run the command below to output audio through the 3.5mm headphone jack. - -```sh -pactl set-sink-port alsa_output.platform-soc_sound.stereo-fallback "analog-output-headphones" -``` - -**Please note that if you are setting this up on a Raspberry Pi 3B or 4B, you need an additional step at this point to make it route the audio through the 2mic hat (and likely the 4mic one as well). Run the following command to do this.** - -```sh -pactl set-default-sink alsa_output.platform-soc_sound.stereo-fallback -``` - - -## 8. Test and make sure you can hear the wav file.: - -```sh -mpv --ao=pipewire --audio-device=default --audio-samplerate=44100 /usr/share/sounds/alsa/Front_Center.wav -``` - -If volume is low, set it to 150%. - -```sh -pactl set-sink-volume alsa_output.platform-soc_sound.stereo-fallback 150% -``` - -**Note that if you have a Raspbery Pi 3B or 4B, this may or may not seem to work, but it will output on the hat as intended.** - - -## 9. Reboot your Pi: (see step 4) - - -## 10. Done! Return to the tutorial to continue the Linux Voice Assistant install. - - - - - - - - diff --git a/linux_voice_assistant/docs/install_pulseaudio.md b/linux_voice_assistant/docs/install_pulseaudio.md deleted file mode 100644 index c8893a5..0000000 --- a/linux_voice_assistant/docs/install_pulseaudio.md +++ /dev/null @@ -1,239 +0,0 @@ -## Install PulseAudio On Your Wyoming Voice Satellite - -> Courtesy of https://github.com/FutureProofHomes/wyoming-enhancements/blob/master/snapcast/docs/2_install_pulseaudio.md with minor modifications - -## 1. Connect to your Pi over SSH using the username/password you configured during flashing: - -```sh -ssh @ -``` - - -## 2. If already installed Disable/Stop the entire the Linux Voice Assistant service temporarily. If not installed, proceed to step (3.): - -```sh -sudo systemctl disable --now linux-voice-assistant.service -``` - - -## 3. Install PulseAudio drivers and necessary utilities: - -```sh -sudo apt-get update -sudo apt-get install \ - pulseaudio \ - pulseaudio-utils \ - pamixer -``` - - -## 4. Reboot your Pi: - -```sh -sudo reboot -h now -``` - - -## 5. SSH back in to your Pi. (See step 1.) - - -## 6. Ensure PulseAudio is runnining in "system-wide mode". Per the [official instructions](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/) we first need to stop some existing services to be safe: - -```sh -sudo systemctl --global disable pulseaudio.service pulseaudio.socket -``` - - -## 7. It is also advisable to set `autospawn = no` in `/etc/pulse/client.conf`: - -```sh -sudo sed -i.bak \ - -e '$a### Disable autospawn' \ - -e '$aautospawn = no' \ - /etc/pulse/client.conf -``` - - -## 8. Create the `PulseAudio.service`: - -```sh -sudo cp ~/linux-voice-assistant/service/pulseaudio.service /etc/systemd/system/pulseaudio.service -``` - - -## 9. Start the `PulseAudio.service`. This will require you to type in your password a couple times. - -```sh -systemctl --system enable pulseaudio.service -``` - -```sh -systemctl --system start pulseaudio.service -``` - - -## 10. Ensure pi user is in the `pulse-access` group: -***If you aren't using the default "pi" user, put your user in here instead of "pi".*** -```sh -sudo sed -i '/^pulse-access:/ s/$/root,pi/' /etc/group -``` - - -## 11. Reboot your Pi: (see step 4) - - -## 12. (OPTIONAL) If plugging speakers into the headphone jack of the ReSpeaker, set the correct PulseAudio Sink Port: - -Run `pactl list sinks` and scroll to the bottom and notice your Active Port is probably "analog-output-speaker". Run the command below to output audio through the 3.5mm headphone jack. - -```sh -pactl set-sink-port 1 "analog-output-headphones" -``` - -**Please note that if you are setting this up on a Raspberry Pi 3B or 4B, you need an additional step at this point to make it route the audio through the 2mic hat (and likely the 4mic one as well). Run the following command to do this.** - -```sh -pactl set-default-sink alsa_output.platform-soc_sound.stereo-fallback -``` - - -## 13. Test and make sure you can hear the wav file.: - -```sh -paplay /usr/share/sounds/alsa/Front_Center.wav -``` - -**Note that if you have a Raspbery Pi 3B or 4B, this may or may not seem to work, but it will output on the hat as intended.** - - -## 14. The following modifications are specifically required for LVA's mpv_player.py to work with PA. If you do not have a working PA at this point, do not proceed.: -Backup current PA daemon.conf file. - -```bash -sudo cp /etc/pulse/daemon.conf{,.bak.$(date +%s)} -``` - -Update the PA /etc/pulse/daemon.conf file with required change. Replaces if present (commented or not). - -```bash -sudo sed -i -E \ - -e 's|^[#;[:space:]]*exit-idle-time\s*=.*$|exit-idle-time = -1|' \ - -e 's|^[#;[:space:]]*resample-method\s*=.*$|resample-method = trivial|' \ - -e 's|^[#;[:space:]]*flat-volumes\s*=.*$|flat-volumes = no|' \ - -e 's|^[#;[:space:]]*default-sample-rate\s*=.*$|default-sample-rate = 44100|' \ - -e 's|^[#;[:space:]]*alternate-sample-rate\s*=.*$|alternate-sample-rate = 48000|' \ - -e 's|^[#;[:space:]]*default-fragment-size-msec\s*=.*$|default-fragment-size-msec = 15|' \ - /etc/pulse/daemon.conf -``` - -Just in case the values were missing, may not be needed but shouldn't hurt. - -```bash -for kv in \ - 'exit-idle-time = -1' \ - 'resample-method = trivial' \ - 'flat-volumes = no' \ - 'default-sample-rate = 44100' \ - 'alternate-sample-rate = 48000' \ - 'default-fragment-size-msec = 15'; do - k="${kv%% =*}" - sudo grep -Eq "^[[:space:]]*${k}[[:space:]]*=" /etc/pulse/daemon.conf || echo "$kv" | sudo tee -a /etc/pulse/daemon.conf >/dev/null -done -``` - -Backup current PA system.pa file. - -```bash -sudo cp /etc/pulse/system.pa{,.bak.$(date +%s)} -``` - -Update the PA /etc/pulse/system.pa file with required change. Replaces if present (commented or not). - -```bash -sudo sed -i -E \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-udev-detect)([[:space:]].*)?$|\1 tsched=0|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-native-protocol-unix.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-default-device-restore.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-always-sink.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-position-event-sounds.*)$|\1|' \ - /etc/pulse/system.pa -``` - -Just in case the values were missing, may not be needed but shouldn't hurt. - -```bash -for m in \ - 'load-module module-native-protocol-unix' \ - 'load-module module-default-device-restore' \ - 'load-module module-always-sink' \ - 'load-module module-position-event-sounds'; do - sudo grep -Eq "^[[:space:]]*$m(\s|$)" /etc/pulse/system.pa || echo "$m" | sudo tee -a /etc/pulse/system.pa >/dev/null -done -``` - -Backup current PA default.pa file. - -```bash -sudo cp /etc/pulse/default.pa{,.bak.$(date +%s)} -``` - -Update the PA /etc/pulse/default.pa file with required change. Replaces if present (commented or not). - -```bash -sudo sed -i -E \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-udev-detect)([[:space:]].*)?$|\1 tsched=0|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-native-protocol-unix.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-default-device-restore.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-always-sink.*)$|\1|' \ - -e 's|^[#;[:space:]]*(load-module[[:space:]]+module-intended-roles.*)$|\1|' \ - /etc/pulse/default.pa -``` - -Just in case the values were missing, may not be needed but shouldn't hurt. - -```bash -for m in \ - 'load-module module-native-protocol-unix' \ - 'load-module module-default-device-restore' \ - 'load-module module-always-sink' \ - 'load-module module-intended-roles'; do - sudo grep -Eq "^[[:space:]]*$m(\s|$)" /etc/pulse/default.pa || echo "$m" | sudo tee -a /etc/pulse/default.pa >/dev/null -done -``` - -Optional since LVA handles duck/unduck: if you enabled role-ducking explicitly in system.pa, you can comment it out with: - -```bash -sudo sed -i -E 's|^([[:space:]]*)load-module[[:space:]]+module-role-ducking\b|# \0|' /etc/pulse/system.pa -``` -## 15. Restart PA and verify - -```bash -sudo systemctl restart pulseaudio.service -``` - -Test mpv can ouput to PA with current configs: - -```bash -mpv --ao=pulse --audio-device=default --audio-samplerate=44100 /usr/share/sounds/alsa/Front_Center.wav -``` - -If you disabled your Linux Voice Assistant service in step 2., enable it now: - -```bash -sudo systemctl enable --now linux-voice-assistant.service -``` - -## 16. Reboot your Pi: (see step 4) - - -## 17. Done! Return to the tutorial to continue the Linux Voice Assistant install. - - - - - - - - - diff --git a/linux_voice_assistant/docs/linux-voice-assistant-2mic-install.md b/linux_voice_assistant/docs/linux-voice-assistant-2mic-install.md deleted file mode 100644 index da3ee4a..0000000 --- a/linux_voice_assistant/docs/linux-voice-assistant-2mic-install.md +++ /dev/null @@ -1,302 +0,0 @@ -# Linux Voice Assistant on RaspberryPi with ReSpeaker 2‑Mic — Installation & Configuration Guide - -> Created using ChatGPT 5 with the following prompt: -```html - 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 - -```bash -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 - -```bash -git clone https://github.com/imonlinux/linux-voice-assistant.git -``` - - -## 3. Install ReSpeaker drivers - -```bash -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) - - -```bash -git clone https://github.com/rhasspy/wyoming-openwakeword.git -``` - -```bash -cp ~/linux-voice-assistant/wyoming-openwakeword/requirements.txt ~/wyoming-openwakeword/requirements.txt -cd wyoming-openwakeword/ -script/setup -``` - - -## 5. Linux Voice Assistant (LVA) - -```bash -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](install_pipewire.md). - -**Enable linger (required for user services to start after reboot):** -```bash -sudo loginctl enable-linger pi -``` - -**Install user-mode services:** -```bash -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:** -```bash -systemctl --user daemon-reload -systemctl --user enable --now wyoming-openwakeword.service -systemctl --user enable --now linux-voice-assistant.service -``` - -**Verify:** -```bash -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](install_pipewire.md). - -**Enable linger:** -```bash -sudo loginctl enable-linger pi -``` - -**Install user-mode service:** -```bash -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:** -```bash -systemctl --user daemon-reload -systemctl --user enable --now linux-voice-assistant.service -``` - -**Verify:** -```bash -systemctl --user status linux-voice-assistant --no-pager -l -``` -
- -
-PulseAudio + OpenWakeWord (system services) - -**Prep (PulseAudio):** Follow the PulseAudio tutorial first: [the tutorial](install_pulseaudio.md). - -**Install LVA (system) + tuning drop-in:** -```bash -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):** -```bash -sudo cp ~/linux-voice-assistant/service/wyoming-openwakeword.service /etc/systemd/system/wyoming-openwakeword.service -``` - -**Enable & start:** -```bash -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_pulseaudio.md). - -**Install LVA (system) + tuning drop-in:** -```bash -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:** -```bash -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: -```bash -arecord -l -aplay -l -``` - -**Install LVA (system):** -```bash -sudo cp ~/linux-voice-assistant/service/alsa-oww-linux-voice-assistant.service /etc/systemd/system/linux-voice-assistant.service -``` - -**Install OWW (system):** -```bash -sudo cp ~/linux-voice-assistant/service/wyoming-openwakeword.service /etc/systemd/system/wyoming-openwakeword.service -``` - -**Enable & start:** -```bash -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: -```bash -arecord -l -aplay -l -``` - -**Install LVA (system):** -```bash -sudo cp ~/linux-voice-assistant/service/alsa-mww-linux-voice-assistant.service /etc/systemd/system/linux-voice-assistant.service -``` - -**Enable & start:** -```bash -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:** -```bash -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: - -```text -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, PW, PA see section 6. - -If you intend to switch from PA to ALSA, you must first stop the pusleaudio.service. - -```bash -sudo systemctl stop pulseaudio.service -``` -```bash -sudo systemctl disable pulseaudio.service -```