From 3165b0f495c4cbcd6827c45997536c0138930b98 Mon Sep 17 00:00:00 2001 From: Michael Hansen Date: Mon, 8 Sep 2025 14:08:01 -0500 Subject: [PATCH] More options in README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5f71ff6..962f852 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,25 @@ script/setup Use `script/run` or `python3 -m linux_voice_assistant` +You must specify `--name ` with a name that will be available in Home Assistant. + See `--help` for more options. +### Microphone + +Use `--audio-input-device` to change the microphone device. Use `python3 -m sounddevice` to see the available PortAudio devices. + +The microphone device **must** support 16Khz mono audio. + +### Speaker + +Use `--audio-output-device` to change the speaker device. Use `mpv --audio-device=help` to see the available MPV devices. + +## Wake Word + +Change the default wake word with `--wake-model ` where `` is the name of a model in the `wakewords` directory. For example, `--wake-model hey_jarvis` will load `wakewords/hey_jarvis.tflite` by default. + + ## Connecting to Home Assistant 1. In Home Assistant, go to "Settings" -> "Device & services"