This release is a pre-release and may not be stable for production use.
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.
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:
- Provided by plugins (for example, the OpenAI plugin).
- 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 Notes
- Technical Manual
- OpenVoiceOS Chat
- Website
- Open Conversational AI Forums (previously Mycroft forums)
4 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ovos_core-3.1.1a1.tar.gz.
File metadata
- Download URL: ovos_core-3.1.1a1.tar.gz
- Upload date:
- Size: 79.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb46ed8a2d810c8bcf9448b528e0d3cd867ff312110079ae28dde1806fa28e60
|
|
| MD5 |
68e675a42269dbda3bffca898d63c8ab
|
|
| BLAKE2b-256 |
a1abc0d3137a2eee158a3563070bab948dfa65f8b0beff243f91554feac0df9e
|
File details
Details for the file ovos_core-3.1.1a1-py3-none-any.whl.
File metadata
- Download URL: ovos_core-3.1.1a1-py3-none-any.whl
- Upload date:
- Size: 88.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
302a5df06f9c4a7b300f43361761c8d2bea7a787a39d56d6af7b3ad1be786eeb
|
|
| MD5 |
17686e031c4c409aa6d660d2f5651320
|
|
| BLAKE2b-256 |
b6e2f3d4f7dce1ead08d8f8da6aae6581d292eb6c96af8aae4d03469626ec913
|
