Initialisation depot

This commit is contained in:
Serge NOEL committed 2026-06-17 14:00:51 +02:00
commit efdf1683af
33190 files changed
+5907629

No files matched your search

@@ -0,0 +1,115 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure Digitrax BDL168</title>
<meta name="author" content="Bob Jacobsen">
<meta name="author" content="B. Milhaupt">
<meta name="keywords" content="JMRI help configure loconet BDL16 BDL162 BDL168 BDL16x">
<!--#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">
<a href="BDL16xConfigTool.png"><img src="BDL16xConfigTool.png" alt=
"BDL16x Configuration Tool Screen" width="386" height="423" style=
"float:right; margin: 5px;"></a>
<h1>Configure Digitrax BDL16x</h1>
<p>The JMRI BDL16x programming tool lets you configure the internal options of a BDL16,
BDL162, or BDL168 directly from your computer, when the board is connected to a JMRI LocoNet
connection.</p>
<p>To open this tool select "Configure BDL16/BDL162/BDL168" from the LocoNet menu.</p>
<h2>Selecting the BDL16x board</h2>
<p>Each BDL16x device present on the LocoNet connection is identified by its "Board ID". This
tool may access a particular BDL16x device by entering the "Board ID" number in the selection
box at the upper left of the tool window.</p>
<p>Upon start-up, this tool queries the LocoNet connection to create a list of BDL16x
devices. Each BDL16x Board ID is added to the list in the pull-down selector, accessed by
selecting the downward-pointing triangle which is just to the right of the Board ID text
entry space.</p>
<p>Any time that a Board ID number is typed into the Board ID text entry space, the number
will be added to the list if it is not already present in the list.</p>
<p>While it is possible to change the Board ID number using JMRI, it cannot be done using
this tool due to limitations of the BDL16x design. Instead, follow the instructions found
<a href="../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>. Those
instructions are for programming a BDL168 board, but they are believed to apply also to BDL16
and BDL162 boards.</p>
<h2>Reading and writing the OpSw settings</h2>
<p>This tool only accesses the board's OpSw values when the "Read Full Sheet" or "Write Full
Sheet" button is pressed.</p>
<p>The "Read Full Sheet" button may be used to read the OpSw settings from the BDL16x.
Performing the "Read Full Sheet" operation reads all OpSw values from the board selected by
the "Board ID" field and updates each of the tool's selections.</p>
<p>The "Write Full Sheet" button may be used to write the OpSw settings currently shown in
the tool to the BDL16x device specified by the "Board ID" number shown at the top of the
window. Performing the "Write Full Sheet" operation writes all OpSw values to the board.</p>
<h2>The configurable options</h2>
<p>The basic operating settings are shown grouped into three sections:</p>
<ul>
<li>The top-most section shows the options which apply to all BDL16x types.</li>
<li>Immediately below are the basic operating settings which apply only to the BDL162 and
BDL168.</li>
<li>Below this are the basic operating settings which apply only to the BDL168.</li>
</ul>
<p>Each setting may be changed by selecting one of the options from the pull-down list of
values.</p>
<p>When performing a "Write Full Sheet" operation to a BDL16 or BDL162 device, this tool will
write all of the OpSw values, not just the OpSw values which are defined for the BDL16 or
BDL162 device. This is thought to be safe, as it is thought that these OpSw values will be
ignored by the hardware. If you are concerned that this may not be acceptable, then select
the "default" value for the OpSw values which do not apply to the board type which you are
configuring.</p>
<h2>Limitations</h2>
<ul>
<li>This tool is not able to detect the difference between a BDL16, a BDL162, and a BDL168.
As such, it always shows all OpSw values and descriptions for the BDL168, and the "Write
Full Sheet" operation will write all OpSw values.</li>
<li>This tool is able to access BDL16x boards with addresses between 1 and 128. Users are
advised to avoid using the factory default board address (board address 1) as it will be
difficult to program new boards with unique data if any in-service board is using the
factory default board address.</li>
<li>Because of the way the BDL16x board works, this tool can't change the basic address of
the unit. The BDL16x documentation describes how to change the board address. It is
possible to change the Board ID number using JMRI by following the instructions found
<a href="../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>. Those
instructions are for programming a BDL168 board, but they are believed to apply also to
BDL16 and BDL162 boards.
</li>
</ul>
<h2>See Also</h2>
<p>Documentation for the BDL16, BDL162, and BDL168 can be found at the <a href=
"http://www.digitrax.com">Digitrax Web Site.</a></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
<!-- closes #mainContent-->
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: LocoNet Fast Clock Control</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help loconet fast clock monitor">
<!--#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>LocoNet Fast Clock Control</h1>
<p>See the <a href="../../../../../html/tools/fastclock/LocoNetClock.shtml">LocoNet Clock
Help</a></p>
This is the help/jmri/jmrix/loconet/clockmon/ClockMonFrame help page
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
<!-- closes #mainContent-->
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,39 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure Digitrax Command Station</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help configure Digitrax command station">
<!--#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>Configure a Digitrax Command Station</h1>
<p>Recent JMRI versions support configuration of the Command Station "Operation Switches"
(OpSws) via a "roster" entry. See the JMRI <a href=
"../../../../../html/hardware/loconet/CommandStationConfig.shtml">Digitrax Command Station
Configuration</a> page for details. The new "roster" entry-based method is preferred over the
tool described below.</p>
<p>This tool Configures the Digitrax MASTER DCS OpSw's. You do not need to set any of the
switches on the DCS to use this tool.</p>
<p>OpSw2 being set to Thrown allows this tool to access Slot 127, which contains the OpSw
settings. DB do not have OpSw and can not be set with this tool, DCS's that have OpSw2 set to
Closed are not programmed by this tool.</p>
<p>To configure DB's and DCS's set as Boosters, you need to follow the original Digitrax
instructions.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
<!-- closes #mainContent-->
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,608 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Digitrax Downloader</title>
<meta name="author" content="Bob Jacobsen">
<meta name="author" content="B. Milhaupt">
<meta name="keywords" content="JMRI help digitrax downloader">
<!--#include virtual="/help/en/parts/Style.shtml" -->
<!-- center class -->
<style>
.ctr {text-align: center;}
</style>
</head>
<body>
<!--#include virtual="/help/en/parts/Header.shtml" -->
<div id="mBody">
<div id="mainContent" class="no-sidebar">
<h1>LocoNet&reg; "Download Firmware" Tool</h1>
<table border="0">
<tr>
<td colspan="2">Table of Contents</td>
</tr>
<tr>
<td colspan="1">
<ul>
<li>
<a href="#General">General information</a>
</li>
<li>
<a href="#Disclaimer">Disclaimer</a>
</li>
<li>
<a href="#Updating">Updating Device Firmware Contents</a>
</li>
<li>
<a href="#Problem">What if my device does not work correctly after updating the
firmware?</a>
</li>
<li>
<a href="#Verify">Verifying Device Firmware Contents</a>
</li>
<li>
<a href="#ErrorMessages">Error Messages</a>
<ul>
<li>
<a href="#NoInputFile">"You Must Select An Input File" Pop-up Window</a>
</li>
<li>
<a href="#FileNotFound">"File Not Found" Pop-up Window</a>
</li>
<li>
<a href="#InvalidOptionsInFile">"Invalid value for Options key" Pop-up
Window</a>
</li>
<li>
<a href="#FileReadError">"Firmware file cannot be read." Status Message</a>
</li>
<li>
<a href="#ParameterValidationProblem">"Invalid parameter(s) above." Status
Message</a>
</li>
<li>
<a href="#nullFirmwareData">Do not have any firmware information to send."
Status Message</a>
</li>
<li>
<a href="#ContentNotUnderstood">"Firmware content in the file is not
understood" Status message</a>
</li>
<li>
<a href="#InvalidParameterInFile">"Invalid Prog Blk Size parameter in file"
dialog box message</a>
</li>
</ul>
</li>
<li>
<a href="#WhatItDoes">What this tool does and does not do</a>
</li>
<li>
<a href="#UpdatableDevices">Some devices which support firmware update via this
tool</a>
</li>
<li>
<a href="#NotUpdatableDevices">Devices which are not supported by this tool</a>
</li>
<li>
<a href="#Notes">Other Notes</a>
</li>
<li>
<a href="#ForHelp">If you need additional help</a>
</li>
</ul>
</td>
<td colspan="1"><img src="./LocoNetDownloadFirmwareWindow.png" alt=
"Example of the Download Firmware Window">
</td>
</tr>
</table>
<h2 id="General">General information</h2>
<p>Some LocoNet devices allow users to update the firmware (internal program) via the LocoNet
connection. The LocoNet Download Firmware tool provides a mechanism to perform updates via a
LocoNet connection.</p>
<p><em>This tool is not used for loading sound projects into Digitrax sound decoders. The
<a href="../soundloader/LoaderFrame.shtml">Sound Download Tool</a> may be used for that
purpose.</em>
</p>
<p>This tool supports firmware update files distributed as either the ".dmf" (Digitrax
Mangled Firmware) file format or a ".hex" file format (sometimes referred to as the Intel
"I8HEX" file format).</p>
<p>This version of the tool automatically determines how to interpret the firmware update and
performs a number of file and data integrity checks before the update information can be
used. If any issues are identified in the firmware file, the user is informed and the tool
will not allow the user to update the device with what could be erroneous firmware
information. This significantly reduces the risk of corrupting the device firmware as
compared to previous versions of this tool.</p>
<h2 id="Disclaimer">Disclaimer</h2>
<p><strong>This tool is capable of modifying the firmware in LocoNet devices in ways that
could make the devices inoperable.</strong> The developers of this tool have attempted to
reduce the chances that the tool would corrupt a LocoNet device's firmware. We have
successfully tried this tool with a variety of LocoNet devices, computers, operating systems,
LocoNet interfaces, and firmware update files.</p>
<p><strong>We cannot guarantee that there is no risk of corrupting device firmware when using
this tool.</strong> It is impossible for the tool developers to predict every way of using
the tool and it is impossible to predict the nuances of various devices, firmware files,
computer operating systems, computer-to-LocoNet interface hardware, etc.</p>
<p>In cases where a firmware update attempt does not apply properly, it is often possible to
<a href="#Problem">re-apply the firmware update to the device</a> to restore proper device
functionality. This has been recommended by at least one LocoNet device manufacturer and has
been found to be effective in some cases by the developers of this tool.</p>
<p><em><strong>Use this tool at your own risk.</strong></em>
</p>
<h2 id="Updating">Updating Device Firmware Contents</h2>
To use this tool to update a LocoNet device's firmware:
<ul>
<li>Consult the device manufacturer to determine if the device supports user updates of
firmware.</li>
<li>Acquire the appropriate firmware file from the device manufacturer.</li>
<li>It is best to perform LocoNet firmware updates with a very simple LocoNet environment,
including as little LocoNet hardware as possible. A good choice for a simple LocoNet
firmware update configuration would include the device to be updated, a LocoNet-based
command station, and a PC-to- LocoNet interface device. A simple LocoNet configuration
helps reduce the amount of other LocoNet message traffic that could potentially disrupt the
firmware update process. If you plan to re-configure your LocoNet connectivity to perform
firmware updates, be sure that you will be able to restore your LocoNet connectivity
properly once you have completed the update process. Take notes or make a drawing if
necessary.</li>
<li>The device being updated must be plugged into a live LocoNet connection. If the device
can be battery powered, ensure that the batteries are good before starting this process. If
the device uses an external power supply, ensure that it is powered and attached.</li>
<li>Some devices may require changes to jumpers or DIP switch settings, and perhaps require
removal and restoration of power, in order to allow the device to accept the firmware
update via LocoNet. Devices produced by Digitrax which support LocoNet firmware updates do
not require any physical configuration changes to the device. Consult the LocoNet device
manufacturer's firmware update instructions for details.</li>
<li>Open the LocoNet Firmware Download tool by selecting the "Download Firmware" item from
the LocoNet menu. If you have more than one LocoNet connection, you must open the tool from
the LocoNet menu which is associated with the connection which communicates with the device
you wish to update.</li>
<li>Click the Select button, and select the .dmf file or .hex file you want to use as the
source of your firmware update. Click the Open button to select the file for use. The file
will then be read and inspected for errors.
<p>If the file is read and parsed successfully, the tool window will enable the
"Download" and "Verify" buttons, and update the status message at the bottom of the
window to state "Click Download to download new firmware".</p>
<p>If the file cannot be read and parsed successfully, a pop-up message will appear or
the tool window will update the status message at the bottom of the window with a
description of the problem it found. For more information, see <a href=
"#ErrorMessages">Error Messages</a>, below.</p>
</li>
<li>Only if instructed to by the device manufacturer, change the various values in the
Firmware File Properties portion of the display. It is usually not necessary to change any
of the values.</li>
<li>Click the Download button to update the firmware in the device. This may take a few
seconds or minutes, depending on the amount of firmware to be updated and the speed at
which the messages are sent to the device. A progress bar is displayed below the
"Download", "Verify", and "Abort" buttons to show progress of the update process. The bar
will darken from one end to the other as the update gets closer to completion.</li>
<li>Once the update tool completes its work, <em>the tool is unable to tell if the LocoNet
device has properly accepted the update</em>. This is a limitation of the LocoNet messaging
used for the firmware update and firmware verify processes. Because of this limitation, the
tool is only able to report that it has completed its work.
<p>The device may provide an indication that the update process has completed (or failed)
using lights on the product or on the display of the product. Consult the device
manufacturer's instructions for further information.</p>
</li>
<li>After performing the firmware update, it may be necessary to reset or remove and
restore power to the device. Consult the manufacturer's firmware update instructions.</li>
<li>If you re-configured your LocoNet connectivity for a simplified LocoNet at the
beginning of the firmware update process as described above, restore the LocoNet
connectivity to its normal state.</li>
</ul>
<h2 id="Problem">What if my device does not work correctly after updating the firmware?</h2>
<p>Sometimes the device firmware update process does not appear to work, and the device may
fail to provide its normal functionality. <em>Often, repeating the firmware update process
one or more times will solve the problem.</em> This has been recommended by at least one
LocoNet device manufacturer and has been found to be effective in many cases by the
developers of this tool.</p>
<p>As an example, if the firmware in a Digitrax DT402D throttle has been updated and that
update was not successful, when the DT402D throttle is powered up, the display will usually
show a series of dim, filled-in rectangles rather than the normal power-up display of model
and firmware revision information. In this case, re-updating the device, using the process
shown above, will usually restore the throttle to proper functionality.</p>
<p>In other cases, a device may not be easily restored to proper operation after a firmware
update attempt. In this case, consult the device manufacturer for further instructions.</p>
<p>Consult your device documentation and, if necessary, the device manufacturer's technical
support if your device fails to function properly after updating its firmware.</p>
<h2 id="Verify">Verifying Device Firmware Contents</h2>
<p>Some devices support a firmware "verify" process. This tool can perform the process to
send the appropriate LocoNet messages by using the "Verify" button in the tool window. This
tool <em>cannot</em> provide any indication of whether the device firmware does or does not
match the firmware update file's information because there is no well-defined LocoNet message
that conveys this type of information to the tool. Instead, the device may provide the pass
or fail results of the verify process, perhaps by a specific blink sequence on an LED or by
displaying a message on a display on the device. If a LocoNet device supports the verify
operation, the manufacturer' s instructions should describe how the product provides status
information for the results of the verify process.</p>
<h2 id="ErrorMessages">Error Messages</h2>
<p>This tool can identify problems at two different stages of the firmware update process.
The tool checks for problems within the firmware update file when reading the file. When the
user activates the "Download" or "Verify" button, the tool checks the validity of the
parameters which the user can change in the tool window for obvious problems. If any issues
are found at either of these stages, the tool will update the message at the bottom of the
tool window. If a parameter is found to be out of range, that parameter value will be shown
with red text instead of black text. The "Download" and "Verify" buttons will not perform any
useful function if any of the parameters are invalid.</p>
<p>Typically, when this type of pop-up window appears, a message in the JMRI "console" log
will provide additional technical detail about the problem. The firmware update file provider
may find this information useful in correcting firmware update file issues.</p>
<p>The tool may also create a pop-up window under certain circumstances.</p>
<h3 id="NoInputFile">"You Must Select An Input File" Pop-up Window</h3>
<p>The tool will open a pop-up window with this message if the user uses the "Cancel" button
on the file selection pop-up window. The tool cannot perform a firmware update if no firmware
file is selected.</p>
<h3 id="FileNotFound">"File Not Found" Pop-up Window</h3>
<p>The tool will open a pop-up window if the file selected by the user does not exist. The
pop-up window will state that the file was not found. Use the "Select" button to re-specify
the correct firmware file.</p>
<h3 id="InvalidOptionsInFile">"Invalid value for Options key" Pop-up Window</h3>
<p>The tool will open a pop-up window if the file selected by the user contains a value for
the "Options" key which is not supported by this tool. Consult the device manufacturer for
advice if this occurs.</p>
<h3 id="FileReadError">"Firmware file cannot be read." Status Message</h3>
<p>This status message is shown when an abnormal event occurs which prevents the tool from
reading the file from the disk. This is typically a problem with the computer or the media
from which the file is being read.</p>
<h3 id="ParameterValidationProblem">"Invalid parameter(s) above." Status Message</h3>
<p>This message indicates that one or more of the values are out of range. Usually it is
unnecessary for the user to change any of the parameter values because either the tool's
default values are appropriate or because the firmware file specifies the required values. If
an invalid value is found in one of the parameter entry fields, the invalid parameter will be
highlighted in red. To resolve the problem, close the Firmware Download tool, then re-open it
and re-read the file. Be careful not to change any of the parameter field values. If the tool
still identifies a value as invalid, consult the device manufacturer.</p>
<h3 id="nullFirmwareData">Do not have any firmware information to send." Status Message</h3>
<p>This status message indicates that the firmware file did not contain any valid firmware
information. Consult the device manufacturer for a valid firmware file.</p>
<h3 id="ContentNotUnderstood">"Firmware content in the file is not understood" Status
message</h3>
<p>When the tool reads a firmware file which it does not understand, it will show the message
"Firmware content in the file is not understood by this reader." in the status line at the
bottom of the tool window. Consult the device manufacturer for support - usually this means
that the manufacturer must provide a new firmware file.</p>
<h3 id="InvalidParameterInFile">"Invalid Prog Blk Size parameter in file" dialog box
message</h3>
<p>When the tool reads a firmware file and can determine that the file requires a process
which the tool cannot support, the tool will pop-up a dialog box saying "Invalid Prog Blk
Size parameter ...". The tool will prevent itself from attempting to update the device. This
applies to firmware updates for some newer Digitrax hardware which requires a different
firmware update process. For these devices, the Digitrax <em>DigiIPLII</em> software should
be used.</p>
<h2 id="WhatItDoes">What this tool does and does not do</h2>
<p>The table below shows some capabilities and limitations of this tool.</p>
<table border="2">
<tr>
<td class="ctr"><strong>"Download Firmware" Tool Capabilities</strong>
</td>
<td class="ctr"><strong>"Download Firmware" Tool Limitations</strong>
</td>
</tr>
<tr>
<td>This tool can read a firmware update file from the computer's local storage.</td>
<td>This tool does not acquire firmware update files from manufacturers.</td>
</tr>
<tr>
<td>With some older versions of this tool it was very easy to read the firmware update
file in a way that caused improper interpretation of the information and which could
result in corruption of the device's firmware. This version performs several checks of
the firmware update file to ensure that the file is interpreted correctly and to identify
partial or damaged firmware update files. If any issues are found in the firmware update
file, the tool will not allow the user to perform the update process. This should
significantly reduce the risk of corrupting a LocoNet device's firmware when using this
tool.</td>
<td>
</td>
</tr>
<tr>
<td>This tool can send the contents of a firmware update file to LocoNet with a request
that the associated device(s) update their firmware based on the contents of the LocoNet
Messages.</td>
<td>This tool cannot know whether any of the firmware update file information was
successfully programmed into a LocoNet device's firmware. The LocoNet messaging protocol
does not provide any indication of the status of the firmware update process.</td>
</tr>
<tr>
<td>This tool can send the contents of a firmware update file to LocoNet with a request
that the associated device(s) compare their firmware to the contents of the LocoNet
Messages.</td>
<td>This tool cannot know whether any of the firmware update file information actually
matches or is different from information within the device's firmware. The LocoNet
messaging protocol does not provide any indication of the status of the compare.</td>
</tr>
<tr>
<td>This tool allows the user to change some aspects of the firmware update process,
including some information used to identify which LocoNet device type is to accept the
firmware update information, as well as some LocoNet timing delays. <strong>Changes to
the information in the "Firmware File Properties" portion of the tool window should only
be made under direction of the manufacturer. Changes to the values could result in
corruption of the targeted device OR other devices which may be connected to
LocoNet.</strong></td>
<td>This tool cannot predict how changes to the information in the "Firmware File
Properties" could possibly cause malfunction of any LocoNet device. <strong>Changes to
the information in the "Firmware File Properties" portion of the tool window should only
be made under direction of the manufacturer.</strong></td>
</tr>
<tr>
<td>
</td>
<td>This tool does not read the contents of a LocoNet device's firmware.</td>
</tr>
</table>
<h2 id="UpdatableDevices">Some devices which support firmware update via this tool</h2>
<p>The table below lists some devices which are believed to allow firmware updates using this
tool. This list is not necessarily complete, and does not necessarily apply to all versions
of the listed devices.</p>
<table border="2">
<thead>
<tr>
<td class="ctr"><strong>Manufacturer</strong>
</td>
<td class="ctr"><strong>Product</strong>
</td>
</tr>
</thead>
<tr>
<td rowspan="7" class="ctr">Digitrax</td>
<td>UR92, UR92CE</td>
</tr>
<tr>
<td>DCS51</td>
</tr>
<tr>
<td>DT402-series throttles</td>
</tr>
<tr>
<td>DT500-series throttles</td>
</tr>
<tr>
<td>LNRP</td>
</tr>
<tr>
<td>PR3</td>
</tr>
<tr>
<td>RF24 (the radio module found in Duplex devices like UR92, UR92CE, DT402D and
DT500D)</td>
</tr>
<tr>
<td rowspan="7" class="ctr">RR-CirKits</td>
<td>LocoBuffer-USB</td>
</tr>
<tr>
<td>LNCP</td>
</tr>
<tr>
<td>MotorMan</td>
</tr>
<tr>
<td>Tower Controller 64</td>
</tr>
<tr>
<td>TowerMan</td>
</tr>
<tr>
<td>SignalMan</td>
</tr>
<tr>
<td>WatchMan</td>
</tr>
<tr>
<td class="ctr">Fremo</td>
<td>FREDI (version 1.8 and above)</td>
</tr>
<tr>
<td class="ctr">Tam Valley Depot</td>
<td>Quad-LN</td>
</tr>
<tr>
<td colspan="2" class="ctr"><strong>Table updated June, 2017</strong>
</td>
</tr>
</table>
<h2 id="NotUpdatableDevices">Devices which are not supported by this tool</h2>
<p>The table below lists some devices which are known to be <em>unsupported</em> by this
tool. The tool will not attempt to update these devices because this tool does not implement
the correct protocol. <em>Using the protocol implemented in this tool when a newer protocol
is required would result in a corrupted firmware image in the device.</em> Use the Digitrax
program <em>DigitIPLII.exe</em> to update these devices.</p>
<table border="2">
<thead>
<tr>
<td class="ctr"><strong>Manufacturer</strong>
</td>
<td class="ctr"><strong>Product</strong>
</td>
</tr>
</thead>
<tr>
<td rowspan="5" class="ctr">Digitrax</td>
<td>DB210</td>
</tr>
<tr>
<td>DB210 (Opto-isolated)</td>
</tr>
<tr>
<td>DB220</td>
</tr>
<tr>
<td>DCS210</td>
</tr>
<tr>
<td>DCS240</td>
</tr>
<tr>
<td colspan="2" class="ctr"><strong>Table updated June, 2017</strong>
</td>
</tr>
</table>
<h2 id="Notes">Other Notes</h2>
<ul>
<li>The LocoNet Firmware Download tool is similar to the "DigiIPL.exe" and "DigiIPLII.exe"
which have been released by Digitrax. "DigiIPLII.exe" is available from their website as
part of the SoundLoader2 package. Support for the DigiIPLII.exe program is provided by
Digitrax. Note that DigiIPLII.exe is intended for use with Digitrax products and is not
able to perform firmware updates on at least some non-Digitrax hardware.</li>
<li>This tool does <strong>not</strong> receive any LocoNet messages from the device as
part of the firmware update process. At the time this tool was written, the firmware
protocol does not define any sort of feedback from the device to the programming tool. As
such, it is not possible for this tool to provide any definitive indication of the success
of a firmware update or firmware verify operation. It is up to the user to determine if the
device has been properly updated.</li>
<li>This version of the tool does <strong>not</strong> allow the user to configure the file
addressing format. The tool automatically determines whether the file uses 16-bit or 24-bit
addressing. This removes the possibility that the wrong setting could be used.</li>
<li>This tool cannot be used to update the firmware in the LocoBuffer-II device.</li>
<li>It is possible to update firmware on multiple devices of the same type at the same
time. If attempting this, ensure that the devices are all actively connected to LocoNet,
properly powered, and properly configured before activating the "Download" button. The
developers of this tool do not recommend this as any failure of the process could result in
all of the hardware being updated becoming unusable.</li>
<li>Do not open multiple LocoNet Firmware Download tools at the same time. Do not perform
firmware updates and/or verifies from multiple sources (computers) simultaneously, as this
is likely to result in corrupted device firmware.</li>
<li>If the selected update file's filename is too long to fit the tool window, the filename
will be displayed in a shortened form. If the cursor is placed over the displayed filename,
the "tool tip" will attempt to show the complete file name.</li>
</ul>
<h2 id="ForHelp">If you need additional help</h2>
<p><strong>If you experience difficulty with this tool and believe that your problem is
caused by the tool, seek help through the <a href="https://groups.io/g/jmriusers/">"JMRI
Users" forum at "groups.io"</a>.</strong>
</p>
<p>If you believe that your problem is related to the firmware update file or the hardware
itself, consult the hardware instructions and the hardware manufacturer's technical
support.</p>
<p>Note that <strong>Digitrax does not</strong> provide any support this tool.</p>
<p>LocoNet is a registered trademark of Digitrax, Inc.</p>
<p>(This is the package/jmri/jmrix/loconet/downloader/LoaderFrame help page)</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure Digitrax DS64</title>
<meta name="author" content="B. Milhaupt">
<meta name="keywords" content="JMRI help configure loconet DS64">
<!--#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>Configure Digitrax DS64</h1>
<a href="../../../../../html/hardware/loconet/images/DS64TabbedPanel.png"><img src=
"../../../../../html/hardware/loconet/images/DS64TabbedPanel.png" style=
"float:right; margin: 5px;" height="408" width="438" alt="Configure DS64 panel image"></a>
<p>The JMRI DS64 Configuration tool lets you configure the internal options of a Digitrax
DS64 Stationary Decoder directly from your computer running JMRI.</p>
<p>To open this tool select "Configure DS64" from the LocoNet menu for the connection this
DS64 is attached to.</p>
<h2>Selecting the DS64 board</h2>
<p>Each DS64 present on LocoNet is identified uniquely by its <a href=
"http://www.digitrax.com/tsd/KB805/ds64-setting-board-id-for-additional-ds64s/">"Board
ID"</a>. This tool may access a particular DS64 by entering the Board ID number in the
selection box at the top of the window.</p>
<p>Upon start-up, this tool queries LocoNet to create a list of DS64s. Each DS64 Board Id is
listed in the pull-down selector. New Board Id numbers may be typed into the box and will be
added to the list.</p>
<p>While it is possible to change the Board ID number using JMRI, it cannot be done using
this tool due to limitations of the DS64 design. Instead, follow the instructions found
<a href="../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>, but you
must consult the DS64 manual and modify the JMRI-based process to suit the DS64's buttons,
button press time, and lamp flashes.</p>
<h2>Configuring the basic operating modes</h2>
<p>The basic operations are configured on the "Basic Settings" tab. This tab gives
human-readable descriptions of the various options. Changes made here are immediately
reflected on the "OpSw Values" tab, but are not written to the addressed DS64 until the
"Write full sheet" button is pressed.</p>
<p>The "Read full Sheet" button may be used to read the OpSw settings from the DS64.</p>
<h2>Configuring the OpSws</h2>
<p>The "OpSw Values" tab displays the individual "OpSw" settings which correspond to the
settings found on the "Basic Settings" tab. Changes made on this tab will immediately
reflected on the "Basic Settings" tab.</p>
<p>The "Read full Sheet" pushbutton may be used to read the OpSws from the addressed DS64.
The "Write Full Sheet" pushbutton may be used to write the OpSw values to the addressed
DS64.</p>
<h2>Configuring the Output Addresses</h2>
<p>The "Output Addresses" tab allows reading and writing the DS64 output addresses. The
addresses need not be sequential.</p>
<p>The "Read full Sheet" pushbutton may be used to read the Output addresses from the
addressed DS64. The "Write Full Sheet" pushbutton may be used to write the Output addresses
to the addressed DS64.</p>
<h2>Configuring Routes</h2>
<p>Each DS64 may be programmed to hold up to 8 "Routes". Each route consists of a "Top" (or
"trigger") switch command, plus up to seven additional switch commands. When the "Top"
("trigger") switch command is seen by the DS64 on LocoNet, the DS64 will send the other
switch commands to LocoNet.</p>
<p>When the proper OpSw settings are made, the DS64 A* and S* input signals may each be used
to trigger one of the programmed routes.</p>
<p>This tool allows configuring each of the 8 "Routes" via the "Routes" tab. Once the
"Routes" tab is selected, an individual "Route" is selected on the left side by selecting one
of the tabs.</p>
<p>Within each individual Route, the "Top" turnout command is the command which begins the
sequence. The received LocoNet command must match the "Top" turnout command exactly - both in
address and direction, in order to trigger the route via a LocoNet command. Once triggered,
the DS64 will transmit the subsequent turnout messages to LocoNet, until it finds an entry
marked as "unused", or until it has sent the 8th entry, which ever comes first.</p>
<p>When a DS64 input is used to trigger the route, and the route has a "Top" entry which is
something other than "Unused", the DS64 will transmit (on LocoNet) the "Top" switch command,
as well as any subsequent commands, until the 8th entry of the route has been sent or until
it reaches an entry marked as "Unused", whichever happens first.</p>
<p>If the topmost entry of a route is marked as "unused", the whole route is considered
invalid.</p>
<p>Note that it is not necessary to enter a duplicate turnout command to terminate the route
before the end of the list. Simply configure a turnout as "Unused" to terminate the route.
For example, if there are five turnouts in the route, including the top-most turnout, then
set the sixth turnout entry as "Unused". The DS64 will then ignore the sixth, seventh and
eighth entries for the route.</p>
<h3>Clearing a Route</h3>
<p>When the "Routes" tab has been selected, the tool provides an additional button for
"clearing" the route. This button is found at the top of the window. When this button is
pressed, the tool will ask for confirmation before making any changes to the DS64. Upon user
confirmation, the tool updates the DS64 to clear the route which is selected.</p>
<p>Only the selected route will be cleared; other routes remain unmodified.</p>
<h2>Limitations</h2>
<ul>
<li>Because of the way the DS64 board works, this tool can't change the basic address (the
"Board ID") of the unit. It is possible to change the Board ID number using JMRI by
following the instructions found <a href=
"../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>. Note that it
is necessary to consult the DS64 manual and modify the JMRI-based process shown at the link
above to suit the DS64's buttons, button press time, and lamp flashes.
</li>
<li>This tool does not have the capability to save the DS64 configuration.</li>
<li>The "Output Addresses" tab shows the state of the output <em>at the time that the
"sheet" was last read from the DS64</em>. This tool does not attempt to track any ongoing
turnout control messages, so it cannot provide real-time updates of the DS64 output
state.</li>
<li>When a route is "cleared", the tool will simply update the DS64 with the information
that the top-most entry is "Unused", and then clear the route display. The remaining
information from the route remains un-modified in the DS64. It cannot be executed as a
route. A "Read full sheet" operation, for the route, will display the remaining "orphaned"
route information.</li>
</ul>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,717 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Duplex Network Configuration Tool</title>
<meta name="author" content="B. Milhaupt">
<meta name="keywords" content="JMRI configure LocoNet UR92 UR92CE">
<!--#include virtual="/help/en/parts/Style.shtml" -->
<!-- center class -->
<style>
.ctr {text-align: center;}
</style>
</head>
<body>
<!--#include virtual="/help/en/parts/Header.shtml" -->
<div id="mBody">
<div id="mainContent" class="no-sidebar">
<h1>Digitrax Duplex Network Configuration Tool</h1>
<table border="0">
<tr>
<td>
<strong>CONTENTS</strong>
<ul>
<li>
<a href="#Overview">Overview</a>
</li>
<li>
<a href="#Disclaimer">Disclaimer</a>
</li>
<li>
<a href="#Starting">Starting the Duplex Network Configuration Tool</a>
</li>
<li>
<a href="#GroupIdTab">The Group Identity Tab</a>
<ul>
<li>
<a href="#Fields">The Duplex Group Identification Fields</a>
<ul>
<li>
<a href="#NameField">Duplex Group Name</a>
</li>
<li>
<a href="#ChannelField">Duplex Group Channel</a>
</li>
<li>
<a href="#PasswordField">Duplex Group Password</a>
</li>
<li>
<a href="#GroupIdField">Duplex Group ID</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#Scanning">The Channel Scan Tab</a>
<ul>
<li>
<a href="#ScanningLimitations">Channel Scan Limitations</a>
</li>
</ul>
</li>
<li>
<a href="#Notes">Notes</a>
<ul>
<li>
<a href="#LNWISideEffects">Effect on LNWI device configuration</a>
</li>
</ul>
</li>
<li>
<a href="#Interfere">Some possible interference sources</a>
</li>
<li>
<a href="#SimplexInteract">Digitrax Simplex radio system interaction</a>
</li>
<li>
<a href="#SeeAlso">See Also</a>
</li>
</ul>
</td>
<td><img src="./UR92.jpg" alt="UR92 image">
</td>
</tr>
</table>
<h2 id="Overview">Overview</h2>
<p>The JMRI Digitrax Duplex Configuration Tool provides a mechanism to read and modify the
Duplex Group identification information associated with a Digitrax Duplex wireless network.
It also can scan the Duplex channels for radio interference.</p>
<p>This tool supports both the UR92 and the UR92CE. For clarity, this text and this tool uses
the term UR92.</p>
<p>This tool provides the same basic features as provided by the Digitrax program
"DuplexGroupSetup". Duplex network "identification" information may read and changed by using
the fields availble in the "Group Identity" tab. Scanning the Duplex channels for radio
interference me be performed using the "Channel Scan" tab. Each tab is described below.</p>
<p>If the Duplex Group identity information is changed, then throttles must join the network
with the new identity information in order to communicate properly. Join the network using
any of the mechanisms which apply for the throttle(s) you use.</p>
<p>This configuration tool has no effect on Digitrax infrared or simplex network
configuration, and has no useful effect if there are no UR92 devices connected to
LocoNet.</p>
<h2 id="Disclaimer">Disclaimer</h2>
<p>This tool was not developed by Digitrax. This tool is not supported by Digitrax. The
tool's original author reverse-engineered the operations of the DigiGroupSetup software
package to determine how this tool should operate. It is not possible to guarantee that this
tool will work properly with future Digitrax Duplex-related hardware.</p>
<p>Note that this tool can have some effect on the configuration of the Digitrax LNWI device.
This is a "feature" of the Digitrax design. The Digitrax software package "DigiGroupSetup"
has the same sorts of effects. See <a href="#LNWISideEffects">Effect on LNWI device
configuration</a>.</p>
<h2 id="Starting">Starting the Duplex Network Configuration Tool</h2>
<p>This tool is available in DecoderPro under the LocoNet menu, as the item "Configure Duplex
Group". Other tools may provide different methods to start this tool.</p>
<p>When this tool is started, the tool automatically determines if it can access any UR92
devcies. If the tool is able to find and read the UR92 Duplex Group identification
information, the identification information is updated in the display. A sample is shown
below.</p>
<p><img src="SampleInitialView.png" alt="Duplex Configuration Tool">
</p>
<p>If the tool cannot communicate with any UR92 devices, then this tool cannot provide any
useful function. In this case, the tool disables all Duplex Group identification entry fields
and displays a status message. This is shown (in part) below.</p>
<p><img src="SampleNoUr92Found.png" alt="Status message showing no UR92s found">
</p>
<p>Once LocoNet communication between the computer and the UR92(s) is restored, the user can
press the "<strong>Read Group Information</strong>" button to re-try the UR92 query.</p>
<p>If the tool finds more than one UR92, and they are configured with different Duplex Group
identity information, then the display will show configuration information from the first
UR92 to respond to the tool's identity query. The tool reports the number of UR92s found, and
shows a message in the status line at the bottom of the tool, such as shown (in part)
below.</p>
<p><img src="SampleConflictingGroupIdentity.png" alt=
"Display when UR92s have non-matching Duplex Group identity information">
</p>
<p>In this case, it is advisable to Set all of the UR92s to the same Duplex Group identity
information by modifying the Duplex Group identification fields as required and then pressing
the "<strong>Set Group Information</strong>" button to configure all UR92s to the same Duplex
Group identity information.</p>
<h2 id="GroupIdTab">The Group Identity Tab</h2>
The "Group Identity" tab is used to read and change the identification information associated
with the Digitrax Duplex network. This information is used by the devices which support the
Digitrax Duplex radio system, which includes the UR92, the DT402D, and the UT4D.
<p>As fields are modified, they are marked in orange, as shown below:</p>
<p><img src="./SampleChangedName.png" alt="Tool showing modified fields">
</p>
<p>The "<strong>Set Group Information</strong>" button may be used to write the displayed
Duplex Group identification information to the UR92(s). All values are checked for validity
before being written to the UR92(s). If any invalid values are found, the incorrect data will
be shown in red text and a message will be shown near the bottom of the tool, but no
information will be written to the UR92(s).</p>
<p>After changing the Digitrax Duplex Group identification information, it is necessary for
each Duplex throttle to join the network to learn the updated identification. Rejoining must
be done for each throttle. This tool cannot inform throttles that they will need to rejoin,
and cannot cause throttles to rejoin. Rejoining can be as simple as unplugging and plugging
each Duplex throttle into LocoNet, or done wirelessly on the DT402D. See DT402D throttle
instructions for information on wirelessly joining a Duplex Group network.</p>
<p>Changes to the Duplex Group identification information happens immediately when the
UR92(s) accept the Duplex Group identity information. Any Duplex throttle which was
communicating with a UR92 using the old Duplex Group identification information will no
longer be able to communicate with the UR92 until it re-joins the Duplex network using the
new Duplex Group identification information. Because of this, it is recommended that all
Duplex throttle users stop their trains and exit programming modes as necessary before
changing the Duplex Group identity information.</p>
<p>To ensure that the Duplex throttles understand <em>any</em> changes to the Duplex Group
identity information, it is necessary for each throttle to join the Duplex Group network. See
throttle documentation for details on joining the Duplex Group network. Re-joining may be as
simple as plugging the throttle into a LocoNet jack. Re-joining may be done on the DT402D
throttle by "find"ing the Duplex Group name on the correct Duplex Group channel, and, if
necessary, entering the Duplex Group password.</p>
<p>The "<strong>Read Group Information</strong>" button may be used to request a read of
Duplex Group identity information from UR92(s) on LocoNet. This will refresh the displayed
Duplex Group identity information and UR92 count information based on the response(s) from
the UR92 devices.</p>
<h3 id="Fields">The Duplex Group Identification Fields</h3>
<p>A Duplex Group is identified by a Duplex Group Name, a Duplex Group "Password" a Duplex
channel number, and a "Duplex Group ID". Each of these is described below.</p>
<h4 id="NameField">Duplex Group Name</h4>
<p>The Duplex Group Name is a field of 8 characters which is used to help distinguish one
Duplex Group network from another. It may be configured with an 8 character text message
which is meaningful to the user.</p>
<p>The Duplex Group Name is stored in the UR92(s). Each Duplex-capable throttle must be
configured to a specific Duplex Group Name in order to be able to communicate with a
UR92.</p>
<p>If you enter a Duplex Group Name with less than 8 characters, this tool will automatically
add spaces after the characters you have entered to fill it out to 8 characters. When
entering the Duplex Group Name on a DT402D, a Duplex Group Name of less than 8 characters
must similarly be padded with spaces to fill it out to 8 characters.</p>
<p>If you enter more than 8 characters, this tool will report an error message in the status
line at the bottom of the tool window, as shown below. The tool will not update the Duplex
Group identification information in the UR92(s) if this field (or any other field) contains
unacceptable data.</p>
<p><img src="./SampleInvalidSetting.png" alt="Tool showing too many name characters">
</p>
<h4 id="ChannelField">Duplex Group Channel</h4>
<p>The Duplex Group Channel number controls which frequency band the UR92(s) and throttle(s)
will use to communicate. By default, the UR92 uses Duplex Group Channel number 11. The
Digitrax Duplex radio system supports channel numbers 11 through 26 (inclusive).</p>
<p>If an invalid Duplex Group Channel Number is entered, this tool will report an error
message in the status line at the bottom of the tool window.</p>
<p>Because there are other electronic communication systems which may use the same frequency
bands which are available to the Digitrax Duplex radio system, it may be useful to select a
Duplex Group Channel number other than the default.</p>
<h4 id="PasswordField">Duplex Group Password</h4>
<p>The Duplex Group Password is a four character security code which can be used to control
access to a Duplex Group network. It is stored in the UR92(s).</p>
<p>The Duplex Group Password is always four characters. The Duplex Group Password may contain
characters between 0 and 9 (inclusive). Although not documented by Digitrax, the UR92 and
DT402D also support the use of the characters "A", "B", and "C". This tool supports use of
these additional characters. <em>To help ensure compatibility with future Digitrax devices,
it is advised that the password characters should be chosen to use only the numbers 0 through
9 (inclusive); the letter characters should not be used.</em></p>
<p>If an invalid Duplex Group Password is entered, this tool will report an error message in
the status line at the bottom of the tool window.</p>
<p>A Duplex throttle does not need to know the Duplex Group Password if joining a Duplex
Group network by plugging into the LocoNet. When the Duplex Group Password is "0000",
untethered DT402D throttles can join the Duplex Group network easily and without entering a
Password. As such, a Duplex Group network which is configured with a Duplex Group Password of
"0000" should be considered un-secured.</p>
<p>When the Duplex Group Password is other than "0000", untethered throttles may only join a
Duplex Group network if the tetherless throttle user enters the correct Duplex Group Password
when attempting to join the network. Since UT4D throttles do not allow the user to enter the
Duplex Group Password, a UT4D must be plugged into LocoNet to join a Duplex Group network
when that network uses a Duplex Group Password that is other than "0000".</p>
<p>For a variety of technical reasons, the Duplex Group Password cannot provide a
highly-secured Duplex wireless network. Please do not expect the Duplex Group password system
to prevent unauthorized users from joining the Duplex network.</p>
<h4 id="GroupIdField">Duplex Group ID</h4>
<p>The Duplex Group ID number is a number between 0 and 127. The UR92 device(s) stores and
reports the Duplex Group ID setting. It appears that the UR92, DT402D, and UT4D do not make
any active use of this setting. Changing the Duplex Group ID number does not appear to have
any effect on operation of the Duplex Group network.</p>
<p><em>The default Duplex Group ID setting of 0 is recommended to help ensure compatibility
with future Digitrax devices.</em>
</p>
<h2 id="Scanning">The Channel Scan Tab</h2>
<p>The Channel Scan tab allows the user to temporarily use the UR92(s) to "scan" the Duplex
Radio channels for interfering signal sources. Results are shown graphically, in a way
similar to that used by the Digitrax "DigiGroupSetup" program.</p>
<p>The Channel Scan is started by pressing the "<strong>Scan Duplex Channels</strong>"
button. This begins a loop which scans each available Duplex Group channel number
sequentially, then repeating, for a total of 25 scans of each channel. As each channel is
scanned, the graphical chart area is updated to show the channel being scanned, the reported
signal strength, and the average and maximum signal strength reported for the channel. The
channel being scanned is indicated by a diamond-shaped icon which is shown just above the
channel number near the bottom of the graphical area.</p>
<p>The data reported by the UR92(s) is shown graphically on the chart, with a light blue
vertical bar shown for each channel as it is scanned, a red horizontal line which represents
the highest value reported for the channel, and a green horizontal line which represents the
average value reported for the channel.</p>
<p>Values higher on the chart indicate stronger interfering sources than values shown lower
on the chart.</p>
<p>The chart also shows a horizontal dashed yellow line, which corresponds roughly to the
dashed yellow line shown on the Digigrax "DigiGroupSetup" program channel scan display. It is
believed that this Digitrax may intend this dashed yellow line to represent a recommendation
for maximum amount of interfering radio signal.</p>
<p>The best Duplex Group channel to use is one which <em>never</em> has any interfering radio
signals. In this case, the red line for the channel will be shown at the bottom of the chart,
indicating a very low maximum interfering radio signal strength. In some environments, there
may be not be any channels where the maximum interfering signal strength is very low. In this
case, choose a Duplex Group channel number where the maximum interfering signal strength is
lowest. It may be advisable to run the radio scan occasionally to determine that the radio
signal environment has not changed over time.</p>
<p>The image below shows a sample Channel Scan tab display. Note the diamond above the lower
line showing channel numbers - it indicates the channel being scanned at that time.</p>
<p><img src="SampleScanDisplay.png" alt="Sample Channel Scan display">
</p>
<p>The image below shows a sample Channel Scan tab display which has indicates some channels
which should be avoided due to high levels of radio signal from interfering sources.</p>
<p><img src="SampleBadChannels.png" alt="Sample Channel Scan display with bad channels">
</p>
<h3 id="ScanningLimitations">Channel Scan Limitations</h3>
<ul>
<li>
<p>The UR92 mechanism which measures interfering radio signals is one which acts for a
very short period of time. Many possible interfering radio signal sources only generate
interfering signals for very short periods of time or at random intervals. The
measurement mechanism can only report strength from an interfering source if the
measurement is taken when the interfering source is transmitting. This makes it likely
that a given scan operation can "miss" the signal from an interfering source. By
executing the measurements for each channel 25 times, the tool attempts to increase the
chance of seeing interfering sources. The user can run additional scans without clearing
previous scan data to increase the chances of measuring interfering radio signals.
times</p>
</li>
<li>
<p>When the channel scan is being performed, the UR92 cannot be relied upon to pass radio
signals between Duplex throttles and LocoNet.</p>
</li>
<li>
<p>When performing the channel scan operation, the UR92(s) can interpret radio traffic
from Duplex throttles as signal sources. To prevent improper interpretation of Duplex
throttle activity as interfering sources, remove batteries from all Duplex throttles and
unplug them from LocoNet for the duration of the channel scan operation.</p>
</li>
<li>
<p>If multiple UR92s are connected to LocoNet, each one will report a value for the
channel scan operations. The tool will properly update the maximum and average lines
based on the data from channel scan reports from UR92s, but the light blue bar will only
reflect the last scan report seen for the channel. So in some cases, the chart can show a
maximum line for a channel where the light blue bar has only been shown at lower
heights.</p>
<p>When multiple UR92s are installed, it might be useful to generate a separate chart for
each UR92 acting alone (by disconnecting all other UR92s from LocoNet and power), and
then comparing the charts. It may be possible to generate separate charts to help
identify possible stationary interference sources by relating signal strength seen on
specific channels to UR92 location. Presumably, a stronger signal reading implies a
closer interference source.</p>
</li>
</ul>
<h2 id="Notes">Notes</h2>
<ul>
<li>
<p><strong>Multiple UR92s with Differing Duplex Group Identification
Information:</strong> A Duplex throttle will only communicate with UR92s which use
identical Duplex Group Identification information to the network which it has most
recently joined. If any UR92 on LocoNet is configured differently, it will not establish
communication with the throttle.</p>
<p>When a Duplex throttle is plugged into LocoNet, it queries (reads) the Duplex Group
Identification from the UR92. If more than one UR92 is attached to LocoNet, each will
respond with its Duplex Group Identification information, but the throttle will only
accept the information from the first response. It is impossible to predict which UR92
will reply first. Therefore, it is important for all UR92s to have the same Duplex Group
Identification information.</p>
<p>Any time when this tool queries (reads) the UR92 Duplex group information, it displays
only the first Duplex Group information which it receives. If any UR92 reports Duplex
Group information which is different from the first UR92 reply, this tool will provide a
message in the status line stating that differing Duplex Group identification was
reported, as shown above.</p>
<p>This is an indication that at least one UR92 is configured with differing Duplex Group
Identification - for best Duplex throttle operation, the user should set the Duplex Group
information to a common identity. This can be done using the "Set Group Information"
button or using the procedure documented in the Digitrax DT402D documentation.</p>
</li>
<li>
<p><strong>Multiple UR92s on LocoNet:</strong> When adding a UR92 to a LocoNet which
already has one or more UR92 devices installed, there can be some confusion as to which
Duplex Group information is used - the information from the existing UR92(s) or from the
new one. To resolve this issue, Digitrax recommends that the user turns track power off
then back on when installing a new UR92. Upon receipt of a "Track Power On" message, the
UR92s will negotiate and automatically change all UR92s to one of the sets of Duplex
Group information. The Duplex Group information from the previously-existing UR92(s)
might NOT win this negotiation, so the Duplex Group information might be set to match the
new UR92.</p>
<p>Alternately, when adding a UR92 to a LocoNet which already has one or more UR92
devices installed, this tool can be used to help configure all UR92s to the
previously-configured settings from the old UR92(s). First install the new UR92 on
LocoNet and then start this tool.</p>
<p>If this tool shows the desired Duplex Group Identity information when started, simply
click the "<strong>Set Group Information</strong>" button to update all UR92s to the
desired configuration.</p>
<p>If this tool instead shows the Duplex Group Identity information from the new UR92,
simply click the "<strong>Read Group Information</strong>" button to re-query the system.
Repeat this if necessary until the previously-configured settings from the old UR92(s)
appear. Then click the "<strong>Set Group Information</strong>" button to update all
UR92s to the desired configuration.</p>
</li>
<li>
<p><strong>UR92 Reset to Factory Default:</strong> The user may reset a UR92 to its
factory-default Duplex Group information by holding down the UR92's reset button for
about 5 seconds while the UR92 is powered. The UR92's red and lights will flicker for a
few seconds while the reset process completes. After resetting a UR92 to its factory
defaults, the user may use this tool's "Read Group Information" to refresh the tool
display. Resetting one UR92 has no direct effect on other UR92s on LocoNet and can result
in use of different Duplex Group identification information in the UR92s. This tool's
"Set Group Information" can be used to write the displayed Duplex Group identification
information to all UR92s to ensure use of consistent Duplex Group identification
information by all UR92s on LocoNet.</p>
</li>
<li>
<p><strong>Duplex Group Identification Changes by Other Agents:</strong> This tool's
display will be updated only when the tool receives a response to its query for Duplex
Group information, including the query automatically made when this tool is opened. If
some other agent, such as a throttle, changes the Duplex Group information while this
tool is open, and the changed data is later reported on LocoNet, this tool will display
the status message "UR92(s) have different info than shown above." The tool's data entry
fields will <em>not</em> be updated to show the information from the LocoNet message.</p>
<p>The user may click the "<strong>Read Group Information</strong>" button to refresh the
data entry fields to find the Duplex Group information which was modified by some other
LocoNet agent.</p>
</li>
<li>
<p><strong>Duplex Group Name Characters:</strong> The DT402D can be used to select
characters which are not normally available on English-based computer platforms which are
configured for the English language. Generally, characters which show up on a "standard"
English keyboard should work properly with this tool. Characters known to be awkward
include the left-facing and right-facing arrows (on the DT402D display) and the tilde
("~") character on the PC keyboard. Operation of this tool for non-PC and/or non-English
platforms has not been tested by this tool's original author. Operation of this tool has
only been tested by the tool's original author using Digitrax Duplex equipment sold for
use in the United States.</p>
</li>
<li>
<p><strong>Duplex Group Channel Number:</strong> The Duplex Group Channel Number is like
a television channel in that each channel number defines a unique frequency range for
communication. If you experience communication difficulties and suspect interferance from
other wireless devices, you may change the Duplex Group channel number to try a different
frequency range. All of the available Duplex Group channel numbers specify frequencies in
the 2.4 GHz "ISM" frequency range. Other wireless devices which operate in this frequency
range include WiFi networks, Bluetooth devices, 2.4 GHz cordless telephones, some
wireless video systems, and many other consumer, industrial, and medical wireless
devices.</p>
</li>
<li>
<p><strong>Duplex Group Password Characters:</strong> The DT402D and UR92 allow use of
characters "A", "B", and "C" in the Duplex Group Password, while Digitrax documentation
describes the password as being a 4 digit number between 0 and 9999. This software
supports "A", "B", and "C" in the Duplex Group Password. When entering a Duplex Group
Password on the DT402D keypad, the "C" character is entered using the pushbutton which
shows both a "C" and the number "12", not the pushbutton marked "CLOC" and "c".</p>
</li>
<li>
<p><strong>Count of UR92 Devices:</strong> The count of UR92s is used primarily to
provide a display of the number of UR92s found. The mechanism this tool uses to count the
number of UR92s connected to LocoNet sometimes does not provide an accurate count. An
inaccurate count does not prevent operation of this tool but may indicate that the UR92
devices are not properly communicating with LocoNet.</p>
<p>The user should compare this number against the known number of UR92s. If the reported
count does not match the number of UR92s known to be installed on LocoNet, the count can
be refreshed by clicking on the "<strong>Read Group Information</strong>" button. If the
count continues to be wrong, check for proper LocoNet and power wiring to all installed
UR92s.</p>
</li>
<li>
<p><strong>Non-connected UR92s:</strong> To the best knowledge of the author of this
tool, it is not possible to wirelessly connect two separate wired LocoNet segments. To
the best knowledge of the original author of this tool, it is not possible to affect the
Duplex Group identity information of any UR92 or any Duplex Group other than those which
are connected to the same wired LocoNet.</p>
</li>
</ul>
<h3 id="LNWISideEffects">Effect on LNWI device configuration</h3>
<p>Like the Digitra DigiGroupSetup program, this tool can have an effect on the LNWI
device.</p>
<p>If a LNWI device is connected to LocoNet and has certaion OpSw settings, when this tool is
used to configure the Duplex Group identity information, the LNWI device can also be
re-configured. The UR92 and LNWI are configured by default to use the same "name" and "net
number". They also, under the default configuration, configure their "channel" number to be
related but not identical values. This is summarized below:</p>
<ul>
<li>When the Duplex Group "name" is changed, the LNWI will inherit the same name if the
LNWI OpSw 11 is set to "t"hrown. If the LNWI OpSw 11 is set to "c"losed, then the LNWI will
ignore changes to the Duplex Group "name".</li>
<li>When the Duplex Group "channel" is changed, the LNWI will inherit a WIFI channel number
which is 10 less than the duplex group channel number if the LNWI OpSw 12 is set to
"t"hrown. If the LNWI OpSw 12 is set to "c"losed, then the LNWI will ignore changes to the
Duplex Group "channel" number. If the Duplex Group "channel" number is greater than 21,
then the LNWI seems to default to WIFI channel 1.</li>
<li>When the Duplex Group "net" number is changed, the LNWI will inherit the same "net"
number if the LNWI OpSw13 is set to "t"hrown. If the LNWI OpSw13 is set to "c"losed, then
the LNWI will ignore changes to the Duplex Group "net" number. Note that the Duplex system
seems to ignore the "net" number, but the LNWI does pay attention to the "net" number. Note
that it may be desirable to set LNWI OpSw 13 to "c" to avoid sharing the same frequency
spectrum between LNWI WiFi and Duplex operations - see <a href="#DuplexLnWiChannels">a note
on Duplex and WiFi frequency sharing</a>, below.
</li>
<li>When the Duplex Group "passcode" is set, the LNWI accepts the passcode if LNWI OpSw 17
is "c"losed and OpSw18 is "t"hrown, and uses this as a WiFi "WPA2" passcode. If LNWI OpSw
17 is "t"hrown or LNWI Opsw 18 is "c"losed, then the Duplex Group "passcode" is
ignored.</li>
</ul>
<p>Note that any time that the LNWI "name", "channel" number, "net" number, or "passcode" is
chaged, all LNWI WiFi connections are "dropped" it will need to be re-established using the
new WiFi SSID "connection name" and/or new security passcode.</p>
<h2 id="Interfere">Some possible interference sources</h2>
<p>All of the available Duplex Group channel numbers specify frequencies in the 2.4 GHz "ISM"
frequency range. Some electronic devices which are known to use the 2.4 GHz "ISM" frequency
range, and thus can interfere with Duplex radio operation include:</p>
<ul>
<li>2.4 GHz cordless telephones</li>
<li>WiFi networks</li>
<li>"Bluetooth" devices</li>
<li>2.4 GHz wireless video cameras</li>
</ul>
<p><a id="DuplexLnWiChannels">Note</a> that, by default, the LNWI "WiFi" device "channel"
shares some frequency spectrum with the Duplex "channel". This can cause "contention" between
the LNWI radio signal and the Duplex radio signal. Ideally, each radio system would operate
within non-overlapping frequency spectra. The table below summarizes the "overlap" between
WiFi channels and Duplex channels:</p>
<table border="2">
<tr>
<th class="ctr">WiFi Channel</th>
<th class="ctr">Overlapping Duplex Channels</th>
</tr>
<tr>
<td class="ctr">1</td>
<td class="ctr">11, 12, 13, 14</td>
</tr>
<tr>
<td class="ctr">2</td>
<td class="ctr">12, 13, 14, 15</td>
</tr>
<tr>
<td class="ctr">3</td>
<td class="ctr">13, 14, 15, 16</td>
</tr>
<tr>
<td class="ctr">4</td>
<td class="ctr">14, 15, 16, 17</td>
</tr>
<tr>
<td class="ctr">5</td>
<td class="ctr">15, 16, 17, 18</td>
</tr>
<tr>
<td class="ctr">6</td>
<td class="ctr">16, 17, 18, 19</td>
</tr>
<tr>
<td class="ctr">7</td>
<td class="ctr">17, 18, 19, 20</td>
</tr>
<tr>
<td class="ctr">8</td>
<td class="ctr">18, 19, 20, 21</td>
</tr>
<tr>
<td class="ctr">9</td>
<td class="ctr">19, 20, 21, 22</td>
</tr>
<tr>
<td class="ctr">10</td>
<td class="ctr">20, 21, 22, 23</td>
</tr>
<tr>
<td class="ctr">11</td>
<td class="ctr">21, 22, 23, 24</td>
</tr>
<tr>
<td class="ctr">12</td>
<td class="ctr">22, 23, 24, 25</td>
</tr>
<tr>
<td class="ctr">13</td>
<td class="ctr">23, 24, 25, 26</td>
</tr>
<tr>
<td colspan="2">Note that the table above reflects regulatory requirements for North
America only.</td>
</tr>
</table>
<p>As such, it may be appropriate to configure the LNWI so that it does not respond to Duplex
"channel" changes. This may be done by following the steps listed below:</p>
<ul>
<li>Set the LNWI to accept Duplex "channel" number writes (LNWI OpSw 12 = "t")</li>
<li>Use this tool to configure set the Duplex channel to give the desired LNWI channel,
which is 10 less than the Duplex "channel" number</li>
<li>Set the LNWI to ignore Duplex "channel" writes by setting LNWI OpSw 12 to "c"</li>
<li>)Use this tool to configure the desired "channel" number for use by the Duplex radio
system.</li>
</ul>
<h2 id="SimplexInteract">Digitrax Simplex radio system interaction</h2>
<p>It is believed that the Digitrax Simplex radio throttle system (UR91, DTx00R, DT402R,
UT4R) has no effect on the Duplex Channel Scan tool, because the Simplex radio throttle
system operates in the 915 MHz "ISM" frequency range, while the Duplex radio throttle system
operates in the 2.4GHz "ISM" frequency range.</p>
<p>Because the Simplex and Duplex radio systems use different radio frequency ranges, the
Duplex Channel Scan tool cannot be used to analyze the Simplex radio frequency range. To the
best knowledge of the tool's original author, the Simplex radio system does not provide any
mechanisms to allow creation of a similar tool for analyzing Simplex radio interference.</p>
<h2 id="SeeAlso">See Also</h2>
<p>The <a href="../locoid/LocoIdFrame.shtml">LocoNet ID Tool</a> allows reading and writing
the LocoNet ID number</p>
<p>Support for this software tool is available through the <a href=
"https://groups.io/g/jmriusers/">JMRI User forum at "groups.io"</a>. Digitrax does
<strong>NOT</strong> provide support for this tool.</p>
<p>The <a href="http://www.digitrax.com">Digitrax website</a> offers official Digitrax
documentation, their "Tech Support Depot", and the Digitrax program "DigiGroupSetup", which
is available for Windows operating systems.</p>
<p>LocoNet&reg; is a registered trademark of <a href="http://www.digitrax.com">Digitrax,
Inc.</a></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

@@ -0,0 +1,31 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>JMRI: Discover LocoNet SV1 Devices</title>
<meta name="author" content="Egbert Broerse">
<meta name="keywords" content="JMRI help send loconet svf1">
<!--#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>Discover LocoNet SV1 Devices</h1>
<p><span class="since">since 5.11.5</span>The "Manage LocoIO (LNSV1) Devices" tool lets
you list all connected LocoNet devices that respond to the LocoNet SV version 1 protocol.<br>
You find the tool in the LocoNet menu as long as a LocoNet connection is available.</p>
<p>As the tool is still under development, we advise to use it in combination with the "Show
Raw Data" option in the <a href="../locomon/LocoMonFrame.shtml">LocoNet Monitor</a> to check
for any additional responses rejected by the SV1 filters.</p>
<p>Read more on the tool <a href="../swing/lnsv1prog/Lnsv1ProgPane.shtml">here</a></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<!-- Copyright Bob Jacobsen 2008 -->
<html lang="en">
<head>
<title>JMRI: Discover LocoNet SV2 Devices</title>
<meta name="author" content="Egbert Broerse">
<meta name="keywords" content="JMRI help send loconet svf2">
<!--#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>Discover LocoNet SV2 Devices</h1>
<p>The "Send Discover SV2 Devices" tool lets you list all connected LocoNet devices that
respond to the SV version 2 protocol.<br>
You find the tool in the LocoNet menu as long as a LocoNet connection is available.</p>
<p>To debug unexpected results we advise to use this tool alongside the "Show
Raw Data" option in the <a href="../locomon/LocoMonFrame.shtml">LocoNet Monitor</a> to check
for any additional responses rejected by the SV2 filters.</p>
<p>Simply click "Discover" to start the discovery sequence.</p>
<p>After a maximum of 3 seconds all SV2 responses will be listed in the table.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,41 @@
<!DOCTYPE html>
<!-- Copyright Bob Jacobsen 2008 -->
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Send LocoNet Packet</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help send loconet packets">
<!--#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>Send LocoNet Packet</h1>
<a href="../../../../../html/hardware/loconet/images/Send_LocoNet_Packet_Plain.png"><img src=
"../../../../../html/hardware/loconet/images/Send_LocoNet_Packet_Plain.png" width="268"
height="156" alt="Send LocoNet Packet window" class="floatRight"></a><br>
The "Send LocoNet Packet" tool lets you directly command LocoNet devices.
<p>It works best in combination with the "Show Raw Data" option in the <a href=
"../locomon/LocoMonFrame.shtml">LocoNet Monitor</a>, because packets are entered here in raw
hexadecimal format.</p>
<p>The top section of the window lets you send a single LocoNet packet. Just type the packet
contents as hexadecimal numbers, for example "83 7C", and click "Send". You should include
the byte for the checksum at the end of the message.</p>
<p>The bottom section lets you enter from one to four packets that will be repeatedly sent in
sequence, with user-defined delays in between. Press the "Go" button to start the
transmission sequence, and press it again to stop the sequence. <a href=
"../../../../../html/hardware/loconet/images/Send_LocoNet_Packet_Sequence.png"><img src=
"../../../../../html/hardware/loconet/images/Send_LocoNet_Packet_Sequence.png" width="267"
height="155" alt="Send LocoNet Packet window" class="floatRight"></a></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,83 @@
<!DOCTYPE html>
<!-- Copyright Bob Jacobsen 2008 -->
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure LocoNet ID</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help configure loconet ID">
<!--#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>Configure LocoNet ID Tool</h1>
<h2>What is LocoNet ID?</h2>
<p>The "LocoNet ID" is a number which is used by throttles and UR90, UR90X, UR91, UR92, and UR92CE
devices when a throttle is operating in a tetherless mode using infrared or simplex radio
communications. When receiving infrared signals, the UR90, UR90X, UR91, UR92 and UR92CE will only pay attention
to throttles which are using the same LocoNet ID number. When receiving simplex radio
signals, the UR91 will only pay attention to throttles which are using the same LocoNet ID
number.</p>
<p>The LocoNet ID number is intended to allow multiple Digitrax layouts to operate
independently when in close proximity. In this case, each each layout must use a different
LocoNet ID number.</p>
<p>If there are no other Digitrax layouts in close proximity, then there is no need to change
the LocoNet ID number.</p>
<p>When there is more than one UR9x device installed, it is important that all UR9x devices
use the same LocoNet ID number.</p>
<p>When there are no UR9x devices installed, this tool does not perform any useful
function.</p>
<h2>Using the LocoNet ID Tool</h2>
<p>The LocoNet ID Tool may be used to read and to change the LocoNet ID number.</p>
<p>Use the "Query" button to read the current LocoNet ID number. If a UR9x device responds to
the query, the reported LocoNet ID number will be updated in the tool.</p>
<p>To change the LocoNet ID number, use the pull-down box to select the desired LocoNet ID
number, then use the "Set" button to write the LocoNet ID number to the UR9x devices.</p>
<p>After changing the LocoNet ID number, all throttles capable of tetherless operation must
be un-plugged then plugged in to LocoNet so that they will accept the new LocoNet ID number.
<em>Failure to acquire this updated LocoNet ID number on a throttle will prevent the throttle
from communicating with the UR9x device via infrared and/or Simplex radio</em>.</p>
<h2>Note</h2>
<p>For the purposes of this discussion, the UR92CE is equivalent to the UR92. For clarity,
this discussion only shows the term "UR92".</p>
<h2>See Also</h2>
<p>For more information on the UR90 or UR90X and its infrared tetherless operation, see the
appropriate UR90 or UR90X link at the <a href="http://digitrax.com/menu_wireless.php">Digitrax
"Wireless" page</a>.</p>
<p>For more information on the UR91 and its infrared and "Simplex" radio tetherless
operation, see the appropriate link at the <a href=
"http://digitrax.com/menu_wireless.php">Digitrax "Wireless" page</a>.</p>
<p>For more information on the UR92 and its infrared and "Duplex" radio tetherless operation,
see the appropriate link at the <a href="http://digitrax.com/menu_wireless.php">Digitrax
"Wireless" page</a>.</p>
<p>The UR93 does not support infrared.</p>
<p>See also page 98 of the Digitrax <a href=
"http://www.digitrax.com/ftp/superchief.pdf">Super Chief manual</a>(PDF).</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,175 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Monitor LocoNet Traffic</title>
<meta name="author" content="Bob Jacobsen">
<meta name="author" content="B.Milhaupt">
<meta name="keywords" content="JMRI help monitor loconet traffic message packet">
<!--#include virtual="/help/en/parts/Style.shtml" -->
<!-- center class -->
<style>
.ctr {text-align: center;}
</style>
</head>
<body>
<!--#include virtual="/help/en/parts/Header.shtml" -->
<div id="mBody">
<div id="mainContent" class="no-sidebar">
<h1>Monitor LocoNet Traffic</h1>
<a href="../../../../../html/hardware/loconet/images/LocoMonFrame.png"><img src=
"../../../../../html/hardware/loconet/images/LocoMonFrame.png" width="300" height="150" alt=
"Command Station Slot Monitor" class="floatRight"></a><br>
The LocoNet Monitor tool displays LocoNet traffic in a human-readable form. The most recent
messages are available in a scrolling window. Optionally, you can include the time the
message was received, and/or the raw packet bytes. The log information can also be stored in
a text file.
<h2>LocoNet Monitor "Controls"</h2>
For more information on the various controls and options, please see the <a href=
"../../AbstractMonFrame.shtml">Communications Monitor Window page</a>.
<h2>LocoNet Monitor "Raw Data"</h2>
<p>When the LocoNet Monitor is configured to include "raw data" in its output, it
differentiates between messages sent by JMRI to the interface hardware and those messages
coming back from the LocoNet interface hardware. The "Raw data" for those messages which JMRI
sends to the LocoNet interface hardware are prefixed with "Tx - ". The "Raw data" for those
messages which the LocoNet interface hardware provides to JMRI are prefixed with "Rx - ".</p>
<h2>LocoNet Monitor Timestamps</h2>
<p>When Timestamps are enabled, each message is preceeded by the computer time when JMRI sees
the message. For a variety of technical reasons, these timestamps cannot reflect the actual
time when the message is on the LocoNet data wires.</p>
<p>Because of this, a wide range of odd effects can be seen. Two different messages can be
shown with the same timestamp. A transmit message and a receive message can have the same
timestamp. And a "Rx" message show up in the display before the "Tx" message is shown.</p>
<p>These behaviors are normal and expected, even though they can be annoying. These behaviors
result from a combination of the implementations of JMRI, Java, the computer operating
system, the computer hardware and the LocoNet interface hardware. As such, the JMRI
implementation has very little control over these odd behaviors, although the JMRI developers
have attempted to minimize the influence of these odd behaviors upon JMRI.</p>
<h2>Filtering LocoNet Messages</h2>
<p>Users may specify LocoNet "OpCode" values which should be filtered (ignored) by LocoNet
Monitor. Filtering messages in LocoNet monitor does <strong>not</strong> prevent messages
from getting to other JMRI components, and does <strong>not</strong> prevent messages from
being sent to the LocoNet interface hardware; filtering only affects the display of LocoNet
messages.</p>
<p>The "Filter Bytes:" text entry area on the LocoNet monitor window may be used to specify
one or more LocoNet message "OpCode(s)". When the LocoNet monitor is notified of a LocoNet
message, the message's OpCode value is compared to the hexadecimal value(s) in the "Filter
Bytes:" text entry area. If the message's OpCode value is specified in the text entry area,
then the LocoNet monitor will ignore the message.</p>
<p>A LocoNet OpCode value is entered as a two character hexadecimal value, such as "81", "A0"
and "E5", without quotes. When multiple OpCode values are to be filtered, provide a space
between each value, such as "81 E5 A0" (without quotes).</p>
<p>The filtering mechanism checks only the first byte of the LocoNet message. This means that
the filtering mechanism cannot specifically ignore those LocoNet messages which rely on more
than the OpCode value to define the specific LocoNet message. This is a known limitation of
the message filtering mechanism.</p>
<p>Specific information on many LocoNet OpCode values can be found in documentation provided
by Digitrax, while others are not publicly documented. Below is a short list of some OpCode
values and the associated LocoNet functionality.</p>
<table border='2'>
<tr>
<td class="ctr" colspan="2"><strong>Some LocoNet OpCode values and their
functionality</strong>
</td>
</tr>
<tr>
<td class="ctr"><strong>OpCode Value (Hexadecimal)</strong>
</td>
<td class="ctr"><strong>Functionality</strong>
</td>
</tr>
<tr>
<td class="ctr">81</td>
<td>Master (command station) is busy</td>
</tr>
<tr>
<td class="ctr">B0</td>
<td>Control switch position (without acknowledgment)</td>
</tr>
<tr>
<td class="ctr">B1</td>
<td>Switch position report</td>
</tr>
<tr>
<td class="ctr">B2</td>
<td>General sensor state report</td>
</tr>
<tr>
<td class="ctr">B4</td>
<td>Long acknowledge - sent by command station in response to a large variety of LocoNet
messages</td>
</tr>
<tr>
<td class="ctr">B8</td>
<td>Unlink (de-consist) two slots</td>
</tr>
<tr>
<td class="ctr">B9</td>
<td>Link (consist) two slots</td>
</tr>
<tr>
<td class="ctr">BC</td>
<td>Request current position of Switch</td>
</tr>
<tr>
<td class="ctr">BD</td>
<td>Control switch position</td>
</tr>
<tr>
<td class="ctr">E4</td>
<td>Uhlenbrock LISSY automatic train detection and RFID tag readers</td>
</tr>
<tr>
<td class="ctr">E7</td>
<td>Slot data report - locomotive control, programming track, fast clock, etc.</td>
</tr>
<tr>
<td class="ctr">ED</td>
<td>Mobile decoder function control (F9-F28), control of some stationary decoders,
etc.</td>
</tr>
<tr>
<td class="ctr">EF</td>
<td>Write slot - locomotive control, programming track, fast clock, etc.</td>
</tr>
</table>
<p>Detailed descriptions of LocoNet message OpCodes are beyond the scope of this
document.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,93 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: LocoNet Statistics</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help digitrax downloader">
<!--#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>LocoNet Statistics</h1>
<p>Advanced LocoNet interfaces like the LocoBuffer series from RR-CirKits or the PRn series
from DIgitrax collect statistics on the operation of the attached LocoNet. This window
displays those.</p>
<p>The "Update" button requests information from the interface for display.</p>
<h2>LocoBuffer Values</h2>
<dl>
<dt>Version</dt>
<dd>The version number of the unit.</dd>
<dt>Breaks</dt>
<dd>The number of LocoNet breaks seen since the last time the interface was powered on.
This is the number of times that the locobuffer sees a problem with its output message to
the loconet and issues a break, that tells the devices that are receiving the data to throw
that packet away and the locobuffer then resends the packet.</dd>
<dt>Errors</dt>
<dd>The number of LocoNet errors seen since the last time the interface was powered on.
This happens when the Locobuffer detects a problem on a packet it is receiving off the
loconet. This should be a result of the sending device seeing a problem with the packet it
is sending and issuing a break. The data is not lost when this happens, the sending device
then sends the packet again. The worst case is if the Locobuffer seeing a problem with a
packet it is receving and the transfitting device does not. The packet is then lost.</dd>
</dl>
<h2>Digitrax PRn</h2>
<dl>
<dt>Serial Number</dt>
<dd>The serial number of the unit.</dd>
<dt>PR2 Status</dt>
<dd>The status bits from an interface in PR2 (programmer) mode.</dd>
<dt>Current</dt>
<dd>The current being drawn by the track, in some arbitrary units.</dd>
<dt>Hardware Version</dt>
<dd>The version number of the interface's hardware.</dd>
<dt>Software Version</dt>
<dd>The version number of the interface's software.</dd>
<dt>Good Message Count</dt>
<dd>The number of good LocoNet messages seen since the last time the interface was powered
on.</dd>
<dt>Bad Message Count</dt>
<dd>The number of bad LocoNet messages seen since the last time the interface was powered
on.</dd>
<dt>MS100 Status</dt>
<dd>The status bits from an interface in MS100 (LocoNet adapter) mode.</dd>
</dl>
<p>Some of these are displayed when the interface is acting as a programmer (PR2 mode), and
others when it's acting as an interface (MS100 mode).</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,67 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure Digitrax PM4</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help configure loconet PM4">
<!--#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">
<a href="PM4xConfigTool.png"><img src="PM4xConfigTool.png" style="float:right; margin: 5px;"
alt="PM4x Configuration Tool Screen Capture"></a>
<h1>Configure Digitrax PM4x</h1>
<p>The JMRI PM4x programming tool lets you configure the internal options of a PM4 or PM42
directly from your computer.</p>
<p>To open this tool from the JMRI start page select the LocoNet tab then find the tool on
the drop down list.</p>
<p>To use it, you put the address of a PM4x board in the text field and click "Read from
PM4x". The tool will read back the current state of the various options, and set the check
boxes to correspond to their current values.</p>
<p>You can then, if you wish, change the checkboxes and click "Write to PM4x" to make your
changes permanent.</p>
<p>The tool relies upon each PM4x board to have a unique "Board ID" (Board Address) in order
to configure each device individually. While it is possible to change the Board ID number
using JMRI, it cannot be done using this tool due to limitations of the PM4x design. Instead,
follow the instructions found <a href=
"../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>, but you must
consult the appropriate PM4x manual and modify the JMRI-based process to suit the PM4x
device's buttons, button press time, and lamp flashes.</p>
<h2>Limitations</h2>
<ul>
<li>This tool is able to access PM4x boards with addresses between 1 and 256. Users are
advised to avoid using the factory default board address (board address 1) as it will be
difficult to program new boards with unique data if any in-service board is using the
factory default board address.</li>
<li>Because of the way the PM4x board works, this tool can't change the basic address of
the unit. The PM4x documentation describes how to change the board address. It is possible
to change the Board ID number using JMRI by following the instructions found <a href=
"../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>. Note that it
is necessary to consult the appropriate PM4x manual and modify the JMRI-based process shown
at the link above to suit the PM4x's buttons, button press time, and lamp flashes.
</li>
</ul>
<h2>See Also</h2>
<p>Documentation for the PM4 and PM42 can be found at the <a href=
"http://www.digitrax.com">Digitrax Web Site.</a></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: Select PR3 Mode</title><!--#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">
<h2>JMRI: Select PR3 Mode</h2>
A <a href="../../../../../../html/hardware/loconet/PR3.shtml">Digitrax PR3</a> can act either
as a stand-alone programmer, or as an interface to a LocoNet, but it can only do one at a
time. Normally, you choose the PR3 mode as part of <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">setting the JMRI preferences</a>.
<p>In some cases, you might want to quickly change the mode during debugging. This tool
provides two buttons to allow you to change the PR3's mode immediately. <em>Note that this
may result in unusual (and usually bad) behavior from the program!</em> It's generally better
to switch mode by changing the JMRI preferences and restarting the program.</p>
<p>For more information on the PR3, please see its <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">JMRI reference page</a>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: Select PR3 Mode</title><!--#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">
<h2>JMRI: Select PR3 Mode</h2>
A <a href="../../../../../../html/hardware/loconet/PR3.shtml">Digitrax PR3</a> can act either
as a stand-alone programmer, or as an interface to a LocoNet, but it can only do one at a
time. Normally, you choose the PR3 mode as part of <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">setting the JMRI preferences</a>.
<p>In some cases, you might want to quickly change the mode during debugging. This tool
provides two buttons to allow you to change the PR3's mode immediately. <em>Note that this
may result in unusual (and usually bad) behavior from the program!</em> It's generally better
to switch mode by changing the JMRI preferences and restarting the program.</p>
<p>For more information on the PR3, please see its <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">JMRI reference page</a>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,160 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: SDF Sound File Editor</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help Digitrax SDF Sound File Editor">
<!--#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>SDF Sound File Editor</h1>
<p>Digitrax sound decoders are loaded with "sound projects", stored in "Sound Project" (.spj)
files. Those contain a number of "sound fragments" in .wav format, plus a small program that
tells the decoder when to play the various sounds, and controls the use of functions and CVs.
That program is stored in a "Sound Definition" (SDF) format.</p>
<p>The SDF Sound File Editor allows you to make certain kinds of changes to the SDF
information in a sound project. It's used with the <a href=
"../soundloader/EditorFrame.shtml">SPJ editor</a> because the SDF information is stored in a
Digitrax SPJ sound project file. After you edit the SDF information, you can save it to a
file from the <a href="../soundloader/EditorFrame.shtml">SPJ editor</a>, and then download it
to a Digitrax sound decoder with a Digitrax PR2 or PR3 and the <a href=
"../soundloader/LoaderFrame.shtml">JMRI sound downloader tool</a> or the Digitrax SoundLoader
program.</p>
<p>Digitrax provides sample sound project files at their Sound Depot <a href=
"http://www.digitrax.com/sounddepot.php">(http://www.digitrax.com/sounddepot.php)</a> web
site. You can also find links to documentation and additional tools there.</p>
<p>When you open the SDF editor by clicking the "Edit" button in the <a href=
"../soundloader/EditorFrame.shtml">SPJ editor</a>, a new window opens that has two parts:<br>
<a href="SdfInitSound.gif"><img src="SdfInitSound.gif" width="415" height="235" alt=
"SDF Editor"></a><br>
On the left is a view of the entire SDF information as a tree of nested elements. On the
right is a window that shows additional information on the element that's selected on the
left.</p>
<p>The right hand window has the "assembly" format for the selected element at the top, then
an explanation of what the element does in the middle. If an editor for that particular type
of element has been defined, the section at the bottom will have checkboxes and selection
boxes for modifying the content of the element.</p>
<h2>SDF Structure</h2>
Sound definitions define a series of layers that together control the decoder. By opening and
closing the icons on the left side of the editor window, you can explore the structure of a
sound definition. Feel free to explore! Until you save the file, you can't actually hurt
anything.
<h3>Scheme</h3>
At the top level are "schemes", which are like programs for the decoder. A decoder can only
be using one scheme at a time, although there can be several present in memory at once. The
schemes are numbered, starting with 0, and the active scheme is selected via the contents of
CV. Scheme 31 marks the end of the file.
<p>There are no options to the scheme itself for you to edit, but you can open the scheme to
work with its contents.</p>
<p>The first element of a scheme is a version number tag. These defines the format used to
store the scheme's contents. Currently, only version 1 is a defined format.</p>
<p>After the version tag, one or more "channels" are defined.</p>
<h3>Channel</h3>
The decoder hardware is capable of handling several things at once. These are called
"channels", and one or more of them make up each scheme. How many there can be depends on the
specific decoder hardware, but it's quite common to see four channels within a scheme.
<p>Although all the channels can be playing sounds simultaneously, each channel can only play
one sound (one .wav fragment) at a time. The purpose of the commands within the channel is to
define which sounds it should play, and when they should start and end.</p>
<p>The channel element itself has no options for you to edit, but you can open it and work
with its contents.</p>
<h3>Sequence</h3>
Within each channel, there can be one or more sequences. Each one has a condition under which
it starts, and then a series of operations to take then it's started.
<p>The operations can be things like starting to play a particular sound, or modifying how a
sound is played, or changing various information internal to the decoder. When the sequence
is started, it runs right to the end, leaving behind things for the decoder to do in the
future. For example, it can define which sound fragment to play next when the current one is
done, or stop the sound that's currently being played by the channel and start a new one.</p>
<p>The sequence starts when a trigger condition becomes true. You can examine and change the
trigger condition using the lower-right part of the editor frame. Some examples include:</p>
<ul>
<li>Trigger when a function becomes true, e.g. when the user sets F1 on.</li>
<li>Trigger on how the decoder is controlling the locomotive, for example:
<ul>
<li>when the motor speed increases</li>
<li>when the motor direction changes</li>
<li>when the motor starts moving</li>
</ul>
</li>
<li>Trigger on other events from the outside, such as:
<ul>
<li>when the chuff cam goes active</li>
<li>when a CV is written in ops mode</li>
<li>when an input connection goes active</li>
</ul>
</li>
</ul>
There are a lot of possibilities, which are listed in the selection box and (partially)
documented on a <a href="TriggerConditions.shtml">separate page</a>.
<p>There are also four options that can be selected to change when the sequense is
started:</p>
<dl>
<dt>Zap</dt>
<dt>Run while triggered</dt>
<dt>No preemptive trigger</dt>
<dt>Not triggered</dt>
<dd>The sequence starts when the opposite condition happens. For example, if the trigger is
"When F1 goes active", and this option is selected, the sequence will start when F1 goes
inactive.</dd>
</dl>
<p>Each sequence contains one or more instructions, the last of which has to be an "End
Sequence" instruction.</p>
<h3>Instructions</h3>
Within each sequence are instructions that tell the decoder what to do as it's processing the
sequence. We describe the most important ones here.
<h4>Play Fragment</h4>
<h4>Set Modifier</h4>
<h2>Examples</h2>
(Provide some fragments of code here as examples)
<h2>Status and Future Work</h2>
<img src="../../../../../images/bangdesk.gif" class="floatRight" height="45" width="45" alt=
"Cute image of work"> This editor tool is still very much a work in progress. It's good at
browsing the content of the file, but it needs a lot more explanatory text added. Also, it
currently only provides a way to make small changes to the contents of an SDF file, but
doesn't (yet) allow you to make larger changes to structure of the file. For example, if you
selected an "Initiate Sound" element, which tells the decoder to start playing a sound under
certain conditions, you can change those conditions. But the editor (at present) doesn't
provide a way to add new "Initiate Sound" elements.
<p>The editor is meant to be a beginner's tool, and we need a lot of explanatory text on each
window so people know what the options do.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

@@ -0,0 +1,127 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: SDF Trigger Conditions</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help Digitrax SDF Sound File Editor">
<!--#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>SDF Trigger Conditions</h1>
This page documents the meaning of the trigger conditions that can defined in a Digitrax SDF
instruction.
<dl>
<dt>TRIG_NEVER</dt>
<dd>Never triggers. This can be used to disable part of a SDF file.</dd>
<dt>TRIG_MODE_CHNG</dt>
<dt>TRIG_MATH</dt>
<dt>TRIG_DISTANCE</dt>
<dt>TRIG_SPD_INC</dt>
<dd>Triggers when the motor speed is increased.</dd>
<dt>TRIG_SPD_DEC</dt>
<dd>Triggers when the motor speed is decreased.</dd>
<dt>TRIG_CAM</dt>
<dd>Triggers on either the actual cam input, or the autochuff mechanism.</dd>
<dt>TRIG_NOT_TRIG</dt>
<dt>Function 0 On</dt>
<dd>Triggers when DCC function 0 is on.</dd>
<dt>Function 28 On</dt>
<dt>TRIG_DIRNOW_CHNG</dt>
<dd>Triggers when the direction of the motor is changed.</dd>
<dt>TRIG_MOVING</dt>
<dd>If the motor is currently running at a non-zero speed.</dd>
<dt>TRIG_SND_ACTV11</dt>
<dd>Function 11</dd>
<dt>TRIG_BSC0</dt>
<dd>Triggers when a "binary state change" DCC packet is received for BSC 0.</dd>
<dt>TRIG_BSC7</dt>
<dt>TRIG_IN_0</dt>
<dd>Trigger when the input connection goes active, usually used for a chuff input.</dd>
<dt>TRIG_IN_7</dt>
<dt>TRIG_NOTCH_CHNG</dt>
<dt>TRIG_TIME_16PPS</dt>
<dd>Triggers 16 times per second.</dd>
<dt>TRIG_FACTORY_CVRESET</dt>
<dt>TRIG_OPSPROGWR_CV</dt>
<dd>Triggers when a CV is written in ops mode (on the main).</dd>
<dt>TRIG_SCAT0</dt>
<dt>TRIG_SCAT7</dt>
<dt>T_SPD_MUTE</dt>
<dt>T_SPD_TURNON</dt>
<dt>T_SPD_IDLE</dt>
<dt>T_SPD_ACCEL1</dt>
<dt>T_SPD_ACC_CHNG</dt>
<dt>T_SPD_ACCEL2</dt>
<dt>T_SPD_IDLEXIT</dt>
<dt>T_SPD_RUN</dt>
<dt>T_SPD_DECEL1</dt>
<dt>T_SPD_DEC_CHNG</dt>
<dt>T_SPD_DECEL2</dt>
<dt>T_SPD_DEC_IDLE</dt>
<dt>T_SPD_TURNOFF</dt>
<dt>T_SPD_DEC_SP1</dt>
<dt>T_SPD_DEC_SP2</dt>
<dt>T_SPD_DIR_CHNG</dt>
</dl>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Configure Digitrax SE8c</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help configure loconet SE8C">
<!--#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>Configure Digitrax SE8c</h1>
<a href="SE8cConfigTool.png"><img src="SE8cConfigTool.png" alt=
"SE8c Configuration Tool Screen Capture" style="float:right; margin: 5px;"></a>
<p>The JMRI SE8c programming tool lets you configure the internal options of a Digitrax SE8c
Signaling Decoder Board directly from your computer.</p>
<p>To open this tool from the JMRI pane select the LocoNet menu and then find the tool on the
list.</p>
<p>To use it, you put the address of an SE8c board in the text field and click "Read from
SE8c". The tool will read back the current state of the various options, and set the check
boxes to correspond to their current values.</p>
<p>You can then, if you wish, change the checkboxes and click "Write to SE8c" to make your
changes permanent.</p>
<p>The tool relies upon each SE8C board to have a unique "Board ID" (Board Address) in order
to configure each device individually. While it is possible to change the Board ID number
using JMRI, it cannot be done using this tool due to limitations of the SE8C design. Instead,
follow the instructions found <a href=
"../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>, but you must
consult the SE8C manual and modify the JMRI-based process to suit the SE8C device's buttons,
button press time, and lamp flashes.</p>
<h2>Limitations</h2>
<ul>
<li>Because of the way the SE8c board works, this tool can't change the basic address of
the unit. It is possible to change the Board ID number using JMRI by following the
instructions found <a href=
"../../../../../html/hardware/loconet/Digitrax.shtml#deviceBoardId">here</a>. Note that it
is necessary to consult the SE8C manual and modify the JMRI-based process shown at the link
above to suit the SE8C's buttons, button press time, and lamp flashes.
</li>
<li>The SE8c can be configured to send Sensor status on the LocoNet in response to a "track
power on" command. The SE8c does not send Turnout status in response to a "track power on"
command.</li>
<li>This tool is able to access SE8c boards with addresses between 1 and 36. Users are
advised to avoid using the factory default board address (board address 1) as it will be
difficult to program new boards with unique data if any in-service board is using the
factory default board address.</li>
</ul>
<h2>See Also</h2>
<p>Documentation for the SE8c can be found at the <a href=
"http://www.digitrax.com/tsd/product/SE8C/">Digitrax Web Site</a>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
<!-- closes #mainContent-->
</div>
<!-- closes #mBody-->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

@@ -0,0 +1,108 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: LocoNet Slot Monitor</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help loconet slot monitor">
<!--#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>LocoNet Slot Monitor</h1>
<a href="SlotMonitorScreenShot.bmp"><img src="SlotMonitorScreenShot.bmp" width="365" height=
"263" alt="Command Station Slot Monitor" class="floatRight"></a>
<p>The Slot Monitor tool displays a table of the "command station slots'" contents. Slots are
used to control individual locomotives and consists. The display includes the decoder's speed
step format, current speed and function settings, consist information and status. You can
choose to show either all slots or just the ones being actively used.</p>
<p>The checkboxes at the top allow you to show just the active (in use) slots, or all
locomotive slots. You can also choose whether to show the "system" slots which don't carry
locomotive information.<br>
The "Estop All" button sets the speed of all the locomotives to "Emergency Stop" in one
action.<br>
The "Release all unused slots" button (not visible in this screen shot) will reclaim extra
slots in the Command Station.</p>
<p>The columns are:</p>
<dl>
<dt>Slot</dt>
<dd>The number of the slot</dd>
<dt>E Stop</dt>
<dd>Click this button to set the speed of the decoder to emergency stop</dd>
<dt>Address</dt>
<dd>The address of the locomotive the slot controls</dd>
<dt>Speed</dt>
<dd>For unconsisted locomotives and addresses that are the top of a consist, this is the
current speed setting. It's an internal value for consisted slots.</dd>
<dt>Status</dt>
<dd>The format of the commands being sent to the decoder, typically either 128 step, 28
step, or 14 step, though other values are possible.</dd>
<dt>Use</dt>
<dd>
Displays one of four possible states:
<dl>
<dt>Free</dt>
<dd>Not reserved for any particular use, no contents</dd>
<dt>Idle</dt>
<dd>Not reserved for any particular use, no contents</dd>
<dt>Common</dt>
<dd>Not in use at the moment, but still contains valid data for the last decoder to use
it.</dd>
<dt>In Use</dt>
<dd>Currently controlling a decoder</dd>
</dl>
</dd>
<dt>Free</dt>
<dd>Click this button to free the slot, so it can be reused for another locomotive.</dd>
<dt>Consisted</dt>
<dd>Displays the consist status of the slot, whether it's not consisted, the top of a
consist, included in a consist, etc.</dd>
<dt>Throttle ID</dt>
<dd>The ID of the throttle using this slot. It's displayed as two hexadecimal bytes. The
second pair can be configured into the throttle, see the Digitrax instructions.</dd>
<dt>Direction</dt>
<dd>Whether the decoder is currently being commanded to go Forward or Reverse.</dd>
<dt>F0-F8</dt>
<dd>The current function settings. A check mark indicates a function is On.</dd>
</dl>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

@@ -0,0 +1,114 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Sound Editor</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help sound editor"><!--#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>SPJ Sound File Editor</h1>
<p>Digitrax sound decoders are loaded with "sound projects", stored in "Sound Project" (.spj)
files. Those contain a number of "sound fragments" in .wav format, plus a small program that
tells the decoder when to play the various sounds, and controls the use of functions and CVs.
That program is stored in a "Sound Definition" (SDF) format.</p>
<p>The "Digitrax SPJ Editor" window allows you to examine and change the contents of a sound
project file. Once you've changed them, you can install them into your decoder with the
<a href="LoaderFrame.shtml">sound downloader</a>.</p>
<p>Digitrax provides sample sound project files at their Sound Depot <a href=
"http://www.digitrax.com/sounddepot.php">(http://www.digitrax.com/sounddepot.php)</a> web
site. You can also find links to documentation and additional tools there.</p>
<p>When you invoke the SPJ Sounds File Editor tool from the LocoNet menu, you first get a
file selection window:<br>
<img src="OpenFilePane.gif" width="240" height="61" alt="File selection window"></p>
<p>Click "Open File..." and select the .spj file that you'd like to work with. (The examples
on this page are from the Digitrax AC4400 example) The editor window will then expand to show
the content of the file:<br>
<a href="InitEditorPane.gif"><img src="InitEditorPane.gif" width="351" height="251" alt=
"Initial Editor Image"></a><br>
(Click on any of the images on this page to see a full size version)</p>
<p>Most of the content of a DIgitrax SPJ file is the individual .wav sound fragments. For
those, the columns of the table are:</p>
<ul>
<li>The number of the fragment</li>
<li>The type, WAV for .wav sound fragments</li>
<li>The short name given this fragment by the file's author</li>
<li>The handle number, which the SDF sound definition uses to refer to the sound</li>
<li>The original filename for this fragment</li>
<li>The fragments length in second</li>
<li>A button that plays the sound on your computers speakers</li>
<li>A "Replace" button</li>
</ul>
<p>If you click the "Replace" button on a sound fragment, a file selection window opens in
which you can select a new sound file (.wav file) which the replaces the original fragment.
The new file should contain 8-bit unsigned monaural sound sampled 11.025kHz. Other formats
might or might not work, but we know that this one does.</p>
<p>After making changes, you can click "Save" at the top of the editor window to save the
file with the original name, or (better) under another name. You can then use the <a href=
"LoaderFrame.shtml">Sound Downloader</a> tool to load the modified file into a Digitrax
decoder via a <a href="../../../../../html/hardware/loconet/PR2.shtml">PR2</a> or <a href=
"../../../../../html/hardware/loconet/PR3.shtml">PR3</a> interface.</p>
<p>SPJ files contains some additional parts, visible at the bottom of the list here:<br>
<a href="LowerEditorPane.gif"><img src="LowerEditorPane.gif" width="351" height="251" alt=
"Lower Editor Image"></a></p>
<p>The "comment" element contains human-readable information from the SPJ file's author, in a
specific format with other parts of DecoderPro are able to read. The View button shows it in
another window:<br>
<a href="CommentWindow.gif"><img src="CommentWindow.gif" width="360" height="316" alt=
"Comment View"></a></p>
<p>The ".map file" element contains the connection between sound names (3rd column) and
handle number (4th column) used by the SDF sound program. The View button shows it in another
window:<br>
<a href="MapPane.gif"><img src="MapPane.gif" width="82" height="237" alt="MAP View"></a></p>
<p>The "SDF" element contains the Sound Definition File (or Format) information that the
decoder uses to determine which sound fragments to show when. These are written in a form of
assembly language, written in a specific format. The file only contains the result of that
process; the human-readable source code is not stored in the SPJ file. Still, JMRI can
recreate it (except for the original spacing and comments) to give you a rough idea of the
content, and will show that in another window if you click the View button:<br>
<a href="SDFview.gif"><img src="SDFview.gif" width="620" height="439" alt="SDF View"></a><br>
JMRI also provides a limited capability to edit the SDF information using the <a href=
"../sdfeditor/EditorFrame.shtml">SDF Editor</a>. Click the "Edit" button to open a separate
SDF editor window, with its own <a href="../sdfeditor/EditorFrame.shtml">help page</a>.<br>
<a href="../sdfeditor/SdfInitSound.gif"><img src="../sdfeditor/SdfInitSound.gif" width="415"
height="235" alt="SDF Editor"></a></p>
<p>The "CV data" element isn't used by JMRI. DecoderPro uses another method for storing CV
information.</p>
<h2>Related Tools</h2>
The JMRI <a href="LoaderFrame.shtml">Sound File Downloader</a> lets you download SPJ sound
files to a Digitrax decoder if you have a Digitrax PR2 interface.
<p>The <a href="../sdfeditor/EditorFrame.shtml">SDF Editor</a>, referenced above, lets you
edit the SDF program within a SPJ file.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

@@ -0,0 +1,101 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: Sound Loader</title>
<meta name="author" content="Bob Jacobsen">
<meta name="keywords" content="JMRI help loconet sound loader">
<!--#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>Sound Loader</h1>
Digitrax sound decoders are loaded with "sound projects", stored in "Sound Project" (.spj)
files. Those contain a number of "sound fragments" in .wav format, plus some additional
control information.
<p>The Decoder Sound Downloader tool lets you load a new .spj file into a Digitrax sound
decoder via a Digitrax PR2 or PR3 interface. If you're using a PR3, it needs to be put into
"Programmer mode" before trying to download, see the main <a href=
"../../../../../html/hardware/loconet/PR3.shtml">PR3 page</a>.</p>
<p>Digitrax provides sample sound project files at their Sound Depot <a href=
"http://www.digitrax.com/sounddepot.php">(http://www.digitrax.com/sounddepot.php)</a> web
site. You can also find links to documentation and additional tools there.</p>
<p>JMRI also provides tools for <a href="EditorFrame.shtml">editing sound project files</a>
to include new sounds and even to <a href="../sdfeditor/EditorFrame.shtml">change the sound
logic</a>.</p>
<h2>Using the downloader</h2>
When you first select the Download Sounds tool, it opens a window with most of the controls
disabled:<br>
<a href="LoaderPane.gif"><img src="LoaderPane.gif" width="236" height="118" alt=
"Initial Editor Image"></a><br>
(Click on any image on this page to see a larger version)
<p>The status line at the bottom will walk you through the steps needed.</p>
<ol>
<li>First, click "Select" and pick the .spj file you want to download.</li>
<li>Next, click "Read" to read the file (this is a separate step so you can just click
"Read" multiple times if you're editing and saving new versions of the file).
<p>If everything is OK, the file will be read into the program and verified, a version
string from the file will be displayed, and the "Download" button will be enabled.</p>
<p><a href="LoaderPaneReady.gif"><img src="LoaderPaneReady.gif" width="236" height="118"
alt="Initial Editor Image"></a><br>
</p>
</li>
<li>Click "Download" to start the download process. It will take a little while. The
progress is described in the status line:
<dl>
<dt>"Starting download; erase flash"</dt>
<dd>The first step is to erase the decoders memory so it can take new data. This will
take up to about 30 secondx, depending on the specific decoder.</dd>
<dt>"Sending initialization message"</dt>
<dd>Set up the decoder to accept data after being erased. This should only take a
fraction of a second.</dd>
<dt>"Send SDF data"</dt>
<dd>Load the Sound Definition data into the decoder, which should only take a few
seconds</dd>
<dt>"Send WAV data"</dt>
<dd>The sound data is being downloaded. As each block is sent you'll get an update:
"Send WAV data block 1", then 2, then 3, etc.</dd>
<dt>"Done"</dt>
<dd>The downloadload completed OK.</dd>
</dl>
If something goes wrong, the final status will be "Download aborted". The most common
reason is that the PR2 couldn't handle the data that was being send, which is listed as
"PR2 not ready". If this happens repeatedly, make sure that the serial port and cable
that the PR2 is using as the control leads properly connected. An intermitted cable can
cause problems here.
</li>
</ol>
<p>If you have more decoders to load with the same file, you can just connect them each in
turn to the PR2/PR3 and click "Download", there's no need to reload the file each time.</p>
<p>Also, you can use a JMRI <a href=
"../../../../../html/tools/throttle/ThrottleMain.shtml">Throttle</a> to try out your new
sounds via the PR2. JMRI takes care of converting the PR2/PR3 from a programmer/loader into a
low power command station to run the locomotive.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

@@ -0,0 +1,150 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<title>JMRI: LocoNet LNCV Programming Pane</title>
<meta name="author" content="Egbert Broerse">
<meta name="keywords" content="JMRI help send loconet lncv uhlenbrock">
<!--#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>LocoNet > Manage LNCV Modules Pane</h1>
<p><span class="since">since 4.21.4</span>The "Manage LNCV Modules" tool lets you access
and program connected LocoNet devices that respond to the (Uhlenbrock) LNCV LocoNet
programming protocol.<br>
Examples are the Uhlenbrock Switch Module 63410 and Digikeijs DR5033 booster. You find the
tool in the LocoNet menu as long as a LocoNet connection is available.</p>
<img src="images/LNCVTool1.png" alt="Initial view of Manage LNCV Modules tool pane"> <img src=
"images/LNCVTool2.png" alt="Manage LNCV Modules tool pane with Article and Address filled in">
<p>You might use this tool in combination with the "Show Raw Data" option in the
<a href="../../locomon/LocoMonFrame.shtml">LocoNet Monitor</a> to check for any additional
responses rejected by the LNCV filters.</p>
<p>Unless a programming session is running, LNCV modules will not respond to Write commands
(the Read and Write buttons in the tool are only enabled during a session).</p>
<h2>Module LNCV Programming</h2>
<p>LNCV Programming requires 3 elements to address CVs in an LNCV module on LocoNet:</p>
<ol>
<li>Article Number (aka type/class/productID)</li>
<li>Module Address (optional, see below)</li>
<li>CV number</li>
</ol>
<p>Uhlenbrock and Digikeijs/Digirails publish the Article number for each (new) device. For
example, the Digikeijs DigiBoost DR5033 has Article number 5033, which was registered with
Uhlenbrock. The Uhlenbrock 63330 has Article number 6333, the Uhlenbrock 63410 has 6341
(skip last zero).<br>
Enter the Article number e.g. 5033 in the "Article" field before proceeding.<br>
Next, enter the Module Address in the corresponding field.</p>
<p>After opening a programming session, the "Open Module Programming" stays highlighted and
the Read and Write buttons are enabled.<br>
To close the programming of a module, click the same button, that now reads "Stop Module
Programming".<br>
While a programming session is running this button is highlighted and the Address field is
not editable, to prevent switching module address without first closing the session running.
Note that changing the module address stored in CV0 won't immediately halt the session, so
take care and close the current session before opening a new session on the new module
address.</p>
<p>For incidental programming, the tool allows reading and writing of individual CV
values.<br>
To read, enter a CV number in the fields on the right of the tool pane and click [Read] to
see the value in the Value field.<br>
To write, enter a CV number plus the new value to set in the CV, and click [Write].</p>
<p>LNCV Responses coming back from the layout will be listed in the LNCV Monitor, and the
devices sending a reply show up in the Devices table.</p>
<p>When your Roster contains (exactly) one entry for a decoder of this article number and
address, it will be listed in the table as the Roster Entry ID, as shown below.<br>
When you have a matching Roster Entry, the button in the Program column will read
[Program] and will directly open the Roster Entry tabs.</p>
<img src=
"images/LncvProgrammerPane.png" alt=
"Manage LNCV Modules tool can't find a matching definition">
<p>When no match was found in your Roster but a matching definition was found in the JMRI
Decoder Index, the button will read [Create Entry]. Click on it and enter an ID (name) for your new roster
entry.</p>
<img src="images/LNCVToolEntry.png" alt=
"LNCV Programming Tool ask for a name for the new Entry when you click Add Entry">
<p>After clicking [OK] the button is updated to [Program].</p>
<img src="images/LNCVTool3.png" alt="LNCV Programming Tool found a Decoder Entry and
shows Program button">
<p>Be sure to complete the Entry creation process by clicking [Save to Roster] on the
DecoderPro Roster Entry tab.</p>
<p>If your device responded to a general call but is not yet found in the Decoder Index,
the button will read [No Match in Roster].<br>
<span class="since">since 5.1.3</span>Click the button to get a dialog to recreate the
Decoder Index, as a new decoder file that was copied to the user files /decoder folder
might not yet be part of the Index.<br>
If that doesn't fix it, report your device on the jmri_users group or create an Issue in
GitHub.</p>
<h2>Broadcast LNCV Programming</h2>
<p>Older LNCV devices may not have their own address, or even no article ID. They can be
programmed using Broadcast mode, but you have to be sure only one such device is powered, as
they all would respond to programming commands.</p>
<p>Click "Start Broadcast Programming" to start a session.</p>
<p>To close a Broadcast session, click "Stop Broadcast Programming".</p>
<p>Using the universal address 65535 (or simply leaving the Article field empty) you can, as
the name suggests, call up all LNCV Adapters that want to respond (not all do).<br>
As the universal address is not valid for addressing specific modules, it can only be used to
call up an individual adapter for which the address is unknown. For this you connect ONLY the said
adapter to the LocoNet. The adapter can then be called up and its address read from LNCV
0.<br>
By only filling in an Article number (and leaving the address field empty) you can send a
Broadcast call to all devices of that specific type, and many devices will respond by
providing their DCC address, which will be added to the table.</p>
<p>Once you have the report back from the layout, click [Close Broadcast Session] to exit the
general access.<br>
Click on one of the rows to copy the address to the top, and click [Start Module Programming]
to continue.</p>
<h2>Direct Mode</h2>
<p>Check the 'Direct Mode' checkbox to access 16 state buttons to set LEDs etc. on
Uhlenbrock Track-Control items.</p>
<h2>LNCV Decoder definitions</h2>
With an LNCV Module Programming session (to a specific device) running, you can use the
Roster entry programming panes for more advanced (and accessible) configuration. Easily
switch to DecoderPro Roster either by clicking the [Program] button in the table or manually
open the entry for the module in your Roster entries list.<br>
Go to the "LNCV (Booster) Configuration" tab to read and write options supported by the
device.
<p>Anyone interested in writing their own LNCV decoder definitions in JMRI, please note that
in the definition programming mode should be defined as
<code>&lt;mode&gt;LOCONETLNCVMODE&lt;/mode&gt;</code>.<br>
The Article part (item 1. in the list above) must be defined in the definition as the<br>
<code>&lt;model productID="5033" /&gt;</code>. To process LNCV commands in JMRI
LnOpsProgrammer, elements 1. and 3. are combined into a single CV number as
"part_1.part_3".<br>
For example CV6 in the DR5033 is defined as:<br>
<span class="wide">
<code>&lt;variable CV="5033.6" readOnly="yes" item="Temperature"&gt;</code>
</span></p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

@@ -0,0 +1,114 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>JMRI: Configure LocoIO (LNSV1) Devices Tool</title>
<meta name="author" content="Egbert Broerse">
<meta name="keywords" content="JMRI help send loconet lnsv1 locoio">
<!--#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>Configure LocoIO (LNSV1) Devices Tool</h1>
<p><span class="since">since 5.11.5</span>The "Configure LocoIO (LNSV1) Modules" tool lets you access
and program connected LocoNet devices that respond to the LNSV version 1 LocoNet
programming protocol.<br>
Examples are the classic Jabour, HDL and GCA LocoIO boards. You find the
tool in the LocoNet menu as long as a LocoNet connection is available.</p>
<img src="images/LNSV1Tool1.png" alt="Initial view of LNSV1 Programming Tool pane">
<p>As this tool is new, you might use it in combination with the "Show Raw Data" option in the
<a href="../../locomon/LocoMonFrame.shtml">LocoNet Monitor</a> to check for any additional
responses rejected by the LNSV1 filters.</p>
<p>LNSV1 modules will respond to any Read and Write commands addressed to them
(only the Read button in the tool is enabled).</p>
<p>LNSV1 Responses coming back from the layout will be listed in the LNSV1 Monitor, and if not already in the
list, devices sending a read reply will be added to the Devices table.</p>
<h2>Module LNSV1 Programming</h2>
<p>LNSV1 Programming requires 3 elements to address an SV in an LNSV1 module on LocoNet:</p>
<ol>
<li>Low module address</li>
<li>High or module subaddress</li>
<li>SV number</li>
</ol>
<p>Enter the low address e.g. 81 in the field to the left of the slash, and enter the subaddress in the field
on the right.</p>
<p>After first starting the tool, existing LocoIO modules are detected on LocoNet. After a couple of seconds
they will appear in the table. Note the Version column and other properties.<br>
To repeat the probing, for example after you powered up a LocoIO, press the [Probe All] button at top left.</p>
<p>When your Roster contains (exactly) one entry for a decoder of the same DCC address (the value in the second
column), its name will be listed in the table as the Roster Entry ID, as shown below.<br>
When you have a matching Roster Entry, the button in the Program column will read
[Program] and will directly open the Roster Entry tabs.</p>
<img src="images/LNSV1Tool2.png"
alt="LNSV1 Programming Tool pane with one LNSV1 device selected and a No Match">
<p>When no match was found in your Roster, the button will read [No Match in Roster]. You may click on the
button to receive a short hint. That will tell you to open your Roster and
create a new Entry with the DCC address mentioned in the dialog.<br>
Be sure to complete the Entry creation process by clicking [Save to Roster] on the
DecoderPro Roster Entry tab.</p>
<p>When a matching DCC address was found in the Roster but that decoder doesn't support LNSV1
programming, we must assume it is a mismatch. Perhaps a decoder in one of the locos has the same address as one
of the LocoIO composite addresses.<br>
The button will read [Not for LNSV1] and you advised to change the LocoIO address.</p>
<h2>LNSV1 Read</h2>
<p>For incidental checking, the tool allows reading of individual SV values.<br>
<p>Click on one of the rows to copy a modules' address and SV last read to the top part of the pane.<br>
Enter an SV number in the SV: field on the right of the tool pane and click [Read] to
find the value returned in the Value: field.<br>
The [Write] button is disabled to prevent messing up the complicated LocoIO configuration variables (in contrast
to the <a href="../lncvprog/LncvProgPane.shtml">Configure LNCV</a> tool). DecoderPro <a
href="../../../../../../html/hardware/loconet/LocoIO.shtml">Programming on Main</a> gives you
access to the full suite in a consistent and accessible way.</p>
<img src="images/LNSV1Tool3.png"
alt="LNSV1 Programming Tool pane with a selected device and address filled in">
<h2>Broadcast LNSV1 Programming</h2>
<p class="important">Click "Probe All" to start a session.</p>
<p>Module addresses can be changed from this tool using Broadcast mode [Set All Addresses] button, but you have
to make sure only one such device is powered, as they will all respond to broadcast programming commands.</p>
<p>WARNING: this will change the SV1 and SV2 address values in ALL connected LocoIO family boards</p>
<img src="images/LNSV1BroadcastWarning.png" alt="LocoIO (LNSV1) Tool warning for Broadcast">
<h2>LNSV1 Decoder definitions</h2>
<p>You use the
Roster entry programming panes for advanced (and accessible) configuration changes. Easily
switch to DecoderPro Roster either by clicking the [Program] button in the LNSV1 table or manually
open the entry for the module in your Roster entries list.<br>
Go to the "LocoIO" or "Ports" tabs to read and write options supported by the device.</p>
<p>Anyone interested in writing their own LNSV1 decoder definitions in JMRI, please note that
in the definition the programming mode should be defined as
<code>&lt;mode&gt;LOCONETLNSV1MODE&lt;/mode&gt;</code>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: Send Throttle Message</title><!--#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>JMRI: Send Throttle Message</h1>
<p>JMRI has a limited ability to send messages to a hand-held throttle.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: Select DCS240 USB Mode</title><!--#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">
<h2>JMRI: Select DCS240 USB Mode</h2>
A <a href="../../../../../../html/hardware/loconet/DCS240.shtml">Digitrax DCS240</a> USB
interface can act either as a stand-alone programmer, or as an interface to a LocoNet, but it
can only do one at a time. Normally, you choose the USB mode as part of <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">setting the JMRI connection
preferences</a>.
<p>In some cases, you might want to quickly change the mode during debugging. This tool
provides two buttons to allow you to change the DCS240 USB mode immediately. <em>Note that
this may result in unusual (and usually bad) behavior from the program!</em> It's generally
better to switch mode by changing the JMRI preferences and restarting the program.</p>
<p>For more information on the DCS240, please see its <a href=
"../../../../../../html/hardware/loconet/DCS240.shtml">JMRI reference page</a>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>
@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
<!-- Copyright Bob Jacobsen 2008 -->
<title>JMRI: Select DCS52 USB Mode</title><!--#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">
<h2>JMRI: Select DCS52 USB Mode</h2>
A <a href="../../../../../../html/hardware/loconet/DCS52.shtml">Digitrax DCS52</a> USB
interface can act either as a stand-alone programmer, or as an interface to a LocoNet, but it
can only do one at a time. Normally, you choose the USB mode as part of <a href=
"../../../../../../html/hardware/loconet/PR3.shtml">setting the JMRI connection
preferences</a>.
<p>In some cases, you might want to quickly change the mode during debugging. This tool
provides two buttons to allow you to change the DCS52 USB mode immediately. <em>Note that
this may result in unusual (and usually bad) behavior from the program!</em> It's generally
better to switch mode by changing the JMRI preferences and restarting the program.</p>
<p>For more information on the DCS52, please see its <a href=
"../../../../../../html/hardware/loconet/DCS52.shtml">JMRI reference page</a>.</p>
<!--#include virtual="/help/en/parts/Footer.shtml" -->
</div>
</div>
<!-- close #mBody -->
<script src="/js/help.js"></script>
</body>
</html>