OVOS Quick Start Guide
So you just want to give OVOS a try? Here are the three fastest ways to get started:
NOTE All official OVOS images are running alpha versions of 0.0.7 until OVOS 0.0.8 is released. At that point, users will have the option to choose between alpha or stable versions.
This quick start will help get an OVOS image installed and running on your Raspberry Pi. These images are all 64-bit operating systems.
If you want to build your own 32-bit image for OVOS, note that 32-bit operating systems on the Raspberry Pi will have limited OVOS functionality due to lack of dependency support.
NOTE: The OVOS GUI will not reliably run on a RPi3 and is therefore not recommended for that device.
Download an OVOS image
OVOS provides a couple of different types of pre-built images made specifically for the RPi.
GUI The GUI images allow you to interact with your assistant using a screen along with your voice. There are even skills available specifically designed for use with the GUI.
buildroot - An OS completely built from source so it is optimized for the Rpi.
Features - A small set of skills so you can enjoy your assistant from the first boot. - Fully built from source packages. - This allows the software to be optimized for the hardware being used. - Headless and GUI images - Compatible with RPi4/RPi3b RPi3b headless only - New hardware is being added
raspOVOS - The full OVOS stack on top of the latest Raspberry Pi OS.
Features - A small set of skills so you can enjoy your assistant from the first boot. - Built on top of the latest Raspberry Pi OS providing a full operating system. - Head and GUI images - Compatible with RPi4/RPi3b RPi3b headless only - New hardware coming soon
- raspOVOS Images
- These are unstable builds, and not always working.
- Backup images of previous builds are located here
Docker on Raspberry Pi
The Docker version of OVOS works well on a Raspberry Pi with any distro. It also has a minimal GUI available. For more information, see the Docker instructions.
For most users, the easiest way to get started with OVOS is to use Docker. Docker is a containerization platform that allows you to run applications in a sandboxed environment. This means that you can run OVOS on any operating system that supports Docker, including Windows, MacOS, and Linux. Podman is also supported.
The new OVOS buildroot image (under construction) uses Podman to manage the OVOS services, allowing for easy setup and upgrades.
OVOS Docker provides its own documentation with details on how to use and configure for your situation.
To install Docker, please see the official documentation.
OVOS provides an official installer which should allow you to easily install OVOS to a variety of operating systems including Windows and MacOS. More information on using this tool can be found on the ovos_installer page in these docs.
For Debian-based Linux distros, you can install OVOS manually via a shell script. This is not recommended for most users, but may be useful for developers and advanced users.
OVOS also maintains an Ansible playbook for installing the assistant software. It currently supports Debian-based distros, but support for other distros is planned, and PRs are welcome.
The OVOS community is always happy to help. If you have any questions, please feel free to ask in the OVOS Support Matrix room.
Flashing an image
There are a few ways to flash your image to a drive to use in a Raspberry PI. Both methods described below will work for either OVOS image that you would like to try.
Raspberry PI Imager
This method can be used with a Linux or Windows host machine.
The people at raspberry pi provide a great little program made for burning an image to a device. You can get it here. The team at OVOS has tried to make the setup as simple as possible, and if you follow the steps below, you should have no problems on your first boot.
- Start up the Raspberry Pi Imager. On Linux, start Raspberry Pi Imager with
- For "Choose OS", select "Use custom" and select the OVOS image file downloaded from the step above.
- For "Choose Storage", select your removable boot media, probably something like "Internal SD Card Reader".
- Then select "Write". Do not click the cog. Do not change the username. Username is ovos and is built in. Do not enter WiFi credentials, you will add them at first boot.
Linux dd command
Be careful with the dd command, you can easily render your computer useless if the command is entered wrong
- Find the location of your boot medium with the
- It should show up as something like
sdb. If you are unsure what drive it is, remove it, and run the command again. The one that is missing, is the drive you want to use.
- Write the image to the disk with the
WARNING: Please make sure you are writing to the correct location, as this is the step that can screw everything up
sudo dd if=<path_to_unzipped_image> of=<path_to_boot_medium> bs=4M status=progress
- This step will take several minutes to complete.
- When the command is done, and the prompt apears again, finish the process with the command
With either method used, you should now have a bootable disk to use with your Raspberry PI