v3.7.0-alpha

Caution

Raspberry Pi OS Trixie is not yet supported.
Using Raspberry Pi OS Bookworm is the current recommendation.

Automated Release for v3.7.0-alpha

v3.6.0: Full Bookworm support (GPIO), 64-bit, ...

Caution

Raspberry Pi OS Trixie is not yet supported.
Using Raspberry Pi OS Bookworm is the current recommendation.

Summary

Features

• #2470 Replace RPi.GPIO with rpi-lgpio
  • Due to the replacement of the lib, some changes in behavior take place. Please see here for more information.
  • #2568 fix lgpio build for armv6 and python 3.13
• #1943 Event Device Support (evdev)
• #1970 Shutdown after [Time] idle
  • #2332 Add Idle Shutdown Timer support
• #2352 Allow to enable/disable Cover Art in Web App & load from filesystem
• #2425 lift 64bit restriction
• #2557 Improve IRQ configuration and fallback handling for RC522 SPI RFID reader
• #2412 add basic mqtt support
• #2380 Add INA219 battery sensor

Fixes

• #2239 github actions update
• #2284 Add markdown linting
• #2292 search filter in library
• #2293 Stop Back Action at audiofolder root level
• #2307 Build libzmq locally to work on all host types
• #2320 Add Python 3.12 to Action
• #2323 Fix PlayerMPD.rewind to start with the first song
• #2325 Fix CoverartCacheManager
• #2326 Fix PlayerMPD.prev/next() when stopped
• #2351 docker build after pyzmq update
• #2498 fix evdev breakingchange
• #2444 RDM6300 configuration bug
  • #2450 Use correct raspi-config command for bookworm
• #2339 fix bad utils.get_config_action invocations

Documentation

• #2257 Extract docs for battery monitor
• #2284 Add markdown linting
• #2300 Manually upgrade to the latest version
• #2301 Fix GPIO shutdown button naming
• #2484 Fix the url to Autohotspot docs
• #2616 installation instructions for new imager version

Chore

• various dependabot updates

What's Changed

• Extract docs for battery monitor by @s-martin in #2257
• github actions update by @AlvinSchiller in #2239
• (doc) Update docstring by @s-martin in #2259
• (maint) Remove duplicate rst by @s-martin in #2269
• merge hotfix 3.5.2 by @AlvinSchiller in #2273
• Event Device Support (evdev) by @votti in #1943
• fix: search filter in library by @pabera in #2292
• fix: Stop Back Action at audiofolder root level by @pabera in #2293
• Reactivate delete artifact by @AlvinSchiller in #2297
• Docs: Fix GPIO shutdown button naming by @hoffie in #2301
• Add markdown linting by @s-martin in #2284
• docs: Manually upgrade to the latest version by @pabera in #2300
• Customize markdownlint by @s-martin in #2310
• Update CodeQL to v3 by @s-martin in #2312
• fix: Build libzmq locally to work on all host types by @pabera in #2307
• Fix PlayerMPD.rewind to start with the first song (future3) by @hoffie in #2323
• Add Python 3.12 to Action by @s-martin in #2320
• Fix CoverartCacheManager by @hoffie in #2325
• maint: Update actions by @s-martin in #2334
• Fix PlayerMPD.prev/next() when stopped by @hoffie in #2326
• doc: fix typo in docker.md by @s-martin in #2336
• fix: Fix broken utils.get_config_action invocations by @hoffie in #2339
• Merge Hotifx 3.5.3 by @AlvinSchiller in #2346
• fix: docker build after pyzmq update by @pabera in #2351
• feat: Allow to enable/disable Cover Art in Web App & load from filesystem by @pabera in #2352
• (maint) Remove setup-python-dependencies by @s-martin in #2363
• (maint) fix links by @s-martin in #2366
• add details about cards for RC522 by @s-martin in #2372
• (maint) Remove unused read of parameter by @s-martin in #2382
• feat: Add INA219 battery sensor by @saeugetier in #2380
• Docker semantic fix by @pabera in #2451
• Future3/lift 64bit restriction by @mittler-works in #2425
• fix: Use correct raspi-config command for bookworm by @s-martin in #2450
• feat: Add Idle Shutdown Timer support by @hoffie in #2332
• [maint] Ignore LICENSE file in markdown linter by @s-martin in #2455
• fix: correct function name reference in is_debian_version_at_least() by @pabera in #2464
• fix wrong usage of variable introduced with 2450 by @AlvinSchiller in #2473
• Fix the url to Autohotspot docs by @s-martin in #2484
• feat: add basic mqtt support by @c0un7-z3r0 in #2412
• Replace RPi.GPIO with rpi-lgpio for V3 future3 by @s-martin in #2470
• fix evdev breakingchange by @AlvinSchiller in #2498
• fix flake8 config by @AlvinSchiller in #2566
• v3 - fix lgpio build for armv6 and python 3.13 by @AlvinSchiller in #2568
• Improve IRQ configuration and fallback handling for RC522 SPI RFID reader by @astnerdev in #2557
• Update docs by @AlvinSchiller in #2616
• Update docs (update.md) and githook by @AlvinSchiller in #2623
• Release v3.6.0 by @AlvinSchiller in #2258
• fix: release version 3.6.0 by @AlvinSchiller in #2624

New Contributors

• @saeugetier made their first contribution in #2380
• @mittler-works made their first contribution in #2425
• @astnerdev made their first contribution in #2557

Full Changelog: v3.5.3...v3.6.0

v2.9.0: Full Bookworm support (GPIO), Bugfixes

Caution

Raspberry Pi OS Trixie is not yet supported.
Using Raspberry Pi OS Bookworm is the current recommendation.

Summary

Fixes

• #2469 Replace RPi.GPIO with rpi-lgpio for V2 legacy
  Due to the replacement of the lib, some changes in behavior take place. Please see here for more information.
• #2567 fix lgpio build for armv6 and python 3.13
• #2493 Bluetooth sink led update for rpi-lgpio
• #2569 fix Spotify playback
• #2467 remove deprecated spotify properties (username, password). Only client ID and secret is needed.
• #2466 Fix card swipe detection issue after NTP update

Chore

• various dependabot updates
• documentation updates

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 DavidAnson/markdownlint-cli2-action from 17 to 18 by @dependabot[bot] in #2460
• Fix card swipe detection issue after NTP update by @wastlmuc in #2466
• Bump DavidAnson/markdownlint-cli2-action from 18 to 19 by @dependabot[bot] in #2477
• Bump docker/setup-buildx-action from 3.7.1 to 3.8.0 by @dependabot[bot] in #2478
• Remove Spotify username and password by @s-martin in #2467
• Replace RPi.GPIO with rpi-lgpio for V2 legacy by @s-martin in #2469
• Bump phpunit/phpunit from 11.0.3 to 11.5.6 by @dependabot[bot] in #2490
• Bluetooth sink led update for rpi-lgpio by @AlvinSchiller in #2493
• Bump docker/setup-qemu-action from 3.2.0 to 3.3.0 by @dependabot[bot] in #2491
• Bump php-mock/php-mock-phpunit from 2.10.0 to 2.13.0 by @dependabot[bot] in #2517
• Bump docker/setup-buildx-action from 3.8.0 to 3.10.0 by @dependabot[bot] in #2507
• Bump docker/setup-qemu-action from 3.3.0 to 3.6.0 by @dependabot[bot] in #2508
• Bump DavidAnson/markdownlint-cli2-action from 19 to 20 by @dependabot[bot] in #2525
• Bump docker/setup-buildx-action from 3.10.0 to 3.11.1 by @dependabot[bot] in #2527
• Updated README.md to make setup easier by @bold-gman in #2528
• fix markdown warnings by @s-martin in #2538
• Don't override TestCase constructor by @s-martin in #2549
• Bump php-mock/php-mock-phpunit from 2.13.0 to 2.13.1 by @dependabot[bot] in #2548
• Bump github/codeql-action from 3 to 4 by @dependabot[bot] in #2554
• v2 - fix lgpio build for armv6 and python 3.13 by @AlvinSchiller in #2567
• Bump actions/download-artifact from 4 to 6 by @dependabot[bot] in #2552
• Bump actions/setup-python from 5 to 6 by @dependabot[bot] in #2545
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #2546
• Use new gst-plugin-spotify 0.15.0 alpha.1-4 by @s-martin in #2569
• Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #2555
• Bump DavidAnson/markdownlint-cli2-action from 20 to 21 by @dependabot[bot] in #2579
• Bump docker/setup-qemu-action from 3.6.0 to 3.7.0 by @dependabot[bot] in #2578
• build(deps): bump DavidAnson/markdownlint-cli2-action from 21 to 22 by @dependabot[bot] in #2588
• build(deps): bump actions/cache from 4 to 5 by @dependabot[bot] in #2590
• build(deps): bump docker/setup-buildx-action from 3.11.1 to 3.12.0 by @dependabot[bot] in #2589
• build(deps): bump actions/download-artifact from 6 to 7 by @dependabot[bot] in #2586
• build(deps): bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in #2585
• Update Readme by @AlvinSchiller in #2612
• Release 2.9.0 by @AlvinSchiller in #2611

New Contributors

• @wastlmuc made their first contribution in #2466
• @bold-gman made their first contribution in #2528

Full Changelog: v2.8.0...v2.9.0

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_mode SecondFunc and SecondFuncRepeat behavior. 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

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

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

Documentation

What's Changed

• hotfix pyzmq installation on bullseye (pin version <26) by @AlvinSchiller in #2345

Full Changelog: v3.5.2...v3.5.3

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
• 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

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

Documentation

What's Changed

• Hotfix for pyzmq installation by @AlvinSchiller in #2272

Full Changelog: v3.5.1...v3.5.2

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

Documentation

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

v3.6.0-alpha

Automated Release for v3.6.0-alpha