88 lines
3.4 KiB
Plaintext
88 lines
3.4 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<title>JMRI Hardware Support - OpenLCB Signal Masts</title>
|
|
<!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="Sidebar.shtml" -->
|
|
|
|
<div id="mainContent">
|
|
<h1>Hardware Support: OpenLCB Signal Masts</h1>
|
|
<em>JMRI support for OpenLCB is rapidly evolving; the actual code might be ahead or behind
|
|
the documentation on any given day.</em>
|
|
<p>This page describes JMRI's support for OpenLCB-native Signal Masts. It's part of JMRI's
|
|
<a href="index.shtml">documentation of its OpenLCB support</a>.</p>
|
|
|
|
<h2>OpenLCB Signal Masts</h2>
|
|
|
|
<p>A <a href="SignalMast.pdf">technical summary on masts</a> is available as a <a href=
|
|
"SignalMast.pdf">PDF document</a>.</p>
|
|
|
|
<h3>Names</h3>
|
|
Valid OpenLCB Signal Mast system names look like:
|
|
<ul>
|
|
<li>MF$olm:basic:one-searchlight($1)</li>
|
|
</ul>
|
|
where the parts are
|
|
<ul>
|
|
<li>M - The system connection; these need a specific connection ID to use</li>
|
|
|
|
<li>F - Indicates signal mast</li>
|
|
|
|
<li>$olm - indicates an OpenLCB mast</li>
|
|
|
|
<li>basic - signal system</li>
|
|
|
|
<li>one-searchlight - mast type</li>
|
|
|
|
<li>$1 - 1st mast (The $ indicates automatically assigned)</li>
|
|
</ul>
|
|
|
|
<h3>Adding and Editing OpenLCB Signal Masts</h3>
|
|
You add and/or edit OpenLCB Signal Masts via the Signal Mast Table using the usual "Add" and
|
|
"Edit" buttons. For adding, select "OpenLCB Event Mast" as the mast driver type. You'll then
|
|
get a pane that will let you configure a specific mast:
|
|
|
|
<p><a href="images/Add_OlcbSignalMast.png"><img src="images/Add_OlcbSignalMast.png" height=
|
|
"293" width="204" alt="empty signal definition"></a> <a href=
|
|
"images/Edit_OlcbSignalMast.png"><img src="images/Edit_OlcbSignalMast.png" height="290"
|
|
width="203" alt="sample signal definition"></a></p>
|
|
|
|
<p>Starting from the top of the pane, the options are:</p>
|
|
|
|
<ul>
|
|
<li>"This Mast can be unlit" - same as for other mast types, this tells the signal logic
|
|
that it's OK for this mast to be unlit (set to dark).</li>
|
|
|
|
<li>A scrolling set of aspects to configure: For each one, enter the OpenLCB EventID that
|
|
sets the mast to this aspect. You can use any of the <a href="Names.shtml">EventID formats
|
|
that JMRI understands</a> such as "x1234567890ABCDEF" or "00.01.02.03.04.05.06.07" or
|
|
"0.1.2.3.4.5.6.7". Whatever format you enter will be retained for when you later edit the
|
|
mast.
|
|
</li>
|
|
|
|
<li>A box for the EventIDs that tell the mast to be lit or unlit.</li>
|
|
|
|
<li>A box for the EventIDs that tell the mast that it's held or not held.</li>
|
|
|
|
<li>Cancel and Create or Apply buttons that do what's expected of them.</li>
|
|
</ul>
|
|
If you format one of those EventID entries improperly, you'll get a not-particularly specific
|
|
error message dialog. (Perhaps somebody will improve this some day)
|
|
<h3>JMRI Help</h3>
|
|
|
|
<p>Back to the <a href="index.shtml">main OpenLCB Help page</a></p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|