Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Description

Vosk wake word plugin for OpenVoiceOS. It uses the Vosk speech recognizer to transcribe short audio chunks and check the transcript against one or more wake word samples.

Install

pip install ovos-ww-plugin-vosk

Configuration

Quick start

Add the following to the hotwords section in mycroft.conf.

  "listener": {
    "wake_word": "hey_computer"
  },
  "hotwords": {
    "hey_computer": {
        "module": "ovos-ww-plugin-vosk",
        "listen": true
    }
  }

Replace hey_computer with your wake word. A model downloads automatically for the configured language.

Single keyword

Some wake words are hard to trigger, usually because the language model does not include them. For example, hey mycroft is often transcribed as hey microsoft. By default, this plugin checks for the wake word name, but you can configure the keyword in a number of ways.

  • model_folder - full path to a Vosk model. Optional; the plugin downloads one automatically.
  • lang - language code for the model. Optional; uses the global value if not set. Only affects which model downloads.
  • debug - if true, prints extra info, like the transcript contents.
  • rule - how to compare the transcript against the samples. See the rules below.
  • time_between_checks - the length in seconds between inferences. Must be between 0.2 and 3.
  • full_vocab - use the full model vocabulary for transcription. If false (default), Vosk runs in keyword mode.
  • samples - list of samples to match the rules against. Optional; defaults to the keyword name.
  "listener": {
    "wake_word": "hey_computer"
  },
  "hotwords": {
    "hey_computer": {
        "module": "ovos-ww-plugin-vosk",
        "listen": true,
        "full_vocab": true,
        "rule": "equals",
        "debug": true,
        "samples": ["hey computer", "a computer", "hey computed"],
        "model_folder": "/home/user/Downloads/vosk-model-small-en-us-0.4",
        "time_between_checks": 0.6
    }
  }

Keyword rules

You can define different rules to trigger a wake word.

  • contains - the transcript contains any of the samples.
  • equals - the transcript exactly matches any of the samples.
  • starts - the transcript starts with any of the samples.
  • ends - the transcript ends with any of the samples.
  • fuzzy - fuzzy match the transcript against the samples.

Enable the debug flag and check the logs to see what the plugin transcribes. Use this to tune the rule and samples.

Each wake word must fit in 3 seconds, the length of audio the model parses at a time.

time_between_checks controls how often the plugin checks the buffered audio. Lower values run more checks and use more CPU. Higher values check less often and may miss short wake words. The default is 1.0.

Set full_vocab to transcribe all known words before applying the detection rules. By default this is false, and the plugin only looks for the wake word samples. Depending on the wake word, this may raise or lower accuracy.

Multiple keywords

A single model per language can check for multiple keywords at once. For example, to replace the default wake words:

  "hotwords": {
    "hey mycroft": {"active": false},
    "wake up": {"active": false},
    "hey xxx": {
        "module": "ovos-ww-plugin-vosk-multi",
        "listen": true,
        "wakeup": true,
        "keywords": {
           "hey mycroft": {"samples": ["hey mycroft", "hey microsoft", "hey minecraft"], "rule": "fuzzy"},
           "wake up": {"wakeup": true}
        }
    }

You can load any number of languages side by side.

  "hotwords": {
    "hey_xxx": {
        "module": "ovos-ww-plugin-vosk-multi",
        "listen": true,
        "full_vocab": false,
        "keywords": {
           "hey mycroft": {"samples": ["hey mycroft", "hey microsoft", "hey minecraft"], "rule": "fuzzy"},
           "hey neon": {},
           "hey computer": {},
           "hey jarvis": {},
           "computador": {"lang": "pt"},
           "jarbas": {"lang": "pt"}
        }
    }

License

Apache-2.0

Metadata

Release files for ovos-ww-plugin-vosk 0.1.12a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-ww-plugin-vosk 0.1.12a1
File Size Uploaded Provenance Actions
ovos_ww_plugin_vosk-0.1.12a1.tar.gz 15.0 kB Without provenance Details for ovos_ww_plugin_vosk-0.1.12a1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ovos-ww-plugin-vosk 0.1.12a1
File Interpreter ABI Platform Actions
ovos_ww_plugin_vosk-0.1.12a1-py3-none-any.whl Python 3 none any Details for ovos_ww_plugin_vosk-0.1.12a1-py3-none-any.whl

Total release size: 27.7 kB

Release files / ovos_ww_plugin_vosk-0.1.12a1.tar.gz

Download URL ovos_ww_plugin_vosk-0.1.12a1.tar.gz
Size 15.0 kB
Tags Source
SHA-256 checksum
How to use checksums
95974e5340ecd935f3bee8ae2cc22ed7682398cd20d325868d9823289e4ad060
BLAKE2b-256 checksum
How to use checksums
69b8ef800ae705bae1321a36ba87970fbc1ffdffd60bc2aea488be4461ebc456
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ovos_ww_plugin_vosk-0.1.12a1-py3-none-any.whl

Download URL ovos_ww_plugin_vosk-0.1.12a1-py3-none-any.whl
Size 12.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9635280f6ee15cd4ac852f39f8dfbd65311588560ef34035e3df47a0bfbefe0e
BLAKE2b-256 checksum
How to use checksums
ba4ab73e5ec4f9e9607eee883939a4d723dc1b1a43f8a05b522343928f57355b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for ovos-ww-plugin-vosk 0.1.12a1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page