v3.5.0-alpha

Important

Currently no updates can be performed and new installation is needed. See Note for further information

Summary

Features

• New card actions for playback (play, pause, prev, next, toggle, repeat, shuffle)
• Support for Network management via NetworkManager (incl Autohotspot)
• Setup script for HifiBerry Soundcards
• New support for RFID Reader without HID Driver (NFCPy)
• Welcome message on system login

Improvements

• Web App Bundle is now automatically build on commit for official branches (main, develop)
• Kioskmode setup is officially unsupported for arm6 devices and now deactivated in the installer for those
• Github Workflow tests
• Documentation (updates and wording)

Fixes

• Cover Art is working again
• Python venv activation is now integrated for common scripts (see docs for new location of scripts to run)
• Network management via dhcpcd (StaticIP, IPv6)
• Prevent rerun of installer on existing installations due to unexpected and destructive behavior (see Note)
• Other minor fixes

Note

As there are some significant changes in the Jukebox installation, no updates can currently be performed. To get the new version, a new installation on a fresh image has to be done. See How to Update

We are sorry for the inconvenience and working on a fix for the next Release!

How to update

Documentation

v3.4.0

Important

Currently network related features are broken on bookworm, due to changes on the network config. For a status and a workaround see #2184

Summary

• CI Workflow
• Allow custom username
• Bump libzmq to 4.3.5
  • Fixes Webapp not working in Firefox
• Introduce better functions for Installation logging
• Documentation updates
• Minor fixes

Note

See Notes of v3.3.0 for changes of python plugin installation and manual usage

How to update

Documentation

What's Changed

• Add installation checks + CI Workflow by @AlvinSchiller in #2119
• Add badges to future3 by @s-martin in #2133
• future3 - allow custom username by @AlvinSchiller in #2132
• Future3/bump-libzmq by @pabera in #2135
• [Bugfix] Webapp allows to assign single song to card by @pabera in #2143
• [Docs] Inform about Python venv by @pabera in #2147
• Add running pytest to GitHub action by @s-martin in #2146
• [Bugfix] setup_autohotspot.sh for multiple wifi country codes, use first by @ben0r33 in #2150
• some documentation updates by @AlvinSchiller in #2151
• Better logging functions for Installation script by @pabera in #2152
• Minor doc improvements by @s-martin in #2149
• Add coverage badge by @s-martin in #2153
• Release v3.4.0 by @pabera in #2137
• Update version to 3.4.0 by @AlvinSchiller in #2155

New Contributors

• @ben0r33 made their first contribution in #2150

Full Changelog: v3.3.0...v3.4.0

v3.3.0

Summary

• Bookworm Support
• Documentation in Github (removed Sphinx and Readthedocs)
• Webapp Dependency updates
• Python Dependency updates
• Python venv
• Better Dockerfiles
• Installation fixes

Note

With Bookworm Debian followed Pythons PEP668. To fully support this all python plugins
are now installed in an virtual environment located in the project root ~/RPi-Jukebox-RFID/.venv.

This changes the way configuration scripts need to be run, as the venv has to be activated first.
To do this execute the command source ~/RPi-Jukebox-RFID/.venv/bin/activate prior to calling any python script manually.
If the venv was activated correctly your terminal should have now a prefix (.venv)
If you want to leave the venv again execute deactivate.

How to update

As there are some significant changes in the installation, a new setup on a fresh image is required.

What's Changed

• typos in docs by @kugelzucker in #1950
• Fix count in flake8 config by @s-martin in #1954
• a few more typos and wordings by @kugelzucker in #1952
• Use env variables for pyzmq by @notapirate in #1928
• Fix Workflow Actions flake8 (future3) by @AlvinSchiller in #1989
• update webapp dependencies by @pabera in #2010
• Fix typo in System Setup chapter by @micxer in #2012
• future3 - Feature "sync shared" by @AlvinSchiller in #2009
• future3 - Editorconfig: Fix indent_size for js and yaml files by @AlvinSchiller in #2026
• Add info to install script and documentation about 64bit systems #2041 by @pabera in #2057
• Add dependabot.yml by @s-martin in #2022
• future3: Abort installation if user is not "pi" by @AlvinSchiller in #2077
• fix unavailable repo for pi-rc522 by @AlvinSchiller in #2075
• docker: optimizations by @notapirate in #2074
• Fix pyzmq installation from source with drafts support by @DivineDominion in #2096
• Remove unused _jukebox_core_download_prebuilt_pyzmq by @DivineDominion in #2097
• future3 - Move docs back to Github & markdown by @pabera in #2085
• Fix link to feature status by @s-martin in #2102
• Fix future3 installation for bookworm by @Chilipp in #2100
• fix some more doc links by @s-martin in #2105
• fix #2101 by @s-martin in #2107
• Future3/update dependencies by @pabera in #2103
• More links fixed by @s-martin in #2106
• Keep docs for template reader at src and fix markdown warnings by @s-martin in #2113
• Future3 fix venv usage by @AlvinSchiller in #2111
• fix docker description for windows by @s-martin in #2114
• Cleanup installation messages by @AlvinSchiller in #2109
• Update some links in the documentation by @pabera in #2122
• Future3/update docs by @pabera in #2123
• Remove content folder from docs by @pabera in #2124
• Future3/documentation by @AlvinSchiller in #2127
• future3 V3.3 - reference webapp build by @pabera in #2126

New Contributors

• @DivineDominion made their first contribution in #2096
• @Chilipp made their first contribution in #2100

Full Changelog: V3.2.1...v3.3.0

Release 3.2.1: Documentation update and bug fixes

Summary

• This is minor update fixing some smaller issues and improving on the documentation side
• Note: Cover Art is currently not being displayed. We are working on a solution.

How to update from version 3.2.0

Simply pull in the new changes from the repository

Summary

• New GPIO backend based on GPIOZero including more sophisticated controls for inputs and outputs
• Bluetooth Headset support with device buttons
• Equalizer + Mono down mixer
• Localization support for Webapp, current languages supported are English and German (help us translate!)
• Timer support in Webapp and via RFID cards
• Additional system information in Webapp like Battery status, CPU temperature or IP address
• Preperation for Text-to-Speech + Read My IP as a first example
• Bug fixes and stability improvements

How to update from version 3.1.1 or 3.1.0

IMPORTANT

GPIO support has been entirely re-implemented. This release will break with previous GPIO configurations. When updating, you must re-create your GPIO configuration.

sudo apt install -y python3-rpi.gpio python3-gpiozero espeak caps
git pull
rm -f shared/settings/gpio.yaml
diff ressources/default-setting/jukebox.yaml shared/settings/jukebox.yaml
# --> Manually merge diff with your favourite diff tool
# Reboot
# Read GPIO Recepies in the documentation and recreate gpio.yaml

Link to GPIO Recepies in the docs

For updating from all other versions, start with a fresh SD card.

What's Changed

• Correct script to use future3/main by @charlesvestal in #1776
• (docs) fixed typos in audio.rst by @marc-up in #1800
• Fix newline/comment generation in run_configure_audio by @marc-up in #1798
• (docs)fixed typo in pinout doc for rc522_spi by @kugelzucker in #1796
• Update README.rst by @davidgerick in #1784
• Update 'GPIO Recipes' for power button by @fl0x53 in #1836
• Fixed documentation and example for shutdown button by @arnotron in #1927
• Correct paths in configuration.rst by @obehr in #1908
• Bump up version number to 3.2.1 by @ChisSoc in #1944

New Contributors

• @marc-up made their first contribution in #1800
• @kugelzucker made their first contribution in #1796
• @davidgerick made their first contribution in #1784
• @fl0x53 made their first contribution in #1836
• @arnotron made their first contribution in #1927
• @obehr made their first contribution in #1908

Full Changelog: V3.2.0...V3.2.1

Version 2.3.0: Stability, USB buttons and Bluetooth toggle

• Improved installation guide
• Holding buttons feature fixed #1406
• Bluetooth buttons and headphones toggle #1262
• fixed stop on removal for RC522 #1122
• USB Encoder buttons support for anyone who dors not want to solder...
• Improved robustness and better documentation for GPIO control
• Auto convert wrong Spotify URLs to a format Mopidy understands
• Support for PC/SC-readers
• Removed support for Raspian Stretch
• Lots of fixed bugs and minor improvements...

Version 2.2.0: GPIO control working!!!

• 🔥 Fixed location of gpio_settings.ini for GPIO control
• Added support for files with embedded chapters metada (like m4a) enhancement
• Added customizable poweroff command bash enhancement
• Finally fixed resume function...
• Lots of fixed bugs and minor improvements...
  • Status LED, Rotary Button, Volume Up/Down, custom music directory for +Spotify, Startup sound volume

Version 2.1.1: hotfixes

Fixed:

• #1078
• #1084

Version 2.1.0: Improved installer and bug fixes

• Use multiple readers simultaneously
• Improved GPIO control and integrated in one-line install script
• Integrated selection of RFID readers in one-line install script
• Improved handling of playlists in web UI
• Improved Spotify handling of albums covers, etc.
• Seeking via GPIO buttons
• Lots of fixed bugs and minor improvements...

Version 2.0.0: WiFi management, Touchscreen display, GPIO control, Python 3.5, Mopidy 3

• WiFi management
  • RFID cards to toggle Wifi (or switch it on/off)
  • Read out the Wifi IP address (if you are connecting to a new network and don't know where to point your browser)
  • Hotspot Phoniebox: ad-hoc hotspot if no known network found (IP: 10.0.0.5 SSID: phoniebox Password: PlayItLoud)
• Touchscreen LCD display Player (file: index-lcd.phpin web app)
• GPIO control for improved hadling of GPIO devices (buttons, rotary control, ...)
• Improved PN532 RFID reader support
• Improved one-line install script featuring non-interactive installs based on a config file
• Updated all python code to 3.5 and consistent use of packages via requirements.txt files
• Migration to mopidy3 for Spotify and Google Music integration
• Improved development life cycle (unit tests, checkers, continous integration, ...)
• ... and many bug fixes (as well as new bugs, we don't know yet)

Version 1.1.9 : Single track play, playlist web ui, language switch, refactoring

• single track play: settings in WebUI, behaviour: if switched on, swiping a card will play only one track of the playlist
• @Franzformator fixed the following :) My son often presses the volume buttons while the Phoniebox is not playing any file. After starting a new file the box is often very load.
• Fixing: stop after idle for x minutes in WebUI display
• refactoring inc.header.php to make it easier to read, maintain and extend
• expand folders in web ui with [] chars #469
• volume control in settings web ui
• web app playlist display: filename if no mp3 tags #465
• adding user and group pi to services #438
• web app lang files #454