Serge NOEL
172 lines
6.5 KiB
Plaintext
172 lines
6.5 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: LogixNG Module Table</title>
|
|
<meta name="author" content="Dave Sand">
|
|
<meta name="keywords" content="JMRI logixng module"><!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="../../../../html/tools/logixng/Sidebar.shtml"-->
|
|
|
|
<div id="mainContent">
|
|
<h1>JMRI: LogixNG Module Table</h1>
|
|
|
|
<p>The LogixNG Module table contains a list of the defined LogixNG Modules.</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<a href="#tableContent">Table Content</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#selectActions">Select Actions</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#menuItems">Menu Items</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#addModule">Add a LogixNG Module</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<h2 id="tableContent">Table Content</h2>
|
|
|
|
<p>The LogixNG Module table lists all of the currently defined LogixNG Modules. Each row has
|
|
a standard set of columns.</p>
|
|
|
|
<dl>
|
|
<dt>System Name</dt>
|
|
|
|
<dd>
|
|
The system name for the LogixNG Module. Module system names have an <strong>IQM</strong>
|
|
prefix normally followed by numbers. For details about the Module system name, see
|
|
<a href="#addModule">Add a LogixNG Module</a>. The system name cannot be changed.
|
|
</dd>
|
|
|
|
<dt>User Name</dt>
|
|
|
|
<dd>The user name for the LogixNG Module. This is a free form field that contains a
|
|
meaningful name.</dd>
|
|
|
|
<dt>Comment</dt>
|
|
|
|
<dd>A free form comment field for the LogixNG Module</dd>
|
|
|
|
<dt>Menu</dt>
|
|
|
|
<dd>
|
|
The <strong>Select</strong> combo box is used to select actions for the selected LogixNG
|
|
Module. See <a href="#selectActions">Select Actions</a>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2 id="selectActions">Select Actions</h2>
|
|
|
|
<p>The dropdown combo box has 3 actions that can be applied to the current LogixNG Module
|
|
row.</p>
|
|
|
|
<div style="margin-left: 2em">
|
|
<a href="../logixng/images/SelectActionsNoCopy.png"><img src=
|
|
"../logixng/images/SelectActionsNoCopy.png" alt="Select Actions No Copy" width="147"
|
|
height="80"></a>
|
|
</div>
|
|
|
|
<dl>
|
|
<dt>Edit</dt>
|
|
|
|
<dd>
|
|
When <strong>Edit</strong> is selected, the Module editor will open. See <a href=
|
|
"../logixng/ModuleEditor.shtml">Module Editor</a> for details.
|
|
</dd>
|
|
|
|
<dt>Browse</dt>
|
|
|
|
<dd>
|
|
The <strong>Browse</strong> option opens a text window with a representation of the
|
|
definitions within the LogixNG Module. See <a href=
|
|
"../logixng/LogixNGBrowser.shtml">LogixNG Browser</a> for details about the browser.
|
|
</dd>
|
|
|
|
<dt>Delete</dt>
|
|
|
|
<dd>
|
|
The <strong>Delete</strong> action deletes the current LogixNG Module and the LogixNG
|
|
Module content. A confirmation dialog will be displayed.
|
|
<div style="margin-left: 2em">
|
|
<a href="../logixng/images/DeleteModule.png"><img src=
|
|
"../logixng/images/DeleteModule.png" alt="Delete LogixNG Module Confirmation" width=
|
|
"378" height="126"></a>
|
|
</div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2 id="menuItems">Menu Items</h2>
|
|
|
|
<dl>
|
|
<dt>Tools</dt>
|
|
|
|
<dd>The tools menu has two items: <strong>Open clipboard</strong> and <strong>Open PickList
|
|
Tables</strong>. See <a href="../../../../html/tools/logixng/reference/chapter2.shtml">
|
|
LogixNG Reference - Chapter 2</a> for details on the using the clipboard. The PickList was
|
|
designed for dragging names, such as sensor names, to a text field. Most LogixNG name fields
|
|
use drop down combo boxes, but this could be used when building Formulas.</dd>
|
|
</dl>
|
|
|
|
<h2 id="addModule">Add a LogixNG Module</h2>
|
|
|
|
<p>To create a new LogixNG Module, click on the <strong>Add...</strong> button. The
|
|
<strong>Add LogixNG Module</strong> window will be displayed.</p>
|
|
|
|
<div style="margin-left: 2em">
|
|
<a href="../logixng/images/AddModule.png"><img src="../logixng/images/AddModule.png" alt=
|
|
"Add LogixNG Module" width="663" height="198"></a>
|
|
</div>
|
|
|
|
<p>The system name is required. The system name for a LogixNG Module always begins with the
|
|
letters <strong>IQM</strong>. If the entered name does not start with <strong>IQM</strong>,
|
|
it will be automatically added. The typical suffix is a number. If <strong>Automatically
|
|
generate System Name</strong> is checked, the system name format will be
|
|
<strong>IQM:AUTO:nnnn</strong>. Any other format requires adding a <strong>$</strong>
|
|
(dollar) character between <strong>IQM</strong> and the suffix.</p>
|
|
|
|
<p>The user name is optional but recommended. A user name may be any useful text, provided
|
|
the new user name was not previously assigned to another LogixNG Module. Once a LogixNG
|
|
Module is created, its system name cannot be changed. Its user name may be changed in the
|
|
LogixNG Module Table. The user name is usually used to provide a more descriptive name, for
|
|
example, "Signal 5 Control".</p>
|
|
|
|
<p>LogixNG has a concept called sockets. They are used to provided connection points that
|
|
support a variety of connections. When a LogixNG Module is being created, it has to know what
|
|
kind of socket it will support.</p>
|
|
|
|
<p>The <strong>Socket type</strong> combo box is used to select the socket type.</p>
|
|
|
|
<div style="margin-left: 2em">
|
|
<a href="../logixng/images/AddModuleType.png"><img src=
|
|
"../logixng/images/AddModuleType.png" alt="Add LogixNG Module Socket Type" width="215"
|
|
height="132"></a>
|
|
</div>
|
|
|
|
<p>The <strong>Digital expression socket</strong> is equivalent to a Logix Conditional that
|
|
only has variables and returns a true or false when called from another Conditional.</p>
|
|
|
|
<p>The <strong>Digital action socket</strong> is used to perform a set of actions. It can
|
|
also implement a full if/then/else set of logic.</p>
|
|
|
|
<p>After clicking <strong>Create</strong>, the LogixNG Module will be created and the
|
|
<a href="../logixng/ModuleEditor.shtml">Edit Module</a> window will appear.</p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|