dumpModules.py

Go to the documentation of this file.

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

__facility__ = "Online"
__abstract__ = "Dump FSW module names and versions from a unit"
__author__   = "S. Tuvi <Stuvi@SLAC.Stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2006/02/08 00:17:30"
__updated__  = "$Date: 2006/04/18 01:31:29 $"
__version__  = "$Revision: 1.3 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

import logging as log
import            struct

from LICOS.lib.scriptEngine.seAppBase    import seAppBase
from LICOS.lib.scriptEngine.ArgumentImpl import ArgumentImpl
from LICOS.lib.cmdTlmDb.LCATcmdDb        import LCATcmdDb
from LICOS.lib.cmdTlmDb.LCATtlmDb        import LCATtlmDb
from LICOS.lib.cmdTlmDb.TelemetryEvent   import TelemetryEvent



#  Example application implementation.
class dumpModules(seAppBase):
  """!\brief Sample script based on seAppBase that demonstrates tele-commands.

  Demonstrates queuing memory dump commands to the VSC.

  """
  def __init__(self, common):
    """!\brief MemDump constructor.

    \param common ScriptEngineCommon constructor
    """
    seAppBase.__init__(self, common)
    log.debug("%s.__init__()" % self.getName())
    self.__arg = None

  def getName(self):
    """!\brief Return the name of this class.

    \return Class name
    """
    return self.__class__.__name__

  def setup(self):
    """!\brief SETUP transition method.

    """
    log.debug("%s.setup()" % self.getName())

    if self.rc is None:
      self.__arg = userArgText()
    else:
      self.rc.execGUImethod(self.createGUI)

  def createGUI(self):
    """!\brief Create the argument GUI.

    Must be passed to an execGUImethod.
    This is done here in a separate method so that the GUI creation
    and deletion is done in the GUI thread.

    Executing self.__arg = self.rc.createGUI(userArgument, self.rc, 'test1', 1)
    does not work since the GUI object was being garbage collected (deleted)
    in the non-GUI thread.
    """
    self.__arg = userArgument(self.rc, 'test1', 1)

  def run(self):
    """!\brief RUN transition method.

    """
    log.debug("%s.run()" % self.getName())

    caption = "Enter Unit Id"
    if self.rc is None:
      unit = self.__arg.getValue(caption)
    else:
      unit = self.rc.execGUImethod(self.__arg.getValue, caption)

    if unit is None:
      self.setCompletionStatus(self.COMPL_STATUS_ABORTED)
      return -1

    unit = unit << 12    # 4 bit unit, 12 bit transaction ID
    
    self.lcatTlm = LCATtlmDb()

    mnem = 'LLCMMODLIST'

    modListTlm  = TelemetryEvent(self.vsc.getDiagHandler(),
                                 [self.lcatTlm.getApidFromName(mnem)],
                                 self.printModule)
    modListTlm.enable()

    lcat = LCATcmdDb(self.vsc)
    lcat.enableCmdConfirmTelem()
    lcatTlm = LCATtlmDb()
    lcm = lcat.LCM
    result = lcm.LCMMODDUMP(unit)
    if lcat.waitForSuccessfulConfirmation(timeout=60):
      self.setCompletionStatus(self.COMPL_STATUS_PASSED)
    else:
      self.setCompletionStatus(self.COMPL_STATUS_FAILED)
    modListTlm.disable()
    lcat.disableCmdConfirmTelem()
    # End of run

  def printModule(self, telem):
    pkt = self.lcatTlm.decodeTelemetry(telem)
    pkgName = ""
    for i in range(8):
      pkgName+=chr(pkt.get_payload("LCMMDMPPACKAGE%d" % i))

    conName = ""
    for i in range(15):
      conName+=chr(pkt.get_payload("LCMMDMPCONSTIT%d" % i))

    verStr = 'V%s-%s-%s' % (pkt.get_payload("LCMMDMPMAJVER"),
                            pkt.get_payload("LCMMDMPMINVER"),
                            pkt.get_payload("LCMMDMPPATVER"))

    log.info('%(pkg)-8s %(con)-15s %(ver)s'% \
    {'pkg':pkgName.strip(),'ver':verStr.strip(),'con':conName.strip()})


  def teardown(self):
    """!\brief TEARDOWN transition method.

    """
    # Allow the C++ object to be deleted
    if self.__arg is not None:
      self.__arg.deleteLater()


#  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):
  """!\brief GUI for getting the user to input some sort of value.

  """
  def __init__(self, parent = None, name = None, modal = 0, fl = 0):
    """!\brief userArgument constructor.

    \param parent Parent GUI
    \param name   GUI name
    \param modal  Whether the dialog is modal or not
    \param fl     GUI flags
    """
    ArgumentImpl.__init__(self, parent, name, modal, fl)
    self.__value = 0
    self.setCaption("Hello world!")

  def OKButtonClicked(self):
    """!\brief Slot for the OK button.

    """
    self.__value = int(self.ArgumentList.text().latin1())
    self.close()

  def CancelButtonClicked(self):
    """!\brief Slot for the Cancel button.

    """
    self.__value = None
    self.close()

  def getValue(self, caption):
    """!\brief Bring up the GUI and return a value when OK is clicked.

    \param caption Dialog caption

    \return The value entered by the user
    """
    self.setCaption(caption)
    self.show()
    self.exec_loop()
    return self.__value

class userArgText(object):
  """!\brief Text user interface for getting the user to input some sort of value.

  """
  def __init__(self):
    """!\brief userArgText constructor.

    """
    pass

  def getValue(self, caption):
    """!\brief Use console input to return a value from the user.

    \return The value entered by the user
    """
    return int(raw_input("%s: " % (caption)))

---