Skip to content

Commit f19dadc

Browse files
authored
Merge pull request #1160 from flash62au/sphinx
2 parents 24f3bde + b03822d commit f19dadc

File tree

8 files changed

+85
-103
lines changed

8 files changed

+85
-103
lines changed

docs/ex-toolbox/using.rst

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ CV Programming (Operation Mode)
153153

154154
EX-Toolbox CV Programming (Operation Mode) Screen
155155

156-
Operation Mode CV Programming is available form the 'CV Programming' screen, when 'Program on Main (Operation Mode)' is selected in the drop down list at the top of the screen.
156+
Operation Mode CV Programming is available from the 'CV Programming' screen, when 'Program on Main (Operation Mode)' is selected in the drop down list at the top of the screen.
157157

158158
Operation Mode CV Programming ONLY allows you to *Write* CVs.
159159

@@ -497,14 +497,33 @@ View log
497497

498498
Accessed from any of the main screens via :menuselection:`Menu --> View Log`.
499499

500-
This screen allows you to view the internal Engine Driver log of events.
501-
This is sometimes useful for analysing problems.
500+
This screen allows you to view the internal EX-Toolbox log of events. (referend to as 'logcat').
502501

503502
The option to `Start recording to file` creates a user-accessible file that can be sent to the |EX-TB| app developers to assist you in resolving a problem.
504-
The file will be located on your mobile phone at:
505-
Internal storage ``/Android/data/dcc_ex.toolbox/files`` |br|\ and will be named something like: ``logcat9999999999999.txt``
506503

507-
Enable the preference to include the timestamp on each line of the log.
504+
The file will be located on your Android device/phone at:
505+
Internal storage ``/Android/data/dcc_ex.ex_toolbox/files`` |br|\ and will be named something like: ``logcat9999999999999.txt``
506+
507+
Optionally enable the preference to include the timestamp on each line of the log.
508+
509+
Saving a Log File
510+
-----------------
511+
512+
To record a log file in |EX-TB|....
513+
514+
1. Start |EX-TB|.
515+
2. From the menu, select :guilabel:`View Log`
516+
3. Click :guilabel:`Start recording to a file`
517+
4. Click :guilabel:`Close``
518+
5. Attempt whatever is causing the problem a few times
519+
6. Exit |EX-TB|
520+
7. Connect a USB cable to your device/phone and PC
521+
8. Allow access if the device/phone asks.
522+
9. In some versions of Android you may also need to change the connection type on the device/phone from 'charging' to 'file transfer'
523+
10. Open a file manager and find the connected device/phone
524+
11. Browse down to the folder ...\Internal shared storage\Android\data\dcc_ex.ex_toolbox\files
525+
12. Find the most recent file that looks like ``logcatxxxxxxxxxxxxx.txt`` e.g. logcat1699833098998.txt
526+
13. Attach that file to a message in discord using the :guilabel:`+` button on the row of the message content```
508527

509528

510529
About
@@ -523,7 +542,7 @@ This screen displays
523542
Connecting via JMRI
524543
===================
525544

526-
|EX-TB| can't normally connect to a |EX-CS| through |JMRI|, however it is possible if you ``Load DCC== over TCP Server`` in the 'DCC-EX' menu in |JMRI|, then connect |EX-TB| to the additional server that is presented.
545+
|EX-TB| can't normally connect to a |EX-CS| through |JMRI|, however it is possible if you ``Load DCC++ over TCP Server`` in the 'DCC-EX' menu in |JMRI|, then connect |EX-TB| to the additional server that is presented in Connection screen. It will be the same name as your JMRI Railroad name, but will have " [DCC-EX]" appended to it.
527546

528547
----
529548

docs/throttles/hardware/dccexcontroller.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ DccEXcontroller (Physical)
1414
:depth: 3
1515
:local:
1616

17+
.. note::
18+
19+
While this contoller code remains fully functional, support for DccEXcontroller has been discontinued.
20+
1721
DccExController uses exactly the same hardware as the WiTcontroller, but uses the DCC-EX Native command protocol instead of the |WITHROTTLE PROTOCOL|.
1822

1923
From |Engine Driver|'s very own Peter Akers (flash62au on our Discord server), comes a physical hardware throttle using only 4 parts:
@@ -65,8 +69,6 @@ Features
6569

6670
* limited dealing with unexpected disconnects. It will throw you back to the Server selection screen.
6771

68-
NOTE: This is a Project and is therefore a work in progress and open source. New features are being added regularly.
69-
7072
Source code and instructions can be found on GitHub here: https://github.com/flash62au/DccExController |EXTERNAL-LINK|
7173

7274
Images

docs/throttles/hardware/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Throttles (Hardware)
1212
.. toctree::
1313
:maxdepth: 1
1414

15-
dccexcontroller
1615
engine-driver-physical-knobs
1716
ex-t3-wifi
1817
handcab
@@ -21,4 +20,5 @@ Throttles (Hardware)
2120
mybluepillthrottle
2221
witcontroller
2322
streamdeck
24-
uwt50
23+
uwt50
24+
dccexcontroller

docs/throttles/index.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Android (Phones and Tablets)
4747
- :doc:`DCCpp CAB (android) <software/dccpp-cab>`
4848
- :doc:`DigiTrainsPro (Android, iOS, Windows) <software/digitrainspro>` *- Requires JMRI*
4949
- :doc:`RtDtive DCC++ (Android) <software/rtdrive-dccpp>`
50+
- :doc:`DCC-EX CAB (iOS and Android) <software/dccex-cab>`
5051

5152
Apple iOS (Phones and Tablets)
5253
------------------------------
@@ -57,20 +58,21 @@ Apple iOS (Phones and Tablets)
5758
- :doc:`Train Driver (iOS) <software/train-driver>`
5859
- :doc:`ThrottleCard (iOS) <software/throttlecard>`
5960
- :doc:`TrainNavigator (iOS) <software/trainnavigator>`
61+
- :doc:`DCC-EX CAB (iOS and Android) <software/dccex-cab>`
6062
- :doc:`WiThrottle (iOS) <software/withrottle>`
6163

6264

6365
Dedicated Hardware
6466
------------------
6567

66-
- :doc:`DccExController (Physical) <hardware/dccexcontroller>`
6768
- :doc:`Elgato Stream Deck (Physical) <hardware/streamdeck>`
6869
- :doc:`EX-T3-WiFi (T3 = Tactile Touch Throttle) (physical) </throttles/hardware/ex-t3-wifi>`
6970
- `HandCab (Physical) <https://github.com/1fatgmc/HandCab/tree/main>`_
7071
- :doc:`LoDi-Con WiFi Throttle </throttles/hardware/lodi-con-wifi-throttle>`
7172
- :doc:`miniThrottle (Physical) <hardware/minithrottle>`
7273
- :doc:`TCS UWT-50 (Physical) <hardware/uwt50>`
73-
- :doc:`WiTcontroller (Physical) <hardware/witcontroller>` |BR| |BR|
74+
- :doc:`WiTcontroller (Physical) <hardware/witcontroller>`
75+
- :doc:`DccExController (Physical) <hardware/dccexcontroller>` - Support Discontinued |BR| |BR|
7476
- See also :doc:`DCC-EX Native command library - DCCEXProtocol </throttles/native-protocol-library>`
7577

7678
Personal Computers
@@ -105,14 +107,15 @@ DCC-EX (DCC-EX Native Commands)
105107
- :doc:`EX-WebThrottle (Web Browser) </ex-webthrottle/index>` *recommended*
106108
- :doc:`Engine Driver (Android) <software/engine-driver>` *recommended*
107109
- :doc:`DCCpp CAB (Android) <software/dccpp-cab>`
110+
- :doc:`DCC-EX CAB (iOS and Android) <software/dccex-cab>`
108111
- :doc:`DCC++ Throttle (Android) <software/dccpp-throttle>`
109112
- :doc:`RtDtive DCC++ (Android) <software/rtdrive-dccpp>`
110113
- :doc:`SRCP Client (iOS) <software/srcpclient>`
111114
- :doc:`TrainNavigator (iOS) <software/trainnavigator>`
112115
- :doc:`JMRI (Win, macOS, Linux) <software/jmri>`
113-
- :doc:`DccExController (Physical) <hardware/dccexcontroller>`
114116
- :doc:`EX-T3-WiFi (T3 = Tactile Touch Throttle) (Physical) </throttles/hardware/ex-t3-wifi>`
115117
- :doc:`miniThrottle (Physical) <hardware/minithrottle>` |BR| |BR|
118+
- :doc:`DccExController (Physical) <hardware/dccexcontroller>` - Support Discontinued
116119
- See also :doc:`DCC-EX Native command library - DCCEXProtocol </throttles/native-protocol-library>`
117120

118121
WiThrottle Protocol Based Throttles
Lines changed: 5 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
.. include:: /include/include.rst
22
.. include:: /include/include-l2.rst
33
.. include:: /include/include-throttles.rst
4-
************************
5-
Android apps on Windows
6-
************************
4+
**********************************
5+
Android apps on Windows & macOS
6+
**********************************
77

88
|SUITABLE| |tinkerer| |engineer| |support-button|
99

10-
All the Android based throttle apps listed can be run on Microsoft Windows PCs.
10+
All the Android based throttle apps listed can be run on Microsoft Windows PCs and Apple Silicon Macs using `BlueStacks <https://www.bluestacks.com/>`_ |EXTERNAL-LINK|.
1111

12-
There are a least two methods:
13-
14-
- Using *BlueStacks*
15-
- Using *Windows Subsystem for Android*
1612

1713
BlueStacks
1814
==========
@@ -21,7 +17,7 @@ The `BlueStacks <https://www.bluestacks.com/>`_ |EXTERNAL-LINK| app allows you t
2117

2218
It has the advantages of:
2319

24-
- Works on most recent Windows PCs
20+
- Works on most recent Windows PCs and Apple Silicon Macs
2521
- User Friendly installation of apps
2622
- Allows you to run multiple instances of same app at the same time
2723

@@ -30,83 +26,3 @@ Disadvantages include:
3026
- Has advertisements
3127

3228
Follow the instructions on their `site <https://www.bluestacks.com/>`_ |EXTERNAL-LINK| to install BlueStacks, then get the appropriate .apk to install the throttle app you want. e.g. The Engine Driver .apk is available from the `Engine Driver site <https://enginedriver.mstevetodd.com/downloads>`_ |EXTERNAL-LINK|
33-
34-
Windows Subsystem for Android
35-
=============================
36-
37-
`Windows Subsystem for Android <https://https://learn.microsoft.com/en-us/windows/android/wsa//>`_ |EXTERNAL-LINK| is a built in feature of Windows 11 that allows you to install and run most Android apps on *some* Windows PCs.
38-
39-
It has the advantages of:
40-
41-
- Built in feature of Windows 11
42-
- No Advertisements
43-
44-
Disadvantages include:
45-
46-
- Only works of Windows 11 PCs with an SSD (not a physical Hard Drive)
47-
- Not very user friendly installation (sideloading) of non-Amazon approved apps (i.e. the throttle apps)
48-
- Does *not* allow you to run multiple instances of same app at the same time
49-
50-
Follow the `instructions here <https://www.windowscentral.com/how-sideload-android-apps-using-wsa-windows-11>`_ |EXTERNAL-LINK| (or `a slightly differnt version of instructions here <https://www.xda-developers.com/how-to-sideload-android-apps-on-windows-11/>`_ |EXTERNAL-LINK|) to setup *Windows Subsystem for Android* to allow 'sideloading'.
51-
52-
You will also need to install the `SDK Platform Tools <https://developer.android.com/tools/releases/platform-tools>`_ |EXTERNAL-LINK|.
53-
54-
You will also need to get the appropriate .apk to install the throttle app you want. e.g. The Engine Driver .apk is available from the `Engine Driver site <https://enginedriver.mstevetodd.com/downloads>`_ |EXTERNAL-LINK|
55-
56-
|hr-dashed|
57-
58-
Refer to pages linked above for details but a summary of the process for installing with Windows Subsystem for Android is:
59-
60-
# Install *Windows Subsystem for Android*
61-
# Download the *SDK Platform Tools*
62-
63-
# Extract the files from the zip file and record the folder there are in |BR| e.g. C:\Users\your_username\Downloads\platform-tools\
64-
65-
# Download the APK you want to install
66-
67-
# Note the name of the file where you saved it |BR| e.g. ``C:\Users\your_username\Downloads\EngineDriver-2.36.177.apk``
68-
69-
# Start *Windows Subsystem for Android*
70-
71-
# Enable the Developer option
72-
73-
# click the overflow menu (the three bars) in the top left
74-
# Then ``Advanced settings``
75-
# Turn on ``Developer mode``
76-
# Note the ip address and port on the same row (normally 127.0.0.1:58526)
77-
78-
# Start a command prompt with Administrator privileges
79-
80-
# Click :guilabel:`Start`
81-
# Type in ``CMD`` or ``command``
82-
# Right click on ``Command Prompt`` from the found list and select ``Run as Administrator``
83-
# Click :guilabel:`Yes` when it asks
84-
85-
# Connect the PC to the Windows Subsystem for Android
86-
87-
# Enter the command |BR| ``<extracted_location>\adb connect <ip_address_&_port>`` |BR| where **<extracted_location>** is the folder you you extracted the *SDK Platform Tools* to above, and |BR| **<ip_address_&_port>** are the ip address and port that you recorded above |BR| e.g. ``C:\Users\your_username\Downloads\platform-tools\adb connect 127.0.0.1:58526``.
88-
# You should see a request to 'Allow ADB debugging'. Click :guilabel:`Allow`
89-
90-
# If you don't see the request. |BR| e.g. you see something like ``cannot connect to 127.0.0.1:58526: No connection could be made because the target machine actively refused it. (10061)``
91-
92-
# In the 'Windows Subsystem for Android' app (on the PC), click ``Turn Off``
93-
# Then open the 'Amazon Appstore' (that you should have installed as part of installing Windows Subsystem for Android). this will automatically restart the subsystem.
94-
# Enter the adb connect command again.
95-
96-
# Note: it is normal (not sure why) to see ``failed to authenticate to 127.0.0.1:58526``
97-
98-
# Install the sdk.
99-
100-
# enter the command |BR| ``<extracted_location>\adb install <apk_file_location>`` |BR| where **<extracted_location>** is the folder you you extracted the *SDK Platform Tools* to above, and |BR| **<apk_file_location>** is the floaction and name of the downlaoded apk above. |BR| e.g. ``C:\Users\your_username\Downloads\platform-tools\adb install C:\Users\your_username\Downloads\EngineDriver-2.36.177.apk``
101-
102-
# Close the command prompt windows
103-
104-
|hr-dashed|
105-
106-
To run the app once installed
107-
108-
# Click :guilabel:`Start`
109-
# Click :guilabel:`all Apps`
110-
# Scroll down to ``Engine Driver`` (or whatever app you installed) and click it.
111-
# First use only: When **Engine Driver** start the first time you will be asked a number of questions
112-
# When you get the "Connect" screen, **Engine Driver** cannot 'discover' the |EX-CS|, so you will need to enter the IP address and port, then click :guilabel:`Connect`

docs/throttles/software/dccex-cab.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. include:: /include/include.rst
2+
.. include:: /include/include-l2.rst
3+
.. include:: /include/include-throttles.rst
4+
**********
5+
DCC-EX CAB
6+
**********
7+
8+
|SUITABLE| |conductor| |tinkerer| |engineer| |support-button|
9+
10+
.. image:: /_static/images/throttles/icon_android.png
11+
:alt: Android Logo
12+
:scale: 30%
13+
:align: left
14+
15+
.. image:: /_static/images/throttles/icon_ios.png
16+
:alt: iOS Logo
17+
:scale: 30%
18+
:align: left
19+
20+
This is an Android and iOS App. One of the major benefits of DCC-EX CAB is that it speaks the |DCC-EX Native Commands| natively. This means it is fast and can take advantage of some features that exist in the |EX-CS| not implemented in other APIs.
21+
22+
You can find it in the Google Play Store: `DCC-EX CAB Android App <https://play.google.com/store/apps/details?id=com.gothicmaestro.dccexcab>`_ |EXTERNAL-LINK|
23+
24+
You can find it in the Apple App Store: `DCC-EX CAB iOS App <https://apps.apple.com/us/app/dcc-ex-cab/id6695754417?uo=2>`_ |EXTERNAL-LINK|
25+

docs/throttles/software/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Android (Phones and Tablets)
2323
- :doc:`Cab Engineer: DCC Throttle (Andriod) <cab-engineer>`
2424
- :doc:`DigiTrainsPro (Android, iOS, Windows) <digitrainspro>` *- Requires JMRI*
2525
- :doc:`RtDtive DCC++ (Android) <rtdrive-dccpp>`
26+
- :doc:`DCC-EX CAB (iOS and Android) <dccex-cab>`
2627

2728
Apple iOS (Phones and Tablets)
2829
------------------------------
@@ -34,6 +35,7 @@ Apple iOS (Phones and Tablets)
3435
- :doc:`Train Driver (iOS) <train-driver>`
3536
- :doc:`Train Throttle (iOS) <train-throttle>`
3637
- :doc:`TrainNavigator (iOS) <trainnavigator>`
38+
- :doc:`DCC-EX CAB (iOS and Android) <dccex-cab>`
3739
- :doc:`WiThrottle (iOS)<withrottle>`
3840

3941
Personal Computers
@@ -57,6 +59,7 @@ Note: The Android throttle apps listed above can be made to made to run on Windo
5759
jmri
5860
Cab Engineer: DCC Throttle (Android) <cab-engineer>
5961
DCCpp CAB (android) <dccpp-cab>
62+
DCC-EX CAB (Android and iOS) <dccex-cab>
6063
DCC++ Throttle (android) <dccpp-throttle>
6164
DigiTrainsPro (Android, iOS, Windows) <digitrainspro>
6265
Locontrol (iOS) <locontrol>

docs/throttles/throttle_table.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,20 @@
235235
-
236236
-
237237

238+
* - :doc:`DCC-EX CAB <software/dccex-cab>`
239+
- Paid
240+
- WiFi
241+
- Native
242+
- App
243+
-
244+
-
245+
- X
246+
- X
247+
-
248+
-
249+
-
250+
- X
251+
238252
* - :doc:`DccExController <hardware/dccexcontroller>`
239253
- Free
240254
- WiFi

0 commit comments

Comments
 (0)