You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* :ref:`automation/EX-RAIL-intro:Tips and Techniques`
25
-
* :ref:`automation/EX-RAIL-intro:Why Can't I Put a Script on an SDCard?`
9
+
.. sidebar:: On this page
26
10
11
+
.. contents::
12
+
:depth: 1
13
+
:local:
27
14
28
15
Introduction
29
16
==============
@@ -41,6 +28,16 @@ To begin, let's define a few terms:
41
28
42
29
Most people wanting to do animations or run trains through an automated route will use a SEQUENCE, but those with :doc:`throttles </throttles/index>` that support it (:doc:`/throttles/engine-driver`, :doc:`WebThrottle-EX </throttles/ex-webthrottle>`) can add routes and automations. Both of these terms are just tags that let throttles with this feature automatically assign sequences to control buttons. "Routes" go into route buttons and can set turnouts, signals, etc., so you can drive your train along that route. "Automations" can appear on a "handoff" button that will supply or handoff the Loco ID to EX-RAIL where it can take over and run the train autonomously. An automation example would be manually driving a train into a station and pressing the assigned handoff button in the throttle that runs an AUTOMATION to take it on a journey around the layout.
43
30
31
+
Things You Can Do With EX-RAIL
32
+
====================================
33
+
34
+
- Create "Routes" which set multiple turnouts and signals at the press of a button in WebThrottle-EX or EngineDriver (other WiThrottle-compatible throttles are available)
35
+
- Automatically drive multiple trains simultaneously, and manage complex interactions such as single line working and crossovers by setting up "Automations"
36
+
- Drive trains manually, and hand a train over to an Automation
37
+
- Animate accessories such as lights, crossings, or cranes
38
+
- Intercept turnout changes to automatically adjust signals or other turnouts
39
+
- Turn on the coffee pot when the train reaches the station
40
+
44
41
.. sidebar:: A note from the Author
45
42
46
43
My original aim was to see if I could create an automated layout with lots going on, that didn’t just run around in circles. Having looked at JMRI (briefly, I must say) and DCC++, I began to wonder whether I could actually make a simpler automation system, and run it entirely on the Arduino used for DCC++.
@@ -55,18 +52,6 @@ Most people wanting to do animations or run trains through an automated route wi
55
52
56
53
- Chris Harlow
57
54
58
-
59
-
60
-
Things You Can Do With EX-RAIL
61
-
====================================
62
-
63
-
- Create "Routes" which set multiple turnouts and signals at the press of a button in WebThrottle-EX or EngineDriver (other WiThrottle-compatible throttles are available)
64
-
- Automatically drive multiple trains simultaneously, and manage complex interactions such as single line working and crossovers by setting up "Automations"
65
-
- Drive trains manually, and hand a train over to an Automation
66
-
- Animate accessories such as lights, crossings, or cranes
67
-
- Intercept turnout changes to automatically adjust signals or other turnouts
68
-
- Turn on the coffee pot when the train reaches the station
- Wait until sensor is active/triggered, use negative values for active HIGH sensors
227
227
* - ATTIMEOUT( sensor_id, timeout_ms )
228
-
- Wait until sensor is active/triggered, or if the timer runs out, then continue and set a testable "timed out" flag
228
+
- Wait until sensor is active/triggered, or if the timer runs out, then continue and set a testable "timed out" flag, use negative values for active HIGH sensors
229
229
* - ATGTE( analogpin, value)
230
230
- waits for analog pin to reach value
231
231
* - ATLT (analogpin,value)
232
232
- waits for analog pin to go below value
233
233
* - AFTER( sensor_id )
234
-
- Waits for sensor to trigger and then go off for 0.5 seconds
234
+
- Waits for sensor to trigger and then go off for 0.5 seconds, use negative values for active HIGH sensors
Copy file name to clipboardExpand all lines: docs/turntable-ex/get-started.rst
+16-10Lines changed: 16 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,12 @@ Getting started
6
6
:alt:Conductor Level
7
7
:scale:50%
8
8
9
+
.. sidebar:: On this page
10
+
11
+
.. contents::
12
+
:depth: 2
13
+
:local:
14
+
9
15
Assembly
10
16
=========
11
17
@@ -99,7 +105,7 @@ Summary table of all connections required during assembly:
99
105
Of course for the Tinkerers and Engineers, if you're not using a Nano or a prototyping shield, adapt the details as suits your configuration.
100
106
101
107
1. BEFORE you start
102
-
^^^^^^^^^^^^^^^^^^^^
108
+
____________________
103
109
104
110
Gather all your components and visually check them all for any obvious damage, paying particular attention to pins on the Arduino to make sure they are straight.
105
111
@@ -112,7 +118,7 @@ Gather all your components and visually check them all for any obvious damage, p
112
118
:scale:50%
113
119
114
120
2. Insert the Nano into the shield
115
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
121
+
___________________________________
116
122
117
123
Insert the Nano into the prototype shield socket, taking care to ensure the USB socket is located at the same end as the DC power jack, and that all pins are straight and aligned correctly with the female headers.
118
124
@@ -135,7 +141,7 @@ With the shield used in these assembly photos, you will note that each of the Na
135
141
:scale:50%
136
142
137
143
3. Connect the stepper controller and motor
138
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
144
+
____________________________________________
139
145
140
146
Firstly, note that the ULN2003 controller will have four pins marked "IN1" through "IN4", as well as a pair of pins with "+" and "-". There is a likely a jumper installed across two pins beside these that is unmarked, leave this in place.
141
147
@@ -180,7 +186,7 @@ Insert the stepper motor connector into the recepticle on the ULN2003 controller
180
186
:scale:50%
181
187
182
188
4. Connect the hall effect sensor
183
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
189
+
__________________________________
184
190
185
191
The hall effect sensor has three pins, and likely only two of these pins are marked, the left with "-" and right with "S". The middle pin is likely to be unmarked, and will be the 5V pin. There are probably many different varieties of sensors and designs out there, but both that I have (from different suppliers) are marked identically.
186
192
@@ -209,7 +215,7 @@ Use three of the Dupont wires and connect these from the hall effect sensor to t
209
215
:scale:50%
210
216
211
217
5. Connect the dual relay board
212
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
218
+
________________________________
213
219
214
220
Note there should be six pins on the dual relay board marked "VCC", "GND", "IN1", "IN2", "COM", and "GND". The "COM" and "GND" pins should have a jumper installed to connect these together. Leave this in place.
215
221
@@ -240,7 +246,7 @@ Use four Dupont wires to connect the other four pins as below:
240
246
:scale:50%
241
247
242
248
6. Connect power and test
243
-
^^^^^^^^^^^^^^^^^^^^^^^^^^
249
+
__________________________
244
250
245
251
At this point, it should be safe to plug in the power supply to the DC power jack on the prototyping shield.
246
252
@@ -261,7 +267,7 @@ To validate the hall effect sensor is connected correctly, put a magnet in close
261
267
:scale:50%
262
268
263
269
7. Load the Turntable-EX software
264
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
270
+
__________________________________
265
271
266
272
.. tip::
267
273
@@ -288,7 +294,7 @@ If you don't have the magnet installed at this point, or if it is too far from t
288
294
If your testing of the hall effect sensor in step 6 above succeeded, then the issue is likely to be the distance the magnet is from the sensor, and this will require adjustment. See :ref:`turntable-ex/troubleshooting:troubleshooting turntable-ex` for further assistance if required.
289
295
290
296
Automatic calibration
291
-
""""""""""""""""""""""
297
+
^^^^^^^^^^^^^^^^^^^^^^
292
298
293
299
.. note::
294
300
@@ -316,7 +322,7 @@ At this point, the full turn step count is written to the Arduino's EEPROM so th
316
322
You can now safely power off Turntable-EX and remove the USB cable from your PC as it is no longer required for normal operation, and all further commands will be issued by the CommandStation.
317
323
318
324
8. Add the Turntable-EX device driver to CommandStation-EX
Copy file name to clipboardExpand all lines: docs/turntable-ex/turntable-ex.rst
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,33 @@ Overview
6
6
:alt:Conductor Level
7
7
:scale:50%
8
8
9
+
.. sidebar:: On this page
10
+
11
+
.. contents::
12
+
:depth: 2
13
+
:local:
14
+
9
15
What is Turntable-EX?
10
16
======================
11
17
12
-
.. note::
18
+
Turntable-EX is a fully integrated turntable controller, using an additional Arduino microcontroller to drive a stepper driver to rotate a turntable and align the bridge track with the surrounding layout tracks. An Arduino Nano or Uno are suitable microcontrollers for Turntable-EX.
19
+
20
+
The aim is to keep things as simple as possible, and to maintain alignment with the categories of our users as defined in our :ref:`get-started/levels:choose your level` guide for CommandStation-EX (Conductor, Tinkerer, and Engineer).
21
+
22
+
The out-of-the-box example configuration should allow a Conductor level user to get up and running relatively quickly using the ubiquitous ULN2003/28BYJ-48 stepper driver and motor combination that are readily available.
23
+
24
+
To make full use of Turntable-EX, you will need a basic understanding of :ref:`EX-RAIL<automation/ex-rail-intro:introduction to ex-rail automation>` automation, but we'll share the details and some examples to help with this.
25
+
26
+
Essentially, if you have setup your own CommandStation, the expectation is that Turntable-EX will be a natural extension of this, and be equally as easy to setup (at least from the electronics and software perspective).
27
+
28
+
.. note::
13
29
14
30
Turntable-EX is in public Beta testing, and as such, we encourage regular feedback on the success or otherwise of both the software and documentation. Please reach out via any of our support methods and help us get Turntable-EX as easy to use and reliable as possible.
15
31
16
32
For a current overview of all outstanding feature requests or enhancements and known bugs to be fixed, visit the Turntable-EX view of the `DCC++ EX GitHub project <https://github.com/orgs/DCC-EX/projects/7/views/1>`_.
17
33
18
34
For those who wish to help us with Beta testing, you're encouraged to follow the testing processes outlined in the `Regression Testing process <https://github.com/DCC-EX/Support-Planning/blob/master/Testing/Turntable-EX/TTEX_Regression_Testing.md>`_, and then submit your test results using the `Beta Test Results <https://github.com/DCC-EX/Turntable-EX/issues/new/choose>`_ issue template.
19
35
20
-
Turntable-EX is a fully integrated turntable controller, using an additional Arduino microcontroller to drive a stepper driver to rotate a turntable and align the bridge track with the surrounding layout tracks. An Arduino Nano or Uno are suitable microcontrollers for Turntable-EX.
21
-
22
-
The aim is to keep things as simple as possible, and to maintain alignment with the categories of our users as defined in our :ref:`get-started/levels:choose your level` guide for CommandStation-EX (Conductor, Tinkerer, and Engineer).
23
-
24
-
The out-of-the-box example configuration should allow a Conductor level user to get up and running relatively quickly using the ubiquitous ULN2003/28BYJ-48 stepper driver and motor combination that are readily available.
25
-
26
36
.. sidebar:: Supported stepper drivers and motors
27
37
28
38
.. image:: ../_static/images/conductor.png
@@ -37,10 +47,6 @@ The out-of-the-box example configuration should allow a Conductor level user to
37
47
38
48
Using other pre-defined, supported stepper drivers and motors should also be achievable at the Conductor level, but may enter into Tinkerer territory depending on the specific hardware.
39
49
40
-
To make full use of Turntable-EX, you will need a basic understanding of :ref:`EX-RAIL<automation/ex-rail-intro:introduction to ex-rail automation>` automation, but we'll share the details and some examples to help with this.
41
-
42
-
Essentially, if you have setup your own CommandStation, the expectation is that Turntable-EX will be a natural extension of this, and be equally as easy to setup (at least from the electronics and software perspective).
0 commit comments