Skip to content

Commit 451f8ff

Browse files
authored
Merge pull request #1230 from flash62au/sphinx
odds and ends
2 parents 1940127 + 66f85fe commit 451f8ff

8 files changed

Lines changed: 35 additions & 27 deletions

File tree

1.71 MB
Loading
280 KB
Loading

docs/reference/glossary.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Glossary
2828
* - Consist |BR| Multiple Unit
2929
- Multiple locos hauling a singe train. see https://dccwiki.com/Multiple_Unit_Consisting |EXTERNAL-LINK|
3030
* - Cab
31-
- A Cab can refer to a throttle (or controller) as well as a loco or locomotive |BR| In the context of DCC-EX commands, `cab` refers to a loco
31+
- A Cab can refer to a throttle (or controller) as well as a loco or locomotive |BR| In the context of DCC-EX commands, `cab` refers to a loco's/Decoder's DCC Address
3232
* - DC
3333
- Direct Current
3434
* - DCC
@@ -47,10 +47,12 @@ Glossary
4747
- Native protocol used by the |EX-CS| in preference to the WitThrottle protocol. This is the preferred protocol for communication with the Command Station as it is considerably more powerful and comprehensive. This was originally developed for the now defunct DCC++ project, hence it is still referred to in JMRI as 'DCC++', but have been considerably enhanced since then.
4848
* - Station (STA) Mode
4949
- Station Mode allows you to connect the Command Station to your existing home network. |BR| The Command Station becomes a Station or Client rather than an Access Point. |BR| That means instead of being a host that manages the IP of the smartphone that runs your Throttle, it becomes a station that connects to your existing network just like any of the other computers or devices connected to your network. The Throttle then connects to the Command Station by finding its IP address on the network. |BR| :doc:`Refer here for more information. </ex-commandstation/advanced-setup/supported-wifi/wifi-config>`
50-
* - Switching |BR| Shunting
50+
* - Switching [1]_ |BR| Shunting [2]_
5151
- The process of moving individual carriages to/from specific locations on yards or sidings.
52-
* - Turnouts |BR| Points
52+
* - Turnouts [1]_ |BR| Points [2]_
5353
- A mechanical device to guide a train from one track to another
54+
* - Switch [1]_
55+
- A switch is another term for a turnout, but may also refer to a physical electronic switch (as in a light switch).
5456
* - USB
5557
- Universal Serial Bus
5658
* - Visual Studio Code (VSC)
@@ -60,5 +62,11 @@ Glossary
6062
* - WiThrottle Protocol
6163
- A proprietary protocol developed by Brett Hoffman
6264
* - WiThrottle Server
63-
- A piece of software that listens and acts on WiThrottle commands |BR| |EX-CS| contains a WiThrottle Server, as does |JMRi|
65+
- A piece of software that listens and acts on WiThrottle commands |BR| |EX-CS| contains a WiThrottle Server, as does |JMRI|
66+
* - roster
67+
-
68+
* - VPIN
69+
- A VPIN is an Arduino pin number that has been extended to include pins on external devices or expanders. Once the mapping of VPIN numbers to devices has been done, the commands that set or test pins do not have to care how the electronics works.
6470

71+
.. [1] Term primariarly used in North American railroading.
72+
.. [2] Term used in most of the rest of the English speaking world. (British origin)

docs/throttles/hardware/ex-t3-wifi.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ EX-T3-WiFi (T3 = Tactile Touch Throttle)
77

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

10+
WiFi throttle for DCC-EX Command Stations
11+
1012
see: https://github.com/DCC-EX/EX-T3-WiFi?tab=readme-ov-file

docs/throttles/hardware/lodi-con-wifi-throttle.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,18 @@ LoDi-Con WiFi Throttle
77

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

10-
see: https://lokstoredigital.jimdoweb.com/lodi-con/
10+
see: https://lokstoredigital.jimdoweb.com/lodi-con/
11+
12+
The LoDi-Con's operating concept is kept simple. We tried to include as little as possible, but as much as necessary, on the device. This resulted in the LoDi-OS.
13+
14+
The LoDi-Con itself is equipped with a high-quality capacitive touchscreen.
15+
16+
Clear menu structures and ease of use were among our goals. The touchscreen is complemented by a very user-friendly rotary control that even uses LED feedback to indicate different actions. For example, the current speed setting is also displayed via the LEDs in the rotary control.
17+
18+
.. figure:: /_static/images/throttles/lodi-con.png
19+
:alt: LoDi-Con WiFi Throttle
20+
:scale: 50%
21+
:align: left
22+
23+
LoDi-Con WiFi Throttle
24+

docs/throttles/hardware/minithrottle.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,6 @@ miniThrottle (Physical)
77

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

10-
.. sidebar::
11-
:class: sidebar-on-this-page
12-
13-
.. contents:: On this page
14-
:depth: 3
15-
:local:
16-
1710
A |EX-CS| and |JMRI| Throttle
1811

1912

docs/throttles/hardware/mybluepillthrottle.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,6 @@ myBluePillThrottle (Physical)
77

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

10-
.. sidebar::
11-
:class: sidebar-on-this-page
12-
13-
.. contents:: On this page
14-
:depth: 2
15-
:local:
16-
1710
A simple DCC-EX tethered throttle using STM32 Blue Pill, 5x4 keypad, and SSD1306 I2C OLED display. It is primarily for operating one loco at a time and does not include consisting or other advanced features.
1811

1912
https://github.com/n1ksn/dcc-ex-bluepill-throttle-7 |EXTERNAL-LINK|

docs/throttles/hardware/simple-throttle.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,18 @@ DCC-EX Simple Throttle (Physical)
77

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

10-
.. sidebar::
11-
:class: sidebar-on-this-page
12-
13-
.. contents:: On this page
14-
:depth: 3
15-
:local:
16-
17-
To accompany my mimic panel's serial throttle (see DCC-EX Tri-Throttle), I decided a very simple WiFi enabled, palm-sized throttle I could walk around the layout with would be a very handy addition, hence the creation of this DCC-EX Simple Throttle.
10+
To accompany my mimic panel's serial throttle (see `DCC-EX Tri-Throttle <https://petegsx-projects.github.io/tri-throttle/index.html>`_ |EXTERNAL-LINK| ), I decided a very simple WiFi enabled, palm-sized throttle I could walk around the layout with would be a very handy addition, hence the creation of this DCC-EX Simple Throttle.
1811

1912
PeteGSX
2013

2114
Note that there is an option to run this on an STM32F103C8 Bluepill via a serial connection instead.
2215

2316
https://petegsx-projects.github.io/simple-throttle/index.html
2417

18+
.. figure:: /_static/images/throttles/dccex-simple-throttle.png
19+
:alt: DCC-EX Simple Throttle
20+
:scale: 25%
21+
:align: left
2522

23+
DCC-EX Simple Throttle
2624

0 commit comments

Comments
 (0)