Serge NOEL
315 lines
14 KiB
Plaintext
315 lines
14 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: Advanced Configuration</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>Advanced Configuration of the Function Panel</h2>
|
|
|
|
<table style="width: 100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>When a new throttle window is initialized, all function button labels are set up
|
|
with a set of defaults (F1...F2...F3...etc.). These are closely related to hand-held
|
|
throttles. But one of the cool features that the JMRI Throttles have to offer over
|
|
hand-held throttles, is the ability to customize the button labels. In addition, each
|
|
button can be hidden from view or switched to an "unlocked" button.</p>
|
|
|
|
<p>The example image on the right shows the default Function Panel window. When the
|
|
mouse pointer hovers over the top of the button, a <strong>right click</strong> of
|
|
the mouse will display a menu with the only option on this menu at this time being
|
|
"<strong>Properties</strong>".</p>
|
|
</td>
|
|
<td><img width="20" height="20" src="images/spacer.gif" alt="spacer">
|
|
</td>
|
|
<td class="ctr">
|
|
<p style="text-align: center; font-size: xx-small"><img width="206" height="250" src=
|
|
"images/jmri022.jpg" title="Function Button Properties" alt="function buttons"><br>
|
|
Figure 3-1: Function Button Properties</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<br>
|
|
|
|
<table style="width: 100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<br>
|
|
|
|
<p style="text-align: center; font-size: xx-small"><img width="180" height="181" src=
|
|
"images/jmri023.jpg" title="Edit Function Button" alt="edit button"><br>
|
|
Figure 3-2: Edit Function Button</p>
|
|
</td>
|
|
<td><img width="20" height="20" src="images/spacer.gif" alt="spacer">
|
|
</td>
|
|
<td>
|
|
<p>When the "<strong>Properties</strong>" option is clicked on, the "<strong>Edit
|
|
Function Button</strong>" window opens (see the example image on the left).</p>
|
|
|
|
<ul>
|
|
<li><strong>Function Number</strong> associates the button with a function
|
|
number</li>
|
|
|
|
<li><strong>Text</strong> customizable button label text</li>
|
|
|
|
<li><strong>Font Size</strong> set the size of text displayed on button</li>
|
|
|
|
<li><strong>Lockable</strong> identifies whether the button acts as an "on/off"
|
|
toggle switch; or as a momentary switch</li>
|
|
|
|
<li><strong>Visible</strong> identifies whether the button is visible in the
|
|
Function Panel window</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>By default, the <strong>Function Number</strong> is associated with the button number that
|
|
you initially right-clicked on. For example, in the figures shown above, function number "1"
|
|
(F1) is being edited. It is recommended that you leave this number as is, however, you
|
|
<u>can</u> change this to a different function number if you really wish. An example of why
|
|
you might want to do this is if you really want the "lights" button, which is usually F0
|
|
(located as the last/bottom button by default), to be located as the first button in the
|
|
Function Panel.</p>
|
|
|
|
<p class="important"><strong>Warning! If any modifications are done to the "Function Number"
|
|
field, verify to make sure that no two buttons are assigned the same function number as some
|
|
unwanted consequences may occur.</strong>
|
|
</p>
|
|
|
|
<p>The <strong>Text</strong> field will be the most welcome and modified field. By default,
|
|
it is set similar to hand-held throttles: F1...F2...F3...etc. The content of the field is
|
|
pretty much open to the imagination, however, there is going to be a point where the length
|
|
of the text is <u>not</u> going to fit on the button. The <strong>Font Size</strong> field is
|
|
available to also assist in getting the wanted text to fit on the button. A little
|
|
experimentation will be required here to determine what looks good for you and what will
|
|
fit.</p>
|
|
|
|
<p>The <strong>Lockable</strong> check box may be a little confusing at first. When enabled,
|
|
as it is by default, it simply means that when the button is clicked on, it will "lock"
|
|
itself in either an "on" state or an "off" state. In other words, the button will act as a
|
|
toggle switch: click once to turn the function "on"; click again to turn the function "off".
|
|
The opposite of this action is what happens when the check box is <strong>disabled</strong>.
|
|
Then the button acts like a momentary switch: supplying a momentary "on" command for as long
|
|
as the mouse button is clicked <em>and held</em> over the button. When the mouse button is
|
|
released, an "off" command is sent to the function. A good example of where one might want to
|
|
use this is when customizing a throttle setup for a sound decoder. The horn/whistle is closer
|
|
to functional when this option is disabled. Depending on the speed of the computer system and
|
|
the DCC system, short and quick click and releases would provide a short blast of the horn or
|
|
whistle. Holding down the button a little longer would produce a longer held blast of the
|
|
whistle.</p>
|
|
|
|
<p>The <strong>Visible</strong> check box allows for the "removal" of unwanted buttons. By
|
|
default, all function buttons are enabled as "visible" so that they can obviously be seen.
|
|
But if there is only a single function being used, for example the "lights" (F0), then this
|
|
option does provide the ability to "hide" all of the other buttons.</p>
|
|
|
|
<p class="important"><strong>Warning! Disabling the "Visible" check box should be one of the
|
|
last steps performed during this customization process. The reason for this is that once the
|
|
button is marked as "invisible" (by removing the check box), it is indeed invisible to the
|
|
user and therefore can't be right-clicked on with the mouse in order to get the "Edit
|
|
Function Button" window back. To make all buttons visible select "View->Show All Function
|
|
Buttons."</strong>
|
|
</p>
|
|
|
|
<table style="width: 100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>The image shown on the right shows an example of a finished customized function
|
|
panel. This particular example was made for a steam locomotive with a sound decoder
|
|
installed so there are additional functions needed for some of the sounds.</p>
|
|
|
|
<p>These function buttons were all set up using the above outlined procedures.</p>
|
|
</td>
|
|
<td><img width="20" height="20" src="images/spacer.gif" alt="spacer">
|
|
</td>
|
|
<td class="ctr">
|
|
<br>
|
|
|
|
<p style="text-align: center; font-size: xx-small"><img width="200" height="205" src=
|
|
"images/jmri041.jpg" title="Customized Function Panel" alt="Customized panel"><br>
|
|
Figure 3-3: Customized Function Panel</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h1 id="WinMenuOptions">Throttle Window Menu Options</h1>
|
|
|
|
<p>There are a few optional options that affect the general preferences of the overall JMRI
|
|
Throttle window. These are found in a couple of menu options located just under the main
|
|
title bar of the window.</p>
|
|
|
|
<h2 id="ViewPanels">View (Panels)</h2>
|
|
|
|
<div style="margin-left: 2em">
|
|
<table style="width: 100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>Clicking on the "<strong>View</strong>" menu option displays a small menu of 3
|
|
items. By default, each with a check mark preceding the item. This corresponds to
|
|
the 3 sub-windows (Address Panel, Function Panel, & Control Panel) that make up the
|
|
overall throttle window.</p>
|
|
</td>
|
|
<td><img width="20" height="20" src="images/spacer.gif" alt="spacer">
|
|
</td>
|
|
<td class="ctr">
|
|
<br>
|
|
|
|
<p style="text-align: center; font-size: xx-small"><img width="308" height="148"
|
|
src="images/jmri018.jpg" title="View Menu Options" alt="view menu options"><br>
|
|
Figure 3-4: View Menu Options</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="3">
|
|
<p>As noted in <a href="ThrottleChapter1.shtml">Chapter 1</a>, because each
|
|
sub-window has a minimize and close buttons, if one gets closed down in error, this
|
|
menu option allows you to restore the window again.</p>
|
|
|
|
<p>Another way to use this option is when using the features of the throttles for
|
|
decoders that are <u>not</u> associated with a motor (such as a lighted passenger
|
|
car or caboose or a Fred unit). In these cases, critical screen real estate can be
|
|
saved by being able to disable (or close down) the Control Panel. Be a little
|
|
creative with the window resizing, and you could have several of these custom
|
|
throttle windows in the same area as one single complete throttle window would take
|
|
up.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<h2 id="EditFrameProperties">Edit (Frame Properties)</h2>
|
|
|
|
<div style="margin-left: 2em">
|
|
<table style="width: 100%">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<p>Clicking on the "<strong>Edit</strong>" menu option displays a single-optioned
|
|
sub menu of "<strong>Frame Properties</strong>". This feature allows you to title
|
|
the overall throttle window.</p>
|
|
|
|
<p>By default, the title of the overall throttle window is titled
|
|
"<strong>Throttle</strong>" and is displayed within the window border (see the
|
|
figure on the right).</p>
|
|
</td>
|
|
<td><img width="20" height="20" src="images/spacer.gif" alt="spacer">
|
|
</td>
|
|
<td class="ctr">
|
|
<br>
|
|
|
|
<p style="text-align: center; font-size: xx-small"><img width="308" height="147"
|
|
src="images/jmri019.jpg" title="Edit Frame Properties" alt="edit frame"><br>
|
|
Figure 3-5: Edit Frame Properties<br>
|
|
<br>
|
|
<br>
|
|
<img width="263" height="77" src="images/jmri020.jpg" title=
|
|
"Frame Properties Dialog" alt="properties dialog"><br>
|
|
Figure 3-6: Frame Properties Dialog</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="3">
|
|
<p>When "<strong>Frame Properties</strong>" is clicked on, a single field dialog
|
|
box will appear. Type in the title for your throttle window in this field. For
|
|
example, "Santa Fe #8259 EMD-SD60" may be descriptive enough as a single
|
|
locomotive. If the throttle is for a consist, you may want to identify it something
|
|
like "Consist #221". Your only limitation is how many characters you can fit into
|
|
the width of the window title bar.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<p>This chapter concludes the advanced throttle options that are currently available. The
|
|
next chapter demonstrates how to save all these customized throttles into a "<strong>Throttle
|
|
Layout</strong>" and then how to load them back again. You can use the right arrow below to
|
|
go to this chapter now.</p>
|
|
|
|
<table style="margin-left: auto; margin-right: auto;">
|
|
<tr>
|
|
<td style="vertical-align: middle">
|
|
<a href="ThrottleChapter2.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="ThrottleChapter4.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>
|