Project

General

Profile

Running DAQ Interface » History » Version 72

John Freeman, 11/21/2014 06:14 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 49 Erik Blaufuss
If RunControl is not running, you'll see something like:
40 1 John Freeman
<pre>
41 49 Erik Blaufuss
(env)[lbnedaq@lbne35t-gateway01 lbnerc]$ lbnecmd check
42 49 Erik Blaufuss
check failed: '[Errno 111] Connection refused'.  Is lbnecontrol running?
43 1 John Freeman
</pre>
44 1 John Freeman
45 61 John Freeman
To check whether the configuration manager is running, you can simply use Linux commands:
46 61 John Freeman
47 61 John Freeman
<pre>
48 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
49 61 John Freeman
</pre>
50 61 John Freeman
51 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:
52 71 John Freeman
53 71 John Freeman
<pre>
54 71 John Freeman
ps aux | grep -v grep | egrep -e lbnecontrol -e daqinterface -e CfgMgr
55 71 John Freeman
</pre>
56 61 John Freeman
57 1 John Freeman
h3. Starting RunControl
58 49 Erik Blaufuss
59 49 Erik Blaufuss
To start RunControl (after loading environment as above):
60 60 John Freeman
<pre>
61 70 John Freeman
rm /tmp/lbnecontrol.pid  # (This should only be necessary of RunControl software wasn't stopped cleanly)
62 49 Erik Blaufuss
lbnecmd launch
63 49 Erik Blaufuss
</pre>
64 1 John Freeman
65 1 John Freeman
h3. Starting DAQInterface
66 1 John Freeman
67 61 John Freeman
To start DAQInterface (after loading environment as above), the basic command is:
68 1 John Freeman
<pre>
69 61 John Freeman
daqinterface -n daqint -r 5570 -c localhost -H localhost &
70 61 John Freeman
</pre>
71 61 John Freeman
However, particularly if multiple users with different terminals wish to check the DAQ output, it is recommended to try:
72 61 John Freeman
<pre>
73 49 Erik Blaufuss
stdbuf -oL daqinterface -n daqint -r 5570 -c localhost -H localhost >>~/DI.log 2>&1 &
74 1 John Freeman
</pre>
75 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)
76 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.
77 1 John Freeman
78 1 John Freeman
h3. Starting the configuration manager
79 63 John Freeman
80 62 John Freeman
Please see Jon Paley's documentation here: https://cdcvs.fnal.gov/redmine/projects/fhicl_cfgmgr/wiki
81 62 John Freeman
82 61 John Freeman
h3. Forcing cleanup: performing a hard reset of RunControl, DAQInterface and the configuration manager
83 49 Erik Blaufuss
84 1 John Freeman
If needed, you can track down the process names and kill them explicitly to get a clean reset:
85 1 John Freeman
<pre>
86 49 Erik Blaufuss
ps aux | grep -v grep | grep lbnecontrol
87 49 Erik Blaufuss
ps aux | grep -v grep | grep daqinterface
88 61 John Freeman
ps aux | grep -v grep | grep CfgMgrApp
89 49 Erik Blaufuss
</pre>
90 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:
91 1 John Freeman
<pre>
92 49 Erik Blaufuss
kill <PID>
93 1 John Freeman
</pre>
94 1 John Freeman
95 61 John Freeman
h1. Configuring and starting Runs
96 1 John Freeman
97 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:
98 49 Erik Blaufuss
<pre>
99 49 Erik Blaufuss
Initialize transition complete; if running DAQInterface in the background, can press <enter> to return to shell prompt
100 61 John Freeman
</pre>
101 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. 
102 1 John Freeman
103 62 John Freeman
h2.  Selecting a configuration and DAQ components
104 49 Erik Blaufuss
105 1 John Freeman
*Before initializing or starting a DAQ run*, a configuration and set of DAQComponents must be selected.  This is done via RunControl.
106 1 John Freeman
107 49 Erik Blaufuss
h3. List and select a configuration:
108 1 John Freeman
109 62 John Freeman
To see the list of available configurations (queried from the configuration manager):
110 49 Erik Blaufuss
<pre>
111 49 Erik Blaufuss
lbnecmd listconfigs
112 1 John Freeman
</pre>
113 49 Erik Blaufuss
Will return a list of configs:
114 49 Erik Blaufuss
<pre>
115 49 Erik Blaufuss
Available configs (Name : description)
116 1 John Freeman
117 49 Erik Blaufuss
demo : Pithy description
118 49 Erik Blaufuss
tmp1 : Pithy description
119 49 Erik Blaufuss
...
120 30 John Freeman
121 49 Erik Blaufuss
Current selected config: No Config
122 49 Erik Blaufuss
</pre>
123 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:
124 49 Erik Blaufuss
<pre> 
125 49 Erik Blaufuss
lbnecmd setconfig demo
126 1 John Freeman
</pre>
127 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.
128 1 John Freeman
129 49 Erik Blaufuss
h3. List and select DAQ components.
130 1 John Freeman
131 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
132 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,
133 1 John Freeman
or DAQInterface will return an error.
134 38 John Freeman
135 1 John Freeman
To see the list of available DAQ components:
136 49 Erik Blaufuss
<pre>
137 1 John Freeman
lbnecmd listdaqcomps
138 49 Erik Blaufuss
</pre>
139 62 John Freeman
Will return a list of components available and selected (*Default* is ALL available components), e.g.:
140 1 John Freeman
<pre>
141 49 Erik Blaufuss
{'available': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
142 49 Erik Blaufuss
{'selected': {'component02': ['lbnedaq2', '5206'], 'component01': ['lbnedaq2', '5205']}}
143 49 Erik Blaufuss
</pre>
144 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:
145 49 Erik Blaufuss
<pre>
146 49 Erik Blaufuss
lbnecmd setdaqcomps component01 component02
147 49 Erik Blaufuss
</pre>
148 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.
149 49 Erik Blaufuss
To change the list of available components, see below.
150 29 John Freeman
151 49 Erik Blaufuss
h2. Configuring, starting, stopping and terminating a Run
152 1 John Freeman
153 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:
154 1 John Freeman
<pre>
155 49 Erik Blaufuss
lbnecmd check
156 1 John Freeman
</pre>
157 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.
158 1 John Freeman
159 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:
160 1 John Freeman
<pre>
161 1 John Freeman
lbnecmd init daq
162 1 John Freeman
</pre>
163 1 John Freeman
164 49 Erik Blaufuss
Take DAQInterface from the "ready" to the "running" state, in order to begin taking data:
165 29 John Freeman
<pre>
166 1 John Freeman
lbnecmd start daq
167 29 John Freeman
</pre>
168 49 Erik Blaufuss
Note: the current run number is displayed when DAQ is in the running state using the "lbnecmd check" command:
169 49 Erik Blaufuss
<pre>
170 49 Erik Blaufuss
lbnecmd check
171 49 Erik Blaufuss
lbnecontrol: running
172 49 Erik Blaufuss
Run number: 207
173 49 Erik Blaufuss
Run configuration: demo
174 1 John Freeman
175 49 Erik Blaufuss
daqint@localhost:5570 (synchronous): running
176 49 Erik Blaufuss
</pre>
177 49 Erik Blaufuss
178 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:
179 22 John Freeman
<pre>
180 21 John Freeman
lbnecmd pause daq
181 42 John Freeman
</pre>
182 41 John Freeman
183 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:
184 48 John Freeman
<pre>
185 48 John Freeman
lbnecmd resume daq
186 48 John Freeman
</pre>
187 48 John Freeman
188 48 John Freeman
Halt the running of the DAQ, returning DAQInterface to the "ready" state from the "running" state:
189 48 John Freeman
<pre>
190 48 John Freeman
lbnecmd stop daq
191 49 Erik Blaufuss
</pre>
192 49 Erik Blaufuss
From the ready state, you can start a new run with the same configuration and DAQ components you originally selected. 
193 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:
194 1 John Freeman
195 1 John Freeman
<pre>
196 1 John Freeman
lbnecmd terminate daq
197 1 John Freeman
</pre>
198 67 Erik Blaufuss
199 67 Erik Blaufuss
If you want to stop all RunControl processes (known as "lbnecontrol"):
200 67 Erik Blaufuss
<pre>
201 67 Erik Blaufuss
lbnecmd kill
202 67 Erik Blaufuss
</pre>
203 67 Erik Blaufuss
After this, you will need to relaunch RunControl as above.
204 1 John Freeman
205 49 Erik Blaufuss
h2. After your DAQ run.
206 1 John Freeman
207 49 Erik Blaufuss
Once you've completed your run, there are a few things you can look at. 
208 48 John Freeman
209 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/. 
210 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. 
211 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. 
212 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. 
213 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.,
214 72 John Freeman
<pre>
215 72 John Freeman
Config name: demo
216 72 John Freeman
Component #0: component01
217 72 John Freeman
Component #1: component02
218 72 John Freeman
lbne-artdaq commit: 13b523181a6f8ff6e78ede590d6372ed6193c79c
219 72 John Freeman
lbnerc commit: 288001cf015e1a763dbba482923fc7ac8f379ae6
220 72 John Freeman
/data/lbnedaq/config commit: 877e43fe3ad96991adf5d57dbfbdefb6300fde25
221 72 John Freeman
</pre>
222 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.
223 1 John Freeman
224 49 Erik Blaufuss
h1. Configuring DAQInterface
225 49 Erik Blaufuss
226 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). 
227 49 Erik Blaufuss
It should look something like the following:
228 1 John Freeman
<pre>
229 49 Erik Blaufuss
lbne-artdaq: /data/lbnedaq/scratch/DAQInterface/build_lbne-artdaq
230 1 John Freeman
231 49 Erik Blaufuss
PMT host: lbnedaq3
232 49 Erik Blaufuss
233 49 Erik Blaufuss
pause before initialization: 5
234 49 Erik Blaufuss
235 49 Erik Blaufuss
# debug level can range from 0 to 3 (increasing order of verbosity)
236 49 Erik Blaufuss
debug level: 1
237 49 Erik Blaufuss
238 49 Erik Blaufuss
log directory:   /data/lbnedaq/daqlogs
239 49 Erik Blaufuss
240 49 Erik Blaufuss
record directory: /data/lbnedaq/scratch/jcfree/TemporarySaveArea/
241 49 Erik Blaufuss
242 1 John Freeman
 EventBuilder host: lbnedaq2
243 48 John Freeman
 EventBuilder port: 5235
244 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo1.fcl
245 48 John Freeman
246 48 John Freeman
 EventBuilder host: lbnedaq2
247 48 John Freeman
 EventBuilder port: 5236
248 48 John Freeman
 EventBuilder fhicl: /data/lbnedaq/fcl/EventBuilder_demo2.fcl
249 48 John Freeman
250 48 John Freeman
 Aggregator host: lbnedaq2
251 48 John Freeman
 Aggregator port: 5265
252 41 John Freeman
253 1 John Freeman
 Aggregator host: lbnedaq2
254 21 John Freeman
 Aggregator port: 5266
255 49 Erik Blaufuss
</pre>
256 1 John Freeman
257 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).
258 49 Erik Blaufuss
259 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.
260 49 Erik Blaufuss
261 57 John Freeman
h1. Adding new configurations to RunControl
262 57 John Freeman
263 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. 
264 68 John Freeman
265 68 John Freeman
As of 11/20/14, the FHiCL documents associated with a given configuration are stored within the directory
266 57 John Freeman
<pre>
267 57 John Freeman
/data/lbnedaq/config/<named_configuration>
268 57 John Freeman
</pre>
269 57 John Freeman
where "named_configuration" would be the name of the configuration, in this example. Within this directory, the following files are expected:
270 57 John Freeman
* Aggregator1.fcl and Aggregator2.fcl, used to initialize the two AggregatorMain processes in the DAQ system
271 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")
272 59 John Freeman
273 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.
274 59 John Freeman
<pre>
275 1 John Freeman
 event_builder_count: PLACEHOLDER
276 59 John Freeman
</pre>
277 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.
278 1 John Freeman
279 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
280 68 John Freeman
<pre>
281 68 John Freeman
git log
282 68 John Freeman
</pre>
283 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:
284 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:
285 68 John Freeman
<pre>
286 68 John Freeman
# On branch master
287 68 John Freeman
# Changes to be committed:
288 68 John Freeman
#   (use "git reset HEAD <file>..." to unstage)
289 68 John Freeman
#
290 68 John Freeman
#	new file:   helloworld/Aggregator1.fcl
291 68 John Freeman
#	new file:   helloworld/Aggregator2.fcl
292 68 John Freeman
#	new file:   helloworld/component01_hw_cfg.fcl
293 68 John Freeman
#	new file:   helloworld/component02_hw_cfg.fcl
294 68 John Freeman
#
295 68 John Freeman
</pre>
296 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.:
297 68 John Freeman
<pre>
298 68 John Freeman
git commit -m "JCF: helloworld: This configuration does not exist in the actual repo, it's simply used for documentation purposes"
299 68 John Freeman
</pre>
300 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. 
301 68 John Freeman
</pre>
302 68 John Freeman
Now, make sure that the commit took place correctly by running
303 68 John Freeman
<pre>
304 68 John Freeman
git diff HEAD
305 68 John Freeman
</pre>
306 68 John Freeman
If your commit is at the head of the master branch, you should see no output; additionally, if you run
307 1 John Freeman
<pre>
308 68 John Freeman
git log
309 68 John Freeman
</pre>
310 69 John Freeman
you should be able to see your commit at the top.
311 57 John Freeman
312 56 Erik Blaufuss
h1. Adding new DAQ Components to RunControl
313 49 Erik Blaufuss
314 49 Erik Blaufuss
The list of available DAQComponents (maps to BoardReader processes) is maintained by RunControl in the file:
315 49 Erik Blaufuss
<pre>
316 49 Erik Blaufuss
/home/lbnedaq/.lbnerc-components
317 18 John Freeman
</pre>
318 55 Erik Blaufuss
Each entry (name: host port) defines:
319 55 Erik Blaufuss
* name - name of the component, maps to a <name>_hw_cfg.fcl in CfgMgr's configuration directory
320 49 Erik Blaufuss
* host - hostname where BoardReader process will be started
321 49 Erik Blaufuss
* port - XMLRPC port to be used, must be unique and used by other processes.
322 18 John Freeman
323 49 Erik Blaufuss
For example:
324 49 Erik Blaufuss
<pre>
325 49 Erik Blaufuss
component01: lbnedaq2 5205
326 49 Erik Blaufuss
component02: lbnedaq2 5206
327 49 Erik Blaufuss
</pre>
328 49 Erik Blaufuss
Has two components (component01 and component02) both running on lbnedaq2 on ports 5205 and 5206.
329 27 John Freeman
330 49 Erik Blaufuss
h1.  Troubleshooting and FAQ
331 28 John Freeman
332 49 Erik Blaufuss
h2.  Common RunControl issues
333 27 John Freeman
334 49 Erik Blaufuss
h3. How can I get a list of all RunControl commands?
335 1 John Freeman
336 49 Erik Blaufuss
<pre>
337 49 Erik Blaufuss
lbnecmd help
338 49 Erik Blaufuss
</pre>
339 50 Erik Blaufuss
will list all available commands for RunControl with some details for help.  
340 50 Erik Blaufuss
 
341 50 Erik Blaufuss
h3.  No real configurations are listed by RunControl
342 45 John Freeman
343 49 Erik Blaufuss
If you run "lbnecmd listconfigs" and see something like:
344 45 John Freeman
<pre>
345 49 Erik Blaufuss
Available configs (Name : description)
346 49 Erik Blaufuss
347 49 Erik Blaufuss
dummy : Dummy description
348 45 John Freeman
</pre>
349 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)
350 1 John Freeman
351 49 Erik Blaufuss
h2.  Common DAQInterface issues
352 49 Erik Blaufuss
353 49 Erik Blaufuss
h3.  *Error handling*
354 49 Erik Blaufuss
355 49 Erik Blaufuss
As of this writing (11/14/14) certain potential problems have been anticipated and are handled within DAQInterface. These problems include:
356 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
357 49 Erik Blaufuss
# During periodic checks, one or more artdaq processes expected to exist are not found
358 49 Erik Blaufuss
359 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). 
360 49 Erik Blaufuss
361 49 Erik Blaufuss
h3. *Your change to docs/config.txt or daqinterface.py doesn't seem to do anything*
362 49 Erik Blaufuss
363 1 John Freeman
Make sure you kill the existing daqinterface process and restart it
364 49 Erik Blaufuss
365 54 John Freeman
h3. *On the initial transition ("lbnecmd init daq"), you see "error: [Errno 111] Connection refused"*
366 49 Erik Blaufuss
367 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.
368 54 John Freeman
369 49 Erik Blaufuss
h3. *On the initial transition, you see a regularly updating printout saying "Waiting for all processes to be launched"*
370 49 Erik Blaufuss
371 1 John Freeman
Seeing one or two of these is fine. If, after several seconds, something like the following
372 1 John Freeman
<pre>
373 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)
374 1 John Freeman
</pre>
375 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 
376 1 John Freeman
<pre>
377 1 John Freeman
ps aux | grep -v grep | grep pmt.rb 
378 1 John Freeman
</pre>
379 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.