Files
JIMRI/help/en/html/tools/throttle/ThrottleChapter2.shtml
2026-06-17 14:00:51 +02:00

667 lines
30 KiB
Plaintext

<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>Throttle: Open/Configure a Throttle Window</title>
<meta name="keywords" content="JMRI decoderpro dcc nmra throttlepro">
<meta name="Description" content="Throttle documentation for JMRI project">
<meta name="Author" content="Paul Fraker (paul@frakers.com)">
<meta name="Language" content="EN"><!--#include virtual="/help/en/parts/Style.shtml" -->
<style>
.ctr {
text-align: center;
}
</style>
</head>
<body>
<!--#include virtual="/help/en/parts/Header.shtml" -->
<div id="mBody">
<!--#include virtual="Sidebar.shtml" -->
<div id="mainContent">
<h1>Current Throttle documentation</h1>
<p>Please note that the Throttles Help was updated. Current version:</p>
<ul>
<li>The <a href="ToolsMenuThrottleEntry.shtml">Throttle menu in JMRI</a>
</li>
<li>The <a href="BasicThrottleWindow.shtml">Throttle Window itself</a>
</li>
<li>The <a href="ThrottleWindowMenus.shtml">Throttle Window menus</a>
</li>
<li>The <a href="ThrottleToolBar.shtml">Throttle Window toolbar</a>
</li>
<li>The <a href="AdvancedThrottleControl.shtml">Throttle Window controls</a>
</li>
<li>The <a href="ThrottlesListWindow.shtml">Throttles List Window</a>
</li>
<li>The <a href="ThrottlesPreferencesPane.shtml">Throttles preferences pane</a>
</li>
</ul>
<hr>
<h1>Throttles in JMRI v2.x</h1>
<h2>Open a New Throttle Window</h2>
<p>This chapter will walk you through the process of opening up a new throttle window and
then configuring it to run a locomotive on your layout. For the purposes of this user guide,
we will be using a locomotive that has been equipped with a sound decoder. The decoder's
address in our examples here is <strong>8251</strong>. If you are following along with a
locomotive of your own while you read this, simply replace your loco's decoder address
anywhere that "8251" is shown.</p>
<p>So let's get started.</p>
<table border="0" style="width: 100%">
<tr>
<td style="text-align: center">
<p style="text-align: center; font-size: xx-small"><img width="163" height="82" src=
"images/jmri004.jpg" title="New Throttle" alt="menu"><br>
Figure 2-1: New Throttle Menu Option</p>
</td>
<td><img width="10" height="20" src="images/spacer.gif" alt="spacer">
</td>
<td>
<p>The first thing that we want to do is to open up a throttle window. As outlined in
the <a href="ThrottleChapter1.shtml" title="Go back to review Chapter 1">previous
chapter</a>, this is accomplished by selecting the following menu options from the
primary main window:</p>
<ul style="list-style-type: square">
<li><strong>Tools</strong>
</li>
<li><strong>Throttles</strong>
</li>
<li><strong>New Throttle</strong>
</li>
</ul>
</td>
</tr>
</table>
<br>
<br>
<h3 id="StructWin">Structure of a Throttle Window</h3>
<div style="margin-left: 2em">
<p>There are <em>three panels</em> (or sub-windows) associated with each Throttle window.
These are identified as:</p>
</div>
<ul>
<li><strong>Control Panel</strong> contains a throttle slider to control the speed of the
loco, a forward and reverse selector, an Emergency Stop action button, and an Idle action
button (mostly used for sound equipped decoders).<br>
<br></li>
<li><strong>Function Panel</strong> is used to associate the function buttons with the
active output functions of the decoder.<br>
<br></li>
<li><strong>Address Panel</strong> is used to identify the decoder's address, and to
dispatch or release the identified address.<br>
<br></li>
</ul>
<p class="important"><strong>Important!</strong> These three panels are actually windows
defined within an overall window. Please note that each of these panels contain their own
"minimize" and "close" buttons - as well as can also be resized. You can actually minimize
one or more of these panels within the Throttle window. This is being pointed out in event
that you accidentally click on one of the buttons and the panel disappears on you.</p>
<p style="text-align: center; font-size: xx-small"><img width="323" height="464" src=
"images/jmri011.jpg" title="JMRI Throttle New Default Window" alt=
"default throttle window"><br>
Figure 2-2: New Throttle Window</p>
<h2 id="WinConfig">Configure The New Throttle</h2>
<p>Now that we have successfully opened up the throttle window, the next thing we need to do
is to configure the throttle for operation. We'll do this in two steps. The first will be to
assign a locomotive's decoder address. Please note in Figure 2-2 above that all of the panels
are pretty much disabled. This is because there is no address assigned yet. After
establishing an address, the other options on the panels will become enabled.</p>
<h3 id="AddressPanel">Assign a Decoder Address to a Throttle</h3>
<div style="margin-left: 2em">
<table border="0" style="width: 100%">
<tbody>
<tr>
<td>
<p>The first thing that needs to happen before any options or buttons in the window
become active, is to assign a decoder's address in the "<strong>Address
Panel</strong>". There are two ways that this can be accomplished.</p>
<ol>
<li>Manually enter the decoder's address in the large text box, then click on the
"<strong>Set</strong>" button.<br>
<div style="margin-left: 2em">
<p class="important"><strong>Important!</strong> When manually entering an
address, be sure to click on the <strong>Set</strong> button. Without this
step, all throttle actions remain disabled.</p>
</div>
</li>
<li>Or, use the drop down list to select from the roster list (as shown in the
figure on the right).<br>
Please note that when you select a loco from this list, it simply reads the
decoders address from the roster file - it currently does <u>not</u> cross
reference this to any saved throttle layout files.</li>
</ol>
</td>
<td><img width="20" height="40" src="images/spacer.gif" alt="spacer">
</td>
<td style="text-align: center">
<p style="text-align: center; font-size: xx-small"><img width="207" height="228"
src="images/jmri015.jpg" title="Address Selection" alt="address selection"><br>
Figure 2-3: Address Selection</p>
</td>
</tr>
<tr>
<td colspan="3"><img width="40" height="40" src="images/spacer.gif" alt="spacer">
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<div style="margin-left: 2em">
<p>After an address is selected, all other controls and options in the throttle
window will become enabled. Two other option buttons also become active in the
"<strong>Address Panel</strong>". These are described as...</p>
</div>
<ul>
<li><strong>Dispatch</strong> releases the decoder address back to the command
station in a "dispatch" mode. Usually, only one address can be in dispatch state
at the command station - all others are either "in use" or "idle" (released). The
controls and options in the throttle window will become disabled until another
address is "<strong>Set</strong>".</li>
<li><strong>Release</strong> releases the decoder address back to the command
station as "no longer needed". The controls and options in the throttle window
will become disabled until another address is "<strong>Set</strong>".</li>
</ul>
</td>
<td>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<table>
<tbody>
<tr>
<td><img width="20" height="40" src="images/spacer.gif" alt="spacer">
</td>
<td style="text-align: center">
<p style="text-align: center; font-size: xx-small"><img width="199" height="129" src=
"images/jmri032.jpg" title="Example of Address Panel option buttons" alt=
"address panel"><br>
Figure 2-4: Address Panel<br>
(with an active address)</p>
</td>
</tr>
</tbody>
</table>
<h2 id="ControlPanel">Control Panel - Let's Run a Train</h2>
<div style="margin-left: 2em">
<table border="0" style="width: 100%">
<tbody>
<tr>
<td>
<p>Now that you have established an address for the throttle, you should be able to
run the train on your layout (if your layout is active and the address you entered
is valid to a locomotive on the track). You do this using the "<strong>Control
Panel</strong>" (see Figure 2-5). But here is where things get a little sticky.</p>
<p>There are multiple combinations of DCC systems and computer platforms that make
up for slight differences in the functionality of the throttles. The programmers
are working hard at trying to get these throttles to function identically. But
because of these differences, you may discover that not everything noted in the
following text will function as defined for your system.</p>
<p class="important"><strong>Important!</strong> The "Control Panel" must have the
"focus" for it to become active (and usable). In other words, it's window bar must
be active. If you are following along with this text with your own locomotive and
just entered an address in the Address Panel, you will discover that the Address
Panel is the window with the current focus. None of the keyboard or mouse actions
described below will move the train until the Control Panel has the focus. To make
the Control Panel the active window, use your mouse pointer to click somewhere
within the Control Panel.</p>
</td>
<td><img width="20" height="40" src="images/spacer.gif" alt="spacer">
</td>
<td style="text-align: center">
<p style="text-align: center; font-size: xx-small"><img width="99" height="330"
src="images/jmri033.jpg" title="Example of the Control Panel" alt=
"control panel"><br>
Figure 2-5: Control Panel</p>
</td>
</tr>
</tbody>
</table>
<br>
<table style="width: 100%; border: 2px solid;">
<tbody>
<tr>
<td>
<p style="color: #FF0000; font-size: medium; font-weight: bold">Beware of where you
click with your mouse pointer in the Control Panel.</p>
<ul>
<li><strong>If you click anywhere near the slider, your loco may take off on you
unexpectedly (more on this below).</strong>
</li>
<li><strong>If you click anywhere on the words "Forward" or "Reverse", you will
activate that action - which isn't too bad - except if the loco is running in the
opposite direction from what action you clicked on.</strong>
</li>
<li><strong>Depending on your screen resolution size, if you attempt to click on
the window bar itself, you may accidentally close down the Control Panel window
or minimize it. This could of course immediately confuse any new user.</strong>
</li>
</ul>
<p>So when first clicking in the Control Panel to make it the "active" window with
the focus, and you know that your loco is stopped, it is suggested to click on the
"Idle" button (if you know for fact that your loco is stopped), or the forward or
reverse area (depending of course on the current direction of the loco). In other
words, you want to click somewhere within the border of the Control Panel window,
yet not cause your loco to do something that you don't want it to do.</p>
<p>After a little experimentation, you will discover what is comfortable for your
usage. The only point we are trying to make here is that many new users immediately
get frustrated with the throttles because they can't get their loco to move, not
realizing that the Control Panel does not have the focus. Or they have clicked on a
function button (more on these below), which then changes the "active" window to
the Function Panel.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h3 id="StandardActions">Keyboard Throttle Control</h3>
<div style="margin-left: 4em">
<p>There is a group of keyboard action keys that have been defined as
"<strong>standard</strong>" across all DCC systems and computer platforms. They are
identified in the following table:</p>
<table>
<tbody>
<tr class="ctr">
<td>KEY*</td>
<td>ACTION</td>
</tr>
<tr>
<td class="ctr"><strong>+</strong>
</td>
<td>Increase speed by 1 step of each press of the key</td>
</tr>
<tr>
<td class="ctr"><strong>-</strong>
</td>
<td>Decrease speed by 1 step of each press of the key</td>
</tr>
<tr>
<td class="ctr"><strong>*</strong>
</td>
<td>Idle (set speed to 0, any speed momentum is enabled)</td>
</tr>
<tr>
<td class="ctr"><strong>/</strong>
</td>
<td>Emergency Stop! (instantly halts the locomotive)</td>
</tr>
<tr>
<td class="ctr"><strong>Up arrow</strong>
</td>
<td>Forward direction</td>
</tr>
<tr>
<td class="ctr"><strong>Down arrow</strong>
</td>
<td>Reverse direction</td>
</tr>
<tr>
<td class="ctr"><strong>Left arrow</strong>
</td>
<td>Increases speed by 1 step for each press of the key</td>
</tr>
<tr>
<td class="ctr"><strong>Right arrow</strong>
</td>
<td>Decreases speed by 1 step for each press of the key</td>
</tr>
<tr>
<td class="ctr"><strong>Page Up</strong>
</td>
<td>Increases speed by approximately 10% for each press of the key</td>
</tr>
<tr>
<td class="ctr"><strong>Page Down</strong>
</td>
<td>Decreases speed by approximately 10% for each press of the key</td>
</tr>
</tbody>
</table>
<div>
<p class="important"><strong>Note:</strong> The implied keys noted above (with the
exception of the arrow keys) are those found on the numeric keypad of the keyboard. For
laptops and other keyboards that don't have a separate numeric keypad, experimentation on
your part may be needed to find the correct key combination. The arrow keys are usually
found grouped in their own separate area.</p>
</div>
<p>Using the standard key actions are pretty easy. After making the Control Panel have the
active focus, each click of the <strong>+</strong> on the numeric keypad should increase
the speed on your locomotive. Each click of the <strong>-</strong> key on the numeric
keypad should decrease the speed of your locomotive. To bring the locomotive to a stop, a
single click of the <strong>/</strong> key on the numeric keypad will set the speed of the
locomotive to zero.</p>
<p>Of course, in addition to the standard keyboard actions, what is the point of having a
mouse if you can't use the mouse to control your trains. So now let's discuss how to move
your locomotive using the mouse on your computer.</p>
</div>
<h3 id="MouseControl">Mouse Control</h3>
<div style="margin-left: 4em">
<p>You can perform all of the keyboard actions noted above by using your mouse pointer
within the Control Panel window. We'll start by defining the Forward, Reverse, Stop and
Idle controls. They are pretty simple to use.</p>
<table>
<tbody>
<tr class="ctr">
<td>BUTTON</td>
<td>ACTION</td>
</tr>
<tr>
<td class="ctr"><strong>Forward</strong>
</td>
<td>Changes the direction of the locomotive to forward.</td>
</tr>
<tr>
<td class="ctr"><strong>Reverse</strong>
</td>
<td>Changes the direction of the locomotive to reverse.</td>
</tr>
<tr>
<td class="ctr"><strong>STOP!</strong>
</td>
<td>Clicking on this button will perform an immediate physical stop of the
locomotive. If any braking momentum feature is enabled for the decoder, it will be
ignored halting the locomotive immediately. When using a sound decoder (such as a
Soundtraxx DSD-150), and the decoder has a "sound shutdown action" (like in the
diesel decoders), the associated engine shutdown sound will occur.</td>
</tr>
<tr>
<td class="ctr"><strong>Idle</strong>
</td>
<td>Clicking on this button will set the speed of the locomotive to 0. If any braking
momentum feature is enabled for the decoder, it will still be active and slow the
locomotive down to a stop. When using a sound decoder (such as a Soundtraxx DSD-150),
the engine sound will remain in its "idle" state.</td>
</tr>
</tbody>
</table>
</div>
<h4 id="SliderBar">THE SLIDER BAR</h4>
<div style="margin-left: 6em">
<p>The slider bar can function differently for each user depending on several factors. This
user guide is not going to try to identify all of the different possibilities. Instead, it
is going to identify several of the primary ways that the slider bar can work. At least one
of these methods should work for you. You may discover that your setup can utilize more
than one of these. A little experimentation on your part may be required.</p>
<ol>
<li>
<strong>Slider Method 1</strong>
<ul>
<li>Clicking anywhere above the current slider pointer position will INCREASE the
loco speed by 1 speed step. For example, if the locomotive's current speed setting
was 23, then a single click will advance the speed to 24. Another click will increase
the speed to 25. Another click...to speed step 26. Another...to speed step 27. And so
on...until it reaches the maximum speed steps for your system. This action has the
same effect as using the <strong>+</strong> key on the numeric keypad.<br>
<br></li>
<li>Clicking anywhere below the current slider pointer position will DECREASE the
loco speed by 1 speed step. For example, if the locomotive's current speed setting is
21, then a single click will decrease the speed to 20. Another click will decrease
the speed to 20. Another click...to speed step 19. And so on...until it reaches speed
step 0. This action has the same effect as using the <strong>-</strong> key on the
numeric keypad.<br>
<br></li>
</ul>
<p class="important"><strong>Note:</strong> Clicking too far below the slider
(especially when close to the bottom of the slider bar) may not have any effect because
you are actually clicking on the "Forward" option. Therefore, it is suggested that when
decreasing speed with this method, that you click on the word "Stop" (not the emergency
stop button (STOP!) but the word "Stop" located at the lower end of the speed
slider).</p>
<br>
<br>
<p class="important"><strong>Note:</strong> If the decoder has acceleration or braking
rates enabled, the loco will speed up or slow down accordingly. If no momentum values
are enabled, the loco will speed up or slow down abruptly.</p>
<br>
<br>
<br>
</li>
<li>
<strong>Slider Method 2</strong>
<ul>
<li>Click and hold the left mouse button over the slider pointer and then drag it to
a speed that you wish, and release the mouse button. This will send a "set speed to"
command to the decoder.</li>
</ul>
<p class="important"><strong>Note:</strong> If the decoder has acceleration or braking
rates enabled, the loco will speed up or slow down accordingly. If no momentum values
are enabled, the loco will speed up or slow down abruptly to the speed set when the
mouse button was released.</p>
</li>
<li>
<strong>Slider Method 3</strong>
<ul>
<li>Clicking anywhere above the current slider pointer position will increase the
slider pointer to the place where the mouse pointer was clicked. For example, if the
locomotive's current speed setting was around 25% of the slider bar, and the mouse
pointer was positioned near approximately the 75% point the slider bar when clicked,
then the speed of the locomotive would be changed to approximately 75%.</li>
<li>Clicking anywhere below the current slider pointer position will decrease the
slider pointer to the place where the mouse pointer was clicked. For example, if the
locomotive's current speed setting was around 50% of the slider bar, and the mouse
pointer was positioned approximately around the 25% point on the slider bar when
clicked, then the speed of the locomotive would be changed to approximately 25%.</li>
</ul>
<p class="important"><strong>Note:</strong> If the decoder has acceleration or braking
rates enabled, the loco will speed up or slow down accordingly. If no momentum values
are enabled, the loco will speed up or slow down abruptly.</p>
<p class="important"><strong>Note:</strong> Clicking too far below the slider
(especially when close to the bottom of the slider bar) may not have any effect because
you are actually clicking on the "Forward" option. Therefore, it is suggested that when
decreasing speed with this method, that you click on the word "Stop" (not the emergency
stop button (STOP!) but the word "Stop" located at the lower end of the speed
slider.</p>
</li>
</ol>
<table style="border: 2px solid; width: 90%">
<tbody>
<tr>
<td>
<p style="font: bold; color: #FF0000; font-size: large">IMPORTANT!</p>
<p>The easiest way to stop a locomotive for any of the methods outlined above is to
simply click on the "<strong>Idle</strong>" button located at the bottom of the
Control Panel window.</p>
<p>Or more abruptly, you can also click on the emergency stop button:
<strong style="font; bold; color: #FF0000; font-size: large">STOP!</strong></p>
</td>
</tr>
</tbody>
</table>
<p>If you have discovered that your system works in some way different from any of those
shown above, then you have simply found yet another method.</p>
</div>
<h3 id="Acquiring">Acquiring a Dispatched Locomotive</h3>
<div style="margin-left: 2em">
<p>When the decoder address is first "<strong>Set</strong>", the software queries the
current status of the decoder. This includes the current direction of the locomotive, its
current speed, and what function buttons are on or off. The software will set the current
direction indicator and identify any functions that are "active" (in the "on" state). But,
if the loco is moving, the loco's speed is not established on the Speed Control slider
bar.</p>
<p class="important"><strong>Note:</strong> At this time, the slider bar does <u>not</u>
automatically correspond to the actual speed. This is important to understand because of
what action you are going to see when you first click on the speed slider bar. When you
first "<strong>Set</strong>" a decoder address, the slider bar is set to the zero (0)
position. So if you acquired a locomotive that is actually moving and you click on the
slider bar, it is going to set the speed to zero (or wherever you click and set the slider
bar pointer).<br>
<br>
A future enhancement of the throttle feature will be to synchronize the slider bar pointer
accordingly. Until then, just beware of this little reaction.</p>
</div>
<h3 id="FunctionPanel">The Function Panel</h3>
<div style="margin-left: 2em">
<table border="0" style="width: 100%">
<tbody>
<tr>
<td>
<p>The Function Panel has 28 function buttons available for each throttle window.
Most decoders currently don't handle 28 functions. The function panel displays the
buttons in two groups, press the "*" button in the lower left corner to see the
second set of function buttons.</p>
<p>Clicking on the function buttons correlate to pressing the same function button
on a hand-held throttle. The F0 function is normally used for the lights.</p>
<p>This is the basic functionality of the Function Panel. All buttons function like
an on/off toggle: click once to turn "on"; click again to turn "off".</p>
<p>The next chapter provides more advanced features for customizing the Function
Panel buttons.</p>
</td>
<td><img width="20" height="40" src="images/spacer.gif" alt="spacer">
</td>
<td class="ctr">
<p style="text-align: center; font-size: xx-small"><img width="208" height="250"
src="images/jmri034.jpg" title="Example of the Function Panel" alt=
"function panel"><br>
Figure 2-6: The Function Panel</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>If you are reading this page from top to bottom as a training manual, at its conclusion
you should be able to...</p>
<ul>
<li>open a new throttle window</li>
<li>establish an active decoder address</li>
<li>run a locomotive through its paces</li>
<li>and activate the lights (and any other enabled functions for your decoder)</li>
</ul>
<p>The next chapter will identify throttle features that can be customized in order to make
your digital model railroading experience even more enjoyable.</p>
<table style="margin-left: auto; margin-right: auto;">
<tr>
<td style="vertical-align: middle">
<a href="ThrottleChapter1.shtml" title="Return to the previous chapter"><img width="18"
height="18" src="images/LeftArrow2.jpg" alt="left arrow"></a>
</td>
<td><img src="images/spacer.gif" width="30" height="18" alt="spacer">
</td>
<td style="vertical-align: middle"><strong><a href="ThrottleTOC.shtml" title=
"Jump to the Table Of Contents page">TOC</a></strong>
</td>
<td><img src="images/spacer.gif" width="30" height="10" alt="spacer">
</td>
<td style="vertical-align: middle">
<a href="ThrottleChapter3.shtml" title="Advance to the next chapter"><img width="18"
height="18" src="images/RightArrow2.jpg" alt="right arrow"></a>
</td>
</tr>
</table>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
<!-- closes #mainContent-->
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>