Merge pull request #54 from johnrm174/develop

Release 4.6.0

README.md

@@ -22,17 +22,24 @@ 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.5.0:
-
-* Schematic Route Buttons Feature:
-    * 'One click' select/deselect of routes, changing all points and signals as required
-    * Point and signal changes can be instantaneous or sequenced with a user-specified time delay
-    * Once successfully set up, routes can be highlighted on the schematic in user-defined colours
-    * Automatic clear-down of highlighting if routes are invalidated (e.g. point or signal changes)
-    * Track-sensors can be used to automatically de-select routes when the trains have cleared the routes
-    * Interlocking is preserved - If a route isn't possible the button will be disabled (with a tooltip)
-
-* Removed constraint on interlocking with conflicting signals - more than 4 signals can now be specified
+## What's new for Release 4.6.0:
+
+BREAKING CHANGE - Single Slip and Double Slip points have been shortened to improve route highlighting but
+this does mean you will need to edit your schematic (extend track lines) to take account of this change.
+Also, Double Slip points have been changed to give a straight route through the point for their default state.
+
+* New feature to scroll canvas via mouse (drag and drop) in Run Mode - useful for larger layouts
+* Changed default GPIO sensor timeout to 20ms (the optimum value I have arrived at by testing)
+* Improvement - Item IDs (signals, points, lines etc) can now be in the range 1-999
+* Improvement - Route selection buttons are now always displayed on top of route lines
+* Improvement - Text Boxes are now always displayed on top of route lines
+* Improvement - Improved representation of Trap Points and single slip points
+* Improvement - Improved Route highlighting through points (for most point types)
+* Improvement - Improved readability for theatre route indications and track occupancy
+* Bugfix to GPIO sensors - to prevent the occasional spurious segmentation errors on settings apply
+* Bugfix to timed signals (triggered by another signal) - to prevent spurious SPAD warnings
+* Bugfix to handle update of Route ID (if changed by user in the route configuration dialog)
+* Bugfix to schematic route highlighting for 'Y' points (route now correctly highlighted)
 
 ![Example Screenshot2](https://github.com/johnrm174/model-railway-signalling/blob/main/README_screenshot1.png)
 
@@ -49,7 +56,11 @@ email: [email protected]
 
 For a first time installation use:
 <pre>
-$ python3 -m pip install model-railway-signals 
+$ pip install model-railway-signals <== This should work for most python installations
+or
+$ python -m pip install model-railway-signals <== If the command line version of pip is not installed/enabled
+or
+$ python -m pip install model-railway-signals <== If you have multiple major versions of python installed
 </pre>
 When installing the application on later versions of python you may get the following error:
 <pre>
@@ -70,44 +81,73 @@ error: externally-managed-environment
     virtual environment for you. Make sure you have pipx installed.
 
     See /usr/share/doc/python3.11/README.venv for more information.
-
-note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
-hint: See PEP 668 for the detailed specification.
 </pre>
-To overcome this, remove the 'EXTERNALLY-MANAGED' file from the default python installation and then re-attempt the install:
+To overcome this, remove the 'EXTERNALLY-MANAGED' file from the default python installation and then re-attempt the install (as above).
+Note that this is the file location for the Raspberry Pi python 3.11 installation. Other platforms may use a different location for this file:
 <pre>
 $ sudo mv /usr/lib/python3.11/EXTERNALLY-MANAGED /usr/lib/python3.11/EXTERNALLY-MANAGED.old
-$ python3 -m pip install model-railway-signals
 </pre>
 To upgrade to the latest version use:
 <pre>
-$ python3 -m pip install --upgrade model-railway-signals 
+$ pip install --upgrade model-railway-signals            <== This should work for most python installations
+or
+$ python -m pip install --upgrade model-railway-signals  <== If the command line version of pip is not installed/enabled
+or
+$ python -m pip install --upgrade model-railway-signals  <== If you have multiple major versions of python installed
+</pre>
+To remove the application:
+<pre>
+$ pip uninstall model-railway-signals <== This should work for most python installations
+or
+$ python -m pip uninstall model-railway-signals          <== If the command line version of pip is not installed/enabled
+or
+$ python -m pip uninstall model-railway-signals          <== If you have multiple major versions of python installed
+</pre>
+To install a specific version of the application the application:
+<pre>
+$ pip install model-railway-signals==4.5.0               <== This should work for most python installations
+or
+$ python -m pip install model-railway-signals==4.5.0     <== If the command line version of pip is not installed/enabled
+or
+$ python -m pip install model-railway-signals==4.5.0     <== If you have multiple major versions of python installed
+</pre>
+The application has minimum external dependencies (over and above the 'standard' python installation),
+'pyserial' and 'paho-mqtt', both of which should automatically get installed with the application.
+If for some reason this doesn't happen (I've been made aware of one instance on a Windows platform) then
+these packages can be installed seperately (prior to installing the model-railway-signals package):
+<pre>
+$ pip install paho-mqtt
+$ pip install pyserial
 </pre>
 If you want to use Block Instruments with full sound enabled (bell rings and telegraph key sounds)
-then you will also need to install the 'simpleaudio' package. Note that for Windows it has a dependency 
-on Microsoft Visual C++ 14.0 or greater (so you will need to ensure Visual Studio 2015 is installed first).
-If 'simpleaudio' is not installed then the software will still function correctly (just without sound).
+then you will also need to install the 'simpleaudio' package. If 'simpleaudio' is not installed then 
+the application will still function correctly (just without sound).
 <pre>
-$ python3 -m pip install simpleaudio
+$ pip install simpleaudio
 </pre>
-Note that if you are running on a later version of Python you may need to install libasound2 before the simpleaudio pip install will work.
+If you are running on a later version of Python you may need to install libasound2 before the simpleaudio pip install will work.
 <pre>
 $ sudo apt-get install libasound2-dev
 </pre>
+Note that for Windows, the 'simpleaudio' it has a dependency  on Microsoft Visual C++ 14.0 or greater 
+(so you will need to ensure Visual Studio 2015 is installed first).
+
 
 ## Running the application
 
 The python package should be run as a module (note underscores):
 <pre>
-$ python3 -m model_railway_signals
+$ python -m model_railway_signals  <== This should work for most python installations
+or
+$ python3 -m model_railway_signals <== If you have multiple major versions of python installed
 </pre>
 If required, a layout schematic can be loaded at startup:
 <pre>
-$ python3 -m model_railway_signals -f layout_file.sig
+$ python -m model_railway_signals -f layout_file.sig
 </pre>
 If required, the logging level can be specified at startup (ERROR, WARNING, INFO or DEBUG)
 <pre>
-$ python3 -m model_railway_signals -f layout_file.sig -l DEBUG
+$ python -m model_railway_signals -f layout_file.sig -l DEBUG
 </pre>
 
 Application documentation, can be found in the 'user_guide' folder: 

configuration_examples/automation_colour_light_example.sig

@@ -17933,10 +17933,10 @@
         "general": {
             "automation": true,
             "editmode": true,
-            "filename": "/home/pi/Software/model-railway-signalling/configuration_examples/automation_colour_light_example.sig",
+            "filename": "/home/john/model-railway-signalling/configuration_examples/automation_colour_light_example.sig",
             "info": "This layout is a development of the basic interlocking example to demonstrate signalling automation\n(note that the application needs to be in 'run' mode for all automation features to function).\n\nTrack sensors (such as those from TrainTech, Heathcote Electronics, DCC Concepts etc) can be located \nwith each signal and connected in to the R-Pi's GPIO ports (via appropriate opto isolator circuits).\nEach GPIO port can then be mapped to a signal to generate 'signal passed' events - In 'edit' mode,\nclick on a signal and select the 'automation' tab to view the configuration. 'Signal passed' events\ncan also be triggered by clicking on the small button at the base of each signal (as an aid to \ndevelopment and testing of signalling schemes before going 'live' with the R-Pi).\n\nTrack sections can be added to the schematic to provide a mimic display of track occupancy (when a\ntrain passes a signal (signal must be 'off') it gets passed from the section behind to the section ahead.\nThe required behavior is configured via the 'automation' tab of each signal. For example, signal 1\ncontrols two 'routes' so when passed, section 2 will be cleared and either section 12 or 3 will be set \nto occupied, depending on which route the signal is cleared for.\n\nAll main signals are configured to be 'overridden' if the track section ahead is occupied. This means\nthat each signal will automatically change to 'on' when passed (section ahead is occupied) and then\nrevert to'off' as soon as the section ahead is cleared. The actual aspect displayed when 'off' will \ndepend on the aspect of the signal ahead (specified via the 'interlocking tab'). This means that any\nsignals on the layout that don't need a level of manual control can be 'fully automated' (no buttons).\n\nTo simulate prototypical aspect changes for trains going off scene, the 'exit' signals (signals 4 and\n11 in this example) can be configured as 'timed signals'. Once passed they are overriden to 'on' (as\nper the other signals on the layout) but then cycle back through the aspects back to 'proceed'.\n\nTrack sensors can also positioned slightly before the signal and mapped to generate 'signal approached'\nevents to simulate 'approach control'. In this example, signal 1 is configured for 'release on yellow'\napproach control for the diverging route (in the case of the diverging route having a speed restriction).\nThis means the signal (when 'off') will initially display a yellow aspect (with the signals behind \ndisplaying flashing yellow and flashing double yellow). When the train approaches the signal (having\nslowed down for the diverging route) it will automatically change to green.\n\nTo demonstrate all the above in action, set 'run' mode and reset the layout to set all signals, points\nand track sections back to their default states. unlock, switch and re-lock points 2 and 3 for the\ndiverging loop line and set signals 8, 1, 2 and 4 to 'off'. Right click the far left track section and\nenter a train designation code of your choice (this sets the section to 'occupied'. Now, move the train\nthrough the schematic, clicking the 'signal passed' button at the base of each signal along the route\nin turn (don't forget to click the 'signal approached' button ahead of signal 1 if you want to see\napproach control working). When you get to signal 4, the train will disappear 'off scene' and the signal\nwill cycle back through the aspects (with a short delay between aspects) until it gets back to green.\n\nAlternatively, if running on a Raspberry pi, the track sensors can be triggered directly via the Ri-Pi's \nGPIO ports (momentarily connect the appropriate GPIO pin to one of the R-Pi's 0V DC pins). Select \n'Settings' =>'Sensors' from the Menubar to view the configuration. In this example the Track Sensor IDs\nhave been mapped to the GPIO port number, but any numbering scheme can be used (e.g. allocate the same ID \nfor the sensor as the signal ID it is triggering). \n\nThe layout is fully configured to support all possible train movements (including shunting movements)\nso have a play - but note that signals can only be 'passed' when 'off' for the track occupancy\nchanges to work correctly (the application currently doesn't support any form of SPAD functionality)\n\n\n\n",
             "spadpopups": false,
-            "version": "Version 4.5.0"
+            "version": "Version 4.6.0"
         },
         "gpio": {
             "portmappings": [

configuration_examples/automation_semaphore_example.sig

@@ -17501,10 +17501,10 @@
         "general": {
             "automation": true,
             "editmode": false,
-            "filename": "/home/pi/Software/model-railway-signalling/configuration_examples/automation_semaphore_example.sig",
+            "filename": "/home/john/model-railway-signalling/configuration_examples/automation_semaphore_example.sig",
             "info": "This layout is a development of the basic interlocking example to demonstrate signalling automation\n(note that the application needs to be in 'run' mode for all automation features to function).\n\nTrack sensors (such as those from TrainTech, Heathcote Electronics, DCC Concepts etc) can be located \nwith each signal and connected in to the R-Pi's GPIO ports (via appropriate opto-isolator circuits).\nEach GPIO port can then be mapped to a signal to generate 'signal passed' events - In 'edit' mode,\nclick on a signal and select the 'automation' tab to view the configuration (note that external\nGPIO sensors haven't been configured for this particular example layout). 'Signal passed' events\ncan also be triggered by clicking on the small button at the base of each signal (as an aid to \ndevelopment and testing of signalling schemes before going 'live' with the R-Pi).\n\nTrack sections can be added to the schematic to provide a mimic display of track occupancy (when a\ntrain passes a signal (signal must be 'off') it gets passed from the section behind to the section ahead.\nThe required behavior is configured via the 'automation' tab of each signal. For example, signal 1\ncontrols two 'routes' so when passed, section 2 will be cleared and either section 12 or 3 will be set \nto occupied, depending on which route the signal is cleared for.\n\nAll main signals are configured to be 'overridden' if the track section ahead is occupied. This means\nthat each signal will automatically change to 'on' when passed (section ahead is occupied) and then\nrevert to 'off' as soon as the section ahead is cleared. Note that some of the signals in this example \nhave been configured as 'fully automatic' (without a control button). This means that they will be 'off'\nby default and controlled entirely by whether the track section ahead is occupied or not.\n\nTo simulate prototypical aspect changes for trains going off scene, the 'exit' signals (signals 4 and\n11 in this example) can be configured as 'timed signals'. Once passed (when 'off') they are overriden \nto 'on' (as per the other signals on the layout) but then revert to 'off' after the specified delay.\n\nTrack sensors can also be positioned slightly before the signal and mapped to generate 'signal \napproached' events to simulate 'approach control'. In this example, all non-fully-automatic home signals \nare configured for 'release on red based on the signals ahead'. This means that if any home signals ahead\nare showing danger then the home signal will also be overridden to 'on' by default.As the train approaches\nthe signal (at a slow speed as the signal is against it) then the signal will be released to 'off' to\nallow the train to pass and then revert back to the overidden 'on' state when the signal is passed.\nSignal 1 is also configured for 'release on red' for the diverging (low-speed) route. In this case it\nwill be overridden to 'on' even if all home signals ahead are 'off', only released as the train approaches.\n\nTo demonstrate all the above in action, set 'run' mode and reset the layout to set all signals, points\nand track sections back to their default states. Right click the far left track section and enter a train\ndesignation code of your choice (this sets the section to 'occupied'). Set signals 8, 1 and 3 to 'off' (note\nthat they will remail overridden to 'on' as home signal ahead 4 is still showing 'on'. Now, move the train\nthrough the schematic, clicking the 'signal passed' button at the base of each signal along the route\nin turn (don't forget to click the 'signal approached' button ahead of each signal if you want to see\napproach control working). When the train reaches signal 4, set the signal to 'off' and trigger the signal\npassed event. The track section before the signal will be cleared and the signal overridden to 'on' as part\nof the timed sequence. After a short delay it will revert to 'off' and when it does, all home signals behind\nwill also revert to 'off' (as they will no longer be overridden on a home signal ahead).\n\nThe layout is fully configured to support all possible train movements (including shunting movements)\nso have a play - but note that signals can only be 'passed' when 'off' for the track occupancy\nchanges to work correctly (the application currently doesn't support any form of SPAD functionality)\n\n",
             "spadpopups": false,
-            "version": "Version 4.5.0"
+            "version": "Version 4.6.0"
         },
         "gpio": {
             "portmappings": [],
@@ -17567,7 +17567,7 @@
             "sublocked": false,
             "theatretext": ""
         },
-        "11": {
+        "1016": {
             "override": false,
             "releaseonred": false,
             "releaseonyel": false,
@@ -17578,7 +17578,7 @@
             "sublocked": false,
             "theatretext": ""
         },
-        "116": {
+        "11": {
             "override": false,
             "releaseonred": false,
             "releaseonyel": false,

configuration_examples/colour_light_signals.sig

@@ -52216,10 +52216,10 @@
         "general": {
             "automation": true,
             "editmode": true,
-            "filename": "/home/pi/Software/model-railway-signalling/configuration_examples/colour_light_signals.sig",
+            "filename": "/home/john/model-railway-signalling/configuration_examples/colour_light_signals.sig",
             "info": "Document your layout here",
             "spadpopups": false,
-            "version": "Version 4.5.0"
+            "version": "Version 4.6.0"
         },
         "gpio": {
             "portmappings": [],