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 and in docs/. See docs/prerelease-quirks.md for what changed since the last stable release.

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.

When an install or uninstall requested over the bus fails, the .failed reply carries the installer's own output in detail, so a remote caller can see why without reading the service log. See docs/skill-installer.md.

A completed runtime install through the bus (ovos.skills.install) triggers a discovery pass, so an eligible skill loads on that report rather than waiting for the periodic scan; the pass keeps the readiness and connectivity gating the scan applies. skillmanager.rescan asks the skill manager for that pass on demand and replies with what it loaded. See docs/skill-manager.md.

A skill uninstalled at runtime through the bus (ovos.skills.uninstall) is unloaded as soon as the installer reports completion, so it stops answering without a restart. See docs/skill-manager.md.


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

Release files for ovos-core 3.5.6a1

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-core 3.5.6a1
File Size Uploaded
ovos_core-3.5.6a1.tar.gz 93.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-core 3.5.6a1
File Interpreter ABI Platform
ovos_core-3.5.6a1-py3-none-any.whl Python 3 none any Details

Total release size: 196.9 kB

Release files / ovos_core-3.5.6a1.tar.gz

Download URL ovos_core-3.5.6a1.tar.gz
Size 93.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dfc1423e17ef8b83b435054fe410f43d0791c99d4185084308045ac3d9b6cd53
BLAKE2b-256 checksum
How to use checksums
45802a7d97976f2345e707d8914833deb9fd29ae49f15b4d5a8c8dbd7a68e1e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / ovos_core-3.5.6a1-py3-none-any.whl

Download URL ovos_core-3.5.6a1-py3-none-any.whl
Size 103.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d2cf969b41a800acbfa41acf5458763760fb7c182445d87f36509b82b7a2ea7
BLAKE2b-256 checksum
How to use checksums
615589f808d727f4d418ab8b120ce9e7de03f2128b6ab336278222ebc9e47ae3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

3.5.6a1 This release

2 release files

2.1.1

2 release files

2.1.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.3

2 release files

1.2.1

2 release files

1.1.0

2 release files

0.5.4

2 release files

0.5.2

2 release files

0.4.0

2 release files

0.3.8

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.8

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.1

1 release file

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