diff --git a/docs/external-references/index.rst b/docs/external-references/index.rst index fc56375f4c..89a71aecb5 100644 --- a/docs/external-references/index.rst +++ b/docs/external-references/index.rst @@ -16,11 +16,19 @@ Articles and Videos :depth: 2 :local: + + The following are articles and videos created by people in and outside the |DCC-EX| project which you may find useful or interesting. Videos ====== +DCC-EX YouTube Channel +---------------------- + +Please visit our YouTube Channel at `www.youtube.com/c/DCCEX `_ |EXTERNAL-LINK| + + Jimmy from 'DIY and Digital Railroad' ------------------------------------- diff --git a/docs/reference/hardware/index.rst b/docs/reference/hardware/index.rst index 637b44d190..d78af47e99 100644 --- a/docs/reference/hardware/index.rst +++ b/docs/reference/hardware/index.rst @@ -7,15 +7,6 @@ Hardware ******** -|SUITABLE| |conductor| |tinkerer| |engineer| |support-button| - -.. toctree:: - :maxdepth: 1 - - index-decoder - wire-gauge - power-supplies - |SUITABLE| |tinkerer| |engineer| |support-button| .. toctree:: @@ -44,3 +35,11 @@ Motor Board List .. include:: include_table_motor_boards.rst +|SUITABLE| |conductor| |tinkerer| |engineer| |support-button| + +.. toctree:: + :maxdepth: 1 + + index-decoder + wire-gauge + power-supplies diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 1f8dc41bd7..1695937334 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -9,22 +9,7 @@ Reference |SUITABLE| |conductor| |tinkerer| |engineer| |support-button| -Glossary -======== - -.. toctree:: - :maxdepth: 1 - glossary - -Videos -====== - -.. toctree:: - :maxdepth: 1 - - videos/index - Hardware, Software, tools ========================= @@ -46,4 +31,12 @@ External References :maxdepth: 1 /external-references/standards - /projects/index \ No newline at end of file + /projects/index + +Glossary +======== + +.. toctree:: + :maxdepth: 1 + + glossary diff --git a/docs/reference/software/index.rst b/docs/reference/software/index.rst index b0f4f43534..3e35081a26 100644 --- a/docs/reference/software/index.rst +++ b/docs/reference/software/index.rst @@ -35,4 +35,5 @@ EXRAIL and Native Commands command-summary-consolidated /exrail/exrail-command-reference /throttles/native-protocol-library + /throttles/withrottle-protocol-library withrottle-vs-native-commands \ No newline at end of file diff --git a/docs/reference/videos/index.rst b/docs/reference/videos/index.rst index efae8f1bff..ee28d4c225 100644 --- a/docs/reference/videos/index.rst +++ b/docs/reference/videos/index.rst @@ -1,3 +1,5 @@ +:orphan: + .. include:: /include/include.rst .. include:: /include/include-l2.rst .. include:: /include/include-description.rst diff --git a/docs/throttles/index.rst b/docs/throttles/index.rst index 8bb64175e0..b7f579d769 100644 --- a/docs/throttles/index.rst +++ b/docs/throttles/index.rst @@ -53,11 +53,11 @@ Android (Phones and Tablets) Apple iOS (Phones and Tablets) ------------------------------ +- :doc:`ThrottleCard (iOS) ` - :doc:`DigiTrainsPro (Android, iOS, Windows) ` *- Requires JMRI* - :doc:`Locontrol (iOS) ` - :doc:`SRCP Client (iOS) ` - :doc:`Train Driver (iOS) ` -- :doc:`ThrottleCard (iOS) ` - :doc:`TrainNavigator (iOS) ` - :doc:`DCC-EX CAB (iOS and Android) ` - :doc:`WiThrottle Cab (iOS and Android) ` @@ -112,6 +112,7 @@ DCC-EX (DCC-EX Native Commands) - :doc:`EX-WebThrottle (Web Browser) ` *recommended* - :doc:`Engine Driver (Android) ` *recommended* +- :doc:`ThrottleCard (iOS) ` - :doc:`DCCpp CAB (Android) ` - :doc:`DCC-EX CAB (iOS and Android) ` - :doc:`DCC++ Throttle (Android) ` @@ -131,13 +132,13 @@ WiThrottle Protocol Based Throttles ----------------------------------- - :doc:`Engine Driver (Android)` *recommended* +- :doc:`ThrottleCard (iOS) ` - :doc:`Cab Engineer: DCC Throttle (Android) ` - :doc:`Locontrol (iOS) ` - :doc:`WiThrottle Cab (iOS and Android) ` - :doc:`WiThrottle (iOS)` - :doc:`SRCP Client (iOS) ` - :doc:`Train Driver (iOS) ` -- :doc:`ThrottleCard (iOS) ` - :doc:`Signal Cab (iOS) ` |BR| |BR| - :doc:`Elgato Stream Deck (Physical) ` - `HandCab (Physical DIY) `_ diff --git a/docs/throttles/software/index.rst b/docs/throttles/software/index.rst index e6c2869717..8981b50768 100644 --- a/docs/throttles/software/index.rst +++ b/docs/throttles/software/index.rst @@ -30,9 +30,9 @@ Apple iOS (Phones and Tablets) ------------------------------ - :doc:`DigiTrainsPro (Android, iOS, Windows) ` *- Requires JMRI* +- :doc:`ThrottleCard (iOS) ` - :doc:`Locontrol (iOS) ` *- Requires JMRI* - :doc:`SRCP Client (iOS) ` -- :doc:`ThrottleCard (iOS) ` - :doc:`Train Driver (iOS) ` - :doc:`Train Throttle (iOS) ` - :doc:`TrainNavigator (iOS) ` @@ -60,6 +60,7 @@ Note: The Android throttle apps listed above can be made to made to run on Windo EX-Web-Throttle (Web Browser) Engine Driver (Android) jmri + ThrottleCard (iOS) Cab Engineer: DCC Throttle (Android) DCCpp CAB (android) DCC-EX CAB (Android and iOS) @@ -71,7 +72,6 @@ Note: The Android throttle apps listed above can be made to made to run on Windo RtDrive DCC++ (Android) SRCP Client (iOS) Train Driver (iOS) - ThrottleCard (iOS) TrainNavigator (iOS) Train Throttle (Windows, Mac, iOS) WiThrottle (iOS) diff --git a/docs/throttles/throttle_table.rst b/docs/throttles/throttle_table.rst index 5f0fa3a0e5..ae04f5f7ac 100644 --- a/docs/throttles/throttle_table.rst +++ b/docs/throttles/throttle_table.rst @@ -480,7 +480,7 @@ Free = No additional cost for full functionality. |BRxa| Paid = Payment required for any usage. |BRxa| Free/Paid = Both Free and Paid versions are available. The free version usually has limited features. |BRxa| - Open Source = Source code is available to view, modify and build your own. |BRxa| However the hardware to build it is not free. |BRxa| + Open Source = Designs and Source code are available to view, modify and build your own. |BRxa| However the hardware to build it is not free. |BRxa| Native = Uses the DCC-EX Native protocol/commands. [#t1]_ |BRxa| WiT = Uses the WiThrottle protocol. [#t1]_ |BRxa| Web = Requires the use of a Web Browser. |BRxa| diff --git a/docs/throttles/withrottle-protocol-library.rst b/docs/throttles/withrottle-protocol-library.rst new file mode 100644 index 0000000000..d2688ba8bd --- /dev/null +++ b/docs/throttles/withrottle-protocol-library.rst @@ -0,0 +1,15 @@ +.. include:: /include/include.rst +.. include:: /include/include-l1.rst +.. include:: /include/include-throttles.rst + +****************************************************** +WiThrottle protocol library - WiThrottleProtocol +****************************************************** + +|SUITABLE| |tinkerer| |engineer| |support-button| + +A WiThrottle protocol library is available to help develop throttle apps on Arduino (primarily ESP32) hardware. + +The library implements the WiThrottle protocol (as used in many commands Staions including the |DCC-EX| |EX-CS|, JMRI, LnWi), allowing a device to connect to the server and act as a client (such as a hardware based throttle). + +Details of the library, including instructions and examples, `is available here `__ |EXTERNAL-LINK|. \ No newline at end of file