Project

General

Profile

Running DAQ Interface » History » Version 73

John Freeman, 11/24/2014 02:42 PM

1 58 John Freeman
{{toc}}
2 58 John Freeman
3 49 Erik Blaufuss
h1. Getting help
4 1 John Freeman
5 49 Erik Blaufuss
If you run into issues, or have questions, please contact:
6 49 Erik Blaufuss
* DAQInterface
7 49 Erik Blaufuss
** John Freeman - jcfree@fnal.gov
8 62 John Freeman
* RunControl
9 49 Erik Blaufuss
** Erik Blaufuss - blaufuss@icecube.umd.edu
10 66 John Freeman
* Configuration Manager
11 66 John Freeman
** Jon Paley - jpaley@anl.gov
12 1 John Freeman
13 1 John Freeman
h1. Starting DAQInterface and Run Control
14 1 John Freeman
15 66 John Freeman
The DAQ software, consisting of RunControl, the configuration manager and DAQInterface (as well as the artdaq processes it controls) is designed to be run on lbne35t-gateway01.fnal.gov, using the lbnedaq account. If you need access to the lbnedaq@lbne35t-gateway01.fnal.gov account, please contact one of us.
16 66 John Freeman
Primarily of developer (as opposed to user) interest, DAQInterface and RunControl software can also be run on the lbnedaqtest01 VM machine, please contact John Freeman at jcfree@fnal.gov, for more details.
17 49 Erik Blaufuss
18 66 John Freeman
The installed code is located at lbne35t-gateway01.fnal.gov:/data/lbnedaq/scratch/DAQInterface/lbnerc. To get started, login and first setup the environment:
19 49 Erik Blaufuss
20 30 John Freeman
<pre>
21 33 John Freeman
ssh lbnedaq@lbne35t-gateway01.fnal.gov
22 1 John Freeman
cd /data/lbnedaq/scratch/DAQInterface
23 1 John Freeman
source fireup
24 1 John Freeman
</pre>
25 1 John Freeman
26 66 John Freeman
This will take you into the /data/lbnedaq/scratch/DAQInterface/lbnerc directory. It's a good idea to check whether lbnecontrol (the RunControl application), DAQInterface (the component which intermediates between RunControl, the configuration manager, and the artdaq processes) and the configuration manager are already running; if they aren't, the instructions below won't work. Also worth noting is that as of 11/21/14, attempts to use multiple DAQs (implying multiple instances of RunControl, DAQInterface, etc.) has not been attempted and likely will not work. To check for RunControl and DAQInterface, you can try:
27 1 John Freeman
28 1 John Freeman
<pre>
29 49 Erik Blaufuss
lbnecmd check
30 1 John Freeman
</pre>
31 1 John Freeman
32 61 John Freeman
This will display the current state of DAQInterface and RunControl. The example below shows that both RunControl and DAQInterface are running, but the DAQ run is in the stopped state:
33 49 Erik Blaufuss
<pre>
34 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
35 49 Erik Blaufuss
lbnecontrol: running
36 49 Erik Blaufuss
daqint@localhost:5770 (synchronous): stopped
37 49 Erik Blaufuss
</pre>
38 1 John Freeman
39 73 John Freeman
If RunControl is running, and at some point DAQInterface was running but has since been killed:
40 73 John Freeman
<pre>
41 73 John Freeman
lbnecontrol: running
42 73 John Freeman
daqint@localhost:5770 (synchronous): missing
43 73 John Freeman
</pre>
44 73 John Freeman
(In this case, just restart DAQInterface).
45 73 John Freeman
46 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
47 1 John Freeman
<pre>
48 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
49 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
50 1 John Freeman
</pre>
51 1 John Freeman
52 61 John Freeman
To check whether the configuration manager is running, you can simply use Linux commands:
53 61 John Freeman
54 61 John Freeman
<pre>
55 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
56 61 John Freeman
</pre>
57 61 John Freeman
58 71 John Freeman
This will either return info on the CfgMgrApp process, or print nothing if it's not running. In fact, it's possible to use Linux commands to check the status of all three programs:
59 71 John Freeman
60 71 John Freeman
<pre>
61 71 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgr
62 71 John Freeman
</pre>
63 61 John Freeman
64 1 John Freeman
h3. Starting RunControl
65 49 Erik Blaufuss
66 49 Erik Blaufuss
To start RunControl (after loading environment as above):
67 60 John Freeman
<pre>
68 70 John Freeman
rm /tmp/lbnecontrol.pid  # (This should only be necessary of RunControl software wasn't stopped cleanly)
69 49 Erik Blaufuss
lbnecmd launch
70 49 Erik Blaufuss
</pre>
71 1 John Freeman
72 1 John Freeman
h3. Starting DAQInterface
73 1 John Freeman
74 61 John Freeman
To start DAQInterface (after loading environment as above), the basic command is:
75 1 John Freeman
<pre>
76 61 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost &
77 61 John Freeman
</pre>
78 61 John Freeman
However, particularly if multiple users with different terminals wish to check the DAQ output, it is recommended to try:
79 61 John Freeman
<pre>
80 49 Erik Blaufuss
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost >>~/DI.log 2>&1 &
81 1 John Freeman
</pre>
82 1 John Freeman
This will launch daqinterface in the background, with all messages being collected (appended to the bottom of...) in the file ~/DI.log  (The stdbuf -oL prevents and buffering of output to the file)
83 63 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.
84 1 John Freeman
85 1 John Freeman
h3. Starting the configuration manager
86 63 John Freeman
87 62 John Freeman
Please see Jon Paley's documentation here: https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki
88 62 John Freeman
89 61 John Freeman
h3. Forcing cleanup: performing a hard reset of RunControl, DAQInterface and the configuration manager
90 49 Erik Blaufuss
91 1 John Freeman
If needed, you can track down the process names and kill them explicitly to get a clean reset:
92 1 John Freeman
<pre>
93 49 Erik Blaufuss
ps aux | grep -v grep | grep lbnecontrol
94 49 Erik Blaufuss
ps aux | grep -v grep | grep daqinterface
95 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
96 49 Erik Blaufuss
</pre>
97 61 John Freeman
If these processes are running, it either means that someone else is using the DAQ, or that someone else who's done using it forgot to clean up. 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.   To kill them, the second field returned from "ps aux" is the process id (PID), use:
98 1 John Freeman
<pre>
99 49 Erik Blaufuss
kill <PID>
100 1 John Freeman
</pre>
101 1 John Freeman
102 61 John Freeman
h1. Configuring and starting Runs
103 1 John Freeman
104 61 John Freeman
Now, you can take the DAQ system through the standard transitions to start a DAQ run.  At all stages, you can use the "lbnecmd check" command to see what state DAQInterface is in; 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 to its log file when transitions are complete:
105 49 Erik Blaufuss
<pre>
106 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
107 61 John Freeman
</pre>
108 1 John Freeman
Note that if a high "debug level" has been set (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. 
109 1 John Freeman
110 62 John Freeman
h2.  Selecting a configuration and DAQ components
111 49 Erik Blaufuss
112 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
113 1 John Freeman
114 49 Erik Blaufuss
h3. List and select a configuration:
115 1 John Freeman
116 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
117 49 Erik Blaufuss
<pre>
118 49 Erik Blaufuss
lbnecmd listconfigs
119 1 John Freeman
</pre>
120 49 Erik Blaufuss
Will return a list of configs:
121 49 Erik Blaufuss
<pre>
122 49 Erik Blaufuss
Available configs (Name : description)
123 1 John Freeman
124 49 Erik Blaufuss
demo : Pithy description
125 49 Erik Blaufuss
tmp1 : Pithy description
126 49 Erik Blaufuss
...
127 30 John Freeman
128 49 Erik Blaufuss
Current selected config: No Config
129 49 Erik Blaufuss
</pre>
130 49 Erik Blaufuss
This lists all available configs, as well as the current selected config (Note, default config is "No Config").  You can then select a configuration:
131 49 Erik Blaufuss
<pre> 
132 49 Erik Blaufuss
lbnecmd setconfig demo
133 1 John Freeman
</pre>
134 64 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.
135 1 John Freeman
136 49 Erik Blaufuss
h3. List and select DAQ components.
137 1 John Freeman
138 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
139 62 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,
140 1 John Freeman
or DAQInterface will return an error.
141 38 John Freeman
142 1 John Freeman
To see the list of available DAQ components:
143 49 Erik Blaufuss
<pre>
144 1 John Freeman
lbnecmd listdaqcomps
145 49 Erik Blaufuss
</pre>
146 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
147 1 John Freeman
<pre>
148 49 Erik Blaufuss
{'available': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
149 49 Erik Blaufuss
{'selected': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
150 49 Erik Blaufuss
</pre>
151 62 John Freeman
Shown are the available components by name, along with the requested host/port to run the BoardReaderMain process on. You can then select a list of DAQ components to use in the run:
152 49 Erik Blaufuss
<pre>
153 49 Erik Blaufuss
lbnecmd setdaqcomps component01 component02
154 49 Erik Blaufuss
</pre>
155 62 John Freeman
This will return "OK" if successful ("lbnecmd listdaqcomps" will show this in the "selected" row of components).  If the specified compnents are not known, an error is returned.
156 49 Erik Blaufuss
To change the list of available components, see below.
157 29 John Freeman
158 49 Erik Blaufuss
h2. Configuring, starting, stopping and terminating a Run
159 1 John Freeman
160 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:
161 1 John Freeman
<pre>
162 49 Erik Blaufuss
lbnecmd check
163 1 John Freeman
</pre>
164 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.
165 1 John Freeman
166 49 Erik Blaufuss
First, take DAQInterface from the "stopped" to the "ready" state; this will create the artdaq processes on the hosts you selected (DAQ components), and initialize them with the FHiCL configuration:
167 1 John Freeman
<pre>
168 1 John Freeman
lbnecmd init daq
169 1 John Freeman
</pre>
170 1 John Freeman
171 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
172 29 John Freeman
<pre>
173 1 John Freeman
lbnecmd start daq
174 29 John Freeman
</pre>
175 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
176 49 Erik Blaufuss
<pre>
177 49 Erik Blaufuss
lbnecmd check
178 49 Erik Blaufuss
lbnecontrol: running
179 49 Erik Blaufuss
Run number: 207
180 49 Erik Blaufuss
Run configuration: demo
181 1 John Freeman
182 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
183 49 Erik Blaufuss
</pre>
184 49 Erik Blaufuss
185 49 Erik Blaufuss
Pause the running of the DAQ, putting DAQInterface into the "paused" state.  This will cause the current open output file to be closed and given a name reflecting the current run number:
186 22 John Freeman
<pre>
187 21 John Freeman
lbnecmd pause daq
188 42 John Freeman
</pre>
189 41 John Freeman
190 1 John Freeman
Resume the running of the DAQ, putting returning to the "running" state.  This will restart data taking to a new output file:
191 48 John Freeman
<pre>
192 48 John Freeman
lbnecmd resume daq
193 48 John Freeman
</pre>
194 48 John Freeman
195 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
196 48 John Freeman
<pre>
197 48 John Freeman
lbnecmd stop daq
198 49 Erik Blaufuss
</pre>
199 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
200 62 John Freeman
*NOTE* To select a new configuration or DAQ component set, you must kill all ArtDAQ processes and return DAQInterface to its "stopped" state with the "terminate" command:
201 1 John Freeman
202 1 John Freeman
<pre>
203 1 John Freeman
lbnecmd terminate daq
204 1 John Freeman
</pre>
205 67 Erik Blaufuss
206 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
207 67 Erik Blaufuss
<pre>
208 67 Erik Blaufuss
lbnecmd kill
209 67 Erik Blaufuss
</pre>
210 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
211 1 John Freeman
212 49 Erik Blaufuss
h2. After your DAQ run.
213 1 John Freeman
214 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
215 48 John Freeman
216 65 John Freeman
* A record of the DAQ's output will be saved in the subdirectory pmt/ relative to where you specified the output logfiles; thus given the "log directory" setting in the example config.txt below, you'd find the output in /data/lbnedaq/daqlogs/pmt/. 
217 72 John Freeman
* Also, a record of the FHiCL documents sent to the artdaq processes, the config.txt file used to control DAQInterface, and some further information will have been saved; as of this writing (11/12/14) the directory in which this can be found defaults to /data/lbnedaq/scratch/jcfree/TemporarySaveArea/<run number>, although as you might imagine the plan is to eventually change this directory. 
218 51 John Freeman
** PLEASE NOTE that there may be slight differences between the saved FHiCL documents and the FHiCL documents specified in config.txt and/or provided by the choice of configuration. The saved FHiCL document name is standardized to <processtype>_<host>_<port>_r<run number>.fcl, so, e.g, "Aggregator_lbnedaq2_5266_r192.fcl" would be the saved name of /data/lbnedaq/fcl/Aggregator_lbnedaq2_2.fcl, listed in the example config.txt file above, assuming datataking was performed in run 192. 
219 1 John Freeman
** More importantly, the FHiCL document actually sent to the artdaq process may be slightly different than the FHiCL document provided for DAQInterface; 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). It is this post-bookkeeping FHiCL document which actually gets sent to the processes which gets saved to the output directory. 
220 72 John Freeman
** The "further information" mentioned above is stored in a file of the form "metadata_r<run number>.txt"; it includes the configuration chosen for the run, the components used, as well as the commit hashes for the lbne-artdaq, lbnerc, and configuration directory used. E.g.,
221 72 John Freeman
<pre>
222 72 John Freeman
Config name: demo
223 72 John Freeman
Component #0: component01
224 72 John Freeman
Component #1: component02
225 72 John Freeman
lbne-artdaq commit: 13b523181a6f8ff6e78ede590d6372ed6193c79c
226 72 John Freeman
lbnerc commit: 288001cf015e1a763dbba482923fc7ac8f379ae6
227 72 John Freeman
/data/lbnedaq/config commit: 877e43fe3ad96991adf5d57dbfbdefb6300fde25
228 72 John Freeman
</pre>
229 52 John Freeman
* Output of the Art modules. 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. 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.
230 1 John Freeman
231 49 Erik Blaufuss
h1. Configuring DAQInterface
232 49 Erik Blaufuss
233 52 John Freeman
DAQInterface has some key information stored in a local configuration file (location and ports for EventBuilders, Aggregators, location of artDAQ, log level, etc). These can be changed while DAQInterface is not running,  It's expected that for normal operations, these should not need to changed too often. Assuming the processes aren't running, before getting started, take a look at the configuration file, found in docs/config.txt (relative to /data/lbnedaq/scratch/DAQInterface/lbnerc). 
234 49 Erik Blaufuss
It should look something like the following:
235 1 John Freeman
<pre>
236 49 Erik Blaufuss
lbne-artdaq: /data/lbnedaq/scratch/DAQInterface/build_lbne-artdaq
237 1 John Freeman
238 49 Erik Blaufuss
PMT host: lbnedaq3
239 49 Erik Blaufuss
240 49 Erik Blaufuss
pause before initialization: 5
241 49 Erik Blaufuss
242 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
243 49 Erik Blaufuss
debug level: 1
244 49 Erik Blaufuss
245 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
246 49 Erik Blaufuss
247 49 Erik Blaufuss
record directory: /data/lbnedaq/scratch/jcfree/TemporarySaveArea/
248 49 Erik Blaufuss
249 1 John Freeman
 EventBuilder host: lbnedaq2
250 48 John Freeman
 EventBuilder port: 5235
251 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo1.fcl
252 48 John Freeman
253 48 John Freeman
 EventBuilder host: lbnedaq2
254 48 John Freeman
 EventBuilder port: 5236
255 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo2.fcl
256 48 John Freeman
257 48 John Freeman
 Aggregator host: lbnedaq2
258 48 John Freeman
 Aggregator port: 5265
259 41 John Freeman
260 1 John Freeman
 Aggregator host: lbnedaq2
261 21 John Freeman
 Aggregator port: 5266
262 49 Erik Blaufuss
</pre>
263 1 John Freeman
264 49 Erik Blaufuss
The "lbne-artdaq" parameter allows the user to set the directory in which the desired build of lbne-artdaq to use is located, the "PMT host" parameter is the host on which artdaq's process management tool script (pmt.rb, used by DAQInterface to launch and kill the artdaq processes) will run, and "log directory" is the directory to which lbne-artdaq's output will be sent. The "debug level" parameter 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. The "pause before initialization" parameter allows the user to set a pause, in seconds, between when the artdaq processes start and when they're initialized; it has been observed that a latency of a few seconds is needed for initialization to proceed correctly (though this is not always the case -- on lbne35t-gateway01, with a high setting for "debug level", a pause is not needed; the reason why "debug level" matters in this context is not yet understood).
265 49 Erik Blaufuss
266 53 John Freeman
After these individual parameters, one defines the EventBuilderMain and AggregatorMain artdaq processes. Specifically, an EventBuilderMain is defined in three lines, where each line should contain "EventBuilder", and define the host and port on which the EventBuilderMain will run (to run an artdaq process on the same host as you're on, use "localhost") as well as the FHiCL document used to initialize the EventBuilderMain. AggregatorMain is defined similarly, using the token "Aggregator", but without the FHiCL document supplied, as this is supplied by the choice of configuration in the configuration manager. Best practice is to place the EventBuilderMain's FHiCL documents in the /data/lbnedaq/fcl directory. 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.
267 49 Erik Blaufuss
268 57 John Freeman
h1. Adding new configurations to RunControl
269 57 John Freeman
270 68 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. 
271 68 John Freeman
272 68 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are stored within the directory
273 57 John Freeman
<pre>
274 57 John Freeman
/data/lbnedaq/config/<named_configuration>
275 57 John Freeman
</pre>
276 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
277 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
278 57 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")
279 59 John Freeman
280 59 John Freeman
There are existing examples of configurations currently within /data/lbnedaq/config which can be studied (and even copied) for further guidance; however, please disregard the "tmp1" and "tmp2" configurations. Note that the FHiCL documents in these directories contain some variables which are set to "PLACEHOLDER", e.g.
281 59 John Freeman
<pre>
282 1 John Freeman
 event_builder_count: PLACEHOLDER
283 59 John Freeman
</pre>
284 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.
285 1 John Freeman
286 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
287 68 John Freeman
<pre>
288 68 John Freeman
git log
289 68 John Freeman
</pre>
290 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:
291 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:
292 68 John Freeman
<pre>
293 68 John Freeman
# On branch master
294 68 John Freeman
# Changes to be committed:
295 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
296 68 John Freeman
#
297 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
298 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
299 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
300 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
301 68 John Freeman
#
302 68 John Freeman
</pre>
303 68 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.:
304 68 John Freeman
<pre>
305 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
306 68 John Freeman
</pre>
307 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. 
308 68 John Freeman
</pre>
309 68 John Freeman
Now, make sure that the commit took place correctly by running
310 68 John Freeman
<pre>
311 68 John Freeman
git diff HEAD
312 68 John Freeman
</pre>
313 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
314 1 John Freeman
<pre>
315 68 John Freeman
git log
316 68 John Freeman
</pre>
317 69 John Freeman
you should be able to see your commit at the top.
318 57 John Freeman
319 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
320 49 Erik Blaufuss
321 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
322 49 Erik Blaufuss
<pre>
323 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
324 18 John Freeman
</pre>
325 55 Erik Blaufuss
Each entry (name: host port) defines:
326 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
327 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
328 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
329 18 John Freeman
330 49 Erik Blaufuss
For example:
331 49 Erik Blaufuss
<pre>
332 49 Erik Blaufuss
component01: lbnedaq2 5205
333 49 Erik Blaufuss
component02: lbnedaq2 5206
334 49 Erik Blaufuss
</pre>
335 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
336 27 John Freeman
337 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
338 28 John Freeman
339 49 Erik Blaufuss
h2.  Common RunControl issues
340 27 John Freeman
341 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
342 1 John Freeman
343 49 Erik Blaufuss
<pre>
344 49 Erik Blaufuss
lbnecmd help
345 49 Erik Blaufuss
</pre>
346 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
347 50 Erik Blaufuss
 
348 50 Erik Blaufuss
h3.  No real configurations are listed by RunControl
349 45 John Freeman
350 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
351 45 John Freeman
<pre>
352 49 Erik Blaufuss
Available configs (Name : description)
353 49 Erik Blaufuss
354 49 Erik Blaufuss
dummy : Dummy description
355 45 John Freeman
</pre>
356 49 Erik Blaufuss
Instead of your expected configurations, RunControl is not able to connect to CfgMgr.  Please make sure it's running (https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki/Wiki)
357 1 John Freeman
358 49 Erik Blaufuss
h2.  Common DAQInterface issues
359 49 Erik Blaufuss
360 49 Erik Blaufuss
h3.  *Error handling*
361 49 Erik Blaufuss
362 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
363 49 Erik Blaufuss
# An artdaq process returns an error state after a transition request, or an exception is thrown by the XML-RPC library during the request
364 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
365 49 Erik Blaufuss
366 49 Erik Blaufuss
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). 
367 49 Erik Blaufuss
368 49 Erik Blaufuss
h3. *Your change to docs/config.txt or daqinterface.py doesn't seem to do anything*
369 49 Erik Blaufuss
370 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
371 49 Erik Blaufuss
372 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
373 49 Erik Blaufuss
374 1 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 docs/config.txt file. Empirically, it appears there needs to be a pause of at least 4 seconds on lbnedaqtest01.fnal.gov 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.
375 54 John Freeman
376 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
377 49 Erik Blaufuss
378 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
379 1 John Freeman
<pre>
380 1 John Freeman
Waiting for all processes to be launched; if zombie pmt.rb is running on localhost please kill it and this program (PID 31820)
381 1 John Freeman
</pre>
382 1 John Freeman
keeps getting output to screen, it means there's a problem initializing. In this case, the current (11/12/14) course of action is to externally kill DAQInterface using the PID listed; also, it's possible that there may already be a pmt.rb executable running on the desired host, blocking the launch of a new one due to a port conflict, in which case you should log onto the host (assuming you're not already on it), and run 
383 1 John Freeman
<pre>
384 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
385 1 John Freeman
</pre>
386 51 John Freeman
to see if this is the case. If it's not and you can't think of what might be wrong (is the configuration manager running? have you double-checked docs/config.txt?), then try increasing the debug level in docs/config.txt for your next run-through, as this will likely shed light on the nature of the problem.