Skip to main content
Pre-release

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

GitHub Discussions License PRs Welcome Unit Tests codecov

OVOS-core

OpenVoiceOS is an open-source platform for smart speakers and other voice-centric devices. ovos-core (this repo) is the central component.


Installing OVOS

If you have an existing system, use the ovos-installer to install OVOS and its dependencies in one step.

For Raspberry Pi users, the RaspOVOS image runs in headless mode (no GUI) and targets Raspberry Pi 3B or higher.

For embedded systems, ovos-buildroot builds a custom Linux distribution for minimal setups.

More detailed documentation is available in the ovos-technical-manual.

Developers can install ovos-core standalone:

pip install ovos-core

This includes the core components, for custom assistant development.


Skills

OVOS is powered by skills. Some skills come pre-installed; most need to be installed explicitly.

Browse OVOS-compatible skills on PyPI or in the OVOS GitHub organization.

Most classic Mycroft skills also work on OVOS.


Persona Support

ovos-persona generates responses when skills fail to handle user input. With Persona you can connect an LLM to ovos-core.

List Personas

  • "What personas are available?"
  • "Can you list the personas?"
  • "What personas can I use?"

Activate a Persona

  • "Connect me to {persona}"
  • "Enable {persona}"
  • "Start a conversation with {persona}"
  • "Let me chat with {persona}"

Stop Conversation

  • "Stop the interaction"
  • "Terminate persona"
  • "Deactivate Large Language Model"
Creating a Persona: Click to expand

Persona Files

Personas are configured using JSON files. These can be:

  1. Provided by plugins (for example, the OpenAI plugin).
  2. Created as user-defined JSON files in ~/.config/ovos_persona.

Personas rely on solver plugins, which try to answer queries in sequence until a response is found.

Example: using a local OpenAI-compatible server.

Save this in ~/.config/ovos_persona/salamandra.json:

{
  "name": "Salamandra",
  "solvers": [
    "ovos-solver-openai-persona-plugin"
  ],
  "ovos-solver-openai-persona-plugin": {
    "api_url": "https://ollama.uoi.io/v1",
    "model": "hdnh2006/salamandra-7b-instruct",
    "key": "sk-xxxx",
    "persona": "helpful, creative, clever, and very friendly."
  }
}

The "Salamandra" persona is now available. The example above uses a demo server; no uptime is guaranteed.

More details on how to create your personas are in the OVOS-persona README.

Pipeline Configuration: Click to expand

Persona Pipeline

Add the persona pipeline to your mycroft.conf after the _high pipeline matchers.

{
  "intents": {
      "persona": {"handle_fallback":  true},
      "pipeline": [
          "stop_high",
          "converse",
          "ocp_high",
          "padatious_high",
          "adapt_high",
          "ovos-persona-pipeline-plugin-high",
          "ocp_medium",
          "fallback_high",
          "stop_medium",
          "adapt_medium",
          "padatious_medium",
          "adapt_low",
          "common_qa",
          "fallback_medium",
          "ovos-persona-pipeline-plugin-low",
          "fallback_low"
    ]
  }
}

Getting Involved

OVOS is open source and depends on community contributions. There is a way to contribute as a coder, designer, or translator.

Help translate OVOS into your language through our Translation Portal.

Have questions or need guidance? Say hi in the OpenVoiceOS Chat, and a team member will help.

Join our Discussions to ask questions and share ideas.


Credits

The OpenVoiceOS team thanks the following organizations for their support in our early days:

  • Mycroft was a hackable, open-source voice assistant by the now-defunct MycroftAI. OpenVoiceOS continues that work.
  • NeonGecko
  • KDE / Blue Systems

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos_core-3.0.7a1.tar.gz (78.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ovos_core-3.0.7a1-py3-none-any.whl (87.1 kB view details)

Uploaded Python 3

File details

Details for the file ovos_core-3.0.7a1.tar.gz.

File metadata

  • Download URL: ovos_core-3.0.7a1.tar.gz
  • Upload date:
  • Size: 78.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ovos_core-3.0.7a1.tar.gz
Algorithm Hash digest
SHA256 daa7864efe496c2b8de1c590980d318cd5cff2dc88197f22ad84fa20a2c09d9e
MD5 bd6bd1e391c487a63515380f796986c9
BLAKE2b-256 db631b6627e18ad9da422db3d53b4c848959602bc26019b5f6a5b676f44e74fc

See more details on using hashes here.

File details

Details for the file ovos_core-3.0.7a1-py3-none-any.whl.

File metadata

  • Download URL: ovos_core-3.0.7a1-py3-none-any.whl
  • Upload date:
  • Size: 87.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ovos_core-3.0.7a1-py3-none-any.whl
Algorithm Hash digest
SHA256 bdf9146ab0fd517ff75400c89521d2df14e282c4df56060f963d04eb04a0bc56
MD5 7bbb7fac17e34625b346db5205597e23
BLAKE2b-256 f8103b14950441f98c029f69b85b5b11e3519b9429677182d868664e51896376

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page