Serge NOEL
172 lines
7.4 KiB
Plaintext
172 lines
7.4 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<title>JMRI: Transit Add/Edit Actions</title>
|
|
<meta name="author" content="Bob Jacobsen">
|
|
<meta name="keywords" content="JMRI help Dispatcher Transit Special Actions">
|
|
<!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<div id="mainContent" class="no-sidebar">
|
|
<h1>Transit: Add/Edit Action</h1>
|
|
|
|
<h2>The Add/Edit Action Window</h2>
|
|
|
|
<p>Special <strong><a href="ViewSpecialActions.shtml">Actions</a></strong> are tasks that can
|
|
be initiated automatically as a Dispatcher Train running in automatic mode traverses the
|
|
layout.<br>
|
|
The Add Action pane provides for creating new Actions:</p>
|
|
<img src="images/AddEditAction.png" width="322" height="247" alt="add transit action">
|
|
<p>The "Edit" version of this window is the same as the one shown above, except the
|
|
<strong>Create New Action</strong> button is replaced by an <strong>Update Action</strong>
|
|
button and the selections and data are filled in to current values of the Action being
|
|
edited.</p>
|
|
|
|
<p>An Action is defined in two steps:</p>
|
|
|
|
<ol>
|
|
<li>specifying <strong>When</strong> an action should be initiated</li>
|
|
|
|
<li>specifying <strong>What</strong> action is to be executed</li>
|
|
</ol>
|
|
|
|
<h3 id="when">When to act</h3>
|
|
|
|
<p>To specify the <strong>When</strong> part, select an option in the <strong>When</strong>
|
|
popup menu, and fill in any data that might be required. Data item fields or menus will
|
|
appear when the item needing them is selected. Each data item is supplied with a text
|
|
description (tooltip) that may be summoned by hovering the cursor over the item. Each
|
|
<strong>When</strong> option is described in more detail in the <strong><a href=
|
|
"ViewSpecialActions.shtml#when">Actions</a></strong> Help.</p>
|
|
|
|
<p>Optionally a Delay, specified in milliseconds, can be set with each <strong>When</strong>
|
|
option. The default Delay of 0 causes the Action to be be initiated immediately after the
|
|
<em>when</em> event occurs. If a Delay time greater that 0 is specified, Dispatcher will wait
|
|
for the specified time after the <em>when</em> event occurs before initiating the Action.</p>
|
|
|
|
<p>To specify <strong>What</strong> action is requested, select an option in the
|
|
<strong>What:</strong> popup menu, and fill in any data that might be required. Entry fields
|
|
will appear when the item needing them is selected. Each data item is supplied with a text
|
|
description (tooltip) that may be summoned by hovering the cursor over the item.<br>
|
|
From the drop down box choose one of:</p>
|
|
|
|
<ul>
|
|
<li><strong>On Section Entry</strong> - When the automatic train enters the current Section
|
|
(see above image).</li>
|
|
|
|
<li><strong>On Section Exit</strong> - When the automatic train exits the current Section.
|
|
This means when the last detectable car leaves the Section, and the Section is
|
|
unoccupied.</li>
|
|
|
|
<li><strong>On Block Entry</strong> - When the automatic train enters a specified Block in
|
|
the Section. For Sections with only one Block, this is equivalent to <strong>On Section
|
|
Entry</strong>.<br>
|
|
<img src="images/AddEditWhenBlock.png" height="110" width="461" alt=
|
|
"add transit action"></li>
|
|
|
|
<li><strong>On Block Exit</strong> - When the automatic train exits a specified Block in
|
|
the Section. This means when the last detectable car leaves the specified Block, and the
|
|
Block is unoccupied. For Sections with only one Block, this is equivalent to <strong>On
|
|
Section Exit</strong>.</li>
|
|
|
|
<li><strong>On Train Stop</strong> - When the automatic train stops. This may be used, for
|
|
example, for stopping the bell in a sound decoder or initiating other actions when the
|
|
train stops at a station.<br>
|
|
<img src="images/AddEditWhenStop.png" height="116" width="460" alt=
|
|
"add transit action"></li>
|
|
|
|
<li><strong>On Train Start</strong> - When the automatic trains starts up after having been
|
|
stopped. This may be used, for example, to initiate actions when a train starts up after a
|
|
station stop.</li>
|
|
|
|
<li><strong>On Sensor ACTIVE</strong> - When the specified Sensor moves to the Active
|
|
state. The specified Sensor may be either internal or hardware, and must be in the Sensor
|
|
Table. This might be used, for example, with a hardware Sensor connected to a fascia push
|
|
button to trigger an action. It could also be used to trigger actions using hardware
|
|
position sensors on the layout. With internal sensors it can provide a link to Logix.<br>
|
|
<img src="images/AddEditWhenSensor.png" height="117" width="461" alt=
|
|
"add transit action"></li>
|
|
|
|
<li><strong>On Sensor INACTIVE</strong> - When the specified Sensor moves to the Inactive
|
|
state. This is the same as above, but with the opposite Sensor state. Use the one that best
|
|
fits your hardware or Logix.</li>
|
|
</ul>
|
|
|
|
<h3>What to do</h3>
|
|
|
|
<p>After making a <strong>When</strong> choice, continue by choosing one of the following
|
|
<strong><a href="ViewSpecialActions.shtml#what">What</a></strong> actions and fill in the
|
|
settings:</p>
|
|
|
|
<ul>
|
|
<li><strong>Pause Train</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Maximum Speed</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Train Speed</strong>
|
|
</li>
|
|
|
|
<li><strong>Ramp Train Speed</strong>
|
|
</li>
|
|
|
|
<li><strong>Go to Manual Mode</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Locomotive Light</strong>
|
|
</li>
|
|
|
|
<li><strong>Start Bell</strong>
|
|
</li>
|
|
|
|
<li><strong>Stop Bell</strong>
|
|
</li>
|
|
|
|
<li><strong>Sound Horn</strong>
|
|
</li>
|
|
|
|
<li><strong>Pattern Sound Horn</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Decoder Function</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Sensor ACTIVE</strong>
|
|
</li>
|
|
|
|
<li><strong>Set Sensor INACTIVE</strong>
|
|
</li>
|
|
|
|
<li><strong>Hold Signal</strong>
|
|
</li>
|
|
|
|
<li><strong>Release Signal</strong>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>When the Action is completely defined, click the <strong>Create New Action</strong> button
|
|
(or the <strong>Update Action</strong> button if editing). Any required data will be
|
|
validated. If a problem is found, a message will appear, and the Add/Edit Action window will
|
|
remain to allow correction of the problem. If everything checks out, the Add/Edit Action
|
|
window will disappear and the new (or edited) Action will appear in the <strong>View
|
|
Actions</strong> window.</p>
|
|
|
|
<p>Click the <strong>Cancel</strong> button to dismiss the Add/Edit Action window without
|
|
creating a new Action or completing the edit of an existing Action. Closing the Add/Edit
|
|
Action window is equivalent to clicking the <strong>Cancel</strong> button.</p>
|
|
|
|
<p>Back to the <a href="ViewSpecialActions.shtml">Special Actions help</a>.</p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|