Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Documentation Hyperlinks #643

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update Documentation Hyperlinks #643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
81555ed
Update 05-audio-interfaces.md
greenreader9 May 30, 2023
beb710f
Update 06-device-support.md
greenreader9 May 30, 2023
be4e925
Merge pull request #1 from greenreader9/patch-2
greenreader9 May 30, 2023
94545bb
Update 07-support.md
greenreader9 May 30, 2023
f6013e0
Update 06-device-support.md
greenreader9 May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/05-audio-interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ balenaSound supports a wide variety of DACs, but in an ever-growing market, chan

Latest versions of balenaOS already ships with drivers for most, if not all, of the DACs available. The testing story, however, is different. It's not possible for us to test all of them individually as it would take an incredible amount of resources. For this reason, we rely on community contributions to help catalogue existing DACs into three categories:

- [Supported DACs](#Supported-DACs): battle-tested, known to work with balenaSound.
- [Untested DACs](#Untested-DACs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one).
- [Unsupported DACs](#Unsupported-DACs): DACs that probably need additional drivers that aren't currently available in balenaOS.
- [Supported DACs](#supported-dacs): battle-tested, known to work with balenaSound.
- [Untested DACs](#untested-dacs): DACs whose drivers are included in balenaOS but haven't been tested with balenaSound (most likely because no balena team member has one).
- [Unsupported DACs](#unsupported-dacs): DACs that probably need additional drivers that aren't currently available in balenaOS.

A curated list for all three categories can be found in the sections below. If you don't find your DAC anywhere, please add a comment to [this](https://github.com/balena-labs-projects/balena-sound/issues/439) GitHub issue and we'll take a look for you.

Expand Down
2 changes: 1 addition & 1 deletion docs/06-device-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ balenaSound has been developed and tested to work on the following devices:

[2]: Multi-room `master` functionality is disabled on Raspberry Pi 1 and 2 family devices due to performance constraints. They can however function in multi-room client mode in conjunction with another device that supports multi-room mode. Read more about modes of operation [here](usage#modes-of-operation).

[3]: There is a known issue where on the 64 bit version of balenaOS no output is coming through the audio jack/hdmi. See troubleshooting section [here](https://balena-labs-projects.github.io/balena-sound/usage#modes-of-operation/support#troubleshooting) (Scroll down to `No audio when using balenaOS 64 bit on Raspberry Pi 3's`)
[3]: There is a known issue where on the 64 bit version of balenaOS no output is coming through the audio jack/hdmi. See troubleshooting section [here](https://balena-labs-projects.github.io/balena-sound/support#no-audio-when-using-balenaos-64-bit-on-raspberry-pi-3s) (Scroll down to `No audio when using balenaOS 64 bit on Raspberry Pi 3's`)

[4]: There is a [known issue](https://github.com/raspberrypi/linux/issues/1444) with all variants of the Raspberry Pi 3 where Bluetooth and WiFi interfere with each other. This will only impact the performance of balenaSound if you use a **Pi 3 as the master server to do multi-room bluetooth streaming**, resulting in stuttering audio (Airplay and Spotify Connect will work fine, as well as all streaming methods with multi-room disabled). In this cases we recommend the use of a Raspberry Pi 4 as the `master` server or a Pi 3 with a bluetooth dongle.

Expand Down
2 changes: 1 addition & 1 deletion docs/07-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Ensure that:
- You correctly plugged an audio or HDMI cable to your device
- You are connected to the device and streaming audio to it via any of the supported alternatives

If you are using a DAC, make sure your DAC is on the supported list [here](audio-interfaces#dac-boards) and that you applied the required configuration changes. If your DAC is not on the list, please let us know by opening an [issue](https://github.com/balena-labs-projects/balena-sound/issues/new). We will work with you to find the correct configuration and add the DAC to the supported list.
If you are using a DAC, make sure your DAC is on the supported list [here](audio-interfaces#supported-dacs) and that you applied the required configuration changes. If your DAC is not on the list, please let us know by opening an [issue](https://github.com/balena-labs-projects/balena-sound/issues/new). We will work with you to find the correct configuration and add the DAC to the supported list.

### Audio cuts or is very stuttery

Expand Down