testEvtBldr_script.py

#!/usr/local/bin/python
#
#                               Copyright 2004
#                                     by
#                        The Board of Trustees of the
#                     Leland Stanford Junior University.
#                            All rights reserved.
#

__facility__ = "Online"
__abstract__ = "Test application to demonstrate event merging"
__author__   = "R. Claus <Claus@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "6/29/2006"
__updated__  = ("$Date: 2006/07/19 16:23:25 $").split(' ')[1]
__version__  = "$Revision: 1.3 $"
__release__  = "$Name: R04-12-00 $"
__credits__  = "SLAC"

import LATTE.copyright_SLAC

import threading
import time

from   LATTE.runcontrol.ArgumentImpl   import ArgumentImpl
from   support.rcTransitionsBT         import rcTransitionsBT

from   LATTE.tests.apps.support.SimpleGasuExample       import *
from   LATTE.tests.apps.support.MiniGLTExample          import *

#from   support.BTdump import testDG


#  This class puts up a GUI for inputting a value of some sort.  It is used by
#  the userApplication example to get the number of self triggers to take.
class userArgument(ArgumentImpl):
  "GUI for getting the user to input some sort of value."
  def __init__(self, parent = None, name = None, modal = 0, fl = 0):
    ArgumentImpl.__init__(self, parent, name, modal, fl)
    self.__value = 0
    self.setCaption("Hello world!")

  def OKButtonClicked(self):
    self.__value = int(self.ArgumentList.text().latin1())
    self.close()

  def CancelButtonClicked(self):
    self.__value = None
    self.close()

  def getValue(self, caption):
    self.setCaption(caption)
    self.show()
    self.exec_loop()
    return self.__value

class userArgText(object):
  "Text user interface for getting the user to input some sort of value"
  def __init__(self):
    pass

  def getValue(self, caption):
    return int(raw_input("%s: " % (caption)))


#  Example application implementation.
#  Note that the name of the class must be userApplication.
#  Look at rcTransitions for names of other transition methods that can be used.
class userApplication(rcTransitionsBT):
  "Implmentation class for a user application"
  def __init__(self, rc, userId, debug):
    rcTransitionsBT.__init__(self, rc, userId, debug)
    import logging
    logging.debug("userApplication.__init__()")
    self.__eventSem    = threading.Semaphore(0)
    self.__cmdSynchSem = threading.Semaphore(0)

  def getName(self):
    return __name__

  def setup(self):
    import logging
    logging.debug("userApplication.setup()")

    if self.rc is None:
      self.__arg = userArgText()
    else:
      self.__arg = self.rc.createGUI(userArgument, self.rc, 'test1', 1)

    # Get a TEM instance
    if self.lat.TEMcnt() == 1:
      tem = self.lat.TEM[self.lat.TEM.keys()[0]]
    elif self.lat.TEMcnt() > 1:
      tem = self.lat.TEM.all()
    else:
      import logging
      logging.fatal("No TEM(s) found in the schema")
      return -1

    #----- The following RESETs and other system register manipulation is
    #----- commented out as it is handled by RunControl.  Other register
    #----- setup should be taken care of in the schema/configuration file.
    # reset the TEM since we are going to modify DATA_MASKS
    #tem.CMD_RESET = 1

    # clear TEM stats reg
    tem.COMMAND_RESPONSE = 0

    # clear TEM status reg
    tem.STATUS = 0

    # enable CAL, disable TKR, no diag #  0x10FF for diag
    #tem.DATA_MASKS = 0x10FF

    # TEM config reg # set TEM timeout
    #tem.CONFIGURATION = 0

    #status = gTEMread( __GT, temId, TEM_REG_CONFIGURATION, &payload);
    #printf("tem config reg = 0x%08x\n", payload);

    # enable output in our GCCCs
    # broadcast load of GCCC_REG_CONFIGURATION

    #bcast_ccc = tem.allCCC()
    #bcast_ccc.CONFIGURATION = 0x80000000L

    #  disable all GCRCs in all GCCCs via broadcast # GCCC_REG_LAYER_MASK_0, GCCC_REG_LAYER_MASK_1
    #bcast_ccc.LAYER_MASK_0 = 0xFFFFFFFFL
    #bcast_ccc.LAYER_MASK_1 = 0xFFFFFFFFL
    #ccc0 = tem.downCCC(0) # O$GCCC_00
    #ccc0.LAYER_MASK_0 = 0xFFFF0000L
    #ccc0.LAYER_MASK_1 = 0xFFFF000FL
    #ccc2 = tem.downCCC(2) # O$GCCC_02
    #ccc2.LAYER_MASK_0 = 0xFFFF0000L
    #ccc2.LAYER_MASK_1 = 0xFFFF0000L

    # config GCFE for calibration -- range 0 first
    #bcast_cfe = tem.allCCC().allCRC().allCFE()
    #bcast_cfe.CONFIG_0    = 0x00
    #bcast_cfe.CONFIG_1    = 0x36
    #bcast_cfe.FLE_DAC     = 0x55
    #bcast_cfe.FHE_DAC     = 0x55
    #bcast_cfe.LOG_ACPT    = 0x10
    #bcast_cfe.RNG_ULD_DAC = 0x7F
    #bcast_cfe.REF_DAC     = 0x7f

    # config GCRC for calibration
    #bcast_crc = tem.allCCC().allCRC()
    #bcast_crc.DELAY_1 = 0xFF
    #bcast_crc.DELAY_2 = 0xFF
    #bcast_crc.DELAY_3 = 0xFF
    #bcast_crc.DAC = 0x42FE
    #bcast_crc.DAC = 0x42FE

    # large timeouts for all GCCCs
    # broadcast load of GCCC_REG_EVENT_TIMEOUTS
    #bcast_ccc.EVENT_TIMEOUTS = 0x0
    #status = gGCCCread( __GT, temId, 1, GCCC_REG_EVENT_TIMEOUTS, &payload);
    #printf("gccc register event timeouts = 0x%08x\n", payload);

    # Register environment variables for housekeeping
    #hsk = self.getHSK()
    #regs = [tem.regs['data_masks'], ccc2.regs['layer_mask_1']]
    #hsk.addEnvRegs(regs)
    #hsk.setUpdateInterval(1)

    # Two choices for the trigger, GEM and MiniGLT
    if self.lat.existsGEM():
      self.trigger( SimpleGasuExample() )
    else:
      self.trigger( MiniGLTExample() )

    # Override the default event handler
    self.selectEventHandler(rcTransitionsBT.EVENT_HANDLER_CUSTOM, self.eventHandler)

    # A state transition can be rejected by not returning None
    return None

  def startRun(self):
    import logging
    logging.debug("userApplication.startRun()")

    # Don't let the Ancillary Trailer stop the run
    #self.autoStopRun(False)

    caption = "Enter number of triggers to take"
    if self.rc is None:
      cnt = self.__arg.getValue(caption)
    else:
      cnt = self.rc.execGUImethod(self.__arg.getValue, caption)

    # The user pressed 'Cancel'
    if cnt is None:  return -1
    self.__cnt = cnt

    self.getParameterVerifier().add(caption, cnt)

    # Spawn a thread to synchronize commands with events
    self.__cmdSynchQuit = False

    # A state transition can be rejected by not returning None
    return None

  def stopRun(self):
    import logging
    logging.debug("userApplication.stopRun()")

    if self.getBadEvents() == 0 and self.getErrorEvents() == 0:
      self.setCompletionStatus(self.COMPL_STATUS_PASSED)
    else:
      self.setCompletionStatus(self.COMPL_STATUS_FAILED)

    self.__cmdSynchQuit = True
    self.__eventSem.release()

    # The STOP_RUN transition can not be rejected

  def resume(self):
    import logging
    logging.debug("userApplication.resume()")

    # Issue self trigger to make up for the one that was lost during PAUSE
    self.trigger().solicit()

    return None

  def stop(self):
    import logging
    logging.debug("userApplication.stop()")

    return self.stopRun()

  def teardown(self):
    import logging
    logging.debug("userApplication.teardown()")
    # Allow the C++ object to be deleted
    if self.rc is not None and self.__arg is not None:
      self.__arg.deleteLater()

  def process(self, (status, latDatagram)):
    "Method called back for each data event taken"
    import logging
    #logging.debug("userApplication.process()")

    #evtCli = self.evtCli

    if status != 0:
      #if evtCli.isGGLTStatus():
      logging.error("%s.process(): GGLT_STATUS = 0x%08x = %d", self.getName(), status, status)
      #logging.error("GGLT_STATUS=%d %s" % (evtCli.getGGLTStatus(), evtCli.getGGLTStatusStr()))
      #elif not evtCli.checkOnlineStatus(status, self.evtCli.PLAYBACK_ERROR):
      #  logging.error("EVENT ERROR= 0x%x %s" % (status, evtCli.getOnlineStatusStr()))
#    testDG(latDatagram)

    # Get next event triggered
    self.__eventSem.release()

  def commandSynch(self):
    "Method called by the command synchronization task"
    import time
    trigger  = self.trigger()
    eventSem = self.__eventSem

    # Drain the semaphore release count
    # Handles the case when the stop run release collided with a trigger release
    while eventSem.acquire(0):  pass

    t0  = time.time()

    # Compensate for the extra CMD_SELF_TRIGGER below
    cnt   = 1
    count = self.__cnt

    # Wait for START_RUN to enable triggers
    trigger.waitForMaskEnable()

    trigger.solicit()                   # Issue an internal trigger
    #eventSem.acquire()                  # Wait for the event to be processed

    t1 = trigger.getEnableTime()        # get the last trigger enable time from GLT
    while cnt < count and not self.__cmdSynchQuit:
      cnt += 1
      trigger.solicit()                 # Issue an internal trigger
      time.sleep(.0001)
      eventSem.acquire()                # Wait for the event to be processed
      #trigger.disable()                # Disable triggers
      # Do stuff
      #trigger.enable()                 # Enable triggers

    t2 = trigger.getTimeStamp()                 # Get the last trigger timestamp

    if t1 is None:
      t1 = t0
    if t2 is None:
      t2 = time.time()
    dT = t2 - t1
    if dT == 0.0:  dT = 0.000001
    import logging
    logging.info("%s processed %d events in %.3f seconds = %.1f events/second" % \
             (self.getName(), self.evtCnt, dT, self.evtCnt/dT))

    # Get out of waiting when in suite or standalone mode
    self.sync()

    # execute the GUI functions for stopRun, just in case
    if not self.__cmdSynchQuit and not self.isRunFromSuite():
      if self.rc is not None:
        self.rc.doStop()

  def wait(self):
    self.__cmdSynchSem.acquire()

  def sync(self):
    if __name__ == "__main__" or self.isRunFromSuite():
      self.__cmdSynchSem.release()


# Standalone mode:
if __name__ == "__main__":
  import os
  import logging
  logging.basicConfig()
  logging.getLogger("").setLevel(logging.DEBUG)
  ua = userApplication(None, 321, 0)
  prefs = {'datasave': 1, 'datadir':os.path.join(os.environ['ONLINE_ROOT'],'temp')}
  ua.setPrefs(prefs)
  ua.rcSetup(os.path.join(os.environ['ONLINE_ROOT'], 'repos/simpleTemSchema.xml'))
  ua.rcStartRun()
  ua.wait()
  ua.rcStopRun()
  ua.rcTeardown()

# History:
#     $Log: testEvtBldr_script.py,v $
#     Revision 1.3  2006/07/19 16:23:25  claus
#     AutoStopRun support
#
#     Revision 1.2  2006/07/14 23:25:55  claus
#     Fix import problems
#
#     Revision 1.1  2006/07/14 22:37:29  claus
#     Example socket based LATTE test script application of the event builder.
#
#     Revision 1.1  2006/07/14 22:35:24  claus
#     Example socket based LATTE test script application of the event builder.
#
#     Revision 1.7  2005/03/21 17:58:12  claus
#     Modified to use the first TEM found in the schema, if only one is there, or
#     broadcast to all TEMs if there are multiple.
#
#     Revision 1.6  2004/11/01 23:09:39  claus
#     Added a comment.
#
#     Revision 1.5  2004/10/30 01:52:20  stuvi
#     Check if the archiver is None before accessing it.
#
#     Revision 1.4  2004/10/25 02:44:43  panetta
#     Fixes regarding byteswapping and error contribution
#
#     Revision 1.3  2004/10/23 23:50:33  claus
#     Added completionStatus logic.
#
#     Revision 1.2  2004/10/18 01:00:19  claus
#     Provided switch between 2 examples of adding custom LATcontributions.
#
#     Revision 1.4  2004/08/31 03:13:38  stuvi
#     Integrated the parameter verifier with Run Control
#
#     Revision 1.3  2004/08/18 18:00:15  stuvi
#     Updated for LATTE 4.
#     All hippo functions go through the Qt GUI bridge now.
#
#     Revision 1.2  2004/08/13 04:46:22  claus
#     Got rid of obsolete TRUE and FALSE declarations.
#
#     Revision 1.1  2004/07/28 21:24:00  stuvi
#     Added testAppCal and its supporting classes.
#
#     Revision 1.28  2004/07/09 23:14:17  stuvi
#     Added "operatorobj" preference that contains the rcUser object and left the "operator" preference to contain the user name.
#
#     Revision 1.27  2004/05/03 22:49:36  stuvi
#     Added commented out code example that demonstrates how to access the CAL and TKR diagnostics contributions.
#
#     Revision 1.26  2004/05/03 21:19:47  stuvi
#     Moved non-Runcontrol scripts to the support directory and modified imports accordingly.
#
#     Revision 1.25  2004/04/21 21:05:29  stuvi
#     Added an example of how to pass the preferences using the setPrefs method when running in standalone mode.
#
#     Revision 1.24  2004/04/17 02:23:48  stuvi
#     Added teardown() to delete the C++ object for the userArgument
#     Fixed LogData parsing based on the evtCli changes
#
#     Revision 1.23  2004/03/31 01:01:19  stuvi
#     Added commented code on how to parse the error contribution.
#
#     Revision 1.22  2004/03/10 22:24:51  panetta
#     Upgraded trigger interface.
#     Removed dependencies on self.glt.
#
#     Revision 1.21  2004/03/04 23:08:47  stuvi
#     Removed glt.destination assignment
#
#     Revision 1.20  2004/02/20 03:20:23  stuvi
#     Added handling of the sweep events and error checking to the process() method,
#
#     Revision 1.19  2004/02/13 03:13:25  stuvi
#     Sweep events are also sent to user script's process event now, so added code to handle the case.
#
#     Revision 1.18  2004/02/02 23:14:00  stuvi
#     Changes required to make the scripts work with the new FSM engine.
#
#     Revision 1.17  2004/01/30 04:33:44  claus
#     Updated for transitions not running in the GUI thread.
#     New commandSynch handling.
#
#     Revision 1.16  2003/12/19 02:05:26  stuvi
#     Added support for creating and updating GUIs from a suite
#
#     Revision 1.15  2003/12/11 02:22:35  stuvi
#     Suite and standalone mode modifications
#
#     Revision 1.14  2003/12/11 01:53:16  stuvi
#     Modified code to support suites.
#
#     Revision 1.13  2003/11/25 02:16:12  stuvi
#     Modified according to the current test setup to generate some results
#
#     Revision 1.12  2003/11/04 04:25:11  stuvi
#     Changed the commandSynch logic so that the enableMask() call would not pose a threat to snapshot taking.
#
#     Revision 1.11  2003/10/31 01:09:37  panetta
#     1)  Moved register writes from startRun to setup
#     2)  Added GLT enabling logic to __commandSynch
#     3)  Gave example of getting the start/stop time from the hardware/event stream
#
#     Revision 1.10  2003/10/28 03:17:34  stuvi
#     Added support for calculating the event rate correctly using the new GLT behaviour.
#
#     Revision 1.9  2003/08/21 21:13:38  stuvi
#     no message
#
#     Revision 1.8  2003/07/17 00:01:35  stuvi
#     no message
#
#     Revision 1.7  2003/06/13 23:26:24  stuvi
#     Added TEM reset
#
#     Revision 1.6  2003/04/12 02:38:34  stuvi
#     Added Cancel button handler to argument class
#
#     Revision 1.5  2003/04/09 00:45:15  stuvi
#     Commented out references to DATA_MASKS register which should not be touched during script execution.
#
#     Revision 1.4  2003/04/01 21:04:59  stuvi
#     Fixed event count discrepancy when the run is stopped in the middle.
#
#     Revision 1.3  2003/03/31 19:23:44  stuvi
#     Fixed name
#
#     Revision 1.2  2003/03/26 21:59:36  stuvi
#     Fixed standalone mode
#
#     Revision 1.1  2003/03/11 21:20:55  stuvi
#     Moved from RunControl directory
#
#     Revision 1.8  2003/02/06 05:19:38  claus
#     Added resume; StopRun bug fix
#
#     Revision 1.7  2003/02/06 04:14:35  claus
#     Fixed StopRun bug
#
#     Revision 1.6  2002/12/11 21:18:07  stuvi
#     Changed glt register assignments to bit field assignments
#
#     Revision 1.5  2002/12/10 01:09:58  claus
#     Added path and changed schema/config file for stand-alone mode
#
#     Revision 1.4  2002/12/04 01:59:23  claus
#     Added message logging
#
#     Revision 1.3  2002/12/02 17:17:09  claus
#     Added provision to allow application to run stand-alone
#
#     Revision 1.2  2002/11/28 02:02:04  claus
#     Shuffled constructor arguments
#
#     Revision 1.1  2002/11/27 05:02:48  claus
#     Initial version of Run Control
#

---