Page History

 --- pydaq module ---

class pydaq.Control(host, platform=0)

    Arguments:
        'host'     : host name or IP address (dotted-string notation or integer)
        'platform' : DAQ platform number (subdivision of readout hardware)

    Function:
        Initializes the interface for controlling the data acquisition system remotely.
        Creates a connection with the local control and queries the configuration
        database and current key in use.

Members:

    Control.dbpath()
        Returns path to configuration database

    Control.dbkey()
        Returns current configuration key (integer) in use

       ControlControl.configure(record=<Bool>,
              key=<Integer>,
              events=<Integer> or duration=[seconds,nanoseconds],
              controls=[(name,value)],
              monitors=[(name,lo_range,hi_range)])
        Configures control to use database key (default to current key) either:
          (1) collecting a fixed number of events on each cycle (when events=<Integer>
              is specified) or
          (2) collection events for a fixed duration (whendbalias()
        Returns current configuration alias (string) in use
      
    Control.partition()
        Returns a list of dictionary objects describing all nodes in the DAQ readout.

    Control.configure(record=<Bool>,
              key=<Integer>,
              events=<Integer> or l1t_events=<Integer> or l3t_events=<Integer> or duration=[seconds,nanoseconds],
              is specified).  
        The list of variables controlled (optional) in the scan and       controls=[(name,value)],
              monitors=[(name,lo_range,hi_range)])
        the Configures listcontrol ofto variablesuse todatabase bekey monitored (optional)default duringto acquisition
        are specified.current key) either:
        The   option(1) tocollecting recorda canfixed alsonumber beof set. events Ifon iteach iscycle omitted, then the value from(when events=<Integer>
        the       local controlor l1t_events=<Integer> is used.

    Control.begin(specified) or
          (2) collecting events until a fixed number of events have been accepted by
              the level3 filter (when l3t_events=<Integer>) or
          (2) collecting events for a fixed duration (when duration=[seconds,nanoseconds]
              is specified).  
        The list of variables controlled (optional) in the scan and
        the list of variables to be monitored (optional) during acquisition
        are specified.
        The option to record can also be set.  If it is omitted, then the value from
        the local control is used.

    Control.begin(events=<Integer> or duration=[seconds,nanoseconds],],
              controls=[(name,value)],)
              monitors=[(name,lo_range,hi_range)])
        Begins acquisition for the specified settings of control variables (if specified).
              controls=[(name,value)],)  Actual control of these variables is the responsibility of the remote application.  
              monitors=[(name,lo_range,hi_range)]) Monitor variables (optional) are enforced during acquisition.  Omitted values
        Begins default acquisitionto forthose thespecified specifiedmost settingsrecently of(or controlin variables (if specifiedthe 'configure' method).

    Control.end()
        Actual Waits controlfor ofthe theseend variablesof isacquisition thecycle responsibilitysignalled offrom the remotelocal host applicationcontrol.  

        Monitor variables Control.stop(optional)
 are enforced during acquisition.  Omitted values
        defaultSignals tothe thoselocal specifiedhost mostcontrol recentlyto (orterminate inthe thecurrent 'configure' method)acquisition cycle.

       ControlControl.endeventnum()
             Waits forReturns the endnumber of acquisitionevents signalledacquired fromin the localcurrent hostacquisition controlrun.

    Control.experiment()
        Returns experiment number of run, if recorded.  
        Only valid after acquisition is complete.

    Control.runnumber()
        Returns run number, if recorded.  
        Only valid after acquisition is complete.