More options in README

This commit is contained in:
Michael Hansen
2025-09-08 14:08:01 -05:00
parent 3bb89f7314
commit 3165b0f495
+17
View File
@@ -25,8 +25,25 @@ script/setup
Use `script/run` or `python3 -m linux_voice_assistant` Use `script/run` or `python3 -m linux_voice_assistant`
You must specify `--name <NAME>` with a name that will be available in Home Assistant.
See `--help` for more options. 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 <id>` where `<id>` 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 ## Connecting to Home Assistant
1. In Home Assistant, go to "Settings" -> "Device & services" 1. In Home Assistant, go to "Settings" -> "Device & services"