Releases: MiczFlor/RPi-Jukebox-RFID
v3.5.3: Hotfix for pyzmq installation on Bullseye
Caution
Do NOT use the latest RaspberryPi OS Bookworm release (also don't upgrade via apt) with the new kernel 6.6, if you need to use GPIO components . There have been incompatible changes for the RPi.GPIO library, so Shims and Rfid Reader usage can be broken (#2295).
Using RaspberryPi OS Bullseye is the current recommendation as it does not use the new kernel.
Important
See notes about updates in v3.5.0
Summary
Fixes
- Hotfix for pyzmq installation on Bullseye. pyzmq version is now pinned to below 26.
- Added installation checks to verify correct ZMQ installation
Note
This hotfix is only relevant for new installations. Existing installations don't need to install or patch.
How to update
What's Changed
- hotfix pyzmq installation on bullseye (pin version <26) by @AlvinSchiller in #2345
Full Changelog: v3.5.2...v3.5.3
Contributors
Assets 4
v2.6.0: Network Management, Button Function Args, Bugfixes
Caution
Do NOT use the latest RaspberryPi OS Bookworm release (also don't upgrade via apt) with the new kernel 6.6, if you need to use GPIO components . There have been incompatible changes for the RPi.GPIO library, so Buttons, Shims and Rfid Reader usage can be broken (#2295).
Using RaspberryPi OS Bullseye is the current recommendation as it does not use the new kernel.
Summary
Features
- Support for NetworkManager
- This implies some behavior changes:
- The currently connected Wifi can't be edited on the Settings page anymore
- This implies some behavior changes:
- Support for correct RFID IDs for RC522 Reader (option for legacy IDds still available during reader setup)
- GPIO and USB Button configuration now supports the definition of an args value for a function call. Also new function calls for "triggerPlayCardId" and "triggerPlayFolder" have been added. This now allows triggering playback of an (pseudo) card id or a folder. See the docs for more information.
Improvements
- The preconfigured wifi set by the rpi-imager is now shown in the Web App wifi settings
- The userscript "addhotspot.sh" has been removed as it was outdated.
- Only userscript that end with ".sh" are now shown in the selection.
- Documentation updates
- github action updates
- Default value for WiFi setup during installation changed to "no"
- Default value for Spotify setup during installation changed to "no"
- setup option for MPD during installation as been removed and is now always performed, as choosing "no" results in a broken installation.
Fixes
- Fix for wrong values for the audio interfaces names during setup (also the first is now selected as default, instead of the fix value 'Master' which didn't fit in all cases)
- Fixes for new mqtt version 2.0.0
- youtube-dl package installation has been updated to work again
- Fix for PirateAudioHAT setup (config.txt path in bookworm changed)
Note
Spotify integration is still not working. See Spotify-FAQ for further information and a possible manual workaround.
Version 3 is becoming mature and will soon be the new default of Phoniebox. Therefore Version 2 is slowly going into a maintenance mode and no new features will be added to this version.
What's Changed
- fix youtube-dl package by @AlvinSchiller in #2185
- Der Neue 2024 Kalender ist da... by @MiczFlor in #2188
- Update README.md to include calendar 2024 by @MiczFlor in #2187
- Bump actions/setup-python from 4 to 5 by @dependabot in #2196
- Bump actions/checkout from 3 to 4 by @dependabot in #2192
- Bump github/codeql-action from 2 to 3 by @dependabot in #2194
- Installation workflow dependabot updates by @AlvinSchiller in #2197
- update v3 refs by @AlvinSchiller in #2212
- Bugfix: re-enable Mifare Ultralight C support by @miohna in #2214
- Bump actions/cache from 3 to 4 by @dependabot in #2231
- update workflow with improvements from v3 by @AlvinSchiller in #2246
- Fixes for rfid reader by @AlvinSchiller in #2250
- Bump mopidy-iris from 3.69.2 to 3.69.3 by @dependabot in #2229
- Update phpunit by @s-martin in #2253
- Fix links in docs and message boxes by @s-martin in #2255
- github actions update by @AlvinSchiller in #2240
- add api version to mqtt.client for new version 2.0.0 compatibility by @AlvinSchiller in #2265
- fix audio interface name in setup by @AlvinSchiller in #2276
- add arguments for buttons functions by @AlvinSchiller in #2266
- Bump docker/setup-buildx-action from 3.0.0 to 3.1.0 by @dependabot in #2281
- Update issue templates by @AlvinSchiller in #2280
- NetworkManager Support by @AlvinSchiller in #2261
- Reactivate delete artifact by @AlvinSchiller in #2296
- Fix path to config.txt for bookworm support by @AlvinSchiller in #2298
- Wiki updates (Sidebar and Gallery) by @AlvinSchiller in #2303
- Enforce MPD setup during installation by @AlvinSchiller in #2309
- Release 2.6 by @AlvinSchiller in #2311
Full Changelog: v2.5.0...v2.6.0
Contributors
Assets 2
v3.5.2: Hotfix for pyzmq installation
Caution
Do NOT use the latest RaspberryPi OS Bookworm release (also don't upgrade via apt) with the new kernel 6.6, if you need to use GPIO components . There have been incompatible changes for the RPi.GPIO library, so Shims and Rfid Reader usage can be broken (#2295).
Using RaspberryPi OS Bullseye is the current recommendation as it does not use the new kernel.
Important
See notes about updates in v3.5.0
Summary
Fixes
- Hotfix for pyzmq installation to not use a prerelease version which might be incompatible.
Note
This hotfix is only relevant for new installations. Existing installations don't need to install or patch.
How to update
What's Changed
- Hotfix for pyzmq installation by @AlvinSchiller in #2272
Full Changelog: v3.5.1...v3.5.2
Contributors
Assets 4
v3.5.1: Hotfix Web App with disabled ipv6
Important
See notes about updates in v3.5.0
Summary
Fixes
- Hotfix for failing Web App start if ipv6 is disabled
- Added missing link to NFCPy Rfid Reader
Note
If in previous versions IPv6 was disabled during setup, the Web App (nginx) will fail to start.
If you have an existing installation with this situation you can also fix it by running the following command
sed -i '/listen \[::\]:80/d' /etc/nginx/sites-available/default
How to update
What's Changed
- Link to nfcpy in docs by @s-martin in #2238
- Fix for nginx with disabled ipv6 by @AlvinSchiller in #2254
Full Changelog: v3.5.0...v3.5.1
Contributors
Assets 4
v3.6.0-alpha
Automated Release for v3.6.0-alpha
v3.5.0: RFID Reader Support, Network Management
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
-
run_rpc_toolcan now run commands directly - Github Workflow tests
- Documentation (updates and wording), e.g.
- Playlists, Livestreams, Podcasts
- Command line client for RPC
- ...
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
What's Changed
- Ignore test directories for coverage by @s-martin in #2158
- Adapt pbc.c to current json rpc spec by @sklemer1 in #1857
- Add docs for command line client for RPC by @s-martin in #2162
- Add Workflow Action to build and upload webapp bundle on Release by @AlvinSchiller in #2161
- Improve the run_rpc_tool script by @s-martin in #2166
- Improve Docs: Fix GPIO and add WSL by @s-martin in #2173
- Cover Art with Cache by @pabera in #2177
- Improve docs by @s-martin in #2178
- Update Pulseaudio docs for Docker on Mac by @pabera in #2176
- Activate codeql analysis by @s-martin in #2182
- future3: Jukebox.Dockerfile - Reorder 'USER' command by @votti in #2199
- add workflow files to paths to trigger run by @AlvinSchiller in #2202
- New card actions: play, pause, prev, next, toggle, repeat, shuffle by @pabera in #2179
- Add swap file adjustment for webapp build by @AlvinSchiller in #2204
- [New component] HiFiBerry Sound Card & OnOff SHIM by @pabera in #2169
- Create markdown docs from docstring in py files by @s-martin in #2181
- deactivate kioskmode installation option on armv6 devices by @AlvinSchiller in #2217
- Update docs by @AlvinSchiller in #2216
- fix the messageboxes by @s-martin in #2223
- Improve Bluetooth docs by @SKHSKHilber in #2174
- Playlists, Livestreams, Podcasts by @flipreverse in #2200
- Future3 add login motd with note about venv by @AlvinSchiller in #2225
- Minor fixes by @AlvinSchiller in #2234
- Add NFCPy support by @powertomato in #2190
- included venv activation for python scripts by @AlvinSchiller in #2233
- prevent installer rerun and remove update path by @AlvinSchiller in #2235
- NetworkManager Support by @AlvinSchiller in #2218
- Allow default value for CoverArtCache path by @pabera in #2237
- Release v3.5.0 by @pabera in #2211
New Contributors
- @sklemer1 made their first contribution in #1857
- @votti made their first contribution in #2199
- @SKHSKHilber made their first contribution in #2174
- @flipreverse made their first contribution in #2200
- @powertomato made their first contribution in #2190
Full Changelog: v3.4.0...v3.5.0
Contributors
Assets 4
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
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
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
Full Changelog: v3.3.0...v3.4.0
Contributors
Assets 3
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
Contributors
Assets 3
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