[New component] HiFiBerry Sound Card & OnOff SHIM

documentation/builders/README.md

@@ -13,6 +13,12 @@
 * [Card Database](./card-database.md)
 * [Troubleshooting](./troubleshooting.md)
 
+## Components
+* [Power](./components/power/)
+    * [OnOff SHIM for safe power on/off](./components/power/onoff-shim.md)
+* [Soundcards](./components/soundcards/)
+    * [HiFiBerry Boards](./components/soundcards/hifiberry.md)
+
 ## Advanced
 
 * [Bluetooth (and audio buttons)](./bluetooth-audio-buttons.md)

documentation/builders/components/power/onoff-shim.md

@@ -0,0 +1,34 @@
+# OnOff SHIM by Pimorino
+
+The OnOff SHIM from Pimorino allows you to savely start and shutdown your Raspberry Pi through a button. While you can switch of your Phoniebox via an RFID Card (through an RPC command), it is difficult to switch it on again without cutting the physical power supply.
+
+## Installation
+
+To install the software, open a terminal and type the following command to run the one-line-installer. A reboot will be required once the installation is finished.
+
+> [!NOTE]
+> The installations will ask you a few questions. You can safely answer with the default response.
+
+```
+curl https://get.pimoroni.com/onoffshim | bash
+```
+
+* [Source](https://shop.pimoroni.com/products/onoff-shim?variant=41102600138)
+
+## How to manually wire OnOff SHIM
+
+The OnOff SHIM comes with a 12-PIN header which needs soldering. If you want to spare some GPIO pins for other purposes, you can individually wire the OnOff SHIM with the Raspberry Pi. Below you can find a table of Pins to be connected.
+
+| Board pin name | Board pin | Physical RPi pin | RPi pin name |
+|----------------|-----------|------------------|--------------|
+| 3.3V           | 1         | 1, 17            | 3V3 power    |
+| 5V             | 2         | 2                | 5V power     |
+| 5V             | 4         | 4                | 5V power     |
+| GND            | 6         | 6, 9, 20, 25     | Ground       |
+| GPLCLK0        | 7         | 7                | GPIO4        |
+| GPIO17         | 11        | 11               | GPIO17       |
+
+## Assembly options
+
+![](https://cdn.review-images.pimoroni.com/upload-b6276a310ccfbeae93a2d13ec19ab83b-1617096824.jpg?width=640)
+

documentation/builders/components/soundcards/hifiberry.md

@@ -0,0 +1,35 @@
+# HiFiBerry
+
+## Automatic setup
+
+Run the following command to install any HiFiBerry board. Make sure you reboot your device afterwards.
+
+```
+$ cd; cd ~/RPi-Jukebox-RFID/installation/components && chmod +x setup_hifiberry.sh && sudo ./setup_hifiberry.sh
+```
+
+Optional: You can register your sound card with ALSA. Define the following variable before running the script: `CONFIGURE_ALSA=true`
+
+## Additional information
+
+If you like to understand what's happening under the hood, feel free to check the [install script](../../../../installation/components/setup_hifiberry.sh).
+
+The setup is based on [HiFiBerry's instructions](https://www.hifiberry.com/docs/software/configuring-linux-3-18-x/).
+
+## How to manually wire your HiFiBerry board
+
+Most HiFiBerry boards come with 40-pin header that you can directly attach to your Pi. This idles many GPIO pins that may be required for other inputs to be attached (like GPIO buttons or RFID). You can also connect your HiFiBerry board separately. The following table show cases the pins required.
+
+* [Raspberry Pi Pinout](https://github.com/raspberrypi/documentation/blob/develop/documentation/asciidoc/computers/os/using-gpio.adoc)
+
+| Board pin name | Board pin | Physical RPi pin | RPi pin name |
+|----------------|-----------|------------------|--------------|
+| 3.3V           | 1         | 1, 17            | 3V3 power    |
+| 5V             | 2         | 2, 4             | 5V power     |
+| GND            | 6         | 6, 9, 20, 25     | Ground       |
+| PCM_CLK        | 12        | 12               | GPIO18       |
+| PCM_FS         | 36        | 36               | GPIO19       |
+| PCM_DIN        | 38        | 38               | GPIO20       |
+| PCM_DOUT       | 40        | 40               | GPIO21       |
+
+You can find more information about manually wiring [here](https://forum-raspberrypi.de/forum/thread/44967-kein-ton-ueber-hifiberry-miniamp-am-rpi-4/?postID=401305#post401305).

installation/components/setup_hifiberry.sh

@@ -0,0 +1,109 @@
+#!/bin/bash
+
+# This script follows the official HiFiBerry documentation
+# https://www.hifiberry.com/docs/software/configuring-linux-3-18-x/
+
+# Check if the script is run as root
+if [ "$(id -u)" != "0" ]; then
+   echo "This script must be run as root" 1>&2
+   exit 1
+fi
+
+check_existing_hifiberry() {
+    existing_config=$(grep 'dtoverlay=hifiberry-' /boot/config.txt)
+    if [ ! -z "$existing_config" ]; then
+        echo "Existing HiFiBerry configuration detected: $existing_config"
+        read -p "Do you want to proceed with a new configuration? This will remove the existing one. (y/n): " yn
+        case $yn in
+            [Yy]* )
+                remove_existing_hifiberry
+                return 0;;
+            [Nn]* )
+                echo "Exiting without making changes.";
+                exit;;
+            * )
+                echo "Please answer yes or no.";
+                check_existing_hifiberry;;
+        esac
+    fi
+}
+
+remove_existing_hifiberry() {
+    echo "Removing existing HiFiBerry configuration..."
+    sed -i '/dtoverlay=hifiberry-/d' /boot/config.txt
+    sed -i '/dtoverlay=vc4-fkms-v3d,audio=off/c\dtoverlay=vc4-fkms-v3d' /boot/config.txt
+    sed -i '/dtoverlay=vc4-kms-v3d,noaudio/c\dtoverlay=vc4-kms-v3d' /boot/config.txt
+}
+
+enable_hifiberry() {
+    echo "Enabling HiFiBerry board..."
+    grep -qxF "dtoverlay=$1" /boot/config.txt || echo "dtoverlay=$1" >> /boot/config.txt
+}
+
+check_existing_hifiberry
+
+# List of HiFiBerry boards
+echo "
+Select your HiFiBerry board:
+1) DAC for Raspberry Pi 1/DAC+ Light/DAC Zero/MiniAmp/Beocreate/DAC+ DSP/DAC+ RTC
+2) DAC+ Standard/Pro/Amp2
+3) DAC2 HD
+4) DAC+ ADC
+5) DAC+ ADC Pro
+6) Digi+
+7) Digi+ Pro
+8) Amp+ (not Amp2)
+9) Amp3"
+read -p "Enter your choice (1-9): " choice
+
+# Enable selected HiFiBerry board
+case $choice in
+    1) enable_hifiberry "hifiberry-dac";;
+    2) enable_hifiberry "hifiberry-dacplus";;
+    3) enable_hifiberry "hifiberry-dacplushd";;
+    4) enable_hifiberry "hifiberry-dacplusadc";;
+    5) enable_hifiberry "hifiberry-dacplusadcpro";;
+    6) enable_hifiberry "hifiberry-digi";;
+    7) enable_hifiberry "hifiberry-digi-pro";;
+    8) enable_hifiberry "hifiberry-amp";;
+    9) enable_hifiberry "hifiberry-amp3";;
+    *) echo "Invalid selection. Exiting."; exit 1;;
+esac
+
+echo "Disabling onboard sound..."
+sed -i '/dtparam=audio=on/c\dtparam=audio=off' /boot/config.txt
+
+if grep -qx 'dtoverlay=vc4-fkms-v3d' /boot/config.txt; then
+    echo "Disabling audio in vc4-fkms-v3d overlay..."
+    sed -i '/dtoverlay=vc4-fkms-v3d/c\dtoverlay=vc4-fkms-v3d,audio=off' /boot/config.txt
+fi
+
+if grep -qx 'dtoverlay=vc4-kms-v3d' /boot/config.txt; then
+    echo "Disabling audio in vc4-kms-v3d overlay..."
+    sed -i '/dtoverlay=vc4-kms-v3d/c\dtoverlay=vc4-kms-v3d,noaudio' /boot/config.txt
+fi
+
+# Check for CONFIGURE_ALSA environment variable
+if [ "${CONFIGURE_ALSA}" == "true" ]; then
+    if [ -f /etc/asound.conf ]; then
+        echo "Backing up existing asound.conf..."
+        cp /etc/asound.conf "/etc/asound.conf.backup.$(date +%Y%m%d%H%M%S)"
+    fi
+
+    echo "Configuring sound settings in asound.conf..."
+    cat > /etc/asound.conf << EOF
+pcm.hifiberry {
+    type softvol
+    slave.pcm "plughw:0"
+    control.name "HifiBerry"
+    control.card 0
+}
+
+pcm.!default {
+    type plug
+    slave.pcm "hifiberry"
+}
+EOF
+fi
+
+echo "Configuration complete. Please restart your device."