LHK.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__ = "LHK 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/04/07 01:19:19 $"
__version__  = "$Revision: 1.16 $"
__release__  = "$Name: HEAD $"
__credits__  = "SLAC"

import LICOS.copyright_SLAC

import os
import logging as log

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

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

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

    \param db  Wrapper database object for the generated module
              containing command and telemetry database classes.
    """
    CmdPkg.__init__(self, db)
    self.__hskFileSeq = 0
    self.hskConfigs = {}

  def requestDiagHskPacket(self, apid, payloadMnems, timeout=10, count=1, interval=100):
    """!\brief Request a housekeeping diagnostic packet.

    This method requests a housekeeping diagnostic packet identified
    by \a apid, waits on it and returns the payload values corresponding
    to the \a payloadMnems list.

    Once the telemetry is received, the request is cancelled.

    \param apid         Housekeeping apid
    \param payloadMnems List of payload mnemonics
    \param timeout      Amount of time to wait for the packet
    \param count        Number of times the packet is requested
    \param interval     The interval between each packet

    \return A list of payload values or None if the packet times out.
            If a given payload mnemonic is not found its value is set to None.
    """
    self.LHKREQDIAGPKT(LHKDIAGAPID=apid, LHKDIAGCOUNT=count, LHKDIAGINTERVAL=interval)
    self.getCmdDb().waitForConfirmation(timeout)
    lhkDiagTlm = TelemetryEvent(self.getCmdDb().getVsc().getDiagHandler(), [apid + 0x60])
    lhkDiagTlm.enable()
    payloads = lhkDiagTlm.waitForPayload(payloadMnems, timeout)
    lhkDiagTlm.disable()
    self.LHKSTOPDIAG()
    self.getCmdDb().waitForConfirmation(timeout)
    return payloads

  def uploadHskCfg(self, hskCfgFile, fileNo, inputPath=LICOS_CONFIG_LHK):
    """!\brief Upload a HSK configuration file to the SIU.

    \param hskCfgFile HSK configuration file
    \param fileNo     File number

    \return File upload status, if None it means file upload failed
    """
    diskFileName = os.path.expandvars(os.path.join(inputPath, hskCfgFile))

    fileID = FswFileID( device     = FSW_DEVICE_RAM,
                        directory  = INT_DIR_LHK,
                        fileNumber = fileNo)

    log.debug("Uploading file %s with file ID 0x%08x=%d" %
              ( diskFileName, fileID.id(), fileID.id() ) )

    try:
      uplFile = self.getCmdDb().FILE.uploadFileFromDisk(
                                            fileName = diskFileName,
                                            unit     = FSW_UNIT_SIU,
                                            fileID   = fileID)
    except Exception, e:
      log.exception(e)
      return None
    else:
      self.hskConfigs[hskCfgFile] = uplFile
      return uplFile

  def getHskFileSeq(self):
    """!\brief Retrieve the next available file number.

    \return The next file number starting with 1
    """
    self.__hskFileSeq+=1
    return self.__hskFileSeq

  def clearHskConfigs(self):
    """!\brief Clear the HSK Config cache.

    """
    self.__hskFileSeq = 0
    self.hskConfigs = {}

---