Commit Graph
100 Commits
Author SHA1 Message Date
imonlinux 5931370c63 Update README.md 2025-11-28 14:10:45 -08:00
imonlinux 53d143fb35 Update README.md
Updated for additional supported Linux distros.
2025-11-28 14:10:18 -08:00
imonlinux be41c876b0 Update lva-desktop.md
Add command to chmod +x on the script/tray file.
2025-11-27 19:10:07 -08:00
imonlinux 48a6ec38a5 Add user mode unit file for the tray client 2025-11-27 19:08:09 -08:00
imonlinux b43cd95ec1 Update pyproject.toml
Add dependencies for the LVA Tray Client.
2025-11-26 20:08:48 -08:00
imonlinux e1fd1ccd4d Update lva-desktop.md
Update to include mpv "just in case"
2025-11-26 20:06:21 -08:00
imonlinux 5ce9085fd9 Merge pull request #42 from imonlinux/desktop-tray-client
Desktop tray client
2025-11-26 20:02:28 -08:00
imonlinux d0a74a2d3b Update README.md
Add info for tray client on Linux desktop.
2025-11-26 19:59:58 -08:00
imonlinux 85560b8126 Add tray script under the scripts folder. 2025-11-26 19:53:38 -08:00
imonlinux 0a2c227cad Add LVA Tray Client
Provide a simple tray client to show the status of the LVA running on a Linux desktop.
2025-11-26 19:51:17 -08:00
imonlinux 11c0e4fbb6 Create lva-desktop.md
Add tutorial for running LVA on a Linux desktop.
2025-11-26 19:49:39 -08:00
imonlinux e13cc31e5b Update satellite.py
Fix bug with no stt after wake word detection.
2025-11-24 15:14:15 -08:00
imonlinux e3f9757bee Update README.md
Clean up What's working section
2025-11-23 20:32:46 -08:00
imonlinux f38c89fb3b Update README.md
Typo
2025-11-23 20:12:02 -08:00
imonlinux c6c34b60e5 Update install-respeaker-drivers.sh
Added logic to support both Bookworm and Trixie version of Raspberry Pi OS.
2025-11-23 20:01:11 -08:00
imonlinux 62164e0142 Update linux-voice-assistant-2mic-install.md
Modified packages list in support of Trixie and soundcard.
2025-11-23 20:00:18 -08:00
imonlinux bd488f555e Update linux-voice-assistant-2mic-install.md
Add AEP tuning details.
2025-11-23 19:33:31 -08:00
imonlinux a9989f0c25 Update README.md
Confirmed working with Rasberry OS Trixie.
2025-11-23 19:25:11 -08:00
imonlinux baa6f9080f Update satellite.py
Fix wake word change bug
2025-11-22 16:11:16 -08:00
imonlinux f3ae02da0d Update util.py
Revert MAC address detection logic.
2025-11-21 17:17:56 -08:00
imonlinux 14d10b351f Merge pull request #41 from imonlinux/non-rpi_system_support
Make LED controller optional on non-RPi hosts and fix --list-output-devices exit code
2025-11-21 17:02:00 -08:00
imonlinux d2a133191b Update __main__.py
File: linux_voice_assistant/__main__.py

In _init_basics(), the --list-output-devices block is updated so that:

It exits with 0 on success.

It exits with 1 only if an exception occurs.
2025-11-21 17:00:25 -08:00
imonlinux 8d474acdab Update led_controller.py
Wrap the board import in a try/except and introduce a _BOARD_AVAILABLE flag.

If board (or Blinka/platformdetect) is not available or fails, log a clear warning and skip hardware LED initialization.

Keep the event subscriptions intact, but ensure all LED actions become no-ops when _is_ready is False.
2025-11-21 16:59:04 -08:00
imonlinux 18e9a49adf Update linux-voice-assistant-2mic-install.md
fix path typo in the new AEC section
2025-11-21 13:05:55 -08:00
imonlinux 61e02f9adb Merge pull request #40 from imonlinux/let_mpv_do_the_work
Simplify mpv audio backend selection and log effective backend
2025-11-21 11:01:07 -08:00
imonlinux 93ceffebae Update mpv_player.py
Removed the home-grown backend probing / priority logic (pipewire → pulse → alsa) when no device is explicitly configured.

Kept support for explicitly specifying an audio_output_device in the config/CLI; if provided, it is passed through to mpv.

Added debug logging after mpv initialization to show:

current ao

current audio-device

the full audio-device-list
2025-11-21 11:00:03 -08:00
imonlinux 9285337a5e Merge pull request #39 from imonlinux/stop-wakeword-audio-device-list
Improve stop wake word behavior and add audio device listing helpers
2025-11-20 20:45:43 -08:00
imonlinux c7af116904 Update linux-voice-assistant-2mic-install.md
Added section for implementing AEC.
2025-11-20 20:43:31 -08:00
imonlinux 25d341927c Update README.md
Updated to include AEC details.
2025-11-20 20:18:47 -08:00
imonlinux adbb37e731 Update __main__.py
New CLI helpers

    Added support for:

    script/run --list-input-devices
    script/run --list-output-devices

    These code paths:

        Initialize just enough of the audio stack to enumerate devices.

        Print a clean, human-readable list of input/output devices (including PipeWire / PulseAudio virtual devices like Echo-Cancel Source and pipewire/echo-cancel-sink).

        Exit cleanly with status 0 instead of trying to start the full LVA process afterward (fixing the previous CalledProcessError when --list-output-devices was used).

Behavior change

    __main__.py now treats the “list devices” modes as early-exit utility modes, not “run LVA and then also print devices”.

    This makes it practical to use these commands in setup docs and shell scripts.
2025-11-20 20:02:23 -08:00
imonlinux 0151b64810 Update audio_engine.py
Behavioral & logging changes

Improved the wake word processing loop to make the following clearly visible in DEBUG logs:

The current set of active wake word IDs (MWW/OWW).

When the Stop wake word:

is activated by the model,

is accepted (i.e. meets refractory timing + is currently allowed), and

is ignored because it is no longer in active_wake_words.

Ensured the special stop model:

Is only treated as “active” when state.stop_word.is_active is True.

Is flipped back to inactive immediately after satellite.stop() is called, so:

The first “Stop” that passes all checks cancels playback and alarm tones.

Subsequent detections in the same moment appear as “TRIGGERED but IGNORED” (expected and now clearly logged).

Why this matters

When the LVA is playing audio (TTS or timer alarm), you can now:

See exactly when the Stop model fires.

Confirm that playback is being canceled at the right time.

Understand why you might see multiple “Stop wake word ACTIVATED” messages even though the alarm already stopped (model still “hearing” the tail, but logically ignored).

This matches the behavior seen in your logs:

At lower volumes / with AEC, stop is reliably accepted and playback stops immediately.

At high volumes without AEC, the model sees far less “clean” speech, so activations are rare or absent.
2025-11-20 20:01:13 -08:00
imonlinux 8d928c6b02 Merge pull request #38 from imonlinux/media_player_persistence
Fix ESPHome media_player persistence and entity key stability
2025-11-20 13:05:45 -08:00
imonlinux 0b3c3e7b42 Update satellite.py
Fix ESPHome media_player persistence and entity key stability
2025-11-20 13:04:46 -08:00
imonlinux f34bc90edd Update satellite.py
Registration bug fix
2025-11-19 20:24:42 -08:00
imonlinux 196d5273f0 Update README.md 2025-11-19 19:06:22 -08:00
imonlinux d3d60e1c99 Merge pull request #37 from imonlinux/refactor-audio_engine
Core Refactor: Stability, Identity Persistence, and Audio Engine Optimization
2025-11-19 18:51:40 -08:00
imonlinux 4616645c40 Update __main__.py
Entry point. Clean imports, timestamp logging, integration of AudioEngine.
2025-11-19 18:49:43 -08:00
imonlinux 6eb3f46cbe Create audio_engine.py
Brand new file. Encapsulates audio logic, suppresses warnings, fixes busy wait.
2025-11-19 18:48:44 -08:00
imonlinux 6f5444237c Update satellite.py
Implements non-blocking downloads.
2025-11-19 18:47:37 -08:00
imonlinux cf82a3158d Update models.py
Added threading event for audio loop optimization.
2025-11-19 18:47:01 -08:00
imonlinux e63bda7e76 Update zeroconf.py
Uses the new util to ensure MDNS matches the device ID.
2025-11-19 18:46:05 -08:00
imonlinux 592d5eb0c3 Update util.py
New robust MAC address logic.
2025-11-19 18:45:16 -08:00
imonlinux 360fe06d96 Update satellite.py
Wrong file uploaded
2025-11-18 15:16:19 -08:00
imonlinux efe2b4ff4e Update api_server.py
Wrong file uploaded
2025-11-18 15:15:46 -08:00
imonlinux e3216d3e68 Update __main__.py
Wrong version uploaded.
2025-11-18 15:15:07 -08:00
imonlinux 5eb1489947 Update satellite.py
Uploaded the wrong version of the file.
2025-11-18 11:51:34 -08:00
imonlinux 2808877895 Update models.py
Uploaded wrong version of the file.
2025-11-18 11:51:04 -08:00
imonlinux 2fdef7d6ce Update __main__.py
Wrong version of file uploaded.
2025-11-18 11:48:04 -08:00
imonlinux 2ccda5ac4a Merge pull request #36 from imonlinux/decouple-controllers-breakup-main
Decouple controllers breakup main
2025-11-17 22:45:12 -08:00
imonlinux fd5cd13f72 Update __main__.py
(Major change) main() function completely refactored into helpers. _init_controllers now handles decoupled initialization. _process_audio loop logic was fixed to correctly initialize wake words on startup.

 mic.recorder() loop is now much more robust against OS buffering issue when the microphone is muted and wakewords were detected and processed after unmute.
2025-11-17 22:40:53 -08:00
imonlinux ada83bdfbb Update satellite.py
Re-added the self.state.satellite = self link, which is necessary for the main loop to be reachable from the audio thread.
2025-11-17 21:51:34 -08:00
imonlinux b62d07be7d Update event_bus.py
The EventHandler base class was modified to support the new decoupled __init__ pattern.
2025-11-17 21:50:53 -08:00
imonlinux f39df8a40a Update mqtt_controller.py
__init__ was completely rewritten to be decoupled. It now listens for mic_muted/mic_unmuted events to manage its own state instead of reading from ServerState.
2025-11-17 21:50:08 -08:00
imonlinux 37922351f6 Update led_controller.py
__init__ was completely rewritten to be decoupled. It now receives loop, event_bus, config, and preferences directly and no longer has any reference to ServerState.
2025-11-17 21:49:21 -08:00
imonlinux 64e2657824 Update models.py
ServerState is now a pure data container, no longer holding controller instances. The satellite reference was re-added, as it's required by the audio thread to call satellite.wakeup(). Fixed a TypeError by re-ordering non-default fields.
2025-11-17 21:48:08 -08:00
imonlinux 8c6df9b245 Update __main__.py
(Major change) main() function completely refactored into helpers. _init_controllers now handles decoupled initialization. _process_audio loop logic was fixed to correctly initialize wake words on startup.
2025-11-17 21:46:42 -08:00
imonlinux 52e5fb374e Update models.py
fixed wrong file uploaded
2025-11-17 20:37:46 -08:00
imonlinux fc6d750257 Merge pull request #35 from imonlinux/refactored-upstream-changes
Refactored upstream changes
2025-11-17 20:26:43 -08:00
imonlinux 4d8f5c97b7 Update util.py
Removed the unused is_arm function
2025-11-17 20:22:54 -08:00
imonlinux c9be5fc026 Update satellite.py
Added all the logic for downloading external wake words
2025-11-17 20:22:05 -08:00
imonlinux a4fa7b8631 Update __main__.py
Replaced sounddevice with soundcard, removed the audio Queue, added the new download directory to the search path, and added the device listing arguments
2025-11-17 20:21:24 -08:00
imonlinux 005900b2ae Update models.py
Replaced sounddevice with soundcard, removed the audio Queue, added the new download directory to the search path, and added the device listing arguments
2025-11-17 20:19:30 -08:00
imonlinux 324881ca8b Update models.py
Removed audio_queue, added download_dir, and updated AvailableWakeWord to use the new libraries
2025-11-17 20:18:38 -08:00
imonlinux f033595649 Update config.py
Added download_dir and removed old oww_ model paths
2025-11-17 20:17:44 -08:00
imonlinux d2a9057dde Update config.py
Updated for the new soundcard library
2025-11-17 20:17:08 -08:00
imonlinux d95c15bf40 Update mypy.ini
Updated for the new soundcard library
2025-11-17 20:16:07 -08:00
imonlinux 8d6b1849bd Update pyproject.toml
Added soundcard, pymicro-wakeword, pyopen-wakeword; removed sounddevice, pymicro-features
2025-11-17 20:14:54 -08:00
imonlinux 19677dfedd Update pyproject.toml 2025-11-17 20:14:11 -08:00
imonlinux e0bb8e7793 Update .gitignore 2025-11-17 20:13:31 -08:00
imonlinux 82c02e9db9 Delete linux_voice_assistant/openwakeword.py 2025-11-17 20:12:33 -08:00
imonlinux 9bc2830a2d Delete linux_voice_assistant/microwakeword.py 2025-11-17 20:12:18 -08:00
imonlinux 3507074698 Delete linux_voice_assistant/wakeword.py 2025-11-17 20:12:04 -08:00
imonlinux bf39055441 Delete wakewords/openWakeWord/melspectrogram.tflite 2025-11-17 20:11:42 -08:00
imonlinux 3587d8329f Delete wakewords/openWakeWord/embedding_model.tflite 2025-11-17 20:11:30 -08:00
imonlinux d07e1be653 Delete lib directory 2025-11-17 20:11:04 -08:00
imonlinux 28c4ade611 Update README.md
Refactor: Sync with Upstream Architectural Changes (Nov 2025)
Type: Refactor / Feat

Description
This PR ports several major architectural changes and new features from the upstream OHF-Voice/linux-voice-assistant repository. Because our codebase has been significantly refactored (config file, state machine), these changes were ported manually to integrate them cleanly with our new architecture.

This brings our fork up-to-date with the upstream's core logic and dependencies, ensuring we benefit from future bug fixes in those externalized libraries.

Key Changes
Audio Library Replaced: Replaced the sounddevice library with soundcard.

New Audio Capture Loop: The entire audio processing pipeline in __main__.py has been rewritten. It no longer uses a Queue and a sounddevice callback. Instead, the process_audio thread now runs a blocking mic.recorder() loop from the soundcard library, which is the new architecture adopted by the upstream project.

External Wake Word Libraries: All local wake word code (microwakeword.py, openwakeword.py, wakeword.py) and the lib/ directory have been deleted. They are replaced by new pip dependencies: pymicro-wakeword and pyopen-wakeword.

New Feature: External Wake Words: Ported the feature to allow Home Assistant to provide custom, external wake words. The LVA will now download models sent from HA to a new local/ directory.

New Feature: List Devices: Ported the --list-input-devices and --list-output-devices CLI helpers from upstream.

Dependency Updates: > * Bumped aioesphomeapi to 42.7.0 and updated api_server.py to use AuthenticationRequest (from ConnectRequest). > * Constrained zeroconf to <1. > * Updated dev dependencies (black, flake8, etc.)

Cleanup: Updated .gitignore to include the new /local/ download directory and mypy.ini for the new libraries.
2025-11-17 20:09:57 -08:00
imonlinux 90f37df4e8 Merge pull request #34 from imonlinux/centralized-configuration-file
Refactor: Centralize Configuration into config.json
Type: Refactor Issue: Closes #XYZ (if you have one)

Description
This pull request completes a major refactoring goal by moving all (20+) command-line arguments into a single, centralized config.json file.

The application is now launched with a single -c or --config flag pointing to this new file, dramatically simplifying startup scripts and configuration management.

Changes
NEW: linux_voice_assistant/config.py > * Adds new dataclasses (AppConfig, AudioConfig, LedConfig, etc.) to define the application's configuration structure. > * Includes a load_config_from_json() helper to parse the JSON file and provide default values for any omitted sections.

MODIFIED: linux_voice_assistant/__main__.py > * Removed all argparse.add_argument() calls, except for the new --config flag. > * The main() function now calls load_config_from_json() at startup. > * All internal logic now references the config object (e.g., config.app.name) instead of the old args object.
2025-11-17 18:40:01 -08:00
imonlinux 8e4480716a Update linux-voice-assistant-2mic-install.md
Updated the tutorial to reflect the change to config.json instead of command line arguements.
2025-11-17 18:38:01 -08:00
imonlinux 531e6500d0 Update README.md 2025-11-17 18:09:34 -08:00
imonlinux 70e51148bf Update satellite.py
Fixed LED startup state bug.
2025-11-17 18:05:06 -08:00
imonlinux 9d27b016ca Update models.py
Fixed LED startup state bug.
2025-11-17 18:04:34 -08:00
imonlinux b209c1300e Update and rename user-linux-voice-assistant.service to linux-voice-assistant.service
Changes the user mode service file to the single command needed to start LVA. All other configuration arguments are in the linux_voice_assistant/config.json file.
2025-11-17 18:03:09 -08:00
imonlinux e073be7978 Delete service/user-pw-linux-voice-assistant.service
No longer needed.
2025-11-17 17:44:16 -08:00
imonlinux 75d02225b0 Delete service/user-pa-linux-voice-assistant.service
No longer needed.
2025-11-17 17:43:47 -08:00
imonlinux 77c2530657 Add config.json
This is the minimum configuration needed to start the LVA. 

{
  "app": {
    "name": "Linux Voice Assistant"
  }
}
2025-11-17 17:42:40 -08:00
imonlinux bd24e543b9 Update README.md
Updated README.md to align with the recent modifications and to close out some of the ToDo's.
2025-11-17 17:38:56 -08:00
imonlinux ebd74c1e80 Update __main__.py
Removed all argparse.add_argument() calls, except for the new --config flag.  The main() function now calls load_config_from_json() at startup.  All internal logic now references the config object (e.g., config.app.name) instead of the old args object.
2025-11-17 17:20:18 -08:00
imonlinux ce5418a27a Add linux_voice_assistant/config.json.example
Here is a complete config.json file showing all available options and explanations.
2025-11-17 17:18:36 -08:00
imonlinux 94e13f2c13 Add linux_voice_assistant/config.py
Adds new dataclasses (AppConfig, AudioConfig, LedConfig, etc.) to define the application's configuration structure. Includes a load_config_from_json() helper to parse the JSON file and provide default values for any omitted sections
2025-11-17 17:13:02 -08:00
imonlinux bd21743c49 Update mpv_player.py
Fix bug with audio backend detection. ALSA was not being detected correctly.
2025-11-17 16:46:15 -08:00
imonlinux 474ddfbaa4 Merge pull request #33 from imonlinux/normalize-satellite-state-machine
Normalize satellite state machine
2025-11-17 15:31:06 -08:00
imonlinux 208e7baec6 Merge pull request #32 from imonlinux/fix-mqtt-race-condition
Update mqtt_controller.py
2025-11-17 15:29:59 -08:00
imonlinux 899130c0d5 Merge pull request #31 from imonlinux/fix_mpv_race_condition
Fix mpv race condition
2025-11-17 15:28:46 -08:00
imonlinux 2ab4ae7b22 Merge pull request #30 from imonlinux/consolidate-dependencies
Consolidate dependencies
2025-11-17 15:26:37 -08:00
imonlinux 4d153d41cd Delete requirements.txt 2025-11-17 15:23:09 -08:00
imonlinux ab4bc2d027 Update pyproject.toml
Goal: You currently have dependencies listed in both pyproject.toml and requirements.txt. These files are redundant and also conflicting (they list different things). This can cause confusion and versioning problems.

The Fix: We will make pyproject.toml the single source of truth by merging all dependencies into it and then deleting the old requirements.txt file.

I merged the two unique libraries from requirements.txt (gpiozero and spidev) into the dependencies list.
2025-11-17 15:22:14 -08:00
imonlinux a1c1336ba2 Update led_controller.py
Update led_controller.py to subscribe to the new, normalized state events being published by satellite.py
2025-11-17 15:09:36 -08:00
imonlinux f1137232e0 Update satellite.py
This is the major change. All the _is_speaking, _run_finished, etc. flags are gone, replaced by a single self._state variable and a _set_state method. The logic is now much cleaner.
2025-11-17 15:08:10 -08:00
imonlinux 0f1ceefc5c Update models.py
Goal: satellite.py currently uses a set of boolean flags (_is_streaming_audio, _tts_played, _run_finished, _is_speaking) to figure out what it's doing. This is hard to read and easy to break. Replaced this with a clean, formal state machine (using an Enum). This makes the logic explicit and much easier to manage.

added the SatelliteState Enum at the top and removed the media_player_entity from ServerState as it's better managed by the satellite itself
2025-11-17 15:05:35 -08:00
imonlinux 2cdabdad30 Update mqtt_controller.py
Goal: We'll apply the exact same pattern to the MqttController. The paho-mqtt library runs its _on_message callback in a separate thread. We'll stop it from modifying state directly and instead schedule a new function to run on the main asyncio loop.

Here is the complete file. The key changes are:

The _on_message function is now tiny. It just gets the topic/payload and uses self.state.loop.call_soon_threadsafe to schedule a new function.

A new function _handle_message_on_loop contains all the logic that used to be in _on_message. This new function will run safely on the main asyncio loop, eliminating the race condition.
2025-11-17 14:44:41 -08:00