CCUSBReadout is installed as: $DAQROOT/bin/CCUSBReadout.
Several command options control the way CCUSBReadout operates:
-serialno
Specifies the serial number of the CCUSB the program
will use. See --enumerate
below.
If not provided, the first CCUSB located will be used.
If you only have one CCUSB connected to your system,
this is suitable.
--ring
Specifies the ring buffer in which event data will be put by the program. By default this is the same as the username you are logged in on .
--daqconfig
Specifies the filename that contains the data acquisition configuration script. This defaults to ~/config/daqconfig.tcl
--ctlconfig
Specifies the filename that contains the slow controls configuration script. This defaults to ~/config/controlconfig.tcl. Note that this file is required even if it is just an empty file.
--init-script
Specifies the name of a script that will be run in the interpreter just prior to starting the interpreter's command/event loop.
--port
Specifies the port on which the slow controls server listens for connections. This defaults to 27000. The value of thie parameter can be either an intger port number or the special string managed.
If the value is managed CCUSBReadout will work with the NSCL port manager to allocate and advertise itself on a managed port. The port will be advertised as CCUSBReadout:controller Where controller is the serial number of the controller or FirstController if no specific serial number was requested.
--enumerate
Requests that the software list the serial numbers of
the CCUSB devices currently attached to the system and
exit. Note that the serial 'numbers' are actually strings
of the form CCnnnn where nnnn
is a number. One of these strings can be handed to the
--serialno
to select the CCUSB
to use.
Sample output:
--sourceid
If a --timestamplib
option is present,
events will have a full body header and the integer
value of this switch determines the value of the source
id.
--timestamplib
The value of this option is a path to a shared object
library. If present, the library must have a C
compatible entry point named getTimestamp
.
If not supplied all events will have abbreviated body
headers and no timestamps will be present.
The library is dynamically loaded into the readout
program and getTimestamp
is called
for each event. getTimestamp
receives a single null pointer parameter, which points
to the event and is supposed to return a
uint64_t value that is that event's
timestamp.
If the library has a further entry named
onBeginRun
, taking no parametesr and
having no return value, this funtion is called when the run
starts.