ReleaseNotes.txt

Version 1.4.6i 30/8/2023
========================
The --vibes command line option is now required to enable the vibes show control command

Version 1.4.6h 22/7/2023
========================

Install an additional library, the DRV2605 library using:
        python3 -m pip install DRV2605
	
There is an addittional example - pp_DRV2605_1p4
	
      
Version 1.4.6c  8/1/2022
========================
In addition to the fix in pp_hyperlinkshow.py you will need an updated version of the pp_hyperlinkshow_1p4 example

Version 1.4.6a  7/7/2021
========================
It will be necessary to update the profiles to version 1.4.6. The update will happen automatically if you edit the profile. I recommend making a backup of all profile directories before editing them.


Version 1.4.5c  2/6/2021
========================
Version 1.4.5a introduced new players for video and web:

 - If you want to use the old players for liveshows or artliveshows then uncomment the line video_player='video' at the start of pp_livelist.py

 - If you want to use the old players for other types of show then use the Track>New>OMX Video or Track>New>UZBL Web menu options.

Version 1.4.5b 13/3/2021
========================
Selection of the VLC Video track audio device is now from the profile. The set of audio devices are the same as those for audio tracks and beeps and are set up in pp_audio.cfg (See manual)

'default' audio device has been deprecated and replaced with a blank entry in the Show; this is the same as the audio track. Templates, and examples have been updated to accomodate this change. If you do not download the new set of examples the deprecated audio device setting of 'default' will now result in use of the hdmi device and will show red in the profile editor until the field is edited.

Version 1.4.5a 6/3/2021
========================
This release adds new players for web and video tracks based on modern applications, Chromium and VLC.

The old players based on omxplayer and UZBL have been retained but are deprecated and could be removed in a future release.

omxplayer is deprecated by Pi Towers, VLC is their recognized replacement. UZBL is an old browser not updated since 2017, Chromium is now the Pi Towers default browser.

Templates, Add Track button, New Show all use the new players. If you want to use the old players then use the Track>New>OMX Video or Track>New>UZBL Web menu options.

All the examples have been updated to use the new players. If you want to use these download them from the examples Github repository.

New dependencies need to be installed. Refer to the README.md file or Github.

It will be necessary to update the profiles to version 1.4.5. The update will happen automatically if you edit the profile. I recommend making a backup of all profiles before editing them.

It is not possible to automatically convert old omx or UZBL tracks into VLC or chrome tracks as the fields in the profile are different, particularly the way in which the Video and Web Windows work. Details are in the manual. As always the default values should produce something useable.

Two changes are worth noting:
  - For VLC volume is now 0 -> 100
  - For Chrome Web the Browser command functionality is different. LOOP can have a value and the exit command has gone.

Please use the Issues tab on Github https://github.com/KenT2/pipresents-beep/issues to report any problems

Version 1.4.4g 1/1/2021
========================
The Dec 2020 version of Raspberry Pi OS has changed the system for selecting the audio device, this time from alsa to pulseaudio. This has yet again disabled the control of audio device by Pi Presents.

This version implements the pulseaudio method of control and also retains the old methods for people using earlier versions of Raspbian.

There is a new configuration file  /pipresents/pp_config/pp_audio.cfg. If you are using the Dec 2020 version of RPi OS and only 1 or 2 hdmi and the A/V port then the configuration set in this file does not require change.

If you want to add USB or bluetooth devices then pp_audio.cfg will need to be changed to add the sink name of the device, details in the file.

If you want to use an older version of Raspbian then you must edit pp_audio.cfg. The previous method of detecting .asoundrc does not now work to detect the audio system in use. 

As of writing there are a few bugs in the RPi OS:

 - The sound can lock up if there are two hdmi monitors connected to a Model 4 Pi.
 - On my new install using 2 hdmi monitors stopped A/V sound.
 - People have had problems upgrading from the previous version of RPi OS, mainly audio not playing on some devices. A fresh install works better.
 - It is not a good idea to change the default audio device from the task bar while PP is running.
 - short tracks do not play reliably on bluetooth devices.
 

Version 1.4.4e 16/6/2020
========================
The May 2020 version of Raspbian (now Raspberry Pi OS) has changed the system for selecting the audio device. This has disabled the control of audio device by Pi Presents. However it is still possible to control it from the Task Bar.

This version implements the new method of control and also retains the old method for people using earlier versions of Raspbian. To select which method to use PP detects the existence a file called .asoundrc which is always in the /home/pi directory for the new audio system but generally not in the old system. However it may be present in an earlier version of Raspbian if a USB sound device was used. So this version of PP will not work with an earlier version of Raspbian if a USB audio device has been used. The workaround for this is to delete .asoundrc if the USB device is not currently attached, or to find the variable audio_sys in pp_audioplayer.py and pp_beepsmanager.py and uncomment the line audio_sys='pi'.

I have also changed the names of audio devices to closer match those on the task bar and those printed on the board. The old names still work but will not appear in the editor.


Version 1.4.4c 2/4/2020
========================
There is a new field 'sender' in /pp_config/pp_email.cfg. This is used in From: field
of the email and allows From to be different from username.
Add the field to pp_email.cfg. If you do not username will be used instead. Editing the
email configuration when running pp_manager will also add the field.



Version 1.4.4b 20/3/2020
========================
Support for 2 displays has been improved to include rotation of the displays
touchscreens are automatically calibrated depending on monitor position and rotation

Read the Section of the Manual on setting up displays and touchscreen. Setup has changed (for the better)

There is a new configuration file /pipresents/pp_config/pp_display.cfg
The out of the box values in this file should work for most situations but will need editing if:
* A HDMI monitor has a touchscreen
* On Model 3/2/1 you are using screen rotation
* You have used --screensize
* You have altered the size or position of the windowed non-fullscreen display

Track plugins can now be in a profile or pp_home. In the examples they have been moved from 
/pipresents/pp_track_plugins and there are now none of the exmple plugins in this directory.
I recommend you move any you have created to the profile where they will not be overwritten by software upgrades

The Monitor Show Control Command must now have the name of the monitor

The 'original' video window type of a Video Track has been ??? in favour of 'default'. 'original may be deleted some time in the future.

Version 1.4.4a 9/9/2019
========================
Pi Presents now supports 2 displays on Pi4 and to a limited extent on Pi3
The 2 displays may be the official touchscreen and HDMI0, or HDMI0 and HDMI1 on Pi 4
This version must use Raspbian Buster
Read the section in the manual on using multiple displays as they need to be configured.

Consequent changes:
a. I the command line --screensize becomes --screensize0 and --screensize1, for Pi3 or single display use --screensize0
b. Additional displays field in each section of screen.cfg


Version 1.4.3a 24/7/2019
========================
Pi Presents is now Python 3. It will not run under Python 2.
The last Python 2 release 1.4.2 a has been tagged as a Github Release if you want it.

To upgrade to this version install the Python 3 version of some packages:

      sudo apt-get install python3-pil.imagetk
      sudo apt-get install python3-pexpect
      sudo pip3 install evdev

The Python 2 versions of these packages can be left installed.

The command to run Pi presents is python3 instead of python

Your profiles will require update for new features


Version 1.4.2a 27/4/2019
========================
This version adds a new field to shows to disable catch up. Profile will require update.
The statistics log output has an additional field containing the profile name

Version 1.4.1a 20/7/2018
========================
Althought in a new repository this version is a minor improvement to Version 1.3.5a
New fields have been added to the profile. You will need to update all your profiles by using the web editor
This version adds an I/O plugin that required a change to the I/O Plugin API - 
All I/O Plugins you have created need to have the following parameters added to
 the init() method pp_dir,pp_home,pp_profile. See a provided I/O plugin for where to add them.

Version 1.3.5a 1/5/2018
=======================
This version integrates editing the time of day schedule with the web editor.
The schedule.json file is no longer used. Keep it temporarily as you will require it to manually populate the profile.
The schedule is in the schedule tab of each show and of the Start show (pp_core section of schedule.json)
The content is the same, the primary change to format is that the fields of the time lines are reversed (now 13:50 open)

Version 1.3.4d 25/03/2018
==============
This version fixes a long standing memory leak when using subshows. The fix involved the most complex part
 of PP so I hope I have not introduced other bugs. Please contact me if a previously working application is now broken
 
 
version 1.3.4b
==============
This version adds a new interface method to I/O plugins which is called by the I/O plugin manager.
All I/O plugins need to have the following method added:

    # allow track plugins (or anything else) to access input values
    def get_input(self,channel):
        return False, None

version 1.3.4a
==============
This version adds a new field to shows and tracks to provide  the value of the paue timeout
You will need to update all your profiles by using the web editor


version 1.3.3c
===============
This version is a redesign of the OSC interface
The format of the profiles do not require update except that:
	-  the osc configuration file, /pp_io_config/osc.cfg, content is different. If you have any profiles with OSC configutration file delete this file and recreate it using the web editor's osc>create menu item.
	
	- The show control commands for osc will require modification. They are now of the form 'osc unit command paramters (see manual)'
	
	the osc message /core/output has changed to /osc/animate
	

The configuration files for the  test programs pp_oscremote.py and pp_oscmonitor.py in /pipresents/pp_config have been replaced. They can be edited using the editor built into the programs.



version 1.3.3b
=================
This version doccuments the I/O plugins API and provides examples
It fixes a few bugs
No changes to the profiles or configuration files required.


Version 1.3.3a
=================

Version 1.3.3a introduce I/O plugins and quiz counters. There is a fix to liveshows and other smaller enhancements and fixes.

You will need to update your profiles using the editor.

I/O Plugins
-----------
input/output is now implemented as plugins so people can write their own. The following changes are required to introduce configuration files:

If you have a modified gpio.cfg or keys.cfg in /pipresents/pp_config  then these should be moved to /pipresents/pp_io_config

gpio.cfg and keys.cfg in a profile remain in /pp_io_config

Any keys.cfg file you have created will require moodification to add the following section

[DRIVER]
title = Tkinter Keys    
enabled = yes
bind-printing = yes
module= pp_kbddriver

See updated /pipresents/pp_io_config/keys.cfg

Any gpio.cfg file you have created yourself will require moodification to add the following section

[DRIVER]
title = GPIO    
enabled = yes
tick-interval = 50
module= pp_gpiodriver

See updated /pipresents/pp_resources/pp_templates/gpio.cfg


/dev/input I/O plugin
---------------------
There is a new I/O plugin pp_inputdevicedriver.py which suppports devices such as wireless remote controls
To use this it will be necessary to install evdev (sudo apt-get install evdev)


Shutting Down the RPi from Pi Presents
-----------------------------------------
The method of achieving this has changed. The delay is now implemented by the I/O plugin so gpio.cfg requires change to any pin used for shutdown:

# shutdown the Rpi after 5 seconds
# changed for version 1.3.3a
[P1-12]
direction = in
rising-name =
falling-name = 
one-name = 
#event is sent after the button is pressed fo 5 seconds NOTE CHANGE OF SYMBOLIC NAME
zero-name = pp-shutdownnow
# 50mS*100
repeat = 100    
threshold = 8
pull-up-down = up

See updated /pipresents/pp_resources/pp_templates/gpio.cfg


Liveshows
---------
Liveshows have been improved to cope with a lockup condition when an empty liveshow was a subshow. It was not possible to return to the parent show.
There is a new field in the profile called an Escape Track
The List Empty Track is now mandatory. The Escape Track is now esential if the List Empty track is a show, it must not be a show. See updated example pp_liveshowempty_1p3



Version 1.3.2a
=================

Version 1.3.2a continues the improvements to Remote Management including a revamp of the look and feel of the Manager and Web Editor. Otherwise there is a large number of enhancements to the core show/player.

The existing editor pp_editor.py will be discontinued after this issue. It is replaced by the web based editor pp_web_editor.py. pp_web_editor.py displays in a browser. It works well on the local Pi and can also be used remotely from any computer with a browser.
The old editor has been updated for this version of Pi Presents but not rigoursly tested. Please use the new editor.

The improvements to the core functionality require changes to the fields in a profile. The example profiles have been updated and  you should download the latest set of profiles from Github. Profiles made under previous versions of PP will not run with this version and will produce an error message. However if you edit those profiles they will automatically be updated, a backup being made first.

After using the editor to update the fields of the profile some of the field content will require manual update.

Liveshow
Liveshows have been enhanced such that if the livelist is empty an alternative track or show can be played.  This is controlled by the List Empty Track field of the liveshow. After update this will be blank resulting in a blank display for an empty list. Replace this with a media track or a show track if required.


Version 1.3.1i

* Significant improvements to Remote Management.

    -  The content of pp_web.cfg has changed so do not copy it across from the previous version.
	There are additional and renamed fields in the manager and manager editable section to add livetracks and change copy to import.
    Unit has moved to the network section ip has been removed to  be replaced by preferred_interface and force_ip which for most user will need to left blank
	 
	- There is a new configuration file pp_email.cfg. Out of the box it disables email alerts, read the manual to set up email alerts.

* Fixes bugs that were causing instability playing videos.

	In 1.3.1g I changed the omxplayer interface to use dbus. 1.3.1h and 1.3.1i improves the stability of this interface. In addition to changes to the code I have found that it is essential to:

      1.  Increase GPU memory from the default 64 MB to 256 MB. This is achieved using the Raspbian menu Preferences>Raspberry Pi Configuration>Performance, increase the 64 to 256.

      2. Use a version of omxplayer dated 23 Sept 2016 or later. Thsi version is in the latest version of Raspbian or can be obtained from here http://omxplayer.sconde.net/ (I recommend keeping Raspbian up to date).
	  
	Running Pi Presents with the -d option will produce a log which tells you the version and gpu memory you are currently using
	
* A log which is designed to help debuf Time of Day Scheduler problems. Enable with -d 256.

* Other minor improvements, see changelog.txt
-------------------------------------

Version 1.3.1h
A bug fix release primarily to improve the reliability of playing videos. 

* In 1.3.1g I changed the omxplayer interface to use dbus. 1.3.1h improves the reliability of this interface. In addition to changes to the code I have found that it is essential to increase GPU memory from the default 64 MB to 128 MB. This is achieved using the Raspbian menu Preferences>Raspberry Pi Configuration>Performance, increase the ???? to 128.

* Jessie does not require sudo when using gpio, however Pi Presents did, a hangover from Wheezy. I have removed this requirement and, for other reasons stopped Pi Presents being used with sudo.

* Other minor improvements, see changelog.txt

Version 1.3.1g

A bug fix release.

* The last version to use omplayer compatible with Raspbian Wheezy was issued on 29/4/2016 hence this will be the last version of Pi Presents Gapless to be tested on Raspbian Wheezy.  

* In an attempt to remove occasional hangs when playing videos (1 in 24 hours when running a 1 second video!) this version uses dbus as the interface with omxplayer instead of Pexpect (Pexpect is still used for other players). Dbus is now the preferred interface for omxplayer so should provide better long term support. The Dbus interface in  pp_omxdriver.py is experimental and not complete in that it does not implement all key bindings for run-time controls. (You can add addittional bindings to the KEY_MAP dictionary at the start of pp_omxdriver.py). Should you need to revert the repository contains the Pexpect version of the interface in pp_omxdriver_px.py.

* Raspbian Jessie uses systemd; it appears that user programs in the autostart file can now be started before the operating system is fully runnning. This requires a change to the autostart process as described in the manual and for Pi Presents and the Web Based Manager pp_manager.py to wait until the operating system boot is complete.


Version 1.3.1c

This release makes use of a later version of omxplayer. Anything after 21 July 2014  (92aad3f) will do. The latest version of Raspbian has a suitable (but not the latest version).

Version 1.3.1b 24/5/2015
* In radiobuttonshow you can now re-start a track while it is playing.
     This is very useful when using radiobuttonshow as a slave track player.(The recommended way of using OSC)
     To stop re-starting a track while it is playing bind the symbolic name to null in track Controls

Version 1.3.1a 3/5/2015
This version has many new fields so the major version number has increased from 1.2 to 1.3

* This version of Pi Presents will not run shows prepared under previous versions of pp_editor.

* Using the Version 1.3 editor on a previous version of a profile will automatically upgrade the profile fields to the current version. However there are many additional changes you will have to do manually. The changes described in the last section of the manual.

* You may find it easier to construct your profiles from the templates/examples than to do all the moodifications that are necessary.

---------------------------------------------------------------------
Version 1.2.3d 22/6/2014
If you want an example of the repeat command in a hyperlinkshow download pp_hyperlinkshow_1p2 example profile

Version 1.2.3b 28/11/2013
bug correction release
liveshow now works with -l option
pp_menu_1p2 example profile updated. No need to download just run editor on it with --forceupdate then correct the xxx window errors
manual updated to change warped to warp in the various Window fields


Version 1.2.3 17/11/2013

uzbl needs to be installed -  sudo apt-get update sudo apt-get install uzbl

There has been a change of profile since 1.2.2. However I have not changed the profile major version number since this is a beta. You must update the profiles by force; to do this run the editor with the --forceupdate command line option.

To ease the updating task there is an editor menu option 'tools>update'  which will update all profiles in a pp_home.

Play safe, keep backups!

In addition the following will need to be changed:

The format of Image Window has changed to allow 4 resizing options.
You will need to edit the Image Window field of every show and any image tracks as follows:
   centred > original
   1 2 > original 1 2
   1 2 3 4 > shrink 1234   You may prefer fit or warp to shrink (see manual)

The format of Video Window (was OMX window) has changed to match Image Window and to allow 4 resizing options in future.
You will need to edit the Video Window field in every show and any video tracks 
   centred > original
   1 2 > original 1 2
   1 2 3 4 > warp 1 2 3 4

The menushow parameters have changed significantly to accomodate the much enhanced menu displays.
The best way to convert from an old menushow to the new is to delete the old show
and replace it with a new one by doing show>new>menu in the editor. Details:
  - Remember the Show Reference of the old menu and the file name of its Medialist.
  - Delete the menu show but not its medialist
  - Create a new menu and give it the same show reference as the old when it is being created.
  - You may get a message saying the medialist already exists, just click OK
  - Edit the Medialist field in the new menu to be the old medialist name.
  - If the old menu and its medialist had different names you may now have an additional EMPTY medialst
    with the name of the menu. You can delete it.
You should then have a menu looking a bit like the old except it has bullets. Now read the menu to improve it.
The pp_menu_1p2 example shows what can be achieved.
The new menu has the menu background disabled by default.

In Track Defaults in mediashows and menus and in the menu itself the Hint Text Y position
is noo wrt to the top of the screen rather than the bottom. There is also a Hont Text x position.
   
There are new examples, additional media and the changes above made to the examples. Best to re-download  the [pipresents-next-examples].







Version 1.2.2a (beta)

There has been a change of profile since 1.2.1d. However I have not changed the profile major version number since this is a beta. You must update the profiles by force; to do this run the editor with the --forceupdate command line option.

To ease the updating task there is a now an editor menu option 'tools>update'  which will update all profiles in a pp_home.

Play safe, keep backups!

In addition the following will need to be changed:

Audio Tracks - change Duration from 0 to <blank>. Zero now means zero duration; <blank> will allow the track to run to completion. Other values of Duration can be used, see the manual.

Mediashows - change the Trigger for Start field to match the new input binding system:
* To trigger off the Return or Down cursor keys:
    Trigger For Start -> input or input-quiet Start Trigger-> <blank>
* To trigger off a GPIO button:
    Trigger For Start -> input or input-quiet Start Trigger-> pp-play (symbolic name bound to P1-18)
* To trigger off a PIR:
    Trigger For Start -> input or input-quiet Start Trigger-> PIR (bound to P1-11)	
PIR and pp-play are now symbolic names not internal operations.

All Shows - Users of earlier versions of [pipresents-next] will need to update OMX Window  from <blank> to centred.

Mediashows - change the Trigger For Next field:
* Change from none to continue (just a tidy up of the meaning, operation is the same).
* Change from GPIO to input and change the Next Input field to be a symbolic name.

Control Tracks - These have been removed. All other track types now have Show Control fields  at Beginning and End of the track.

gpio.cfg - the format has been modified. Any edits you have made to previous gpio.cfg will need to be made to copies of the new file. Also all operations such as play, stop have been changed to symbolic names e.g. pp-play, pp-stop to accomodate the redesigned input event binding system, do not change these back.

resources.cfg - new messages have been added and the text improved. Some of the mediashowmesages have been reorgaanised.


Version 1.2.1d (beta)

There has been a change of profile since 1.2.1c I have added a number of new fields and a new type of track. However I have not changed the profile version number since this is a beta. You must update the profiles; to do this run the editor with the --forceupdate command line option.

To ease the updating task there is a now editor menu option 'tools>update'  which will update all profiles in a pp_home.

Version 1.2.1
MPlayer must now be installed before using Pi Presents - sudo apt-get install mplayer

This version has many new fields so the version number has increased from 1.1 to 1.2
* This version of Pi Presents will not run shows prepared under previous versions of pp_editor
* Using the editor on a previous version of a profile will automatically upgrade the profile to the current version HOWEVER SEE BELOW!!!
* There is one change you might have to do manually. If you used PIR as the trigger for a mediashow change the 'Start Trigger' field to GPIO and enter PIR into the 'trigger input' field.

There is a simplified way to do fullscreen so the --fullscreen (-f) command option now has no parameters. Also there is no need to edit the lxde-rc.xml file or change the taskbar to autohide. However if lxde-rc.xml is already edited just leave it it will not affect operation.

The Version 1.1.x examples use omxplayer to play audio tracks. MPlayer can now be used. To do this in this beta you will need to delete the track and re-create it.

In version 1.1.x at the end of a mediashow the screen went blank, this does not happen in version 1.2.1 as, in order to reduce the flicker between tracks I leave the previous track on display while displaying the next. You will need to add a 1 second blank message track if you want a blank screen. 

This and future versions can potentially blow up your Pi as it controls the digital outputs. Until you are familiar with it I suggest ensuring all GPIO pins are disconnected when using Pi Presents.

Take care when modifying gpio.cfg,  little error checking is done by Pi Presents

Enjoy, feedback welcome.


Version 1.1.2
On a Windows PC the editor did not reliably save medialists. I have added a workaround which asks the user to re-try  the save it seems to always work on the second or third time.

unclutter must be installed before using Pi Presents  (sudo apt-get install unclutter)

In my tests liveshow coped well with deleting tracks at any time. However I can see there are potential problems as files could be deleted at the moment they are being read. If you have problems please report them and I will improve the mutual exclusion.

Take care when modifying resources.cfg, little error checking is done by Pi Presents.