From d3eceb6d6c61e507304e5f85cb196405b99148f3 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 3 Mar 2023 21:41:22 -0500 Subject: [PATCH] Update ThrottleAssists.md --- Release_Notes/ThrottleAssists.md | 46 +++++++++++++++++--------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/Release_Notes/ThrottleAssists.md b/Release_Notes/ThrottleAssists.md index e704b42..2055618 100644 --- a/Release_Notes/ThrottleAssists.md +++ b/Release_Notes/ThrottleAssists.md @@ -13,14 +13,14 @@ The conventional turnout definition commands and the `````` responses do not `````` 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. +````` 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) +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. @@ -30,13 +30,13 @@ Also note that turnouts marked in EXRAIL with the HIDDEN keyword instead of a "d 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. + `````` 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? @@ -45,14 +45,15 @@ Also note that turnouts marked in EXRAIL with the HIDDEN keyword instead of a "d 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 + Thus an Automation expects a start command with a cab id\ e.g. `````` - Roster Information: + Roster Information + ^^^^^^^^^^^^^^^^^^ The `````` command requests a list of cab ids from the roster. e.g. responding `````` or for none. @@ -63,7 +64,8 @@ Thus, a route can be triggered by sending in for example ``````. Refer to EXRAIL ROSTER command for function map format. - Obtaining throttle status. + Obtaining throttle status + ^^^^^^^^^^^^^^^^^^^^^^^^^^ `````` Requests a deliberate update on the cab speed/functions in the same format as the cab broadcast. `````` Note that a slot of -1 indicates that the cab is not in the reminders table and this comand will not reserve a slot until such time as the cab is throttled. @@ -72,10 +74,10 @@ Thus, a route can be triggered by sending in for example ``````. COMMANDS TO AVOID ====================== - `````` Use `````` - `````` Just drop the slot number - `````` other than `````` - `````` + `````` Use ``````\ + `````` Just drop the slot number\ + `````` other than ``````\ + ``````\ ``````