Skip to content

Commit 189bae7

Browse files
authored
Merge pull request #1220 from flash62au/sphinx
add missing commands to start and stop a sequence
2 parents 65abad6 + 1c9c9a3 commit 189bae7

5 files changed

Lines changed: 72 additions & 7 deletions

File tree

docs/reference/software/command-summary-consolidated.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -985,6 +985,41 @@ Also see the `EXRAIL` section below for activating routes.
985985
|_| Response (successful): ``<jA id type "desc">`` |BR|
986986
|_| Response (fail - is not defined): ``<jA id X>``
987987

988+
989+
|hr-dashed|
990+
991+
.. _native-command-equals-start:
992+
993+
``</ start [cab] id>`` - Start an EXRAIL Sequence
994+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
995+
996+
Start an EXRAIL sequence (route or automation).
997+
998+
*Parameters:* |BR|
999+
|_| > **cab** Optional. DCC address of the loco/cab to 'send' on the automation |BR|
1000+
|_| > **id:** Id of the Sequence
1001+
1002+
*Response:* |BR|
1003+
|_| none
1004+
1005+
|hr-dashed|
1006+
1007+
.. _native-command-equals-kill:
1008+
1009+
``</ kill id>`` - Kill an EXRAIL Sequence
1010+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1011+
1012+
Stop the execution of one or all EXRAIL sequences (route or automation).
1013+
1014+
*Parameters:* |BR|
1015+
|_| > **id:** Either: |BR|
1016+
|_| |_| |_| The id of the Sequence, or |BR|
1017+
|_| |_| |_| ``ALL`` = Kill all sequences
1018+
1019+
*Response:* |BR|
1020+
|_| none
1021+
1022+
9881023
----
9891024

9901025
System Information

docs/throttles/hardware/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ Throttles (Hardware)
2222
streamdeck
2323
uwt50
2424
dccexcontroller
25-
simple-throttle
25+
simple-throttle
26+
wifred

docs/throttles/hardware/wifred.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. include:: /include/include.rst
2+
.. include:: /include/include-l2.rst
3+
.. include:: /include/include-throttles.rst
4+
************************
5+
WiFred (Physical)
6+
************************
7+
8+
|SUITABLE| |tinkerer| |engineer| |support-button|
9+
10+
wiFred - a very simple wireless throttle for model railroads to connect to wiThrottle servers like JMRI.
11+
12+
https://newheiko.github.io/wiFred/documentation/docu_en.html

docs/throttles/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ Dedicated Hardware
7575
- :doc:`miniThrottle (Physical) <hardware/minithrottle>`
7676
- :doc:`TCS UWT-50 (Physical) <hardware/uwt50>`
7777
- :doc:`WiTcontroller (Physical) <hardware/witcontroller>`
78-
- :doc:`DCC-EX Simple Throttler (Physical) <hardware/simple-throttle>` |BR| |BR|
78+
- :doc:`DCC-EX Simple Throttler (Physical) <hardware/simple-throttle>`
79+
- :doc:`wiFred (Physical DIY) <hardware/wifred>`
7980
- :doc:`DccExController (Physical) <hardware/dccexcontroller>` - Support Discontinued |BR| |BR|
8081
- See also :doc:`DCC-EX Native command library - DCCEXProtocol </throttles/native-protocol-library>`
8182

@@ -119,8 +120,8 @@ DCC-EX (DCC-EX Native Commands)
119120
- :doc:`JMRI (Win, macOS, Linux) <software/jmri>`
120121
- :doc:`EX-T3-WiFi (T3 = Tactile Touch Throttle) (Physical) </throttles/hardware/ex-t3-wifi>`
121122
- :doc:`miniThrottle (Physical DIY) <hardware/minithrottle>`
122-
- :doc:`DCC Commander (iOS) <software/dcc-commander>` |BR| |BR|
123-
- :doc:`DCC-EX Simple Throttler (Physical) <hardware/simple-throttle>` |BR| |BR|
123+
- :doc:`DCC Commander (iOS) <software/dcc-commander>`
124+
- :doc:`DCC-EX Simple Throttler (Physical) <hardware/simple-throttle>`
124125
- :doc:`DccExController (Physical DIY) <hardware/dccexcontroller>` - Support Discontinued |BR| |BR|
125126
- See also :doc:`DCC-EX Native command library - DCCEXProtocol </throttles/native-protocol-library>`
126127

@@ -142,6 +143,7 @@ WiThrottle Protocol Based Throttles
142143
- :doc:`miniThrottle (Physical DIY) <hardware/minithrottle>`
143144
- :doc:`TCS UWT-50 (Physical DIY) <hardware/uwt50>`
144145
- :doc:`WiTcontroller (Physical DIY) <hardware/witcontroller>`
146+
- :doc:`wiFred (Physical DIY) <hardware/wifred>`
145147

146148
USB Based Throttles
147149
-------------------------------

docs/throttles/throttle_table.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@
362362
-
363363

364364
* - :doc:`miniThrottle <hardware/minithrottle>`
365-
- Free
365+
- Open Source
366366
- WiFi / USB
367367
- Native
368368
- Device
@@ -376,7 +376,7 @@
376376
-
377377

378378
* - :doc:`myBluePillThrottle7 <hardware/mybluepillthrottle>`
379-
- Free
379+
- Open Source
380380
- Serial
381381
- Native
382382
- Device
@@ -390,7 +390,21 @@
390390
-
391391

392392
* - :doc:`WiTcontroller <hardware/witcontroller>`
393-
- Free
393+
- Open Source
394+
- WiFi
395+
- WiT
396+
- Device
397+
- DIY
398+
- X
399+
-
400+
-
401+
-
402+
-
403+
-
404+
-
405+
406+
* - :doc:`wiFred <hardware/wifred>`
407+
- Open Source
394408
- WiFi
395409
- WiT
396410
- Device
@@ -452,6 +466,7 @@
452466
Free = No additional cost for full functionality. |BRxa|
453467
Paid = Payment required for any usage. |BRxa|
454468
Free/Paid = Both Free and Paid versions are available. The free version usually has limited features. |BRxa|
469+
Open Source = Source code is available to view, modify and build your own. |BRxa| However the hardware to build it is not free. |BRxa|
455470
Native = Uses the DCC-EX Native protocol/commands. [#t1]_ |BRxa|
456471
WiT = Uses the WiThrottle protocol. [#t1]_ |BRxa|
457472
Web = Requires the use of a Web Browser. |BRxa|

0 commit comments

Comments
 (0)