NSCL DAQ Software Documentation
PrevNext

s800

Name

s800 -- s800 Readout Callouts module

Synopsis

package require s800
s800::Initialize ?host? ?port?
s800::OnBegin
s800::OnEnd

$DAQHOME/bin/ReadoutShell -host=localhost -path=$DAQHOME/bin/dummyrdo -nomonitor

DESCRIPTION

ReadoutCallouts.tcl package that allows ReadoutGUI to control the S800 readout software, get data from the s800 event builder and insert it into NSCLDAQ rings.

See COMMANDS below for a description of each command and where it should be used. See EXAMPLES below as well for a sample ReadoutCallouts.tcl file. The final entry in the SYNOPSIS section above describes how to invoke the ReadoutGUI in the context of an S800 experiment.

COMMANDS

s800::Initialize ?host? ?port?

Initializes the s800 package. This involves setting up a connection to the S800 Readout program, adding a status line to the ReadoutGUI that shows the status of its readout GUI. It also removes the Pause/Resume button as the S800 readout program does not support pausing runs.

Exit handlers are also created to ensure that everthing gets cleaned up on most exits.

The optional host and port parameters are the host on which the s800 readout program is running and the port on which it is listening for a control connection. These have the correct default values.

s800::OnBegin

Should be called from your OnBegin proc in your ReadoutCallouts.tcl file. This does what's needed to start the S800 readout program taking data. If necessary, the pipeline that takes data from the S800 eventbuilder and inserts those data into an NSCLDAQ ring is started.

s800:OnEnd

Should be called from your OnBegin function to end the run in the S800.

ENVIRONMENT VARIABLES

The following environment variables can modify where the s800 readout callouts looks for stuff:

S800_HOST

If defined overrides the default host in which the S800 is running. The default host is spdaq48. You should only need to modify this value if the S800 spdaq system needs to be replaced in an emergency.

S800_PORT

Overrides the default port on which the S800 is listening for data connections. The command port must and host must be provided when initializing the callouts package. If not defined, this defaults to 9002 which is the normal port.

S800_RING

The name of the ring into which the s800 data are put. This defaults to s800_`whoami` where `whoami` is your logged in username.

EXAMPLES

Here is a minimal ReadoutCallouts example. 


lappend auto_path /usr/opt/daq/10.1/TclLibs 
package require s800

s800::Initialize spdaq48
proc OnBegin run {
    s800::OnBegin       
}
proc OnEnd run {
    s800::OnEnd         
}

KNOWN ISSUES

PrevHomeNext
3tclUpcaennet