ovos-core listener daemon client
Project description
OpenVoiceOS Dinkum Listener
Dinkum Listener made standalone, the voice loop is now a much more responsive state machine
the usual configuration files are loaded, some new params are exposed under the
"listener"
section but not yet documented (check the code...)
Documentation can be found in the technical manual
Install
pip install ovos-dinkum-listener[extras]
to install this package and the default
plugins. Note that by default, either tensorflow
or tflite_runtime
will need
to be installed separately for wakeword detection.
If unable to install tflite_runtime in your platform, you can find wheels here https://whl.smartgic.io/. eg, for pyhon 3.11 in x86
pip install https://whl.smartgic.io/tflite_runtime-2.13.0-cp311-cp311-linux_x86_64.whl
Without extras
, wakeword and STT audio upload will be disabled unless you install
ovos-backend-client
separately. You will also need to manually install,
and possibly configure STT, WW, and VAD modules as described below.
Using ovos-vad-plugin-silero is strongly recommended instead of the default webrtcvad plugin
Configuration
you can set the Wakeword, VAD, STT and Microphone plugins
eg, to run under MacOS you should use https://github.com/OpenVoiceOS/ovos-microphone-plugin-sounddevice
{
"stt": {
"module": "ovos-stt-plugin-server",
"fallback_module": "",
"ovos-stt-plugin-server": {"url": "https://stt.openvoiceos.com/stt"}
},
"listener": {
// NOTE, multiple hotwords are supported, these fields define the main wake_word,
// this is equivalent to setting "active": true in the "hotwords" section
// see "hotwords" section at https://github.com/OpenVoiceOS/ovos-config/blob/dev/ovos_config/mycroft.conf
"wake_word": "hey_mycroft",
"stand_up_word": "wake_up",
"microphone": {
"module": "ovos-microphone-plugin-alsa"
},
VAD": {
// recommended plugin: "ovos-vad-plugin-silero"
"module": "ovos-vad-plugin-silero",
"ovos-vad-plugin-silero": {"threshold": 0.2},
"ovos-vad-plugin-webrtcvad": {"vad_mode": 3}
},
// Seconds of speech before voice command has begun
"speech_begin": 0.1,
// Seconds of silence before a voice command has finished
"silence_end": 0.5,
// Settings used by microphone to set recording timeout with and without speech detected
"recording_timeout": 10.0,
// Settings used by microphone to set recording timeout without speech detected.
"recording_timeout_with_silence": 3.0,
// max time allowed without user speaking before exiting RECORDING mode
"recording_mode_max_silence_seconds": 30.0,
// Setting to remove all silence/noise from start and end of recorded speech (only non-streaming)
"remove_silence": true,
// continuous listen is an experimental setting, it removes the need for
// wake words and uses VAD only, a streaming STT is strongly recommended
// NOTE: depending on hardware this may cause mycroft to hear its own TTS responses as questions
"continuous_listen": false,
// hybrid listen is an experimental setting,
// it will not require a wake word for X seconds after a user interaction
// this means you dont need to say "hey mycroft" for follow up questions
"hybrid_listen": false,
// number of seconds to wait for an interaction before requiring wake word again
"listen_timeout": 45
}
}
Credits
Voice Loop state machine implementation by @Synesthesiam for mycroft-dinkum
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ovos-dinkum-listener-0.0.3a40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a872c12cc6b2d744a84f28dbac031904402d36f5e789772a0368faf18be7d8c |
|
MD5 | e5928e9eda4f91e86985d742e1ff8514 |
|
BLAKE2b-256 | 53b19f5aa1dedcc71a21bd6f798b57d9e8bc6ba794b30d59ea0da0b549a7f483 |
Hashes for ovos_dinkum_listener-0.0.3a40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11893eed912e24bc8329bd42c10777bc73ba4d7e3b2e17ef4d8cc58befa26402 |
|
MD5 | 28e15540075e1063deb124442667c1a2 |
|
BLAKE2b-256 | de2edb004d1244d47cf81ed93df9a1da785de735a8d677ec68a1832ff40d3deb |