Go to file
j1nx 4a2aec918b [ALL] Disable MPRIS support for now (one step at a time) 2023-11-07 09:45:18 +00:00
.github/ISSUE_TEMPLATE Update issue templates 2022-03-14 12:25:25 +01:00
buildroot@debfa2daa1 [ALL] Bump buildroot 2023-11-06 14:49:03 +00:00
buildroot-external [ALL] Disable MPRIS support for now (one step at a time) 2023-11-07 09:45:18 +00:00
documentation Update kernel.md 2022-06-01 17:02:22 +02:00
logs Add empty logs and release directory by default 2021-05-01 09:08:42 +02:00
release Add empty logs and release directory by default 2021-05-01 09:08:42 +02:00
scripts MycroftOS: BNuilding now uses a proper Makefile. 2019-12-10 13:21:49 +01:00
.gitignore More work and get rpi4 inline 2023-08-21 08:05:43 +00:00
.gitmodules WIP push for backup (Sorry for the mess) 2023-08-08 13:08:11 +00:00
Jenkinsfile convert all steps to use sh in jenkins 2021-02-27 16:56:01 +05:30
LICENSE MycroftOS: Initial setup 2018-10-26 15:02:09 +02:00
Makefile More work and get rpi4 inline 2023-08-21 08:05:43 +00:00
README.md First pass on documentation changes within README 2023-08-26 18:47:43 +00:00

README.md

Open Voice Operating System - Buildroot Edition

A minimalistic Linux OS bringing the open source voice assistant ovos-core to embedded, low-spec headless and/or small (touch)screen devices.

System.

OpenVoiceOS - Full 64 Bit distribution

  • Linux kernel 6.1.x (LTS)
  • Buildroot 2023.02.x (LTS) (With some modification here and there)
  • OVOS framework / software package utilizing ovos-docker containers (Currently latest alpha/development version)
  • Raspberry Pi 3|3b|3b+
  • Raspberry Pi 4
  • x86_64 Intel based computers (UEFI based)
  • Open Virtual Appliance (UEFI based)

Stats:

Build Status GitHub last commit
This shows if the code is valid and can be build. This shows when this repo was updated for the last time
GitHub stars GitHub issues
Please this repo if you find it useful Issues are like my personal TODO list and information archive
License: Apache License 2.0 contributions welcome
I'm using the Apache License 2.0 similar as Mycroft A.I. which means commercial use is allowed If you have any ideas, they're always welcome. Either submit an issue or a PR!
Uptime Robot status Buy me a
I use uptime robot to monitor for things i can't monitor when the connection drops. If you feel the need, now it's as easy as clicking this button!

Getting started.

Only use x86_64 based architecture/ hardware to build the image.

The following example Build environment has been tested :

  • Architecture: x86_64
  • Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on less RAM (2GB) and slower storage but more RAM, faster storage = quicker image building)
  • OS: Ubuntu 22.04 LTS desktop

Installing System Build Dependencies

Buildroot dependencies must be installed as a prerequisite, assuming apt:

sudo apt-get install -y
bash
bc
binutils
build-essential
bzip2
cpio
diffutils
file
findutils
gzip
libarchive-tools
make
patch
perl
rsync
sed
tar
unzip
wget
which

The following firewall ports need to be allowed to the internet.

In addition to the usual http/https ports (tcp 80, tcp 443) a couple of other ports need to be allowed to the internet :

  • tcp 9418 (git).
  • tcp 21 (ftp PASV) and random ports for DATA channel. This can be optional but better to have this allowed along with the corresponding random data channel ports. (knowledge of firewalls required)

Getting the code.

First, get the code on your system! The simplest method is via git.

Building the image.

Building the image(s) can be done by utilizing a proper Makefile;
To see the available commands, just run: 'make help'
As example to build the rpi4 version;

  • make clean
  • make rpi4_64

When everything goes fine the created images/files will be available within the release directory.

Documentation.

More information and instructions can be found within the "documentation" folder.

Credits

Mycroft AI (@MycroftAI)
Buildroot (@buildroot) HelloChatterbox (@hellochatterbox)
HassOS (@home-assistant)

Inspired by;

HassOS (@home-assistant)