Merge pull request #59 from johnrm174/develop

Release 5.0.0

README.md

@@ -6,10 +6,14 @@ application is primarily intended for the Raspberry Pi, but will also run on oth
 without some of the Raspberry-Pi specific interfacing functions). 
 
 * Enables layout schematics to be created with signals, points, track sections and block instruments.
+* Supports automation of signals based on track occupancy and state of signals on the route ahead.
+* Supports "one touch" configuration of routes (signals and points) with route highlighting.
+* Supports virtual DCC switches on the schematic for the control of other DCC layout accessories.
 * Supports most types of UK colour light signals, semaphore signals, and ground signals.
 * Interfaces with the Pi-SPROG DCC command station to drive the signals and points out on the layout.
 * Uses the Raspberry Pi GPIO inputs to provide train detection in support of signalling automation.
 * Incorporates MQTT networking to allow multiple signalling applications to be linked for larger layouts.
+* Supports virtual Block Instruments (with networking)for coordinating movements between signal boxes
 * Provides a [Public API](https://github.com/johnrm174/model-railway-signalling/blob/main/PUBLIC_API.md) 
 to support custom layout control interfaces.
 
@@ -22,20 +26,42 @@ The website also included a number of user guides that can be downloaded (in PDF
 My youTube channel also has a number of videos demonstrating the use of the application:
 [https://www.youtube.com/@DCCModelRailwaySignalling](https://www.youtube.com/@DCCModelRailwaySignalling)
 
-## What's new for Release 4.9.0:
-
-* New feature to drag and drop train designators between track sections (for cassette fiddle yards)
-* New option to offset the position of signal buttons (useful for busy schematics to deconflict)
-* New option to hide point buttons in Run Mode (if controlling only via setup/cleardown of routes)
-* New option to hide signal buttons in Run Mode (if controlling only via setup/cleardown of routes)
-* New menubar 'styles' feature to set (and apply) default styles for Route buttons, DCC Switches,
-signal buttons, point buttons, Track Sections, Route Lines (including points) and Text boxes
-* Width of track sections is now specified independently to the default label (4 to 30 characters)
-* Improved appearance of buttons and track sections when displayed on different colour backgrounds
-* Dynamic positioning of tooltips to ensure they always remain within the displayed area of the screen
-* Signal buttons will now only show "overridden" or "approach control set" if they are "OFF"
-* Bugfix to prevent schematic items being selected in Run Mode after scrolling the displayed area
-* Bugfix to route line highlighting (colour of the end-stops are now updated to show the route)
+## What's new for Release 5.0.0:
+
+> [!IMPORTANT]
+> Release 5.0.0 is the last release that will support layout files created by Release 4.9.x or earlier.
+> It is therefore crucial that all users upgrade to this release and then update (by loading and saving)
+> all layout files to ensure compatibility going forward - You have been warned!
+
+* Full documentation is now packaged with the application (Menubar => Help => Docs)
+* Example layout files are now packaged with the application (Menubar => File => Examples)
+* New 'Signalbox Levers' feature - enables you to achieve a fully prototypical simulation of a signalbox:
+    * Levers can be added to the schematic and 'connected' to the signals and points they control.
+    * Seperate levers can be assigned to a point's blades and Facing Point Lock (FPL). 
+    * Seperate levers can be asigned to each signal 'route' (i.e. semaphore signal arm or colour light signal route). 
+    * Full interlocking is preserved, with a clear indication on the Signalbox lever as to the state of the interlocking.
+* Keyboard 'keycode' events can be mapped to Signalbox Levers:
+    * Enables easy integration with physical levers (such as the DCC Concepts S lever) via readily available keyboard encoders. 
+    * Interlocking can either be preserved (recommended) or disabled (if you want the signals/points to reflect the state of the physical levers).
+    * Options are provide to display pop-up warnings if the user switches an external lever is switched whilst the lever is locked.
+* Schematic Object bulk renumbering utility:
+    * An easy way to consolidate your Signal, Point and Signalbox Lever numbering
+    * Most other schematic object types can also be renumbered as required
+* Improvements to the operation of Momentary DCC Switches:
+    * DCC Commands can now be specified for both the 'press' and 'release' events
+    * A fixed 'release delay' can now be specified to 'hold' the momentary switch on
+* New SPROG DCC Address Mode settings option - to cater for the 'DCC Address offsets of 4' issue sometimes
+experienced when transitioning from one DCC System to another (where the NMRA specification has been interpreted
+differently by different DCC system manufacturers/suppliers)
+* The 'Reset Layout' function now preserves track occupancy and incorporates a user-configurable switching 
+delay so point and signal changes can now be sequenced (to avoid overloading the DCC accessory bus on larger
+layouts which may require a large number of points and/or signals to be reset back to their default states).
+* Improved display of Signal Passed at Danger (SPAD warnings) - subsequent warnings are now added to the
+existing pop-up window (rather than appearing in a new pop-up). This can now be left open without affecting
+the normal operation of the application.
+* GPIO sensor events (e.g. 'signal passed', 'sensor passed' etc) are now only processed in Run Mode.
+* Bugfix to Block Instruments sound file selection (due to breaking change in 'importlib' package).
+* Bugfix to the display of validation messages in the 'settings' windows on Apply/OK.
 
 ![Example Screenshot2](https://github.com/johnrm174/model-railway-signalling/blob/main/README_screenshot1.png)