diff --git a/Release_Notes/ThrottleAssists.md b/Release_Notes/ThrottleAssists.md index 5f4a68d..e704b42 100644 --- a/Release_Notes/ThrottleAssists.md +++ b/Release_Notes/ThrottleAssists.md @@ -10,40 +10,44 @@ Turnouts The conventional turnout definition commands and the `````` responses do not contain information about the turnout description which may have been provided in an EXRAIL script. A turnout description is much more user friendly than the cryptic "T123", and having a list helps the throttle UI build a suitable set of buttons. -`````` command returns a list of turnout ids. The throttle should be uninterested in the turnout technology used but needs to know the ids it can throw/close and monitor the current state. +`````` command returns a list of turnout ids. The throttle should be uninterested in the turnout technology used but needs to know the ids it can throw/close and monitor the current state. e.g. response `````` -````` requests info on turnout 17. -e.g. response `````` or `````` -(T=thrown, C=closed) -or `````` indicating turnout description not given. -or `````` indicating turnout unknown (or possibly hidden.) - -Note: It is still the throttles responsibility to monitor the status broadcasts. - (TBD I'm thinking that the existing broadcast is messy and needs cleaning up) - However, I'm not keen on dynamically created/deleted turnouts so I have no intention of providing a command that indicates the turnout list has been updated since the throttle started. - Also note that turnouts marked in EXRAIL with the HIDDEN keyword instead of a "description" will NOT show up in these commands. +````` requests info on turnout 17. +e.g. response `````` or ````` +(T=thrown, C=closed) +or `````` indicating turnout description not given. +or `````` indicating turnout unknown (or possibly hidden.) + +Note: It is still the throttles responsibility to monitor the status broadcasts. +(TBD I'm thinking that the existing broadcast is messy and needs cleaning up) +However, I'm not keen on dynamically created/deleted turnouts so I have no intention of providing a command that indicates the turnout list has been updated since the throttle started. +Also note that turnouts marked in EXRAIL with the HIDDEN keyword instead of a "description" will NOT show up in these commands. Automations/Routes ==================== - A throttle need to know which EXRAIL Automations and Routes it can show the user. - - `````` Returns a list of Automations/Routes - e.g. `````` - Indicates route/automation ids. - Information on each route needs to be obtained by - `````` - returns e.g. `````` for a route - or `````` for an automation. - or `````` for id not found - - Whats the difference: - A Route is just a call to an EXRAIL ROUTE, traditionally to set some turnouts or signals but can be used to perform any kind of EXRAIL function... but its not expecting to know the loco. - Thus a route can be triggered by sending in for example ``````. + A throttle need to know which EXRAIL Automations and Routes it can show the user. + + `````` Returns a list of Automations/Routes + e.g. `````` + Indicates route/automation ids. + Information on each route needs to be obtained by + `````` + returns e.g. `````` for a route + or `````` for an automation. + or `````` for id not found + + What's the difference? + ----------------------- + +A *Route* is just a call to an **EXRAIL ROUTE**, traditionally to set some turnouts or signals but can be used to perform any kind of EXRAIL function... but its not expecting to know the loco. + +Thus, a route can be triggered by sending in for example ``````. + + An *Automation* is a handoff of the last accessed loco id to an EXRAIL AUTOMATION which would typically drive the loco away. - An Automation is a handoff of the last accessed loco id to an EXRAIL AUTOMATION which would typically drive the loco away. Thus an Automation expects a start command with a cab id e.g. `````` @@ -68,10 +72,10 @@ Note: It is still the throttles responsibility to monitor the status broadcasts. COMMANDS TO AVOID ====================== - `````` Use `````` - `````` Just drop the slot number - `````` other than `````` - `````` + `````` Use `````` + `````` Just drop the slot number + `````` other than `````` + `````` ``````