The program requires two configuration files, One of them identifies the event modules to be read out in response to a trigger. The other describes the scaler modules to read.
The SBSReadout framework VMUSBnostackReadout is based on does not have options to specify these files. Therefore the following two environment variable must be set:
Path to the event configuration file. See EVENT CONFIGURATION FILE for the contents of this file.
Path to the scaler configuratino file. See SCALER CONFIGURATION for the contents of this.
--helpPrints out the program options and their meanings. The program then exits without doing anything else useful.
--versionPrints out the version of the SBSreadout framework used. The program then exits without doing anything else useful.
--port stringEnables the Tcl server built into the SBS readout framework. If the parameter is an integer is is the port number the server will listen on. If a string the port is allocated by the port manager and advertised by it with the string.
--ring nameSpecifies the name (not URI) of the ringbuffer into which data are put. Note that if not supplied the user name will be used for the ring name..
--sourcdeid integerprovides the source id to be associated with this readout in the event builder.
--init-script pathIf provided this must be the path to a Tcl script that will be run when the program starts. Defaults to 0.
--log pathIf present, provides the path to a log file for logging output. If not, supplied, no logging is done.
--debug 0 | 1 | 2Describes the verbosity level of logging. 0 logs the least amount of stuff 2 the most.
--no-barriersIf present, run state change items will not participate in barrier synchronization. All readouts must use this or none.
--vme-lockShould be used - serializes access to the VME bus between threads.
This section describes the general format of the Event configuration file. For specific module commands, see Supported Event Modules after the man page. The event configuration file is processed whenever a run starts.
The event configuration file is specified by defining the environment variable DAQCONFIG to be a path to it. It is Tcl script and all Tcl core commands are available. additional module commands are defined (see Supported Event Modules). Each module command is a comman ensemble with the subcommands:
Defines a new module. This command will take a module name, which must be unique. Optional configuration parameters are also allowed. The temporal order in which modules are created determines the readout order.
Configures a modules. This command will take the name of a module that has been created and configuration parameters.
Fetches configuration infoirmation. This commanne takes the name of a module that has already been created and optionally a configuration option. If an option is supplied, the value of that option is returned, if not a Tcl list of two element sublists containing the option names and values of all configuration options for that module type.
The scaler configuration file is pointed to by the SCALERCONFIGFILE environment variable. It is a Tcl script. In addition to the core Tcl commands, a command was added for each scaler module type. In general, scalers are not configurable. They read non-incrementally (cleared only at the start of the run). Therefore the general form of scaler commands in the scaler configuration file is:
Where:
Is the type of scaler being added to the scaler read list. See the section Supported Scaler modules for the set of available scaler-type values.
A name for the scaler. This must be unique within all of the scalers defined. Names can be duplicates of names in the Event configuration file, if you have a burning need for that. The name may be used in the future if modules are added that require additional configuration.
The VME base address for the module.
As with the event configuration file, scalers are read out in the temporal order in which they are defined.