Skip to content

Latest commit

 

History

History
77 lines (67 loc) · 6.87 KB

Development.md

File metadata and controls

77 lines (67 loc) · 6.87 KB
Raw

Setup development environment / IDE

Development system

  • Raspberry Pi 4 Model B With Raspberry OS Bookworm or Ubuntu 22.04 LTS VM on Hyper-V/Windows 11
  • User name raspifm

If not mentioned otherwise, setup instructions refer to this setup.

Update your package repository

Do a sudo apt update first.

Hardware setup

  • If you develop on the Raspberry and want to attach parts of the full hardware setup, e.g. the MiniAmp with speakers, see installation documentation for hardware installation

IDE Setup / Build instructions for Raspberry Pi OS/Linux

    1. On other Linux distributions than Raspberry Pi OS, e.g. Ubuntu you may need to install git: sudo apt install git
    1. Create a new directory for the repository: mkdir ~/raspifm_repo and switch to the directory: cd ~/raspifm_repo.
    1. Clone the repository: git clone https://github.com/Drexel2k/raspiFM .
    1. Install Visual Studio Code with Python Extension,sudo apt install code (on Ubuntu from Ubuntu Software), Python extension in the extension manager of VSC
    1. Install Qt (touch ui), sudo apt install qt6-base-dev libqt6svg6-dev qt6-wayland, on Ubuntu 22.04 sudo apt install qt6-base-dev is sufficient, as it uses x11
    1. On other Linux distributions than Raspberry Pi OS, e.g. Ubuntu you may need to install build packages and VLC media player, sudo apt install build-essential pkg-config libdbus-1-dev libglib2.0-dev python3-dev vlc.
    1. Install PyQt6 from apt repository (a) or if it isn't available (on Ubuntu 22.04 e.g.), if you want the latest version or if you want it as .venv package, take it from the lib directory (b) or install from source (c)
    • a) sudo apt install python3-pyqt6
    • b) Further steps follow on stepp 12
    • c) Install further libs needed on Ubuntu sudo apt install mesa-common-dev
      • On Ubuntu 22.04 you need to set up a workaround for Qt6 to be found by QtChooser an make it the default Qt version:
      • qtchooser -install qt6 $(which qmake6)
      • sudo mv ~/.config/qtchooser/qt6.conf /usr/share/qtchooser/qt6.conf
      • sudo mkdir -p /usr/lib/$(uname -p)-linux-gnu/qt-default/qtchooser
      • sudo rm /usr/lib/$(uname -p)-linux-gnu/qt-default/qtchooser/default.conf
      • sudo ln -s /usr/share/qtchooser/qt6.conf /usr/lib/$(uname -p)-linux-gnu/qt-default/qtchooser/default.conf
      • Further steps follow on stepp 12

In Visual Studio Code:

    1. Open the ~/raspifm_repo directory wioth File -> Open Folder.
    1. Command Palette -> Python: Create Environment
    1. Create venv environement, select to install requirements
    1. Command Palette -> Python: Create Terminal
    1. If you have chosen 7b, install the wheel from libs:
    • x64: pip install ~/raspifm_repo/libs/PyQt6-6.6.1-cp38-abi3-manylinux_2_28_x86_64.whl (built with Qt 6.2.4)
    • arm64: pip install ~/raspifm_repo/libs/PyQt6-6.6.1-cp38-abi3-manylinux_2_28_aarch64.whl (built with Qt 6.2.4)
    1. If you have chosen 4c:
    • Download source from https://pypi.org/project/PyQt6/#files, extract with tar -xzf PyQt6-6.6.1.tar.gz e.g.
    • Install sip tools: pip install PyQt-builder
    • Add path to qmake directory to path environment variable: export PATH="$PATH:/usr/lib/qt6/bin" (not required on Ubuntu)
    • Change terminal directory to the path of tthe source: cd /path/to/extraded/archive/PyQt6-6.6.1
    • Build wheel from the source: sip-wheel --confirm-license --verbose --qmake-setting 'QMAKE_LIBS_LIBATOMIC = -latomic', this takes some hours on Raspberry
    • Install the wheel: pip install ./PyQt6-6.6.1-cp38-abi3-manylinux_2_28_x86_64.whl or whatever the outputfile is called

Requirements for Spotify Connect for Raspberry Pi OS/Linux

To use the Spotify conncet feature, spotifyd needs to be installed. Unfortunetally, spotifyd delivers only 32 bit binaries, so we have to build a 64 bit version by ourselves or use the binary from libs directory (or setup a 32 bit environment in the 64 bit raspberry pi OS).

If you want to build your spotifyd 64 bit binary, follow start with step 1.
If you want to use the file from the libs directory skip step 1 to 9 and start from step 10.

To build a 64 bit spotifyd binary:

    1. Uninstall current rust compiler if one is installed, it may be to old, e.g. by: sudo apt remove rustc or rustup self uninstall
    1. On other Linux distributions than Raspberry Pi OS, e.g. Ubuntu you may need to install curl to install the current rust tolchain: sudo apt install curl
    1. Install current rust toolchain, select option 1: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    1. Setup environment variable: source "$HOME/.cargo/env"
    1. Create a new directory for the repository: mkdir ~/spotifyd_repo and switch to the directory: cd ~/spotifyd_repo.
    1. Clone the repository: git clone https://github.com/Spotifyd/spotifyd.git .
    1. Install required packages: sudo apt install libasound2-dev libdbus-1-dev, on other Linux distributions than Raspberry, e.g. Ubuntu you may need to install further packages to compile spotifyd, sudo apt install build-essential pkg-config, some of these packages may also already be installed during IDE setup.
    1. If you do not want to compile the latest commit, but the latest release, look up the latest release tag: https://github.com/Spotifyd/spotifyd/releases or https://github.com/Spotifyd/spotifyd/tags and do: git checkout tags/v0.3.5 e.g. - Care! Current spotifyd stable release hase some issues due to Spotify backend changes. Maybe use the latest commit and patch the librespot to 0.4.2 (Spotifyd/spotifyd#1301).
    1. Build spotifyd with DBus support: cargo build --release --features dbus_mpris,pulseaudio_backend, this takes some minutes

Install spotifiyd and set up the daemon:

    1. Copy the compiled file to /usr/bin: sudo cp ./target/release/spotifyd /usr/bin or use the file from libs(spotifyd-0.3.5-dbus-pulse_aarch64):
    • x64: sudo cp ~/raspifm_repo/libs/spotifyd-0.3.5-dbus-pulse_x86_64 /usr/bin/spotifyd
      • Care! Current spotifyd stable release hase some issues due to Spotify backend changes. Use the latest build instead: sudo cp ~/raspifm_repo/libs/spotifyd-commit-e280d84124d854af3c2f9509ba496b1c2ba6a1ae-librespot-0.4.2-dbus-pulse_aarch64 /usr/bin/spotifyd
    • arm64: sudo cp ~/raspifm_repo/libs/spotifyd-0.3.5-dbus-pulse_aarch64 /usr/bin/spotifyd
    1. Copy the spotifyd config file from configs to /etc: sudo cp ~/raspifm_repo/configs/spotifyd.conf /etc
    1. Set up daemon: Copy the file from configs to /etc/systemd/system: sudo cp ~/raspifm_repo/configs/spotifyd.service /etc/systemd/user
    1. Enable the daemon/autostart: systemctl --user enable spotifyd.service
    1. Allow the spotifyd daemon to register services on the system DBus: Copy the file from configs to /usr/share/dbus-1/system.d: sudo cp ~/raspifm_repo/configs/spotifyd-dbus.conf /usr/share/dbus-1/system.d
    1. Reboot