Skip to content

5.0
Compare
Choose a tag to compare
@dkulp dkulp released this 03 Aug 21:04
· 2262 commits to master since this release
5.0
This tag was signed with the committer’s verified signature.
dkulp Daniel Kulp
GPG key ID: 858FC4C4F43856A3
Learn about vigilant mode.
2145aa7
This commit was signed with the committer’s verified signature.
dkulp Daniel Kulp
GPG key ID: 858FC4C4F43856A3
Learn about vigilant mode.

FPP 5.0

Enhancements

  • Interface/"Look and Feel" Updates
    • The entire FPP UI has been completely re-written to be more "modern" and mobile friendly. We tried to keep it familiar to FPP users, yet "new and fresh".
    • New "Wizard" on first startup to help configure FPP for the first time
    • Troubleshooting page updated to run commands asynchronously and provide direct links to needed results.
    • Display testing page updated to provide easier adjustments to channel ranges and test settings
    • MultiSync Page updates to provide faster updates and much more information
    • New Privacy settings to prevent callouts to 3rd party sites for vendor logos, statistics, etc...
  • Audio configured to use "dmix" when possible to allow simultaneous audio streams (ex: "Play Media" FPP command can play sound effects from GPIO triggers while show is running)
  • Scheduler Enhancements:
    • Global disable of scheduler to easily disable all scheduled events
    • Allow scheduling of FPP Commands that can execute independently of playlists
    • Allow scheduling of FSEQ files directly so playlists do not need to be created for single sequences
    • Added Preview button to main status page and Scheduler page to preview the upcoming scheduled items
    • Added Dusk/Dawn options to the Scheduler (in addition to SunSet/SunRise). Requires location (Latitude and Longitude) to be set.
  • Pixel Overlay Model Enhancements:
    • Many built in effects for use on Pixel Overlay Models (from WLED project)
    • Automatically create Pixel Overlay Models from descriptions on Pixel Strings and Matrices
  • New Phillips KiNet output support
  • Popup "Run FPP Command" trigger button in footer allowing easy execution of commands from with UI
  • Several enhancements for using FPP in Docker:
    • Auto-set the hostname FPP uses if specified in docker config
    • Auto-set the host description to include the container ID if the description has not been set by the user.
    • Expose the host description setting on the System settings tab when running in docker since the network settings page is not shown.
    • Allow FPP to advertise the external host IP docker is using by setting a FPP_DOCKER_IP environment variable when the container is spawned or by using a setting on the System page
    • Hook up reboot/shutdown actions to kill apache2 when running in docker to trigger the container to shutdown or restart (actual action depends on how the container is configured)
    • Added a sample docker-compose.yml config in docs/samples which uses the FPP image created by dockerBuild.sh or from the docker repo.
  • Pixel String Outputs:
    • Unify the BBB Strings, Pi Pixel Strings, and X11 Pixel Strings pages into a single consistent page
    • Add "End Nulls" option for each virtual pixel string

Major Changes/Incompatibilities

  • Legacy API has been removed. See the API conversion guide for more information
  • "Bridge mode" has been removed. Instead, if e1.31/ArtNet/DDP channel inputs are enabled on the Channel Inputs page, they are always active in both Player and Remote modes. Any incoming channel data will override what is loaded from a sequence. This allows combining pre-rendered sequence data with live data.
  • Retirement of Legacy APIs
  • "Master mode" has been removed. internally, master mode has always been really just player mode with a setting to send out sync packets. This is now reflected in the UI. Thus, FPP now only has two modes: Player and Remote. Either can receive incoming e1.31/ArtNet/DDP data if the Inputs are enabled. A Player can be configured to send sync packets and/or E1.31/DDP/ArtNet data as needed. A Remote will work as before.
  • FPP Events have been changed to "Command Presets". This allows more descriptive names/titles of the events which can make it easier to trigger. There is a now a single trigger channel so users using multiple command channels will need to adjust their configuration.
    • Several stock Command Preset names are called within FPP: FPPD_STARTED, FPPD_STOPPED, PLAYLIST_STARTED, PLAYLIST_STOPPED, PLAYLIST_STOPPING_NOW, PLAYLIST_STOPPING_AFTER_LOOP, PLAYLIST_STOPPING_GRACEFULLY, SEQUENCE_STARTED, SEQUENCE_STOPPED, MEDIA_STARTED, MEDIA_STOPPED

Other updates/changes

  • MQTT - now publishes warnings
  • Additional warnings for common issues like outputting sound to Dummy devices
  • Tons of new REST API's added to support the new UI. Many of the older fppxml.php and fppjson.php calls have been removed. Users using those API's will need to move to the new REST API's. See the API conversion guide for more information
  • Capes/Hats that provide string functionality can remove the "Generic" names in the UI and display the cape names

Upgrade Instructions

It is strongly recommended to do a full "OS Level" upgrade or re-image instead of attempting to upgrade directly from any older FPP version. There are several new features that will not work if an OS level upgrade is not done. There are two ways to do so:

  • Re-image - you can backup your 4.x configuration, create a new image, and restore the configuration.
  • In-place upgrade - this is new and requires you to have FPP 3.6.2 (or 4.0-alpha2) or newer already running on the device. Download the appropriate "fppos" file to your computer. Make sure the file extension is still fppos (some browsers will rename it). Upload it to the "File Manager" on the FPP instance. Then go to the about page. Under the normal "Manual Upgrade", a new Upgrade OS button should appear. Click it and wait a LONG time. When done, it should reboot into 5.0. At that point, go to the Uploads tab of the FPP File Manager and delete the fppos file. Note: In SOME cases, the reboot will fail due to library replacement. In that case, a power cycle may be required to get it back up and running.

Selecting an image

For Raspberry Pi series including Pi B, Pi B+, Pi 3, Pi 3+, Pi 4 and Pi Zero use this image

  • FPP-v5.0-Pi.img.zip

For Beaglebone Black, Beaglebone Green, PocketBeagle, and Beaglebone Green Gateway use this image

  • FPP-v5.0-BBB.img.zip
Assets 10
Loading