Releases: MiczFlor/RPi-Jukebox-RFID
v2.8.0: Fix Spotify Authentication
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
Fixes
- #2367 fix button
hold_modeSecondFuncandSecondFuncRepeatbehavior. The secondary function is no longer triggered additionally to the primary function.
⚠️ This is an incompatible change of the behavior! Existing configurations may need to adapt to this. - #2435 fix Spotify authentication
⚠️ Spotify changed authentication, see here for details https://github.com/mopidy/mopidy-spotify/discussions/405
Check https://github.com/MiczFlor/RPi-Jukebox-RFID/wiki/Spotify-FAQ how to configure authentication.
Note
- 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
- Bump docker/setup-buildx-action from 3.2.0 to 3.3.0 by @dependabot in #2362
- Fix button SecondFunc trigger by @AlvinSchiller in #2367
- Add markdownlint config and action for V2 by @s-martin in #2369
- (maint) fix formatting by @s-martin in #2371
- maint: Use flake8 config file by @s-martin in #2338
- document working cards for rc522 by @s-martin in #2374
- Bump DavidAnson/markdownlint-cli2-action from 15 to 16 by @dependabot in #2379
- Bump docker/build-push-action from 5 to 6 by @dependabot in #2394
- Bump docker/setup-qemu-action from 3.0.0 to 3.2.0 by @dependabot in #2411
- Bump docker/setup-buildx-action from 3.3.0 to 3.6.1 by @dependabot in #2410
- Bump DavidAnson/markdownlint-cli2-action from 16 to 17 by @dependabot in #2434
- Delete tests/htdocs/inc/SetWlanIpMailTest.php by @s-martin in #2448
- Bump docker/setup-buildx-action from 3.6.1 to 3.7.1 by @dependabot in #2447
- Fix FROM as casing warning by @s-martin in #2449
- Fix Spotify authentication by @s-martin in #2435
- Release v2.8.0 by @AlvinSchiller in #2368
Full Changelog: v2.7.0...v2.8.0
Contributors
Assets 2
v2.7.0: Spotify Integration, discontinuation of Buster support, 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 Spotify again!
- a prerelease of mopidy-spotify is used to bring back the spotify integration. Please see Spotify-FAQ for further information
- this includes startup speed improvements for mopidy due to playlists refresh optimization in the prerelease
- Raspberry Pi OS Buster and Python < 3.9 will not be supported/tested anymore with this release.
- official Buster support is running out by June 30th, 2024
- mopidy-spotify minimum support is Bullseye
Improvements
- some refactorings of the installation script
- better installation logging
- documentation updates
- version updates for github actions
Fixes
- fix for special characters entered during setup (spotify credentials, wifi, ...)
- fix for function calls from RotaryEncoder
- update defaults and fixed handling for some yes/no questions
- improved startup time for wifi in combination with the autohotspot feature
Note
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
- Bump docker/setup-buildx-action from 3.1.0 to 3.2.0 by @dependabot in #2314
- Remove Buster Support by @AlvinSchiller in #2319
- README: Fix typo RC422 -> RC522 by @hoffie in #2333
- Spotify fixes by @AlvinSchiller in #2315
- Installation fixes and refactoring by @AlvinSchiller in #2350
- Fix button function call by @AlvinSchiller in #2355
- Update default handling for yes/no questions by @AlvinSchiller in #2357
- Release 2.7.0 by @AlvinSchiller in #2358
Full Changelog: v2.6.0...v2.7.0
Contributors
Assets 2
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
v2.5.0: Early Bookworm, Sync and Maintenance
Automated Release for v2.5.0
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.
Important
Currently network related features are broken on Bookworm, due to changes on the network config. For a status and a workaround see #2183
Summary
- Early Support for Bookworm (not recommended yet - see above)
- Bugfixes
- new Features
- Documentation updates
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
- Updated Python versions to use for CI by @s-martin in #1933
- Create php.yml by @s-martin in #1823
- add badge for PHP CI by @s-martin in #1947
- Remove Gmusic by @s-martin in #1939
- Delete scripts/python-phoniebox directory by @s-martin in #1935
- Clarify when to open an issue or a discussion by @s-martin in #1961
- Bump phpunit/phpunit from 9.5.27 to 9.5.28 by @dependabot in #1965
- Fix Pirate Audio Button Volume Up by @s-martin in #1975
- Bump phpunit/phpunit from 9.5.28 to 9.6.4 by @dependabot in #1976
- add patch for serializable by @s-martin in #1953
- Use existing actions for Docker GitHub Action by @s-martin in #1980
- removed "is set" check (#1967) by @AlvinSchiller in #1968
- Fix docs for 2.x by @s-martin in #1949
- Close devices by @s-martin in #1985
- Fix ShutdownButton LED does not stay on after hold time has expired and shutdown is ongoing by @topas-rec in #1984
- Feature "sync shared" by @AlvinSchiller in #1978
- Delete stretch install scripts by @s-martin in #1936
- Add bullseye Dockerfile by @s-martin in #1986
- Test files not used anymore by @s-martin in #1988
- Update python version matrix by @AlvinSchiller in #1996
- Add new python dependecies (setuptools, wheel) by @AlvinSchiller in #1990
- Bump phpunit/phpunit from 9.6.4 to 9.6.6 by @dependabot in #2004
- Bump php-mock/php-mock-phpunit from 2.6.1 to 2.7.1 by @dependabot in #2005
- Add armv7 Docker test by @s-martin in #1992
- Fix #1848 by @s-martin in #2017
- Bump phpunit/phpunit from 9.6.6 to 9.6.7 by @dependabot in #2021
- Editorconfig: Fix indent_size for js and yaml files by @AlvinSchiller in #2027
- add Coverage action by @s-martin in #2032
- Bump phpunit/phpunit from 9.6.7 to 9.6.8 by @dependabot in #2037
- Bump docker/setup-qemu-action from 2.1.0 to 2.2.0 by @dependabot in #2043
- Bump docker/setup-buildx-action from 2.5.0 to 2.8.0 by @dependabot in #2042
- Bump phpunit/phpunit from 9.6.8 to 9.6.9 by @dependabot in #2045
- Bump php-mock/php-mock-phpunit from 2.7.1 to 2.7.2 by @dependabot in #2044
- Bump docker/setup-buildx-action from 2.8.0 to 2.9.1 by @dependabot in #2052
- Bump docker/setup-buildx-action from 2.9.1 to 2.10.0 by @dependabot in #2062
- Bump phpunit/phpunit from 9.6.9 to 9.6.11 by @dependabot in #2061
- Make test gpio control work again by @topas-rec in #2034
- Bump mopidy-iris from 3.54.2 to 3.68.0 by @dependabot in #2060
- Bump docker/setup-buildx-action from 2.10.0 to 3.0.0 by @dependabot in #2069
- Bump actions/checkout from 3 to 4 by @dependabot in #2072
- Bump docker/build-push-action from 4 to 5 by @dependabot in #2071
- Bump phpunit/phpunit from 9.6.11 to 9.6.13 by @dependabot in #2068
- Bump docker/setup-qemu-action from 2.2.0 to 3.0.0 by @dependabot in #2070
- Abort installation if user is not "pi" by @AlvinSchiller in #2076
- Fix rc-522 dependency by @s-martin in #2078
- fix some warnings by @s-martin in #2081
- Unified Test runs in Docker by @AlvinSchiller in #2082
- Update Status Badge by @AlvinSchiller in #2083
- Bump mopidy-iris from 3.68.0 to 3.69.2 by @dependabot in #2088
- Bump php-mock/php-mock-phpunit from 2.7.2 to 2.8.0 by @dependabot in #2089
- Merge Autohotspot setup into main install script by @AlvinSchiller in #2086
- add autohotspot config checks by @AlvinSchiller in #2091
- Make changes for Raspberry Pi OS Bookworm by @s-martin in #2084
- Update Documentation by @AlvinSchiller in #2008
- Further Optimizations by @AlvinSchiller in #2092
- rename install script to "install-jukebox.sh" by @AlvinSchiller in #2110
- Bump coverallsapp/github-action from 1 to 2 by @dependabot in #2129
- Bump phpunit/phpunit from 9.6.13 to 9.6.15 by @dependabot in #2130
- Bump php-mock/php-mock-phpunit from 2.8.0 to 2.9.0 by @dependabot in #2131
- Bookworm Web Interface 403 by @AlvinSchiller in #2128
- feat: add shutdown by rfid after 120,180,240min by @t0b3 in #2134
- add workflow for release automation by @AlvinSchiller in #2171
- Update Readme for next release by @AlvinSchiller in #2175
- Release 2.5 by @s-martin in #2030
Full Changelog: V2.4.0...v2.5.0
Contributors
Assets 2
Version 2.4.0: Fix evdev bug and bullseye
- 🔥 Finally fixed the annoying
evdevbug during installation (fixes e.g. #1721, #1653, #1618, #1501 and MANY more) - Flexible PHP version in install script (makes sure Raspian Bullseye can be used) #1849
- Publish "card swiped" event via MQTT #1496
- Right now Spotify integration still doesn't work - please follow the discussion at #1835
- Lots of fixed bugs and minor improvements...
What's Changed
Full Changelog: V2.3.0...V2.4.0