Skip to main content

The spiritual successor to Mycroft AI, OVOS is flexible voice assistant software that can be run almost anywhere!

Project description

License Unit Tests codecov PRs Welcome Chat GitHub Discussions

OVOS-core

OpenVoiceOS is an open source platform for smart speakers and other voice-centric devices.

Mycroft was a hackable, open source voice assistant by the now defunct MycroftAI. OpenVoiceOS continues that work and ovos-core (this repo) is the central component.

All Mycroft Skills and Plugins should work normally with OVOS-core, with the exception of Common Play and other media-related skills. Other Mycroft-based assistants are also believed, but not guaranteed, to be compatible.

The biggest difference between OVOS-core and Mycroft-core is that OVOS-core is fully modular. Furthermore, common components have been repackaged as plugins. That means it isn't just a great assistant on its own, but also a pretty small library!

Table of Contents

Installing OVOS

If you have an existing system that you would like to install OVOS on, we strongly suggest the ovos-installer to install OVOS and its dependencies. The full assistant requires several repositories and the installer makes it easy to install them all at once.

If you would like to install OVOS on a Raspberry Pi, we suggest using the RaspOVOS image. This image is based on Raspberry Pi OS and includes OVOS and its dependencies running in a "headless" mode (no GUI). It is designed and optimized for a Raspberry Pi 3B, so on a 4 or higher its performance is even better.

If you would like to install OVOS on embedded hardware, we suggest using ovos-buildroot. This is a buildroot configuration that can be used to build a custom Linux distribution for embedded hardware. It includes OVOS and its dependencies, and is designed to be as small and efficient as possible.

You can find detailed documentation over at the community-docs or ovos-technical-manual

This repo can be installed standalone via pip install ovos-core, which will install the bare minimum components common to all services. This is useful for developers who want to build their own custom voice assistant. For more details, please see the community docs.

Skills

OVOS is nothing without skills. There are a handful of default skills, but most need to be installed explicitly. OVOS skills are all pip-installable, and can be found on PyPI or by browsing the OVOS organization on GitHub. Most classic Mycroft skills will also work on OVOS.

Please share your own interesting work!

Getting Involved

This is an open source project. We would love your help. We have prepared a contributing guide to help you get started.

The easiest way for anyone to contribute is to help with translations! You can help without any programming knowledge via the translation portal

If this is your first PR, or you're not sure where to get started, say hi in OpenVoiceOS Chat and a team member would be happy to mentor you. Join the Discussions for questions and answers.

Credits

The OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or manpower resources available to us:

Links

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

ovos-core-0.2.11a1.tar.gz (310.1 kB view details)

Uploaded Source

Built Distribution

ovos_core-0.2.11a1-py3-none-any.whl (547.1 kB view details)

Uploaded Python 3

File details

Details for the file ovos-core-0.2.11a1.tar.gz.

File metadata

  • Download URL: ovos-core-0.2.11a1.tar.gz
  • Upload date:
  • Size: 310.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos-core-0.2.11a1.tar.gz
Algorithm Hash digest
SHA256 460a0dac8fc5fa28becc80cb5479aa5c6aaa721ba2b05605fb6514fde3cec687
MD5 02b9b11da87c4971191e63b2b0b10498
BLAKE2b-256 5b422670c63fc3e9ee76da340a39ea49d47e4a73eb0acc9da3e6b558227c6590

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovos_core-0.2.11a1-py3-none-any.whl
  • Upload date:
  • Size: 547.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos_core-0.2.11a1-py3-none-any.whl
Algorithm Hash digest
SHA256 d76baf906a2e3ddeca50781d017186dd7dbe4df7d437efca96b357c44f4bd1fd
MD5 4b2ca5ac90e79a73c9f2ec50b0faf811
BLAKE2b-256 866155fea613945ce9072ebd0d9f07b8b94c19ba6dbc8a1a93101f03a6a2a5ee

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page