From 5a0bd2c8c04191839d705381a88c38d1ce5e84dc Mon Sep 17 00:00:00 2001 From: Roddie Hasan Date: Sat, 10 Apr 2021 15:03:43 -0500 Subject: [PATCH 01/13] docs: Add upgrade instructions to docs Connects-to: #434 Change-type: patch Signed-off-by: Roddie Hasan --- README.md | 2 +- docs/01-getting-started.md | 19 ++++++++++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d88790740..8911ded55 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Running this project is as simple as deploying it to a balenaCloud application. ## Documentation -Head over to our [docs](https://sound.balenalabs.io/docs/) for detailed installation and usage instructions, customization options and more! +Head over to our [docs](https://sound.balenalabs.io/docs/) for detailed installation and usage instructions, customization options, and more! ## Motivation diff --git a/docs/01-getting-started.md b/docs/01-getting-started.md index 70ce9d102..403e27e3d 100644 --- a/docs/01-getting-started.md +++ b/docs/01-getting-started.md @@ -62,8 +62,25 @@ For example, if you don't plan on using the Spotify integration, you can edit th - Install the [balena CLI tools](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md) - Login with `balena login` -- Download this [project](https://github.com/balenalabs/balena-sound/) and from the project directory run `balena push ` where `` is the name you gave your balenaCloud application in the first step. +- Download this [project](https://github.com/balenalabs/balena-sound/) and from the project directory run `balena push ` where `` is the name you gave your balenaCloud application in the first step. +## Upgrade + +### Upgrading via CLI + +To deploy bug fixes or new features to your balenaSound application, the process is the same as a deployment: + +- Install the [balena CLI tools](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md) +- Login with `balena login` +- Download this [project](https://github.com/balenalabs/balena-sound/) and from the project directory run `balena push ` where `` is the name you gave your balenaCloud application during the provision step above. + +> **Note:** If you receive the message "Application is ambiguous" during the push, then you will need to specify your balenaCloud username along with the ``, ie. `balena push /` + +### Upgrading via one-click + +To update your application via one-click deploy just click the Deploy with balena button below. Make sure you select your already existing balenaSound application so you don't create a new one! + +[![balena deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balenalabs/balena-sound&defaultDeviceType=raspberry-pi) ## Having trouble? If you are running into issues getting your balenaSound application running, please try the following: From 2f086365681fd8006a2691cf3bb8ddd7e68d8399 Mon Sep 17 00:00:00 2001 From: maik <128029+mauk81@users.noreply.github.com> Date: Wed, 3 Aug 2022 18:06:09 +0200 Subject: [PATCH 02/13] fix link --- docs/01-getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/01-getting-started.md b/docs/01-getting-started.md index 70ce9d102..e13d45e94 100644 --- a/docs/01-getting-started.md +++ b/docs/01-getting-started.md @@ -10,7 +10,7 @@ We've outlined the installation steps below. If you want a step-by-step tutorial ![hardware](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/hardware.jpeg) -- Any device from our [supported devices list](../docs/device-support#recommended). For the best experience, we recommend using a Raspberry Pi 3B+ or 4B. +- 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. From 8166e3f890128e02943da2480b7578a656efc629 Mon Sep 17 00:00:00 2001 From: Nick Sturgess Date: Fri, 26 Aug 2022 12:45:42 +1000 Subject: [PATCH 03/13] Change broken relative links to absolute --- docs/02-usage.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/02-usage.md b/docs/02-usage.md index 290845210..20270857e 100644 --- a/docs/02-usage.md +++ b/docs/02-usage.md @@ -2,7 +2,7 @@ After your device finishes downloading the application, you should be ready to go! -Before starting, make sure to connect the audio output of your device to your Hi-Fi or speaker system. Remember that we support multiple [audio interfaces](../docs/audio-interfaces). This is helpful if you're interested in improving the audio quality of your setup-- be sure to check it out. +Before starting, make sure to connect the audio output of your device to your Hi-Fi or speaker system. Remember that we support multiple [audio interfaces](/docs/audio-interfaces). This is helpful if you're interested in improving the audio quality of your setup-- be sure to check it out. To connect to your balenaSound device: @@ -23,9 +23,9 @@ balenaSound supports multiple modes of operation described below: * Multi-room client mode * Standalone -By default, most devices will start in multi-room mode. You can change that by setting an environment variable, check out the [customization](../docs/customization#general) section to learn how. +By default, most devices will start in multi-room mode. You can change that by setting an environment variable, check out the [customization](/docs/customization#general) section to learn how. -**Note:** Multi-room mode is the default mode for most (but not all!) device types. You can read more about default modes [here](../docs/device-support#recommended). +**Note:** Multi-room mode is the default mode for most (but not all!) device types. You can read more about default modes [here](/docs/device-support#recommended). ### Multi-room mode @@ -59,16 +59,16 @@ balenaSound has been re-designed to easily allow integration with audio streamin | Plugin | Library/Project | | ------ | ------ | -| Spotify | [raspotify](https://github.com/dtcooper/raspotify/) Spotify Connect only works with Spotify Premium accounts. Zeroconf authentication via your phone/device Spotify client is supported as well as providing user and password, see [customization](../docs/customization#plugins) section for details. | +| Spotify | [raspotify](https://github.com/dtcooper/raspotify/) Spotify Connect only works with Spotify Premium accounts. Zeroconf authentication via your phone/device Spotify client is supported as well as providing user and password, see [customization](/docs/customization#plugins) section for details. | | AirPlay | [shairport-sync](https://github.com/mikebrady/shairport-sync/) | | UPnP | [gmrenderer-resurrect](https://github.com/hzeller/gmrender-resurrect) | | Bluetooth | balena [bluetooth](https://github.com/balenablocks/bluetooth/) and [audio](https://github.com/balenablocks/audio) blocks | -| Soundcard input | Experimental support through the balena [audio](https://github.com/balenablocks/audio) block. Check the [customization](../docs/customization#plugins) section to learn how to enable it. | +| Soundcard input | Experimental support through the balena [audio](https://github.com/balenablocks/audio) block. Check the [customization](/docs/customization#plugins) section to learn how to enable it. | -If your desired audio source is not supported feel free to [reach out](../docs/support#contact-us) and leave us a comment. We've also considerably simplified the process of adding new plugins, so [PR's are welcome](../../contributing) too (be be sure to check out our balenaSound [architecture](../../contributing/architecture) guide)! +If your desired audio source is not supported feel free to [reach out](/docs/support#contact-us) and leave us a comment. We've also considerably simplified the process of adding new plugins, so [PR's are welcome](/contributing) too (be be sure to check out our balenaSound [architecture](/contributing/architecture) guide)! ## Audio interfaces -balenaSound supports all audio interfaces present on our [supported devices](../docs/device-support) be it 3.5mm audio jack, HDMI, I2C DAC's or USB soundcards. We rely on [balenaLabs' audio block](https://github.com/balenablocks/audio) to do the configuration required for this to work. +balenaSound supports all audio interfaces present on our [supported devices](/docs/device-support) be it 3.5mm audio jack, HDMI, I2C DAC's or USB soundcards. We rely on [balenaLabs' audio block](https://github.com/balenablocks/audio) to do the configuration required for this to work. -Some audio interfaces require special configuration, you can read more about this in the [audio interfaces](../docs/audio-interfaces) configuration section. +Some audio interfaces require special configuration, you can read more about this in the [audio interfaces](/docs/audio-interfaces) configuration section. From 5439c4ed3f985bafd9d5939c930aacb90155d6c3 Mon Sep 17 00:00:00 2001 From: Flynn Joffray Date: Mon, 24 Oct 2022 13:41:03 -0700 Subject: [PATCH 04/13] Changing references from balenalabs to balena-labs-projects Signed-off-by: Flynn Joffray Change-type: patch --- ARCHITECTURE.md | 6 +++--- CONTRIBUTING.md | 2 +- FAQ.md | 2 +- README.md | 6 +++--- balena.yml | 4 ++-- core/multiroom/client/start.sh | 2 +- core/sound-supervisor/src/ui/index.html | 4 ++-- docs/01-getting-started.md | 6 +++--- docs/04-plugins.md | 6 +++--- docs/05-audio-interfaces.md | 14 +++++++------- docs/07-support.md | 10 +++++----- 11 files changed, 31 insertions(+), 31 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index d15cfda2e..b5dfe0fcc 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -4,7 +4,7 @@ Community contributions have been a staple of this open source project since its ## Overview -![](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/arch-overview.png) +![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-overview.png) balenaSound services can be divided in three groups: - Sound core: `sound-supervisor` and `audio`. @@ -63,13 +63,13 @@ Creation and configuration scripts for these virtual sinks are located at `core/ `balena-sound.output` on the other hand is the output audio multiplexer/mixer. This one is pretty useful in scenarios where there are multiple soundcards available (onboard, DAC, USB, etc). `balena-sound.output` is always wired to whatever the desired soundcard sink is. So even if we dynamically change the output selection, sending audio to `balena-sound.output` will always result in audio going to the current selection. Again, this is useful to route audio internally without worrying about user selection at runtime. ### Standalone -![](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/arch-standalone.png) +![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-standalone.png) Standalone mode is easy to understand. You just pipe ` balena-sound.input` to `balena-sound.output` and that's it. Audio coming in from any plugin will find it's way to the selected output. If this was the only mode, we could simplify the setup and use a single sink. Having the two layers however is important for the next mode which is more complicated. ### Multiroom -![](https://raw.githubusercontent.com/balenalabs/balena-sound/master/docs/images/arch-multiroom.png) +![](https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/docs/images/arch-multiroom.png) Multiroom feature relies on `snapcast` to broadcast the audio to multiple devices. Snapcast has two binaries working alonside, server and client. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index baa78ef6d..6231e9d4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ Pull requests are the only way of pushing your code to the `master` branch. When ### PR approval The PR will only be able to be merged only after: -- It has been approved at least by one [codeowner](https://github.com/balenalabs/balena-sound/blob/master/.github/CODEOWNERS) +- It has been approved at least by one [codeowner](https://github.com/balena-labs-projects/balena-sound/blob/master/.github/CODEOWNERS) - All the checks and tests carried out by our CI are passed diff --git a/FAQ.md b/FAQ.md index b27149cc6..88514b2cb 100644 --- a/FAQ.md +++ b/FAQ.md @@ -6,7 +6,7 @@ Yes! balenaSound requires you to sign up for a free [balenaCloud](https://dashbo free and full-featured. ## Privacy: is balenaSound secure? -balenaSound does not not depend on any type of cloud service to deliver a great experience. Other than that, your device will be running balenaOS which does communicate with balenaCloud to get application updates. This can be disabled however and won't affect your experience. Both [balenaSound](https://github.com/balenalabs/balena-sound/) and [balenaOS](https://github.com/balena-os) are open source projects, so feel free to check the source code if you want to know more about how they work! +balenaSound does not not depend on any type of cloud service to deliver a great experience. Other than that, your device will be running balenaOS which does communicate with balenaCloud to get application updates. This can be disabled however and won't affect your experience. Both [balenaSound](https://github.com/balena-labs-projects/balena-sound/) and [balenaOS](https://github.com/balena-os) are open source projects, so feel free to check the source code if you want to know more about how they work! ## Does balenaSound need internet access? You don't need an internet connection to use balenaSound as speakers (assuming all the apps are downloaded to the devices, set up, and updated), but you need to have music sources on the same shared network or bluetooth-connected devices within range. Accessing apps like Spotify as a music source requires an internet connection. diff --git a/README.md b/README.md index d88790740..0319a5cc3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ 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: -[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balenalabs/balena-sound&defaultDeviceType=raspberry-pi) +[![deploy button](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/balena-labs-projects/balena-sound&defaultDeviceType=raspberry-pi) ## Documentation @@ -30,7 +30,7 @@ This project is in active development so if you have any feature requests or iss ## 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. +If you're having any problem, please [raise an issue](https://github.com/balena-labs-projects/balena-sound/issues/new) on GitHub and we will be happy to help. ## Contributing @@ -38,4 +38,4 @@ Do you want to help make balenaSound better? Take a look at our [Contributing Gu ## License -balenaSound is free software, and may be redistributed under the terms specified in the [license](https://github.com/balenalabs/balena-sound/blob/master/LICENSE). +balenaSound is free software, and may be redistributed under the terms specified in the [license](https://github.com/balena-labs-projects/balena-sound/blob/master/LICENSE). diff --git a/balena.yml b/balena.yml index adefd6d51..63df73ca9 100644 --- a/balena.yml +++ b/balena.yml @@ -22,12 +22,12 @@ assets: repository: type: blob.asset data: - url: 'https://github.com/balenalabs/balena-sound' + url: 'https://github.com/balena-labs-projects/balena-sound' logo: type: blob.asset data: url: >- - https://raw.githubusercontent.com/balenalabs/balena-sound/master/logo.png + https://raw.githubusercontent.com/balena-labs-projects/balena-sound/master/logo.png data: applicationEnvironmentVariables: - SOUND_VOLUME: 75 diff --git a/core/multiroom/client/start.sh b/core/multiroom/client/start.sh index e6e1384ed..9c6ec31e8 100644 --- a/core/multiroom/client/start.sh +++ b/core/multiroom/client/start.sh @@ -20,7 +20,7 @@ echo "Starting multi-room client..." echo "- balenaSound mode: $MODE" echo "- Target snapcast server: $SNAPSERVER" -# Set the snapcast device name for https://github.com/balenalabs/balena-sound/issues/332 +# Set the snapcast device name for https://github.com/balena-labs-projects/balena-sound/issues/332 if [[ -z $SOUND_DEVICE_NAME ]]; then SNAPCAST_CLIENT_ID=$BALENA_DEVICE_UUID else diff --git a/core/sound-supervisor/src/ui/index.html b/core/sound-supervisor/src/ui/index.html index e9dca4f77..ef184f4bd 100644 --- a/core/sound-supervisor/src/ui/index.html +++ b/core/sound-supervisor/src/ui/index.html @@ -23,7 +23,7 @@