LCM.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__ = "LCM related mnemonics"
__author__   = "Selim Tuvi <stuvi@slac.stanford.edu> SLAC - GLAST LAT I&T/Online"
__date__     = "2005/07/23 00:08:27"
__updated__  = "$Date: 2006/02/23 02:43:33 $"
__version__  = "$Revision: 1.8 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

from LICOS.lib.cmdTlmDb.cmdTlmDb       import CmdPkg
from LICOS.lib.LATconstants            import *
from LICOS.lib.cmdTlmDb.TelemetryEvent import TelemetryEvent

class LCM(CmdPkg):
  """!\brief LCM telecommand package class

  Provides access to LCM telecommands.
  """
  def __init__(self, db):
    """!\brief LCM constructor.

    \param db  Wrapper database object for the generated module
              containing command and telemetry database classes.
    """
    CmdPkg.__init__(self, db)
    self.__modList = None

  def modListPopulated(self):
    """!\brief Check if the module list has already been populated.

    \return Boolean specifying whether the module list is populated or not.
    """
    return (self.__modList is not None)

  def cmxAsBuilt(self, unitId, timeout=60, force=False):
    """!\brief Return name and versions of the FSW modules loaded on a unit.

    \param unitId  Unit id
    \param timeout Optional amount of seconds to wait until the version data
                   is completely received. Default is 60 seconds.
    \param force   Force version collection. Default is False.

    \return A list of tuples in the following format:
            (package name, constituent name, version)
    """
    if self.__modList is not None and not force:
      return self.__modList
    cmdDb = self.getCmdDb()
    # Check if we are in primary boot or not
    latHskTlm  = TelemetryEvent(cmdDb.getVsc().getTelemHandler(),
                                range(0x210, 0x231))
    latHskTlm.enable()
    payloads = latHskTlm.waitForPayload([], timeout=5, quiet=True)
    latHskTlm.disable()
    if payloads is None:
      # We are in primary boot so skip version collection
      return None
    self.__modList = []
    modListTlm = TelemetryEvent(cmdDb.getVsc().getDiagHandler(),
                                [cmdDb.getVsc().getTlmDb().getApidFromName('LLCMMODLIST')],
                                self.__collectModuleInfo)
    modListTlm.enable()
    cmdConfirmTelemEnabled = cmdDb.isCmdConfirmTelemEnabled()
    if not cmdConfirmTelemEnabled:
      cmdDb.enableCmdConfirmTelem()
    saveCallback = cmdDb.getCmdConfirmCallback()
    cmdDb.setCmdConfirmCallback(cmdDb.quietConfirmation)
    self.LCMMODDUMP(unitId)
    if cmdDb.waitForSuccessfulConfirmation(timeout, quiet=True):
      result = True
    else:
      result = False
    cmdDb.setCmdConfirmCallback(saveCallback)
    if not cmdConfirmTelemEnabled:
      cmdDb.disableCmdConfirmTelem()
    modListTlm.disable()
    if result:
      return self.__modList
    else:
      return None

  def __collectModuleInfo(self, telem):
    lcatTlm = self.getCmdDb().getVsc().getTlmDb()
    pkt = 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"))
    self.__modList.append((pkgName, conName, verStr))

---