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.

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

[WIP] docs: various updates to documentation #393

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ balenaSound was created as a [hack friday](https://www.balena.io/blog/hack-frida

## Overview

Make sure you checkout our [architecture][../contributing/architecture] guide, which aims to explain how all pieces fit together. It's a good starting point for understanding how we designed and built balenaSound.
Make sure you check out our [architecture](https://sound.balenalabs.io/contributing/architecture/) guide, which aims to explain how all pieces fit together. It's a good starting point for understanding how we designed and built balenaSound.

Another way to improve how you use and contribute to balenaSound is to take our [masterclasses](https://www.balena.io/docs/learn/more/masterclasses/overview/). Each lesson is a self-contained, deep walkthrough on core skills to be successful with your next edge project. Check them out at our [docs](https://www.balena.io/docs/learn/more/masterclasses/overview/).

Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@
## Highlights

- **Bluetooth, Airplay, Spotify Connect and UPnP**: Stream audio from your favourite music services or directly from your smartphone/computer using bluetooth or UPnP.
- **Multi-room synchronous playing**: Play perfectly synchronized audio on multiple devices all over your place.
- **Extended DAC support**: Upgrade your audio quality with one of our [supported DACs](https://sound.balenalabs.io/docs/audio-interfaces/#dac-boards)
- **Multi-room synchronous playing**: Play perfectly synchronized audio on [multiple devices](https://sound.balenalabs.io/docs/device-support/) all over your place.
- **Extended DAC support**: Upgrade your audio quality with one of our [supported DACs](https://sound.balenalabs.io/docs/audio-interfaces/#dac-boards).

## Setup and configuration

Running this project is as simple as deploying it to a balenaCloud application. You can do it in just one click by using the button below:
Running this project is as simple as deploying it to a [balenaCloud](https://www.balena.io/cloud/) application. You can do it in just one click by using the button below:

[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balenalabs/balena-sound&defaultDeviceType=raspberry-pi)
[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balenalabs/balena-sound&defaultDeviceType=raspberry-pi)

## Documentation

Head over to our [docs](https://sound.balenalabs.io/docs/) for detailed installation and usage instructions, customization options and more!

We currently support a [good range of devices](https://sound.balenalabs.io/docs/device-support/) and are always testing more. [Let us know](https://github.com/balenalabs/balena-sound/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) if there are any in particular you would like to see added (it helps a lot if they are already supported by [balenaOS](https://www.balena.io/os/)).

## Motivation

![concept](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/sound.png)
Expand All @@ -26,15 +28,17 @@ There are many commercial solutions out there that provide functionality similar

balenaSound is an open source project that allows you to build your own DIY audio streaming platform without compromises. Why spend big money on hardware that might be deemed obsolete by the vendor as they see fit? With balenaSound you are in control, bring your old speakers back to life!

This project is in active development so if you have any feature requests or issues please submit them here on GitHub. PRs are welcome, too.
This project is in active development so if you have any feature requests or issues please [submit them here](https://github.com/balenalabs/balena-sound/issues/new/choose) on GitHub. PRs are welcome, too.

## Getting Help

If you're having any problem, please [raise an issue](https://github.com/balenalabs/balena-sound/issues/new) on GitHub and we will be happy to help.

## Contributing

Do you want to help make balenaSound better? Take a look at our [Contributing Guide](https://sound.balenalabs.io/contributing). Hope to see you around!
Do you want to help make balenaSound better? Take a look at our [Contributing Guide](https://sound.balenalabs.io/contributing)...we happily welcome PRs to this repo. Hope to see you around!

If you want to find out a little bit more about how balenaSound works (for example how to add your own plugins) then have a look at our [Architecture Guide](https://sound.balenalabs.io/contributing/architecture/).

## License

Expand Down
4 changes: 2 additions & 2 deletions core/audio/balena-sound.pa
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# See https://sound.balenalabs.io/docs/architecture for details
# See https://sound.balenalabs.io/contributing/architecture/ for details

# Create balena-sound sinks
load-module module-null-sink sink_name=balena-sound.input
Expand All @@ -12,4 +12,4 @@ load-module module-loopback latency_msec=%INPUT_LATENCY% source="balena-sound.in
load-module module-loopback latency_msec=%OUTPUT_LATENCY% source="balena-sound.output.monitor" %OUTPUT_SINK%

# Route all plugin input to the default sink
set-default-sink balena-sound.input
set-default-sink balena-sound.input
7 changes: 4 additions & 3 deletions docs/01-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We've outlined the installation steps below. If you want a step-by-step tutorial
- Any device from our [supported devices list](../docs/device-support#recommended). For the best experience, we recommend using a Raspberry Pi 3B+ or 4B.
- An SD Card! We recommend the Sandisk Extreme Pro series. 8GB should be plenty enough for this project.
- Power supply
- 3.5mm audio cable to the input on your speakers/Hi-Fi (usually 3.5mm or RCA). Alternatively you can use the HDMI port to get digital audio out.
- 3.5mm audio cable to the input on your speakers/Hi-Fi (usually 3.5mm or RCA). Alternatively you can use the HDMI port to get digital audio out, or a [USB/I2S DAC or Amp board](https://sound.balenalabs.io/docs/audio-interfaces/)

## Software required

Expand Down Expand Up @@ -68,6 +68,7 @@ For example, if you don't plan on using the Spotify integration, you can edit th

If you are running into issues getting your balenaSound application running, please try the following:
1. Check the [support and troubleshooting guide](../support) for common issues and how to resolve them.
2. Post in the [balenaSound forum](https://forums.balena.io/c/balenalabs/balenasound/85) for help from our growing community.
3. Create an issue on the [balenaSound GitHub project](https://github.com/balenalabs/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound.
2. Take a look at our [architecture](https://sound.balenalabs.io/contributing/architecture/), [usage](https://sound.balenalabs.io/docs/usage), [device support](https://sound.balenalabs.io/docs/device-support/), [audio interfaces](https://sound.balenalabs.io/docs/audio-interfaces/) and [customization](https://sound.balenalabs.io/docs/customization) pages for setup info and tips on using balenaSound.
3. Post in the [balenaSound forum](https://forums.balena.io/c/balenalabs/balenasound/85) for help from our growing community.
4. Create an issue on the [balenaSound GitHub project](https://github.com/balenalabs/balena-sound/issues/new/choose) if you find your issue may be a problem with balenaSound.

15 changes: 11 additions & 4 deletions docs/05-audio-interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ In the balenaCloud dashboard:

![DAC Configuration](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/dac-vars.png)

Alternatively, you can set this configuration variable in the `Define DT overlays` section under the `Device configuration` menu item:

![DAC Configuration Option 2](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/dac-vars-2.png)

As per the above steps, after adding this power cycling your device will then pull in the new overlay.

If you're using multiple devices with multiple DACs for multi-room audio, you'll want to do this process per unique device that is using a DAC. Do not set this variable fleet-wide as it will affect every device within your application.

### dtoverlay values
Expand Down Expand Up @@ -65,11 +71,11 @@ These are the DACs that are known to work with balenaSound. If your DAC is not o
| [Hifiberry Beocreate][22] | hifiberry-dac | Yes
| [Hifiberry DAC+ DSP][23] | hifiberry-dac | Yes
| [Hifiberry MiniAmp][24] | hifiberry-dac | Yes
| [Hifiberry DAC2 HD][27] | hifiberry-dacplushd | Yes
| [Hifiberry DAC2 HD][27] | hifiberry-dacplushd | [Yes][41]
| [Adafruit I2S Audio Bonnet][26]| "hifiberry-dac","i2s-mmap" | Yes
| [Adafruit MAX98357 I2S Class-D Mono Amp][28]| "hifiberry-dac,"i2s-mmap" | Yes
| [RasPiAudio Audio+ DAC][37] | hifiberry-dac | Yes[38]
| [AUDIOPHONICS I-Sabre DAC ES9023][39]| hifiberry-dac | Yes[40]
| [Adafruit MAX98357 I2S Class-D Mono Amp][28]| "hifiberry-dac","i2s-mmap" | Yes
| [RasPiAudio Audio+ DAC][37] | hifiberry-dac | [Yes][38]
| [AUDIOPHONICS I-Sabre DAC ES9023][39]| hifiberry-dac | [Yes][40]

[1]: http://www.suptronics.com/Xseries/x400.html
[2]: https://shop.pimoroni.com/products/phat-dac
Expand Down Expand Up @@ -111,3 +117,4 @@ These are the DACs that are known to work with balenaSound. If your DAC is not o
[38]: https://github.com/balenalabs/balena-sound/issues/355
[39]: https://www.audiophonics.fr/fr/dac-et-interfaces-pour-raspberry-pi/audiophonics-i-sabre-dac-es9023-tcxo-raspberry-pi-a-b-20-i2s-p-9978.html
[40]: https://github.com/balenalabs/balena-sound/issues/345
[41]: https://github.com/balenalabs/balena-sound/issues/377
Binary file added docs/images/dac-vars-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.