ScriptEngineConnector Class Reference

Script Engine proxy connector class. More...

List of all members.

Public Member Functions
def	__init__
	ScriptEngineConnector constructor.
def	initCmdCountMon
	Initialize the command count monitor.
def	getCmdCountMon
	Retrieve the command count monitor instance.
def	getCmdDebug
	Retrieve the command debug flag.
def	getDiagHandler
	Retrieve the diagnostic telemetry handler.
def	getTelemHandler
	Retrieve the LAT/VSC telemetry handler.
def	getPidsHandler
	Retrieve the pids telemetry handler.
def	getArchiver
	Retrieve the command archiver object.
def	getTlmDb
def	setTlmDb
def	bootSIU
	Boot the SIU.
def	bootEPU
	Send boot telecommand to the EPU.
def	resetSIU
	Initiate a warm reboot of the SIU.
def	resetEPU
	Initiate a warm reboot of the EPU.
def	mainFeedOn
	Turn on the main feed.
def	powerOnEpuOnly
	Power on the EPU only.
def	powerOffEpuOnly
	Power off the EPU only.
def	setPowerEpuOnly
def	powerOnTemOnly
def	powerOffTemOnly
def	setPowerTemOnly
def	powerOnCalOnly
def	powerOffCalOnly
def	setPowerCalOnly
def	setBiasVoltageCal
def	powerOnTkrOnly
def	powerOffTkrOnly
def	setPowerTkrOnly
def	setBiasVoltageTkr
def	powerOnAemOnly
def	powerOffAemOnly
def	setPowerAemOnly
def	powerOnFreeBoardOnly
def	powerOffFreeBoardOnly
def	setPowerFreeBoardOnly
def	setBiasVoltageAcd
def	setBiasVoltageAcdNew
	Set ACD bias voltages for free board.
def	start
	Start the scheduler.
def	stop
	Stop the scheduler.
def	getCmdTuple
	Retrieve the command tuple.
def	logCmd
	Log the command and its payloads.
def	execute
	Send the command to the VSC.
def	executeTeleCmd
	Send the command to the VSC and increment command counter.
def	m7
	Send the magic seven.
def	m7default
	Send the default magic seven.
def	m7off
	Send a blank schedule() to turn off magic seven.
def	siuSelect
	Select SIU.
def	daqSelect
	Select DAQ.
def	ssr
	Enable or disable SSR.
def	toggle
	Toggle lines.
def	pids
	Download SIU pids.
def	reset
	Reset the VSC proxy.
def	grb
	grb.
def	monitor
	monitor method.
def	getCmdCount
	Retrieve number of commands sent to the VSC since the start of the ScriptEngine.
def	getController
	Return the VSC controller instance.
Static Public Attributes
	AA = VSC.VscProxy.AA
	AB = VSC.VscProxy.AB
	BA = VSC.VscProxy.BA
	BB = VSC.VscProxy.BB
int	BOOTFLAG_UPPERBANK = 0x5400
int	BOOTFLAG_LOWERBANK = 0xA800
int	BOOTFLAG_MNTEEPROM = 0xC000
int	VscCtrlPort = 3000
	DownloadSiuPids = VSC.VscProxy.DownloadSiuPids
Private Attributes
	__tlmDb

---

Detailed Description

Script Engine proxy connector class.

This class creates three VSC proxies, one to the control stream to send tele-commands, one to the diagnostics proxy and one to the telemetry proxy.

Definition at line 34 of file ScriptEngineConnector.py.

---

Member Function Documentation

def __init__ (    self,   vscHost,   diagHost = None,   telemHost = None,   archiver = None,   cmdDebug = None,   portBase = None )

ScriptEngineConnector constructor. Parameters: vscHost  VSC host name or IP address. Required option. diagHost  Diagnostics telemetry process proxy host name or IP address (Default: None) telemHost  Telemetry proxy process host name or IP address (Default: None) archiver  Command archiver object (Default: None) cmdDebug  If set, command debugging is turned on. (Warning, verbose output to follow) portBase  If set, defines the base for the VSC port mapping. If None, uses self.VscCtrlPort Note: When diagHost and/or telemHost is None, no diagnostic or standard telemetry will be received. Definition at line 49 of file ScriptEngineConnector.py.

def bootEPU (    self,   epuId = 0,   flags_hi = None,   flags_lo = None )

Send boot telecommand to the EPU. Parameters: epuId  EPU id flags  EPU boot flags Definition at line 181 of file ScriptEngineConnector.py.

def bootSIU (    self,   siuId = 0,   flags_hi = None,   flags_lo = None )

Boot the SIU. Parameters: siuId  SIU unit flags_hi  SIU boot flags MSW flags_lo  SIU boot flags LSW Definition at line 161 of file ScriptEngineConnector.py.

def daqSelect (    self,   path )

Select DAQ. Parameters: path  DAQ path Definition at line 669 of file ScriptEngineConnector.py.

def execute (    self,   cmd )

Send the command to the VSC. Parameters: cmd  Command object Returns: Encoded tele-command packet Definition at line 602 of file ScriptEngineConnector.py.

def executeTeleCmd (    self,   cmd )

Send the command to the VSC and increment command counter. Parameters: cmd  Command object Returns: Encoded tele-command packet Definition at line 617 of file ScriptEngineConnector.py.

def getArchiver (    self  )

Retrieve the command archiver object. Returns: A VscArchiver instance Definition at line 148 of file ScriptEngineConnector.py.

def getCmdCount (    self  )

Retrieve number of commands sent to the VSC since the start of the ScriptEngine. Returns: Command count since the start of the ScriptEngine Definition at line 727 of file ScriptEngineConnector.py.

def getCmdCountMon (    self  )

Retrieve the command count monitor instance. Returns: seCmdCountMon instance Definition at line 112 of file ScriptEngineConnector.py.

def getCmdDebug (    self  )

Retrieve the command debug flag. Returns: Command debug flag. Definition at line 119 of file ScriptEngineConnector.py.

def getCmdTuple (    self,   cmd )

Retrieve the command tuple. Parameters: cmd  Command object Returns: A tuple containing (cmdName, payloadDict) Definition at line 575 of file ScriptEngineConnector.py.

def getController (    self  )

Return the VSC controller instance. Returns: VSC.VscProxy.Controller instance Definition at line 735 of file ScriptEngineConnector.py.

def getDiagHandler (    self  )

Retrieve the diagnostic telemetry handler. Returns: seTelemetryHandler instance Definition at line 126 of file ScriptEngineConnector.py.

def getPidsHandler (    self  )

Retrieve the pids telemetry handler. Returns: sePidsHandler instance Definition at line 140 of file ScriptEngineConnector.py.

def getTelemHandler (    self  )

Retrieve the LAT/VSC telemetry handler. Returns: seTelemetryHandler instance Definition at line 133 of file ScriptEngineConnector.py.

def getTlmDb (    self  )

Definition at line 155 of file ScriptEngineConnector.py.

def grb (    self  )

grb. Definition at line 712 of file ScriptEngineConnector.py.

def initCmdCountMon (    self  )

Initialize the command count monitor. Definition at line 104 of file ScriptEngineConnector.py.

def logCmd (    self,   cmdTuple )

Log the command and its payloads. Parameters: cmdTuple  Command tuple generated from the getCmdTuple method. Definition at line 589 of file ScriptEngineConnector.py.

def m7 (    self,   starttime,   endtime )

Send the magic seven. Definition at line 627 of file ScriptEngineConnector.py.

def m7default (    self  )

Send the default magic seven. Definition at line 642 of file ScriptEngineConnector.py.

def m7off (    self  )

Send a blank schedule() to turn off magic seven. Definition at line 656 of file ScriptEngineConnector.py.

def mainFeedOn (    self,   siuId = 0,   pduId = 0,   mfPri = 1,   dabPri = 1,   dabRed = 0,   ppsRed = 0,   ppsInt = 0,   ssrRed = 0,   gbmRed = 0 )

Turn on the main feed. The default parameter values turn on the PDU and GASU at the same time. To turn on the PDU only: pduId = PDU id, mfPri = 1 dabPri = 0 dabRed = 0 To turn on the primary GASU (after turning on the PDU): pduId = PDU id, mfPri = 1 dabPri = 1 dabRed = 0 To turn on the redundant GASU (after turning on the PDU): pduId = PDU id, mfPri = 1 dabPri = 0 dabRed = 1 Parameters: siuId  SIU unit pduId  PDU unit mfPRi  Primary main-feed selection dabPri  Primary DAB selection dabRed  Redundant DAB selection ppsRed  Redundant PPS selection ppsInt  PPS selection Definition at line 226 of file ScriptEngineConnector.py.

def monitor (    self,   state )

monitor method. monitor the VSC telemetry on state (state) Definition at line 719 of file ScriptEngineConnector.py.

def pids (    self  )

Download SIU pids. Definition at line 698 of file ScriptEngineConnector.py.

def powerOffAemOnly (    self,   pduId = 0,   supRed = 0 )

Definition at line 447 of file ScriptEngineConnector.py.

def powerOffCalOnly (    self,   temId )

Definition at line 361 of file ScriptEngineConnector.py.

def powerOffEpuOnly (    self,   epuId = 0,   pduId = 0 )

Power off the EPU only. Parameters: epuId  EPU id pduId  PDU id Definition at line 288 of file ScriptEngineConnector.py.

def powerOffFreeBoardOnly (    self,   freeId )

Definition at line 473 of file ScriptEngineConnector.py.

def powerOffTemOnly (    self,   temId,   pduId = 0 )

Definition at line 331 of file ScriptEngineConnector.py.

def powerOffTkrOnly (    self,   temId )

Definition at line 404 of file ScriptEngineConnector.py.

def powerOnAemOnly (    self,   pduId = 0,   supRed = 0 )

Definition at line 444 of file ScriptEngineConnector.py.

def powerOnCalOnly (    self,   temId )

Definition at line 358 of file ScriptEngineConnector.py.

def powerOnEpuOnly (    self,   epuId = 0,   pduId = 0 )

Power on the EPU only. Parameters: epuId  EPU id pduId  PDU id Definition at line 280 of file ScriptEngineConnector.py.

def powerOnFreeBoardOnly (    self,   freeId )

Definition at line 470 of file ScriptEngineConnector.py.

def powerOnTemOnly (    self,   temId,   pduId = 0 )

Definition at line 328 of file ScriptEngineConnector.py.

def powerOnTkrOnly (    self,   temId )

Definition at line 401 of file ScriptEngineConnector.py.

def reset (    self  )

Reset the VSC proxy. Definition at line 705 of file ScriptEngineConnector.py.

def resetEPU (    self,   epuId = 0 )

Initiate a warm reboot of the EPU. Parameters: epuId  EPU id Definition at line 213 of file ScriptEngineConnector.py.

def resetSIU (    self,   siuId = 0 )

Initiate a warm reboot of the SIU. Parameters: siuId  SIU unit Definition at line 200 of file ScriptEngineConnector.py.

def setBiasVoltageAcd (    self,   freeId,   saaBiasVoltage,   hvBiasVoltage )

Definition at line 500 of file ScriptEngineConnector.py.

def setBiasVoltageAcdNew (    self,   freeId,   saaBiasVoltage,   hvBiasVoltage,   hv1bs,   hv2bs,   priGasu = 1 )

Set ACD bias voltages for free board. Parameters: freeId  Free board id saaBiasVoltage  SAA voltage in counts hvBiasVoltage  HVBS voltage in counts hv1bs  Enable HV1 hv2bs  Enable HV2 priGasu  Primary GASU flag to determine the veto enables Definition at line 518 of file ScriptEngineConnector.py.

def setBiasVoltageCal (    self,   temId,   biasVoltage )

Definition at line 388 of file ScriptEngineConnector.py.

def setBiasVoltageTkr (    self,   temId,   biasVoltage )

Definition at line 431 of file ScriptEngineConnector.py.

def setPowerAemOnly (    self,   pduId,   supRed,   powerOn )

Definition at line 450 of file ScriptEngineConnector.py.

def setPowerCalOnly (    self,   temId,   powerOn )

Definition at line 364 of file ScriptEngineConnector.py.

def setPowerEpuOnly (    self,   epuId,   pduId,   powerOn )

Definition at line 296 of file ScriptEngineConnector.py.

def setPowerFreeBoardOnly (    self,   freeId,   powerOn )

Definition at line 476 of file ScriptEngineConnector.py.

def setPowerTemOnly (    self,   temId,   pduId,   powerOn )

Definition at line 334 of file ScriptEngineConnector.py.

def setPowerTkrOnly (    self,   temId,   powerOn )

Definition at line 407 of file ScriptEngineConnector.py.

def setTlmDb (    self,   db )

Definition at line 158 of file ScriptEngineConnector.py.

def siuSelect (    self,   path )

Select SIU. Parameters: path  SIU path Definition at line 661 of file ScriptEngineConnector.py.

def ssr (    self,   enable )

Enable or disable SSR. Parameters: enable  Boolean enable/disable flag Definition at line 677 of file ScriptEngineConnector.py.

def start (    self,   time = 0 )

Start the scheduler. Parameters: time  Time Definition at line 560 of file ScriptEngineConnector.py.

def stop (    self  )

Stop the scheduler. Definition at line 568 of file ScriptEngineConnector.py.

def toggle (    self,   lines,   values )

Toggle lines. Parameters: lines  Lines values  Values Definition at line 689 of file ScriptEngineConnector.py.

---

Member Data Documentation

__tlmDb [private]

Definition at line 159 of file ScriptEngineConnector.py.

AA = VSC.VscProxy.AA [static]

Definition at line 36 of file ScriptEngineConnector.py.

AB = VSC.VscProxy.AB [static]

Definition at line 37 of file ScriptEngineConnector.py.

BA = VSC.VscProxy.BA [static]

Definition at line 38 of file ScriptEngineConnector.py.

BB = VSC.VscProxy.BB [static]

Definition at line 39 of file ScriptEngineConnector.py.

int BOOTFLAG_LOWERBANK = 0xA800 [static]

Definition at line 42 of file ScriptEngineConnector.py.

int BOOTFLAG_MNTEEPROM = 0xC000 [static]

Definition at line 43 of file ScriptEngineConnector.py.

int BOOTFLAG_UPPERBANK = 0x5400 [static]

Definition at line 41 of file ScriptEngineConnector.py.

DownloadSiuPids = VSC.VscProxy.DownloadSiuPids [static]

Definition at line 47 of file ScriptEngineConnector.py.

int VscCtrlPort = 3000 [static]

Definition at line 45 of file ScriptEngineConnector.py.

---

The documentation for this class was generated from the following file:

• ScriptEngineConnector.py

---