Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GitHub contributors License: MIT

HiFiBerryOS

HiFiBerryOS is our version of a minimal Linux distribution optimized for audio playback. The goal isn't to add as much functionality as possible, but to keep it small. Therefore, it is based on Buildroot and it's not possible to use package managers to add more software.

There is a robust update mechanism that will not overwrite the system, but switch between the current and the new version (they run on different partitions). This is documented in more detail at doc/updater.md.

User interface

The user interface is based on the Bang & Olufsen Beocreate project.

Services

At the moment, the following services are supported:

Tools

Additional tools that are available:

Integrations and additional functionalities

There are several ways to add functionalities to HiFiBerryOS or integrate it into other systems.

Controlling the system

The main backend controller application is called audiocontrol and offers an API that can be used to start/stop players, switch sources or retrieve metadata. This is often the easiest way if you want to integrate it into other systems, e.g. a automation system.

Extending audiocontrol

Audiocontrol provides a plugin system that can be used to add more complex integrations.Also have a look at the "Anatomy of a controller plugin"

Adding packages

HiFiBerryOS is based on buildroot. This means, you can't easily install additional software from command line. Even if you do, it will be gone after the next update as an update will replace the full filesystem. You need to integrate additonal software via the Buildroot build system

Adding UI components

The UI also uses a plugin concept. Plugins are called extensions. Have a look at the Beocreate documentation

How it works / technical documentation

You can find technical documentation in the repository's doc folder

Building a disk image

The documentation for building images from source can be found here

Contributions

We're looking forward to your contributions. Depending on functionality and code quality, we will decide if a contribution will be included in the base system or will be provided as a user-contributed module that users need to install by themselve.