Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/external-references/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.youtube.com/c/DCCEX>`_ |EXTERNAL-LINK|


Jimmy from 'DIY and Digital Railroad'
-------------------------------------

Expand Down
17 changes: 8 additions & 9 deletions docs/reference/hardware/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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
25 changes: 9 additions & 16 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=========================

Expand All @@ -46,4 +31,12 @@ External References
:maxdepth: 1

/external-references/standards
/projects/index
/projects/index

Glossary
========

.. toctree::
:maxdepth: 1

glossary
1 change: 1 addition & 0 deletions docs/reference/software/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions docs/reference/videos/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. include:: /include/include.rst
.. include:: /include/include-l2.rst
.. include:: /include/include-description.rst
Expand Down
5 changes: 3 additions & 2 deletions docs/throttles/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Android (Phones and Tablets)
Apple iOS (Phones and Tablets)
------------------------------

- :doc:`ThrottleCard (iOS) <software/throttlecard>`
- :doc:`DigiTrainsPro (Android, iOS, Windows) <software/digitrainspro>` *- Requires JMRI*
- :doc:`Locontrol (iOS) <software/locontrol>`
- :doc:`SRCP Client (iOS) <software/srcpclient>`
- :doc:`Train Driver (iOS) <software/train-driver>`
- :doc:`ThrottleCard (iOS) <software/throttlecard>`
- :doc:`TrainNavigator (iOS) <software/trainnavigator>`
- :doc:`DCC-EX CAB (iOS and Android) <software/dccex-cab>`
- :doc:`WiThrottle Cab (iOS and Android) <software/withrottle-cab>`
Expand Down Expand Up @@ -112,6 +112,7 @@ DCC-EX (DCC-EX Native Commands)

- :doc:`EX-WebThrottle (Web Browser) </ex-webthrottle/index>` *recommended*
- :doc:`Engine Driver (Android) <software/engine-driver>` *recommended*
- :doc:`ThrottleCard (iOS) <software/throttlecard>`
- :doc:`DCCpp CAB (Android) <software/dccpp-cab>`
- :doc:`DCC-EX CAB (iOS and Android) <software/dccex-cab>`
- :doc:`DCC++ Throttle (Android) <software/dccpp-throttle>`
Expand All @@ -131,13 +132,13 @@ WiThrottle Protocol Based Throttles
-----------------------------------

- :doc:`Engine Driver (Android)<software/engine-driver>` *recommended*
- :doc:`ThrottleCard (iOS) <software/throttlecard>`
- :doc:`Cab Engineer: DCC Throttle (Android) <software/cab-engineer>`
- :doc:`Locontrol (iOS) <software/locontrol>`
- :doc:`WiThrottle Cab (iOS and Android) <software/withrottle-cab>`
- :doc:`WiThrottle (iOS)<software/withrottle>`
- :doc:`SRCP Client (iOS) <software/srcpclient>`
- :doc:`Train Driver (iOS) <software/train-driver>`
- :doc:`ThrottleCard (iOS) <software/throttlecard>`
- :doc:`Signal Cab (iOS) <software/signal-cab>` |BR| |BR|
- :doc:`Elgato Stream Deck (Physical) <hardware/streamdeck>`
- `HandCab (Physical DIY) <https://github.com/1fatgmc/HandCab/tree/main>`_
Expand Down
4 changes: 2 additions & 2 deletions docs/throttles/software/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Apple iOS (Phones and Tablets)
------------------------------

- :doc:`DigiTrainsPro (Android, iOS, Windows) <digitrainspro>` *- Requires JMRI*
- :doc:`ThrottleCard (iOS) <throttlecard>`
- :doc:`Locontrol (iOS) <locontrol>` *- Requires JMRI*
- :doc:`SRCP Client (iOS) <srcpclient>`
- :doc:`ThrottleCard (iOS) <throttlecard>`
- :doc:`Train Driver (iOS) <train-driver>`
- :doc:`Train Throttle (iOS) <train-throttle>`
- :doc:`TrainNavigator (iOS) <trainnavigator>`
Expand Down Expand Up @@ -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) </ex-webthrottle/index>
Engine Driver (Android) <engine-driver>
jmri
ThrottleCard (iOS) <throttlecard>
Cab Engineer: DCC Throttle (Android) <cab-engineer>
DCCpp CAB (android) <dccpp-cab>
DCC-EX CAB (Android and iOS) <dccex-cab>
Expand All @@ -71,7 +72,6 @@ Note: The Android throttle apps listed above can be made to made to run on Windo
RtDrive DCC++ (Android) <rtdrive-dccpp>
SRCP Client (iOS) <srcpclient>
Train Driver (iOS) <train-driver>
ThrottleCard (iOS) <throttlecard>
TrainNavigator (iOS) <trainnavigator>
Train Throttle (Windows, Mac, iOS) <train-throttle>
WiThrottle (iOS) <withrottle>
Expand Down
2 changes: 1 addition & 1 deletion docs/throttles/throttle_table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down
15 changes: 15 additions & 0 deletions docs/throttles/withrottle-protocol-library.rst
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/flash62au/WiThrottleProtocol>`__ |EXTERNAL-LINK|.
Loading