175 lines
9.2 KiB
Plaintext
175 lines
9.2 KiB
Plaintext
<!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: OpenLCB Event Table</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>OpenLCB Event Table Frame</h1>
|
|
This provides a table view of the Events, Producers and Consumers
|
|
in your OpenLCB network.
|
|
<p>
|
|
<a href="Event_Table.png">
|
|
<img src="Event_Table.png" width="1037" height="461""/></a>
|
|
<p>
|
|
The primary purpose of the Event Table is three fold:
|
|
<ul>
|
|
<li>Display the Events used on your OpenLCB network along with all of their related
|
|
Producers and Consumers.
|
|
This is created initially in real time through a query of the actual nodes on your
|
|
network and supplemented by any additional information available to JMRI at the time,
|
|
most usefully open node configuration dialog windows (displaying the node's CDI)
|
|
and JMRI data such as User names from the Turnout or Sensor tables.
|
|
As you open and close the configuration dialog windows for additional nodes,
|
|
these contributions will be added and removed from the Event table in real time.
|
|
For the most complete view of your network's Events and Consumer/Producer relationships,
|
|
open the configuration dialog windows for all of your nodes however you may find
|
|
it more manageable to open just the subset of nodes relevant to your task at hand.
|
|
If the information from all node configuration dialogs are to be considered,
|
|
on a large network open these windows prior to the Event Table for the
|
|
fastest initial response. This information is not retained between sessions.
|
|
<p>
|
|
<li>Apply User names to Events.
|
|
Similar to the use of User defined names in the Turnout or Sensor Tables,
|
|
the Event Table allows you to apply names to Events that are more meaningful as
|
|
to their purpose than just the Event ID itself.
|
|
The Event's user assigned name is retained between sessions and is also shown in the
|
|
OpenLCB Traffic Monitor as an additional aid when the Event box is checked therein.
|
|
<p>
|
|
<li>Provide a document record of your Events and their Consumer and Producer relationships.
|
|
Exported as a *.csv file and then viewed and manipulated through a suitable program like Excel,
|
|
this provides a reference or documentation of all of the Event IDs and their associated
|
|
Consumer/Producer relationships as known by JMRI at the time of the export.
|
|
This document can also be used as a reference source of Event IDs that
|
|
may be cut & pasted into a node configuration dialog as you build additional
|
|
Consumer/Producer relationships on your network.
|
|
This is the same data as displayed in the Event Table at the time of the export
|
|
so the more information available, the more complete the export.
|
|
It is envisioned that the user re-export this reference documentation regularly
|
|
as the network evolves rather than try to maintain the resulting document independently.
|
|
</ul>
|
|
<p><a name="table"/>
|
|
You can resize and sort the columns using the header row.
|
|
<p>
|
|
The Event ID field usually shows a single Event ID.
|
|
If a node has declared that it produces or consumes
|
|
a range of event IDs, the range will be shown as its
|
|
lowest and highest included Event IDs.
|
|
<p>
|
|
The Event Name column will show an event name that you've given
|
|
to this event ID.
|
|
If you haven't given the event ID a name, and if there is
|
|
a well-known standard meaning defined for that event, that will be displayed.
|
|
<p>
|
|
You can enter names for events in the 2nd column. Click on the cell
|
|
to open it for editing. Hit return when done. These will be
|
|
saved automatically and loaded when you next start JMRI.
|
|
|
|
<p><a name="toolbar"/>
|
|
At the bottom of the window, there's a tear-off button bar
|
|
that contains a number of useful controls:
|
|
<ul>
|
|
<li>
|
|
Pressing the "Update from Network" button will load the table from the network.
|
|
This might take a couple seconds. You should press it again
|
|
after changes like adding nodes, changing their configuration, etc.
|
|
The table cannot always detect those changes automatically.
|
|
<p>
|
|
If node names (4th and 6th columns) don't show up after a short time, press
|
|
"Update from Network" a second time.
|
|
<p>
|
|
If you have a configuration window open on one or more events and
|
|
click "Update from Network", the right-hand column will show the
|
|
tree-walking display of where each event is referenced in those
|
|
configuration windows. This can help you determine the function of
|
|
the producers and consumers. You might need to resize the column
|
|
to see the complete entry.
|
|
<p>
|
|
Note that the "Update from Network" button does a "Verify Events" operation
|
|
on the network. Some nodes consider this to be a start-of-day, power-up
|
|
operation and might change the status of their outputs due to that.
|
|
<li>If you've defined
|
|
<a href="../../../../../apps/gui3/lccpro/LccPro.shtml#nodegroups">Node Groups</a>
|
|
in the
|
|
<a href="../../../../../apps/gui3/lccpro/LccPro.shtml">LccPro</a>
|
|
window, there will be a selection box that lets you display events
|
|
from "(All)" nodes or just the ones in a specific group. This
|
|
can be helpful if e.g. you're only interested in events from some
|
|
small part of the layout's network.
|
|
|
|
<li>
|
|
Checking the "Require label" box will display only events with labels.
|
|
This lets you ignore events that you haven't labeled as interesting.
|
|
<li>
|
|
Checking the "Require both producer(s) and consumer(s)" box will
|
|
display only those events that have both at least one producer
|
|
and at least one consumer. These are the events that actually do something
|
|
on your LCC network.
|
|
<li>
|
|
Checking the "Popcorn mode" will highlight the producer for every event that
|
|
JMRI sees being produced.
|
|
Since the window scrolls to show the event, this can result in the screen
|
|
jumping around when it's enabled.
|
|
If there's a lot of traffic, this can slow your
|
|
computer down significantly, so only enable it when you want to use it.
|
|
<li>
|
|
As you type in the "Find Event" box, the table will try to locate an
|
|
event that starts with what you've typed. The first (top most) match will
|
|
be highlighted. If need be, the table will scroll to make that visible.
|
|
<p>
|
|
If you don't find a specific event ID in the table, the "Add"
|
|
button will add it to the table. You can then give it a name in the usual way.
|
|
<li>
|
|
As you type in the "Find Name" box, the table will try to locate
|
|
an event, producer or consumer node name or also-known-as alias that starts with
|
|
what you've typed. Upper vs lower case is ignored. The first
|
|
(left most then top most) match will be highlighted. If need be, the table will
|
|
scroll to make that visible.
|
|
<li>
|
|
Pressing the "Names from Sensors" will fill in the event name column with the
|
|
names from the corresponding JMRI Sensors. Pressing the "Names from Turnouts"
|
|
button will fill in the event name column with the names from the
|
|
corresponding JMRI Turnouts. Note that only empty entries will be filled;
|
|
this does not overwrite any existing names you've already defined.
|
|
</ul>
|
|
|
|
<p><a name="menu"/>
|
|
The File menu contains two items:
|
|
<ul>
|
|
<li>Save to CSV: This exports all columns of the current contents of the table
|
|
to a comma-separated variable (CSV) file.
|
|
<p>The file will contain column
|
|
headers in its first row, followed by a row for every Event ID in the table,
|
|
including ones that are not currently visible.
|
|
<li>Read from CSV: Reads in Event IDs and event names from a CSV file,
|
|
then if each Event ID doesn't already have a name, assign the name from
|
|
the file.
|
|
<p>The file should have a numeric Event ID such as 00.01.02.03.04.05.06.07
|
|
in the 1st column and the desired name in the second column.
|
|
A header row, if present, is ignored. Extra columns are ignored.
|
|
</ul>
|
|
|
|
The table's information is automatically stored within an "eventnames/eventNames.xml" file
|
|
within your profile directory. Should you want to merge the event names from two or more
|
|
profiles, you can copy the "names" element and its contents from one file into the
|
|
end of another file. I.e. you can have more than one "names" element in the file,
|
|
and they will be combined the next time the file is written out. Duplicate names
|
|
for an event (i.e. same name appearing twice for the same event) in the file are not a problem,
|
|
they are automatically handled.
|
|
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
</div>
|
|
<!-- close #mBody -->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|