From 91d36ae909b21eb7cbd215f4f5b6a85ab1181d83 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 3 Mar 2023 21:59:18 -0500 Subject: [PATCH] Update ThrottleAssists.md --- Release_Notes/ThrottleAssists.md | 35 +++++++++++++------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/Release_Notes/ThrottleAssists.md b/Release_Notes/ThrottleAssists.md index 56677ae..19622fd 100644 --- a/Release_Notes/ThrottleAssists.md +++ b/Release_Notes/ThrottleAssists.md @@ -3,18 +3,17 @@ Throttle Assist updates for versiuon 4.? Chris Harlow April 2022 There are a number of additional throttle information commands that have been implemented to assist throttle authors to obtain information from the Command Station in order to implement turnout, route/automation and roster features which are already found in the Withrottle implementations. -These commands are new and not overlapped with the existing commands which are probabaly due to be obsoleted as they are over complex and unfit for purpose. +These commands are new and not overlapped with the existing commands which are probabaly due to be obsoleted as they are over complex and unfit for purpose. -Turnouts -============ +# 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. e.g. response `````` -````` requests info on turnout 17\ -e.g. response `````` or `````\ +`````` 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.) @@ -24,8 +23,7 @@ Note: It is still the throttles responsibility to monitor the status broadcasts. 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 - ==================== + # Automations/Routes A throttle need to know which EXRAIL Automations and Routes it can show the user. @@ -38,8 +36,7 @@ Also note that turnouts marked in EXRAIL with the HIDDEN keyword instead of a "d or `````` for an automation.\ or `````` for id not found - What's the difference? - ----------------------- + ## 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. @@ -50,31 +47,27 @@ An *Automation* is a handoff of the last accessed loco id to an EXRAIL AUTOMATIO 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 `````` +The `````` command requests a list of cab ids from the roster\ +e.g. responding ``````\ or for none. -Each Roster entry had a name and function map obtained by: +Each Roster entry had a name and function map obtained by:\ `````` reply like ``` 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. +`````` 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. +# COMMANDS TO AVOID -COMMANDS TO AVOID -====================== - - `````` - Instead Use ``````\ + `````` Instead Use ``````\ `````` Just drop the slot number\ `````` other than ``````\ ``````\