Merge pull request #37 from johnrm174/develop

Develop

PUBLIC_API.md

@@ -91,6 +91,7 @@ Summary of features supported by each signal type:
            - lock_subsidary / unlock_subsidary
            - lock_signal / unlock_signal
            - set_signal_override / clear_signal_override
+           - set_signal_override_caution / clear_signal_override_caution (not Home)
            - set_approach_control (Release on Red or Yellow) / clear_approach_control
            - trigger_timed_signal
            - query signal state (signal_clear, signal_state, subsidary_clear)
@@ -101,6 +102,7 @@ Summary of features supported by each signal type:
            - lock_subsidary / unlock_subsidary
            - lock_signal / unlock_signal
            - set_signal_override / clear_signal_override
+           - set_signal_override_caution / clear_signal_override_caution (not Home)
            - set_approach_control (Release on Red only) / clear_approach_control
            - trigger_timed_signal
            - query signal state (signal_clear, signal_state, subsidary_clear)
@@ -302,9 +304,16 @@ signal_state(sig_id:int/str) - returns the DISPLAYED state of the signal. This c
                       integer (representing the ID of a signal on the local schematic), or a 
                       string (representing the identifier of an signal on an external MQTT node)
 
-set_signal_override (sig_id*:int) - Overrides the signal to DANGER (can specify multiple sig_ids)
+set_signal_override (sig_id*:int) - Overrides the signal to display the most restrictive aspect
+                      (Distant signals will display CAUTION - all other types will display DANGER)
 
-clear_signal_override (sig_id*:int) - Clears the siganl Override (can specify multiple sig_ids)
+clear_signal_override (sig_id*:int) - Clears the signal Override (can specify multiple sig_ids)
+
+set_signal_override_caution (sig_id*:int) - Overrides the signal to display CAUTION
+                      (Applicable to all main signal types apart from home signals)
+
+clear_signal_override_caution (sig_id*:int) - Clears the signal Override
+                      (Applicable to all main signal types apart from home signals)
 
 trigger_timed_signal - Sets the signal to DANGER and cycles through the aspects back to PROCEED.
                       If start delay > 0 then a 'sig_passed' callback event is generated when

README.md

@@ -12,15 +12,15 @@ From Release 3.0.0, the schematic editor application enables automated and inter
 schemes to be designed and configured without the need to write any code. Note that the editor is in
 active development so any comments and suggestions for future features are welcome.
 
-What's supported in Release 3.1.0:
+What's supported in Release 3.2.0:
 * Draw your layout schematic with lines, points, signals and track occupancy sections
-* Define the DCC acommand sequences to drive the signals and points out on the layout
+* Define the DCC command sequences to drive the signals and points out on the layout
 * Configure the signals and points to implement protototypical interlocking schemes
 * Configure GPIO sensors and track sections to provide a 'mimic' display of the layout
+* Automation of signals as trains traverse the routes that have been configured
 * Save and load your layout schematic and state between running sessions
 
 What's coming soon:
-* Undo/redo for layout editing functions
 * Support for block section instruments
 * MQTT networking (for linking layouts)
 * Application documentation
@@ -74,7 +74,11 @@ To run the editor application:
 
 The python package should be run as a module (note underscores):
 <pre>
-$ python3 -m model_railway_signals 
+$ python3 -m model_railway_signals
+</pre>
+or to load a layout schematic at startup
+<pre>
+$ python3 -m model_railway_signals -f layout_file.sig
 </pre>
 
 ## Using the library functions