-
Notifications
You must be signed in to change notification settings - Fork 331
/
index.shtml
185 lines (140 loc) · 6.77 KB
/
index.shtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.17), see www.w3.org">
<title>JMRI Hardware Support - RFID Readers</title><!-- Style -->
<meta name="keywords" content=
"JMRI hardware rfid readers">
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii">
<link rel="stylesheet" type="text/css" href="/css/default.css"
media="screen">
<link rel="stylesheet" type="text/css" href="/css/print.css"
media="print">
<link rel="icon" href="/images/jmri.ico" type="image/png">
<link rel="home" title="Home" href="/"><!-- /Style -->
</head>
<body>
<!--#include virtual="/Header" -->
<div class="nomenu" id="mBody">
<div id="mainContent">
<h1>Hardware Support: RFID Readers</h1><em>RFID support in
JMRI is rapidly evolving; the actual code might be ahead or
behind the documentation on any given day.</em>
<p>JMRI provides support for general JMRI <a href=
"../../tools/Sensors.shtml">Sensors</a> and <a href=
"../../tools/Reporters.shtml">Reporters</a> in terms of RFID
Reader "events". <a name="hardware" id="hardware"></a></p>
<h2>Supported Hardware</h2>
<h3>Protocols</h3>JMRI supports several different RFID Reader
Protocols:
<ul>
<li>CORE-ID / ID-Innovations - since version 2.11.4</li>
<li>Olimex MOD-RFID125 - since v 3.9.2</li>
<li>Olimex MOD-RFID1356MIFARE - since v 4.7.5</li>
<li>Parallax - since v 3.9.2</li>
</ul>
<p>Choose the appropriate Protocol when setting the
Preferences.</p>
<p>JMRI also supports up to 8 individual readers connected
via a Concentrator. Right now, the only supported
Concentrator is that from <a href="../can/cbus/Details.shtml#c7">MERG</a>, and then only for readers
using the CORE-ID protocol.<br>
Select "MERG Concentrator" for the "Adapter" on the
Connections tab in the JMRI Preferences. </p>
<h2><a name="connecting"
id="connecting">Connecting</a></h2>
<h3>Wiring</h3>
<ul>
<li>Direct serial connections have been supported since
JMRI 2.11.4</li>
<li>Network connections are targeted for the JMRI 4.1.2
release series.</li>
</ul>
<h3>Settings</h3><a href="RFID_Preferences.png"><img src=
"RFID_Preferences.png" align="right" height="220" width=
"430" alt="JMRI RFID Preferences"></a>
<p>You configure JMRI's connection to your RFID hardware in
JMRI's Preferences.<br>
It appears as "RFID" in the System Manufacturer drop-down
list.</p>
<p>The "Baud rate" advanced connection setting is typically not critical
for USB-connected RFID connections so it may be "greyed out" to indicate
that it is not selectable.</p>
<h3>Reader Configuration</h3>
<h4>Olimex readers</h4>
<p>Olimex MOD-RFID125 and MOD-RFID1356MIFARE readers must be operating in "CDC"
mode. This mode is typically configured using a pushbutton on the reader.</p>
<h3>Naming</h3>
<p>The <a href="../../doc/Technical/Names.shtml">system
letter</a> for RFID connections is "F". Details of RFID event
and object names are described below.
<!-- , with technical details on a <a href="Names.shtml">separate page</a> --></p>
<p>JMRI associates RFID events with individual JMRI objects
(Sensors, Reporters, etc.) via System Names. A System Name
like "<code>FSA</code>" defines a Sensor that follows the "A"
reader, whereas a System Name like "<code>FRB</code>" defines
a Reporter that follows the "B" reader.</p>
<h3>Sensors</h3>
<p>RFID readings coming into JMRI applications can be
accessed via JMRI Sensor objects. The Sensor's
<!-- <a href="Names.shtml">system name</a> -->System Name
determines which RFID Reader it corresponds to.</p>
<p>A Sensor is defined by two events: The one that sets it
ACTIVE, and the one that sets it INACTIVE. When an RFID Tag
is within the proximity of an RFID Reader, the associated
sensor is ACTIVE; outside of these times it is INACTIVE. You
create Sensors using the <a href=
"../../../../package/jmri/jmrit/beantable/SensorAddEdit.shtml">
Add...</a> button on the <a href=
"../../../../package/jmri/jmrit/beantable/SensorTable.shtml">Sensor
Table</a>.</p>
<h3>Reporters</h3>
<p>RFID readings coming into JMRI applications can also be
accessed via JMRI Reporter objects. The Reporter's
<!-- <a href="Names.shtml">system name</a> -->system name
determines which RFID Reader it corresponds to.</p>
<p>A Reporter can contain arbitrary information, unlike a
Sensor which is only ACTIVE or INACTIVE. Each Reporter is
associated with some specific source of information on the
layout, and makes that devices information available to the
rest of JMRI.</p>
<p>When an RFID Reader reports that a specific tag has been
seen, the corresponding Reporter will contain details of the
specific <a href="../../tools/IdTags.shtml">IdTag</a> seen.
This then enables other JMRI tools to react to this
information.</p>
<h4>Reporter Table</h4>
<p>The <a href=
"../../../package/jmri/jmrit/beantable/ReporterTable.shtml">Reporter
Table</a> provides easy access to the contents of all
Reporters that JMRI knows about. JMRI automatically creates
Reporter objects for devices discovered on the layout.<br>
There's also an <a href=
"../../../package/jmri/jmrit/beantable/ReporterAddEdit.shtml">
"Add..." button</a> for manually creating your own internal
Reporters.</p>
<h4>Displaying Reporter Values on Panels</h4>
<p>A Reporter's value can be displayed on a Panel via an
icon. To do this:</p>
<ul>
<li>On the Panel Editor window for your panel, find the
"Add Reporter" button.</li>
<li>In the text box next to that button, type the User Name
or System Name of the desired Reporter.</li>
<li>Click the button. The Reporter icon will be placed on
the Panel. If it's not visible, that might be because the
value is currently blank; use the Reporter Table to change
the value to something that will be visible.</li>
<li>You can drag the icon to where you want it in the usual
way.</li>
<li>The pop-up menu on the icon will let you change the
formatting.</li>
</ul>
<!--#include virtual="/Footer" -->
</div><!-- closes #mainContent-->
</div><!-- closes #mBody-->
</body>
</html>