The OpenVoiceOS Technical Manual

Welcome to the OVOS developer documentation

Perspective

OVOS aims to be a full voice operating system, a operating system needs many applications and frameworks, OVOS provides all the required tooling to integrate voice in your projects

The typical use case for OVOS is as a voice assistant, "Hey Mycroft, what is ...", but as a voice operating system OVOS makes no such assumptions and can be customized for any other use case, we have seen our community integrate OVOS on robots, furniture, smart mirrors, cloud applications, TVs and more!

The following companion projects can be seen as "OVOS distros", opinionated combinations of OVOS packages to provide a full voice assistant stack

• raspOVOS - optimized for raspberry pi, built on top of Raspberry Pi OS

• ovos-buildroot - production ready minimal linux for embedded devices, based on ovos-docker and buildroot

• ovos-installer - setup OVOS on top of an existing OS

In these docs you will find info about the architecture of OVOS, the several kinds of plugins available, and OVOS application development guidelines.

External Resources

Docker specific documentation can be found at https://openvoiceos.github.io/ovos-docker

An index of all bus messages emitted or listened too by all the OVOS repositories can be found at https://openvoiceos.github.io/message_spec

If you need to connect remote clients to OVOS, the HiveMind project has it's own dedicated documentations at https://jarbashivemind.github.io/HiveMind-community-docs/

Contributing to Documentation

The OVOS developer documentation is written and maintained by users just like you!

Think of these docs both as your starting point and also forever changing and incomplete

Please open Issues and Pull Requests!