Project

General

Profile

Running DAQ Interface » History » Version 178

John Freeman, 04/10/2015 10:20 AM

1 58 John Freeman
{{toc}}
2 58 John Freeman
3 96 John Freeman
!DAQ_communication_diagram4.png!
4 96 John Freeman
5 49 Erik Blaufuss
h1. Getting help
6 1 John Freeman
7 78 John Freeman
If, after reading this document (in particular, the "Troubleshooting and FAQ" section) you run into issues, or have questions, please contact:
8 49 Erik Blaufuss
* DAQInterface
9 49 Erik Blaufuss
** John Freeman - jcfree@fnal.gov
10 62 John Freeman
* RunControl
11 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
12 66 John Freeman
* Configuration Manager
13 1 John Freeman
** Jon Paley - jpaley@anl.gov
14 123 John Freeman
* TDU XML-RPC server
15 123 John Freeman
** Tom Dealtry - thomas.dealtry@physics.ox.ac.uk
16 1 John Freeman
17 102 Erik Blaufuss
h1. Logbook
18 102 Erik Blaufuss
19 102 Erik Blaufuss
Please document all changes, software updates, and operational activities to the ELog:
20 102 Erik Blaufuss
21 102 Erik Blaufuss
http://dbweb3.fnal.gov:8080/ECL/lbne_35t
22 120 John Freeman
23 1 John Freeman
h1. Brief preliminaries
24 1 John Freeman
25 136 John Freeman
This guide assumes you have access to the lbnedaq account on the LBNE 35 ton gateway node, lbne35t-gateway01.fnal.gov . It also assumes you have a rudimentary knowledge of how to navigate a bash environment in Linux (how to change directories, log onto different machines, perform time-ordered listings of files, edit a file using emacs or vi, etc.). 
26 49 Erik Blaufuss
27 137 John Freeman
The installed code is located at lbne35t-gateway01.fnal.gov:/data/lbnedaq/daqarea/lbnerc. If you need access to the lbnedaq lbne35t-gateway01.fnal.gov account, please contact one of the people listed above under "Getting Help". Once you have access, to get started, login and first setup the environment:
28 1 John Freeman
29 1 John Freeman
<pre>
30 1 John Freeman
ssh lbnedaq@lbne35t-gateway01.fnal.gov
31 1 John Freeman
cd /data/lbnedaq/daqarea
32 1 John Freeman
source fireup
33 1 John Freeman
</pre>
34 1 John Freeman
35 135 John Freeman
This will take you into the /data/lbnedaq/daqarea/lbnerc directory, out of which the DAQ is controlled. For the remainder of this wiki, the assumption is that you've already setup the environment using the above commands. 
36 123 John Freeman
37 134 John Freeman
Finally, when you see an ellipse ("…") in example output, that is to be interpreted as a placeholder for output which is considered irrelevant to the point being explained.
38 123 John Freeman
39 123 John Freeman
h1. Killing, launching, and getting the status of the DAQ applications
40 123 John Freeman
41 123 John Freeman
The DAQ application suite consists of RunControl, the configuration manager, DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the XML-RPC server for the TDU (the program which allows a sync pulse to be sent to the hardware at the start of DAQ running). The following points about these programs should be observed:
42 123 John Freeman
** These applications all need to be running in order for the DAQ to work
43 156 John Freeman
** DAQInterface needs to be launched _after_ RunControl, and unlike the other applications, if a DAQInterface process is already found to be running on login, it shouldn't be used, but rather, killed and restarted (unless someone is actively using the DAQ already, of course; a good way to check this is to see when the last time a logfile in /data/lbnedaq/daqlogs/pmt was modified via "ls -ltr /data/lbnedaq/daqlogs/pmt").
44 1 John Freeman
** The actual names of the processes are "lbnecontrol" (RunControl), "daqinterface" (DAQInterface), "CfgMgrApp" (the configuration manager) and "tdu" (the TDU XML-RPC server)
45 1 John Freeman
46 167 John Freeman
h2. Getting the status
47 167 John Freeman
48 165 John Freeman
In order to determine which DAQ applications are already active, two approaches can be taken, depending on whether or not RunControl is itself active. If it isn't, you'll need to enter the following:
49 1 John Freeman
50 165 John Freeman
<pre>
51 165 John Freeman
check_daq_applications.sh
52 165 John Freeman
</pre>
53 176 John Freeman
which will produce output which looks like this:
54 1 John Freeman
<pre>
55 176 John Freeman
56 176 John Freeman
lbnecontrol: Available
57 176 John Freeman
CfgMgr: **Not Found**
58 176 John Freeman
DAQInterface: Available
59 176 John Freeman
TDUControl: **Not Found**
60 176 John Freeman
61 176 John Freeman
Most recent DAQ logfile written (current US Central Time is Apr 10 09:56):
62 176 John Freeman
Apr 8 17:25 /data/lbnedaq/daqlogs/pmt/pmt-32342.1-20150408171225.log
63 155 John Freeman
</pre>
64 1 John Freeman
65 176 John Freeman
In other words, the above command will both tell you which, if any, of the four primary DAQ applications are running, and then tell you the time of the most recently modified logfile; this last piece of information is helpful in determining whether the DAQ is currently in active use by another individual. In particular, you see that RunControl and DAQInterface already exist, but the configuration manager and the TDU's XML-RPC server do not. In this case, you would not only want to launch the configuration manager and the server, but if the existing instance of DAQInterface hadn't been been launched by you in your terminal, you would also want to kill and relaunch DAQInterface-- an action which should be safe in the context of this example, since you can see above that it's been almost two days since any DAQ output was logged. 
66 155 John Freeman
67 176 John Freeman
Another way of checking which applications are alive is through "@lbnecmd check@"; note this command will only work if RunControl (lbnecontrol) is itself alive:
68 1 John Freeman
<pre>
69 1 John Freeman
lbnecmd check
70 1 John Freeman
</pre>
71 138 John Freeman
72 176 John Freeman
You'll then see output similar to that of check_daq_applications.sh as far as which applications are alive; however, it contains additional information not shown which will be discussed later:
73 124 John Freeman
<pre>
74 124 John Freeman
lbnecontrol: Available
75 124 John Freeman
CfgMgr: **Not Found**
76 1 John Freeman
DAQInterface: Available
77 124 John Freeman
TDUControl: **Not Found**
78 1 John Freeman
...
79 1 John Freeman
</pre>
80 91 John Freeman
81 176 John Freeman
Be aware that if you attempt "lbnecmd check" when RunControl is not yet available, you'll simply see "<code>check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?</code>".
82 49 Erik Blaufuss
83 124 John Freeman
h2. Cleanup: killing RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
84 1 John Freeman
85 152 John Freeman
As of March 30, 2015, a new script called "kill_daq_applications.sh" can be run at the command line to kill the DAQ applications. In order to kill all four applications, one would run:
86 152 John Freeman
87 152 John Freeman
<pre>
88 152 John Freeman
kill_daq_applications.sh -c -d -r -t
89 152 John Freeman
</pre>
90 152 John Freeman
91 160 John Freeman
where each option corresponds to the killing of a particular application: "-c" for the configuration manager, "-d" for DAQInterface, "-r" for RunControl, and "-t" for the TDU XML-RPC server. If only a subset of these four applications are running, then only use the relevant options (e.g., simply run "<code>kill_daq_applications.sh -t</code>" if the only application running is the TDU server). Running the script without any options at all will print out instructions similar to what you see here. Be aware that it's good etiquette to make sure someone's not currently using the DAQ before you start killing applications. 
92 152 John Freeman
93 153 John Freeman
For the previous instructions for killing the applications (still correct, though more work-intensive), click on "Show", below:
94 152 John Freeman
95 152 John Freeman
{{collapse()
96 152 John Freeman
97 124 John Freeman
Killing RunControl has its own special syntax, and is simply:
98 1 John Freeman
99 109 Thomas Dealtry
<pre>
100 124 John Freeman
lbnecmd kill
101 1 John Freeman
</pre>
102 105 John Freeman
103 124 John Freeman
The other DAQ applications, however, need to be killed via the standard Linux command <code>kill <pid></code>, where "<pid>" is the process ID of the application. To find the process IDs of all possible DAQ applications, you can run:
104 105 John Freeman
105 105 John Freeman
<pre>
106 124 John Freeman
ps aux | grep -v grep | grep -v emacs | egrep -e lbnecontrol -e daqinterface -e CfgMgrApp -e tdu
107 105 John Freeman
</pre>
108 1 John Freeman
109 140 John Freeman
For each application which exists, a row will appear, the second field of which is that application's process ID. Keep in mind, of course, that if these processes are running, it might mean that someone else is using the DAQ. As the 9th and 10th fields of the row of variables "ps aux" returns concern how long the program has been running, you can use these values as well as your best judgement, then, before deciding these processes are not in active use and killing them.
110 152 John Freeman
}}
111 105 John Freeman
112 124 John Freeman
h2. Launching RunControl, DAQInterface, the configuration manager, and the TDU XMLRPC server
113 105 John Freeman
114 154 John Freeman
Also as of March 30, 2015, a new script called "launch_daq_applications.sh" can be run at the command line to launch the DAQ applications. In order to launch all four applications, one would run:
115 154 John Freeman
<pre>
116 154 John Freeman
launch_daq_applications.sh -c -t -r -d <daqinterface configuration file>
117 154 John Freeman
</pre>
118 154 John Freeman
119 161 John Freeman
where unless you have your own working copy of the DAQInterface configuration file (what this is will be described later in this wiki), "<code><daqinterface configuration file></code>" should be "<code>docs/config.txt</code>". The options refer to the same applications as in the case of kill_daq_applications.sh, and like kill_daq_applications.sh, executing the script without any options will print out instructions. Be aware, however, that DAQInterface will not be launched if RunControl isn't already running. In practice, though, you can launch RunControl in the same launch_daq_applications.sh command by preceding the DAQInterface option with the RunControl option -- so, if the configuration manager and the TDU server are already up and available, then one would only need to execute "<code>launch_daq_applications.sh -r -d <daqinterface configuration file></code>" in order to have the full suite of DAQ applications available for use. 
120 154 John Freeman
121 154 John Freeman
Note that if an application of a given type is already running, launch_daq_applications.sh will not launch a duplicate application, but will instead print a warning to the screen. 
122 154 John Freeman
123 161 John Freeman
For the previous instructions on how to launch the DAQ applications (still correct, but more detailed and labor-demanding), click on "Show" below:
124 154 John Freeman
125 154 John Freeman
{{collapse()
126 154 John Freeman
127 124 John Freeman
h3. Launching RunControl
128 49 Erik Blaufuss
129 124 John Freeman
<pre>
130 49 Erik Blaufuss
rm -f /tmp/lbnecontrol.pid  # (This should only be necessary if last RunControl session wasn't killed via "lbnecmd kill")
131 1 John Freeman
lbnecmd launch
132 1 John Freeman
</pre>
133 61 John Freeman
134 151 John Freeman
h3. Launching DAQInterface
135 151 John Freeman
136 151 John Freeman
<pre>
137 151 John Freeman
daqinterface -f <daqinterface file> &
138 151 John Freeman
</pre>
139 1 John Freeman
140 1 John Freeman
The "-f <daqinterface file>" is optional; if left out, the lbnerc/docs/config.txt file will be used to configure DAQInterface, otherwise <daqinterface file> will be used. The DAQInterface configuration is not to be confused with run configurations handled by the configuration manager; see the section "The DAQInterface configuration file" for more. 
141 1 John Freeman
142 154 John Freeman
Other "expert" arguments:
143 151 John Freeman
<pre>
144 1 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> &
145 1 John Freeman
</pre>
146 1 John Freeman
Here, the "daqint" argument is arbitrary, and is the name you'll give the DAQInterface process in RunControl; the "5570" argument is the port off of which DAQInterface will run.  "-c" refers to the host on which RunControl is running, and "-H" the host on which DAQInterface is running. 
147 141 John Freeman
148 154 John Freeman
149 154 John Freeman
If multiple users with different terminals wish to check the DAQ output, it is recommended to try:
150 1 John Freeman
<pre>
151 82 John Freeman
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost -f <daqinterface file> >>~/DI.log 2>&1 &
152 1 John Freeman
</pre>
153 1 John Freeman
This will launch daqinterface in the background, with all messages being appended to the bottom of the file ~/DI.log  (The stdbuf -oL prevents buffering of output to the file, so the file should update in real time)
154 141 John Freeman
155 154 John Freeman
156 124 John Freeman
h3. Launching the configuration manager
157 1 John Freeman
158 1 John Freeman
Please see the "Starting up the CfgMgrApp on lbne35t-gateway01" section of Jon Paley's documentation here: https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki
159 109 Thomas Dealtry
160 124 John Freeman
h3. Launching the TDU XMLRPC server
161 109 Thomas Dealtry
162 109 Thomas Dealtry
<pre>
163 124 John Freeman
tdu -T 192.168.100.201 -P 10001 -H localhost -r 50008 &
164 1 John Freeman
</pre>
165 1 John Freeman
166 109 Thomas Dealtry
?Note that if you are using emulators, you don't need to run using the TDU. Remember to set 'TDU XMLRPC port' to less than or equal 0.
167 109 Thomas Dealtry
168 125 John Freeman
See [[Starting and using TDUControl]] for more details.
169 154 John Freeman
170 154 John Freeman
}}
171 62 John Freeman
172 162 John Freeman
h1. Performing a Run
173 1 John Freeman
174 142 John Freeman
With the applications launched, you can take the DAQ system through the standard transitions to perform a DAQ run. The "ground state" of the DAQ is called the "stopped" state. Each successful transition brings the DAQ into a different state.  Described in more detail later, the chain of states (in quotes) and transitions (in italics) in the DAQ system can be represented as follows:
175 1 John Freeman
176 142 John Freeman
---
177 143 John Freeman
178 142 John Freeman
"stopped" -> _init_ -> "ready" -> _start_ -> "running" -> _pause_ -> "ready" -> _resume_ -> "running" -> _stop_ -> "ready" -> _terminate_ -> "stopped"
179 143 John Freeman
180 142 John Freeman
---
181 142 John Freeman
182 125 John Freeman
h2. Checking the state of the DAQ
183 127 John Freeman
184 125 John Freeman
At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; example output of this is as follows:
185 1 John Freeman
<pre>
186 125 John Freeman
lbnecontrol: Available
187 125 John Freeman
CfgMgr: Available
188 125 John Freeman
DAQInterface: Available
189 125 John Freeman
TDUControl: Available
190 125 John Freeman
191 125 John Freeman
Run number: 797
192 125 John Freeman
Run configuration: ganglia_test
193 125 John Freeman
Run type: Test
194 125 John Freeman
daqint@localhost:5570 (synchronous): running
195 125 John Freeman
</pre>
196 125 John Freeman
197 125 John Freeman
Here, you've already seen how lbnecmd check can tell you whether a given application type has been launched or not; on the bottom line, however, you'll also see a description of the _state_ of the DAQ -- in this case, "running", meaning that it's actively acquiring data. 
198 108 John Freeman
199 108 John Freeman
Note that you'll want to wait for a transition to complete before issuing another one, otherwise you'll receive a warning and the transition request will be ignored. DAQInterface will also report when transitions are complete -- e.g., at the end of the "initialize" transition, you'd see:
200 117 John Freeman
<pre>
201 108 John Freeman
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
202 1 John Freeman
</pre>
203 142 John Freeman
If a high "debug level" has been set for DAQInterface (see below for more on this), this message can get buried in a set of output messages; in this case "lbnecmd check" may be the easiest way to determine what state the system is in.
204 1 John Freeman
205 94 John Freeman
h2.  Selecting a run configuration and DAQ components
206 49 Erik Blaufuss
207 125 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQ components must be selected.  This is done via RunControl.
208 1 John Freeman
209 49 Erik Blaufuss
h3. List and select a configuration:
210 1 John Freeman
211 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
212 49 Erik Blaufuss
<pre>
213 1 John Freeman
lbnecmd listconfigs
214 1 John Freeman
</pre>
215 143 John Freeman
This lists all available configs, as well as the current selected config (Note, default config is "No Config"):
216 49 Erik Blaufuss
<pre>
217 49 Erik Blaufuss
Available configs (Name : description)
218 1 John Freeman
219 111 John Freeman
8xssp_with_nova_sync : Sorry, no description found.
220 111 John Freeman
6xssp_ext : Sorry, no description found.
221 111 John Freeman
2xssp_ssp01_led_ssp02_tstamp : Sorry, no description found.
222 111 John Freeman
demo : This is a demo.  Testing 1, 2, 3…
223 30 John Freeman
...
224 49 Erik Blaufuss
225 1 John Freeman
Current selected config: No Config
226 49 Erik Blaufuss
</pre>
227 143 John Freeman
You can then select a configuration -- for the purposes of this tutorial, let's go with "demo", which creates simulated data without using any hardware:
228 49 Erik Blaufuss
<pre> 
229 49 Erik Blaufuss
lbnecmd setconfig demo
230 1 John Freeman
</pre>
231 90 John Freeman
This will return "OK" if successful; "lbnecmd listconfigs" will then show this as the current config.  If the specified configuration is not known, an error is returned. Instructions on how to add a configuration are given later in this document.
232 1 John Freeman
233 49 Erik Blaufuss
h3. List and select DAQ components.
234 1 John Freeman
235 62 John Freeman
You can select which portions of the LBNE DAQ setup you want to use in the upcoming run.  These are mapped generally to the ArtDAQ BoardReaderMain processes
236 90 John Freeman
that read them out.   As an operator, you need to ensure that there are configuration files available in the configuration manager for the DAQ Components that you select here, or DAQInterface will return an error.
237 1 John Freeman
238 49 Erik Blaufuss
To see the list of available DAQ components:
239 1 John Freeman
<pre>
240 49 Erik Blaufuss
lbnecmd listdaqcomps
241 62 John Freeman
</pre>
242 1 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
243 112 John Freeman
<pre>
244 112 John Freeman
Available:
245 112 John Freeman
component01 (lbnedaq2:5205)
246 112 John Freeman
component02 (lbnedaq2:5206)
247 112 John Freeman
248 112 John Freeman
ssp08 (lbnedaq1:5214)
249 112 John Freeman
250 112 John Freeman
Selected:
251 112 John Freeman
component01 (lbnedaq2:5205)
252 112 John Freeman
component02 (lbnedaq2:5206)
253 1 John Freeman
254 1 John Freeman
ssp08 (lbnedaq1:5214)
255 62 John Freeman
</pre>
256 143 John Freeman
The components are shown by name, along with the requested host/port to run the component's corresponding BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
257 1 John Freeman
<pre>
258 1 John Freeman
lbnecmd setdaqcomps component0{1,2}
259 118 John Freeman
</pre>
260 49 Erik Blaufuss
(n.b. the {1,2} in brackets is a Linux bash shell trick which expands <code>component0{1,2}</code> to <code>component01 component02</code>). This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" set of components).  If the specified components are not known, an error is returned.
261 143 John Freeman
262 143 John Freeman
How to make a new component available to RunControl is described later in this document. 
263 29 John Freeman
264 91 John Freeman
h2. Initializing, starting, stopping and terminating a Run
265 1 John Freeman
266 66 John Freeman
For each of these transitions, please recall that while "lbnecmd <cmd>" returns very quickly, the actual issued command can take several seconds or minutes to complete.  Before issuing another command, be sure that the transition is complete by using the check command:
267 1 John Freeman
<pre>
268 49 Erik Blaufuss
lbnecmd check
269 1 John Freeman
</pre>
270 62 John Freeman
For example, before issuing the "start" transition, you can use this command to ensure that the DAQ is in the "ready" state and not still in the "initializing" stage.
271 1 John Freeman
272 167 John Freeman
First, take DAQInterface from the "stopped" to the "ready" state; this will create the artdaq processes on the hosts they've been assigned, and initialize them with the FHiCL documents:
273 1 John Freeman
<pre>
274 1 John Freeman
lbnecmd init daq
275 1 John Freeman
</pre>
276 1 John Freeman
277 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
278 29 John Freeman
<pre>
279 1 John Freeman
lbnecmd start daq
280 49 Erik Blaufuss
</pre>
281 177 John Freeman
Note that the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command. If the start transition was successful, information about the run is saved in the run records directory, @/data/lbnedaq/run_records/<run_number>@, where @<run_number>@ is to be taken as a stand-in for the actual run number. More on how to understand the directory's contents is described below, under "Examining the output". Of immediate interest, the real-time output of the DAQ will be saved in a logfile located in /data/lbnedaq/daqlogs/pmt/. While in the running state, you can obtain its name just by executing the "check_daq_applications.sh" script described above; with its name, if you open up a fresh terminal and run "tail -f <logfilename>" you'll see the logfile updating in real time. 
282 49 Erik Blaufuss
283 178 John Freeman
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output Root file, in /data/lbnedaq/data, to be closed and given a name reflecting the current run and subrun numbers (the format as of April 10, 2015 is @lbne_r<run number>_sr<subrun number>_<creation time>.root@):
284 22 John Freeman
<pre>
285 21 John Freeman
lbnecmd pause daq
286 42 John Freeman
</pre>
287 41 John Freeman
288 167 John Freeman
Resume the running of the DAQ, returning it to the "running" state.  This will restart data taking to a new output file:
289 1 John Freeman
<pre>
290 48 John Freeman
lbnecmd resume daq
291 48 John Freeman
</pre>
292 48 John Freeman
293 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
294 48 John Freeman
<pre>
295 48 John Freeman
lbnecmd stop daq
296 49 Erik Blaufuss
</pre>
297 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
298 127 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must issue the "terminate" command, which will kill all ArtDAQ processes and return DAQInterface to its "stopped" state:
299 1 John Freeman
300 67 Erik Blaufuss
<pre>
301 67 Erik Blaufuss
lbnecmd terminate daq
302 67 Erik Blaufuss
</pre>
303 1 John Freeman
304 172 John Freeman
h2. Examining the output
305 1 John Freeman
306 129 John Freeman
Once you've completed your run, there are typically two primary outputs: the Root files which contain the data which passed through the DAQ (saved, as of March 25, 2015, in /data/lbnedaq/data on the gateway node), and a set of text files containing information about the run. To access these text files, you'll want to go to the run records directory, which defaults to /data/lbnedaq/run_records/<run_number>. This directory contains the FHiCL documents used to control the ArtDAQ processes in the run, the DAQInterface configuration file used (described later in this wiki), and a metadata file, which, among other things, describes where to find a record of the DAQ's output. An example of this file, for run 778, can be found if we look in /data/lbnedaq/run_records/778 at "metadata_r778.txt":
307 119 John Freeman
308 72 John Freeman
<pre>
309 72 John Freeman
Config name: demo
310 72 John Freeman
Component #0: component01
311 1 John Freeman
Component #1: component02
312 119 John Freeman
lbne-artdaq commit: 0f0f9be1c63a3b487170579c887ce79944eca6f8
313 119 John Freeman
lbnerc commit: 92935f2702c5e0aa732fd3cc9ff6758e1a0c288c
314 119 John Freeman
/data/lbnedaq/config/ commit: 97d8b222742a41d5d10ea942a063ddfacac3ce93
315 1 John Freeman
316 114 John Freeman
317 114 John Freeman
pmt logfile(s): lbnedaq3:/data/lbnedaq/daqlogs/pmt/pmt-25771*.log
318 1 John Freeman
319 1 John Freeman
boardreader logfiles: 
320 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37365.log
321 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/boardreader/boardreader-20150320163004-lbnedaq2-37366.log
322 1 John Freeman
323 1 John Freeman
eventbuilder logfiles: 
324 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37364.log
325 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37363.log
326 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/eventbuilder/eventbuilder-20150320163004-lbnedaq2-37368.log
327 1 John Freeman
328 1 John Freeman
aggregator logfiles: 
329 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37369.log
330 1 John Freeman
lbnedaq3:/data/lbnedaq/daqlogs/aggregator/aggregator-20150320163004-lbnedaq2-37367.log
331 1 John Freeman
332 1 John Freeman
</pre>
333 167 John Freeman
The most significant things saved in this file for the end user of the DAQ system are the configuration chosen and the components chosen for the run (at the top of the file), and the wildcard for the pmt (ArtDAQ Process Management Tool) logfiles, which contain the output of the DAQ system, under "pmt logfile(s)" -- so, in this case, executing <code>ls -ltr /data/lbnedaq/daqlogs/pmt/pmt-25771*.log</code> would list the files containing the output of the DAQ in run 778. Concerning this last point, just be aware of the possibility that earlier DAQ sessions may have produced logfiles which also satisfy the wildcard, as the "25771" in the wildcard example provided refer to the process ID of the pmt process, which isn't necessarily unique for a given run. 
334 1 John Freeman
335 119 John Freeman
336 129 John Freeman
{{collapse(Comprehensive details on the contents of the run records directory...)
337 129 John Freeman
338 129 John Freeman
** The full contents of the metadata file, beyond what's described above, include: 
339 129 John Freeman
-The git commit hashes of the lbne-artdaq and lbnerc packages used in the run, as well as the commit hash of the configuration directory used by the configuration manager
340 129 John Freeman
-The individual artdaq process logfiles
341 129 John Freeman
342 129 John Freeman
** A copy of the DAQInterface configuration file with a name of the format <code>config_r<run number>.txt</code> is saved. A description of what this file is comes later in the wiki. 
343 129 John Freeman
344 129 John Freeman
** Please note that the FHiCL documents saved in the run records directory will contain the actual FHiCL sent to the artdaq processes for the run, and that this will be slightly different than the contents of the FHiCL documents found in the configuration manager's directory. This is because DAQInterface performs some bookkeeping on FHiCL variables which account for things such as the number of processes of a given type (note that it makes no changes which would affect the physics). The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "EventBuilder_lbnedaq2_5735_r778.fcl" refers to the FhiCL used to control the EventBuilderMain process on lbnedaq2 at port 5735 during run 778. 
345 129 John Freeman
346 129 John Freeman
** Please also note that the entire subdirectory for the configuration is also saved alongside the FHiCL documents; this is because some FHiCL documents are included via "#include" into the main FHiCL documents for a given process, and this was the way to save them as well as the main FHiCL documents. 
347 129 John Freeman
348 129 John Freeman
}}
349 129 John Freeman
350 129 John Freeman
{{collapse(How to examine your output Root files...)
351 163 John Freeman
Various Art modules may create various types of output. In particular, it's standard for one of the two AggregatorMains running in an artdaq-based DAQ to use Art's RootOutput module, which will save the assembled raw event in an Art-readable *.root file. The location of this output can be found in the FHiCL code used to control RootOutput; as of March 30, 2015, the standard location is /data/lbnedaq/data on the gateway node. The other AggregatorMain typically will run other RootOutput modules designed to create plots, diagnostic printouts, etc.; the nature of the output here is too varied to neatly summarize, but checking the FHiCL code used to control these Art modules should reveal their output location.
352 76 John Freeman
353 76 John Freeman
To take a quick look at the Art-readable *.root file, with a version of lbne-artdaq newer than 11/25/14, you can do the following:
354 76 John Freeman
355 76 John Freeman
<pre>
356 76 John Freeman
cd <lbne-artdaq basedir>
357 76 John Freeman
source setupLBNEARTDAQ
358 76 John Freeman
rawEventDump -s <rootfile> -n <max events>
359 76 John Freeman
</pre>
360 76 John Freeman
361 166 John Freeman
where here, <lbne-artdaq basedir> is the parent directory of the lbne-artdaq package, <rootfile> is the Art-readable *.root file produced in a given run, and <max events> is the max events whose info you wish to look at. For a specific example of the output, say we look at the first event of run 731:
362 166 John Freeman
<pre>
363 166 John Freeman
rawEventDump -s /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root -n 1
364 166 John Freeman
</pre>
365 1 John Freeman
366 166 John Freeman
Then the output will look something like the following:
367 166 John Freeman
368 81 John Freeman
<pre>
369 166 John Freeman
%MSG-i MF_INIT_OK:  art 08-Apr-2015 13:29:00 CDT JobSetup 
370 81 John Freeman
Messagelogger initialization complete.
371 81 John Freeman
%MSG
372 166 John Freeman
%MSG-i PathConfiguration:  art 08-Apr-2015 13:29:00 CDT JobSetup 
373 1 John Freeman
Multiple end paths have been combined into one end path,
374 1 John Freeman
"end_path" since order is irrelevant.
375 1 John Freeman
376 1 John Freeman
%MSG
377 166 John Freeman
08-Apr-2015 13:29:00 CDT  Initiating request to open file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
378 166 John Freeman
08-Apr-2015 13:29:00 CDT  Successfully opened file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
379 81 John Freeman
--------------------------------------------------------------
380 1 John Freeman
Package             |Version             |Timestamp           
381 166 John Freeman
artdaq-core         |v1_04_10            |11-Mar-2015 14:35:37 UTC
382 166 John Freeman
artdaq              |v1_12_08            |11-Mar-2015 14:37:50 UTC
383 166 John Freeman
lbne-raw-data       |v1_02_00            |11-Mar-2015 14:36:11 UTC
384 166 John Freeman
lbne-artdaq         |v1_01_02            |13-Mar-2015 20:31:07 UTC
385 76 John Freeman
--------------------------------------------------------------
386 166 John Freeman
Begin processing the 1st record. run: 731 subRun: 1 event: 1 at 08-Apr-2015 13:29:00 CDT
387 81 John Freeman
PROCESS NAME | MODULE LABEL.. | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE............ | PRODUCT FRIENDLY TYPE | SIZE
388 166 John Freeman
DAQ......... | daq........... | PHOTON............... | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...7
389 166 John Freeman
DAQ......... | daq........... | TPC.................. | std::vector<artdaq::Fragment> | artdaq::Fragments.... | ...8
390 81 John Freeman
DAQAG....... | TriggerResults | ..................... | art::TriggerResults.......... | art::TriggerResults.. | ...-
391 1 John Freeman
392 166 John Freeman
Total products (present, not present): 8 (3, 5).
393 1 John Freeman
394 76 John Freeman
PROCESS NAME | MODULE LABEL | PRODUCT INSTANCE NAME | DATA PRODUCT TYPE.................... | PRODUCT FRIENDLY TYPE.... | SIZE
395 76 John Freeman
DAQAG....... | BuildInfo... | LbneArtdaq........... | std::vector<artdaq::PackageBuildInfo> | artdaq::PackageBuildInfos | ...4
396 1 John Freeman
397 76 John Freeman
Total products (present, not present): 1 (1, 0).
398 81 John Freeman
399 166 John Freeman
08-Apr-2015 13:29:00 CDT  Closed file /data/lbnedaq/data/lbne_r000731_sr01_20150317T162037.root
400 1 John Freeman
401 76 John Freeman
TrigReport ---------- Event  Summary ------------
402 76 John Freeman
TrigReport Events total = 1 passed = 1 failed = 0
403 76 John Freeman
404 76 John Freeman
TrigReport ------ Modules in End-Path: end_path ------------
405 76 John Freeman
TrigReport  Trig Bit#    Visited     Passed     Failed      Error Name
406 76 John Freeman
TrigReport     0    0          1          1          0          0 printBuildInfo
407 76 John Freeman
TrigReport     0    0          1          1          0          0 out1
408 76 John Freeman
409 76 John Freeman
TimeReport ---------- Time  Summary ---[sec]----
410 166 John Freeman
TimeReport CPU = 0.017439 Real = 0.007998
411 1 John Freeman
412 1 John Freeman
Art has completed and will exit with status 0.
413 166 John Freeman
414 129 John Freeman
</pre>
415 166 John Freeman
The first thing you see here is the version and build time of the lbne-artdaq package and some of the main packages on which it depends. Then you see a listing of products in the Root file, here including seven fragments of type PHOTON (from the SSPs) and eight fragments of type TPC (from the RCEs).  Finally, a listing of passed/failed events; the output here is the result of running with "-n 1" as an option, so as we'd expect there's only one event.
416 131 John Freeman
}}
417 1 John Freeman
418 145 John Freeman
h1. The DAQInterface configuration file
419 1 John Freeman
420 167 John Freeman
DAQInterface uses some key information stored in a local configuration file, NOT to be confused with the run configuration described elsewhere on this wiki. Examples of this information are the hosts and ports (i.e., communication sockets) for artdaq processes, location of lbne-artdaq software, debug (log) level, etc). These can be changed while the DAQ is in its "stopped" state. The default DAQInterface configuration file is docs/config.txt (relative to /data/lbnedaq/daqarea/lbnerc); if you wish to change parameters, it's considered best practice not to edit this default file but rather to copy it to a file of the form "<code>docs/config_<your username>.txt</code>", and edit that file, passing it to the DAQInterface executable as described in the section on launching applications. It's expected that for normal operations, most parameters should not need to changed too often, and alterations will be primarily of developer or expert interest. If you ARE a developer/expert or are simply curious, take a look at the default DAQInterface configuration file; it should look something like the following:
421 100 John Freeman
<pre>
422 91 John Freeman
423 1 John Freeman
lbne-artdaq: /data/lbnedaq/daqarea/lbne-artdaq-base/build_lbne-artdaq
424 100 John Freeman
425 1 John Freeman
PMT host: lbnedaq3
426 49 Erik Blaufuss
PMT port: 5400
427 49 Erik Blaufuss
428 49 Erik Blaufuss
pause before initialization: 5
429 49 Erik Blaufuss
430 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
431 49 Erik Blaufuss
debug level: 1
432 49 Erik Blaufuss
433 91 John Freeman
log directory:   /data/lbnedaq/daqlogs
434 49 Erik Blaufuss
435 116 John Freeman
record directory: /data/lbnedaq/run_records
436 116 John Freeman
437 116 John Freeman
# If this file is "config.txt" -- i.e., the standard, non-expert,
438 116 John Freeman
# non-testing version of the DAQInterface configuration file -- do not
439 101 John Freeman
# set "disable configuration check" to "true"
440 101 John Freeman
441 101 John Freeman
disable configuration check: false
442 91 John Freeman
443 167 John Freeman
TDU XMLRPC port: 50008
444 48 John Freeman
445 91 John Freeman
EventBuilder host: lbnedaq2
446 91 John Freeman
EventBuilder port: 5235
447 91 John Freeman
448 48 John Freeman
EventBuilder host: lbnedaq2
449 91 John Freeman
EventBuilder port: 5236
450 91 John Freeman
451 48 John Freeman
Aggregator host: lbnedaq2
452 91 John Freeman
Aggregator port: 5265
453 1 John Freeman
454 1 John Freeman
Aggregator host: lbnedaq2
455 1 John Freeman
Aggregator port: 5266
456 1 John Freeman
457 130 John Freeman
</pre>
458 1 John Freeman
459 130 John Freeman
The parameters you're most likely to change will be the following:
460 1 John Freeman
461 130 John Freeman
* *lbne-artdaq* : the directory in which the desired build of lbne-artdaq to use is located; you would change this if you'd modified and built a personal copy of lbne-artdaq for hardware troubleshooting purposes, for example.
462 130 John Freeman
463 130 John Freeman
* *debug level* : allows the user to set the verbosity level of the output to the screen; setting it to higher values creates greater verbosity, and as a practical matter, the range of settings is currently 0-3. Loosely speaking, "0" means minimal output (not much beyond simply announcing a transition is complete), "1" includes announcements of progress during transitions, "2" includes these announcements plus the values of certain variables as well as lbne-artdaq output, and "3" is primarily of developer interest. 
464 130 John Freeman
465 130 John Freeman
* *disable configuration check* : a boolean which can be set to "true" or "false"; normally this should be set to "false", which means that on the start transition, DAQInterface will intentionally fail and put itself into the "stopped" state if it discovers that edits have been made to the configuration directory since the last commit in that directory. If very frequent edits to the configuration directory are made during hardware debugging, however, switching this feature on to "true" can make life considerably easier. 
466 130 John Freeman
467 130 John Freeman
* *TDU XMLRPC port* : the value of the port through which DAQInterface will communicate with an XML-RPC server linked to the TDU. Needed for DAQInterface to send a sync pulse to the TDU at the beginning of the "start" and "resume" transitions. If this is set to 0 or a negative value, no sync pulse is attempted. For more on the TDU and its code, see Tom Dealtry's Wiki "here":https://cdcvs.fnal.gov/redmine/projects/lbne-daq/wiki/Starting_and_using_TDUControl
468 130 John Freeman
469 1 John Freeman
{{collapse(Other parameters are as follows…)
470 92 John Freeman
471 116 John Freeman
* *PMT host* : the host on which artdaq's process management tool script (pmt.rb, used by DAQInterface to launch and kill the artdaq processes) will run
472 93 John Freeman
* *PMT port* : pmt.rb's port
473 93 John Freeman
474 101 John Freeman
* *pause before initialization* : the time in seconds between when the artdaq processes have been created and when they're initialized via FHiCL documents; empirically a pause of 5 seconds seems to be sufficient (less than this an errors can occur; see below in the "Troubleshooting" section for more
475 1 John Freeman
476 101 John Freeman
* *log directory* : the directory relative to which lbne-artdaq's pmt/*.log output (a record of what it sent to stdout) will be placed, as well as the individual artdaq process logs, found in boardreader/, eventbuilder/, and aggregator/
477 101 John Freeman
478 49 Erik Blaufuss
* *record directory* : the directory to which metadata about the run (FHiCL documents used, DAQInterface configuration file used, etc.) gets sent
479 130 John Freeman
480 49 Erik Blaufuss
After these individual parameters, one defines the EventBuilderMain and AggregatorMain artdaq processes. Specifically, a process is defined in two lines, where each line should contain "EventBuilder" or "Aggregator", and then define the host and port on which the EventBuilderMain or AggregatorMain will run (to run an artdaq process on the same host as you're on, use "localhost"). Please note that the order of processes matters, and that they should be listed front-end to back-end, i.e., EventBuilders should appear before Aggregators.
481 57 John Freeman
}}
482 57 John Freeman
483 132 John Freeman
h1. Adding new configurations to RunControl
484 132 John Freeman
485 68 John Freeman
{{collapse(Expand for info here…)
486 68 John Freeman
487 91 John Freeman
Adding a new configuration selectable from RunControl involves two steps: creating a directory with the desired name of the configuration which contains the desired FHiCL documents, and then committing that directory to the git repository. 
488 57 John Freeman
489 57 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are edited within the directory
490 57 John Freeman
<pre>
491 57 John Freeman
/data/lbnedaq/config/<named_configuration>
492 57 John Freeman
</pre>
493 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
494 59 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
495 59 John Freeman
* <named_component>_hw_cfg.fcl, used to initialize the BoardReaderMain process running the fragment generator associated with detector component "named_component". Note that there can be any number of such files associated with a configuration, as long as a given component is registered to RunControl (see below, "Adding new DAQ Components to RunControl")
496 59 John Freeman
497 167 John Freeman
There are existing examples of configurations currently within /data/lbnedaq/config which can be studied (and even copied) for further guidance; a good starting point is the "demo" configuration due to its relative simplicity. Note that the FHiCL documents in these directories contain some variables which are set to "PLACEHOLDER", e.g.
498 59 John Freeman
<pre>
499 68 John Freeman
 event_builder_count: PLACEHOLDER
500 1 John Freeman
</pre>
501 68 John Freeman
Note that this is not legal FHiCL, but that DAQInterface will substitute in the appropriate value before using the FHiCL document to initialize an artdaq process; here, for example, it would replace "PLACEHOLDER" with the actual number of EventBuilderMain processes being run.
502 68 John Freeman
503 68 John Freeman
Once you've added a new configuration to /data/lbnedaq/config, you'll need to perform a git commit. Essentially,  /data/lbnedaq/config is not merely a collection of directories naming configurations, but also a git repository. In fact, if you run
504 68 John Freeman
<pre>
505 68 John Freeman
git log
506 68 John Freeman
</pre>
507 68 John Freeman
you'll see a history of the commits made to the repository. In order to commit the directory, a couple of steps need to be taken:
508 68 John Freeman
* From /data/lbnedaq/config/, run <pre>git add <named_configuration></pre>. This will "stage" the directory to be committed. Running <pre>git status</pre> should show you something like the following:
509 68 John Freeman
<pre>
510 68 John Freeman
# On branch master
511 68 John Freeman
# Changes to be committed:
512 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
513 68 John Freeman
#
514 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
515 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
516 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
517 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
518 68 John Freeman
#
519 68 John Freeman
</pre>
520 1 John Freeman
* Next, run <pre>git commit -m "<commit message>"</pre>. The commit message should be your three initials followed by a colon, the name of the configuration followed by a colon, and then a brief description of the new configuration, including its name, e.g.:
521 68 John Freeman
<pre>
522 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
523 68 John Freeman
</pre>
524 68 John Freeman
Be aware of rules governing strings delimited by double quotes in bash -- i.e., don't try double quoting a word or phrase inside of your commit description. 
525 68 John Freeman
</pre>
526 68 John Freeman
Now, make sure that the commit took place correctly by running
527 68 John Freeman
<pre>
528 68 John Freeman
git diff HEAD
529 1 John Freeman
</pre>
530 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
531 68 John Freeman
<pre>
532 69 John Freeman
git log
533 57 John Freeman
</pre>
534 79 John Freeman
you should be able to see your commit at the top.
535 79 John Freeman
536 79 John Freeman
* Finally, make sure to push your change to the central repository; to do this, simply execute
537 79 John Freeman
<pre>
538 79 John Freeman
git push origin
539 79 John Freeman
</pre>
540 79 John Freeman
541 79 John Freeman
and now, if you run 
542 79 John Freeman
543 79 John Freeman
<pre>
544 1 John Freeman
git diff origin/master
545 132 John Freeman
</pre>
546 132 John Freeman
547 79 John Freeman
you should again see no output. Pushing to the central repository is important as this is essentially the backup area for configurations; if a user accidentally overwrites something in /data/lbnedaq/config, as long as commits have been pushed to the central repository there will still be a saved record of configurations before the overwrites took place. In fact, as of this writing (12/3/14), if either (A) edits have been made to the /data/lbnedaq/config directory since its most recent commit, or (B) that commit hasn't been pushed to the central repository, DAQInterface will refuse to execute the initialize transition.
548 56 Erik Blaufuss
}}
549 49 Erik Blaufuss
550 133 John Freeman
h1. Adding new DAQ Components to RunControl
551 49 Erik Blaufuss
552 49 Erik Blaufuss
{{collapse(Expand for info here…)
553 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
554 18 John Freeman
<pre>
555 55 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
556 55 Erik Blaufuss
</pre>
557 49 Erik Blaufuss
Each entry (name: host port) defines:
558 49 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
559 18 John Freeman
* host - hostname where BoardReader process will be started
560 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
561 49 Erik Blaufuss
562 49 Erik Blaufuss
For example:
563 49 Erik Blaufuss
<pre>
564 49 Erik Blaufuss
component01: lbnedaq2 5205
565 49 Erik Blaufuss
component02: lbnedaq2 5206
566 133 John Freeman
</pre>
567 133 John Freeman
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
568 133 John Freeman
569 27 John Freeman
*Note* that you will need to kill and re-launch RunControl if you add a component
570 49 Erik Blaufuss
}}
571 28 John Freeman
572 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
573 27 John Freeman
574 49 Erik Blaufuss
h2.  Common RunControl issues
575 1 John Freeman
576 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
577 49 Erik Blaufuss
578 49 Erik Blaufuss
<pre>
579 50 Erik Blaufuss
lbnecmd help
580 50 Erik Blaufuss
</pre>
581 1 John Freeman
will list all available commands for RunControl with some details for help.  
582 45 John Freeman
 
583 49 Erik Blaufuss
h3.  No real configurations are listed by RunControl
584 45 John Freeman
585 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
586 49 Erik Blaufuss
<pre>
587 49 Erik Blaufuss
Available configs (Name : description)
588 45 John Freeman
589 49 Erik Blaufuss
dummy : Dummy description
590 1 John Freeman
</pre>
591 168 John Freeman
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running; how to do this, described earlier in the wiki, is simply to execute "lbnecmd check", and launching the configuration manager, also described earlier, can be done via "launch_daq_applications.sh -c"
592 147 John Freeman
593 169 John Freeman
h3. "lbnecmd check" returns "@Unknown exception '<ProtocolError for localhost:50008/RPC2: -1 >'@"
594 170 John Freeman
595 171 John Freeman
This sometimes happens when the TDU XML-RPC server has died. You can confirm this has happened by running "check_daq_applications.sh";  to relaunch it, run "launch_daq_applications.sh -t".
596 169 John Freeman
597 147 John Freeman
h2.  Common DAQInterface issues
598 148 John Freeman
599 148 John Freeman
As a preliminary: if something goes wrong when running the DAQ, there are two valuable sources of information:
600 174 John Freeman
# The pmt logfile(s), containing the output of the artdaq processes (including the output of the Art modules run within them -- so, for example, an exception throw from within a module would appear here). Where to find these logfiles is described in the section "Examining your output", earlier in this wiki. 
601 146 John Freeman
# The RunControl logfile, /home/lbnedaq/.lbnerc.log . This contains both the information sent from DAQInterface to RunControl, as well as diagnostic logging (such as the traceback of exception throws within DAQInterface)
602 146 John Freeman
603 173 John Freeman
In general, when something goes wrong during the running of the DAQ -- e.g., an artdaq process dies, or a sync pulse is attempted when the TDU XML-RPC server isn't alive -- DAQInterface will impose upon itself the "recovery" transition, where it returns itself to the "stopped" state regardless of whatever state it may have currently been in. When this occurs, you'll see something like the following:
604 173 John Freeman
<pre>
605 173 John Freeman
DAQInterface: "Recover" transition underway
606 173 John Freeman
JCF, 6/12/14 -- for now at least, "Recover" simply kills the artdaq processes
607 173 John Freeman
608 173 John Freeman
Recover transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
609 173 John Freeman
</pre>
610 173 John Freeman
611 175 John Freeman
If a recovery transition occurs, often you can begin using the DAQ again (starting with "lbnecmd init daq") without any issues. However, some issues may be persistent, or require manual intervention. A subset of those issues are described below. If any new ones come up, please contact John Freeman at jcfree@fnal.gov. 
612 173 John Freeman
613 164 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "<code>pmt.rb -p <port number> was already running on <hostname></code>"*
614 146 John Freeman
615 164 John Freeman
An instance of artdaq's Process Management Tool program, tasked with creating the artdaq processes, is already running on the host and port you've requested for it in the DAQInterface configuration file passed to the DAQInterface application. This can happen if, for example, the DAQInterface program from a previous session was killed off before the usual "lbnecmd terminate daq" transition was issued, a transition which prompts DAQInterface to kill off the pmt.rb process it has control over. Generally, DAQInterface will clean this up and free the port in the process of returning itself to the "stopped" state, but in case it doesn't, there's a script called "kill_artdaq_processes.sh" which can be used in the following manner:
616 146 John Freeman
<pre>
617 146 John Freeman
kill_artdaq_processes.sh <pmt host> <pmt port>
618 149 John Freeman
</pre>
619 146 John Freeman
620 146 John Freeman
This script will both kill off the pmt.rb which is clogging the port, as well as the artdaq processes over which it has control.
621 146 John Freeman
622 146 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
623 146 John Freeman
624 146 John Freeman
If a "Recover" is triggered and you can see via "lbnecmd check" that DAQInterface is in the "stopped" state, try initializing again. If that doesn't work, you can try increasing the value of the "pause before initialization" variable in the DAQInterface configuration file. Empirically, it appears there needs to be a pause of at least 5 seconds before the FHiCL documents can be successfully sent via XML-RPC to the processes; increasing this value may make it less likely that the "Connection refused" error occurs.
625 146 John Freeman
626 146 John Freeman
h3. *Regardless of how high the debug level is set to, you don't see any output to screen when you issue transitions to DAQInterface*
627 146 John Freeman
628 146 John Freeman
Chances are that DAQInterface was started in another terminal, and consequently, it's in that terminal where output will appear. This issue can be circumvented by redirecting DAQInterface output into a file; how this can be accomplished is described elsewhere in this document.
629 1 John Freeman
630 1 John Freeman
{{collapse(Of developer interest)
631 1 John Freeman
h3.  *Error handling*
632 1 John Freeman
633 1 John Freeman
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
634 1 John Freeman
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
635 1 John Freeman
# During periodic checks, one or more artdaq processes expected to exist are not found
636 51 John Freeman
637 84 John Freeman
In either case, an error is reported via 0MQ to RunControl, and the "Recover" transition is automatically triggered. This transition is a fairly blunt instrument: it will kill any remaining artdaq processes and return DAQInterface to its original state of "stopped" (i.e., one in which it requires the "init" transition before anything else is done). 
638 77 John Freeman
639 77 John Freeman
h3. *Your change to the DAQInterface configuration file or the daqinterface.py code doesn't seem to do anything*
640 1 John Freeman
641 146 John Freeman
Make sure you kill the existing daqinterface process and restart it
642 1 John Freeman
643 1 John Freeman
}}