1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2024-12-23 21:01:25 +01:00

Update ThrottleAssists.md

This commit is contained in:
Fred 2023-03-03 21:41:22 -05:00 committed by GitHub
parent 79eaaa85fa
commit d3eceb6d6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,14 +13,14 @@ The conventional turnout definition commands and the ```<H>``` responses do not
```<JT>``` 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. ```<JT>``` 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 ```<jT 1 17 22 19>``` e.g. response ```<jT 1 17 22 19>```
```<JT 17>`` requests info on turnout 17. ```<JT 17>`` requests info on turnout 17.\
e.g. response ```<jT 17 T "Coal yard exit">``` or ```<jT 17 C "Coal yard exit">`` e.g. response ```<jT 17 T "Coal yard exit">``` or ```<jT 17 C "Coal yard exit">``\
(T=thrown, C=closed) (T=thrown, C=closed)\
or ```<jT 17 C "">``` indicating turnout description not given. or ```<jT 17 C "">``` indicating turnout description not given.\
or ```<jT 17 X>``` indicating turnout unknown (or possibly hidden.) or ```<jT 17 X>``` indicating turnout unknown (or possibly hidden.)
Note: It is still the throttles responsibility to monitor the status broadcasts. 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) (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. 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. 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. A throttle need to know which EXRAIL Automations and Routes it can show the user.
```<JA>``` Returns a list of Automations/Routes ```<JA>``` Returns a list of Automations/Routes\
e.g. ```<jA 13 16 23>``` e.g. ```<jA 13 16 23>```\
Indicates route/automation ids. Indicates route/automation ids.\
Information on each route needs to be obtained by Information on each route needs to be obtained by\
```<JA 13>``` ```<JA 13>```\
returns e.g. ```<jA 13 R "description">``` for a route returns e.g. ```<jA 13 R "description">``` for a route\
or ```<jA 13 A "description">``` for an automation. or ```<jA 13 A "description">``` for an automation.\
or ```<jA 13 X>``` for id not found or ```<jA 13 X>``` for id not found
What's the difference? 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. 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 ```</START 13>```. Thus, a route can be triggered by sending in for example ```</START 13>```.
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. ```</START 13 3>``` e.g. ```</START 13 3>```
Roster Information: Roster Information
^^^^^^^^^^^^^^^^^^
The ```<JR>``` command requests a list of cab ids from the roster. The ```<JR>``` command requests a list of cab ids from the roster.
e.g. responding ```<jR 3 200 6336>``` e.g. responding ```<jR 3 200 6336>```
or <jR> for none. or <jR> for none.
@ -63,7 +64,8 @@ Thus, a route can be triggered by sending in for example ```</START 13>```.
Refer to EXRAIL ROSTER command for function map format. Refer to EXRAIL ROSTER command for function map format.
Obtaining throttle status. Obtaining throttle status
^^^^^^^^^^^^^^^^^^^^^^^^^^
```<t cabid>``` Requests a deliberate update on the cab speed/functions in the same format as the cab broadcast. ```<t cabid>``` Requests a deliberate update on the cab speed/functions in the same format as the cab broadcast.
```<l cabid slot speedbyte functionMap>``` ```<l cabid slot speedbyte functionMap>```
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. 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 ```</START 13>```.
COMMANDS TO AVOID COMMANDS TO AVOID
====================== ======================
```<f cab func1 func2>``` Use ```<F cab function 1/0>``` ```<f cab func1 func2>``` Use ```<F cab function 1/0>```\
```<t slot cab speed dir>``` Just drop the slot number ```<t slot cab speed dir>``` Just drop the slot number\
```<T commands>``` other than ```<T id 0/1>``` ```<T commands>``` other than ```<T id 0/1>```\
```<s>``` ```<s>```\
```<c>``` ```<c>```