SAL Interfaces

Note

This page is generated by the following python script generate_cet.py.

This page provides an html display of the SAL Interfaces for the CSCs. After the index of the individual CSCs, you will find the generic commands and events.

• ATAOS
• ATArchiver
• ATBuilding
• ATCamera
• ATDome
• ATDomeTrajectory
• ATHeaderService
• ATHexapod
• ATMCS
• ATMonochromator
• ATOODS
• ATPneumatics
• ATPtg
• ATSpectrograph
• ATWhiteLight
• AdamSensors
• CBP
• CCArchiver
• CCCamera
• CCHeaderService
• CCOODS
• CatchupArchiver
• DIMM
• DSM
• Dome
• EAS
• EFDTransformationServer
• ESS
• Electrometer
• Environment
• FiberSpectrograph
• GenericCamera
• HVAC
• Hexapod
• IOTA
• LOVE
• LinearStage
• MTAOS
• MTAlignment
• MTArchiver
• MTCamera
• MTDomeTrajectory
• MTEEC
• MTHeaderService
• MTM1M3
• MTM1M3TS
• MTM2
• MTMount
• MTPtg
• MTVMS
• NewMTMount
• PromptProcessing
• Rotator
• Scheduler
• Script
• ScriptQueue
• SummitFacility
• Test
• TunableLaser
• Watcher

Generics

abort

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_abort Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

enable

Description: Transition from state Disabled to Enabled.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_enable Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

disable

Description: Transition from state Enabled to Disabled.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_disable Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

standby

Description: Transition from state Offline, Disabled or Fault to Standby.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_standby Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

exitControl

Description: Transition from state Standby to Offline. For CSCs that are not “externally commandable” this makes the CSC quit.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_exitControl Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

start

Description: Transition from state Standby to Disable, in a specified configuration.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_start Explanation:http://project.lsst.org/ts/sal_objects/help

settingsToApply

IDL_Type:string IDL_Size:256 Units:unitless Count:1

Description: Name of the selected settings set

enterControl

Description: Transition from state Offline to Standby. Only “externally commandable” CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_enterControl Explanation:http://project.lsst.org/ts/sal_objects/help

value

IDL_Type:boolean Units:unitless Count:1

Description: Not used

setLogLevel

Description: Set the logging level.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_setLogLevel

level

IDL_Type:int Units:unitless Count:1

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

setValue

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_setValue Explanation:http://project.lsst.org/ts/sal_objects/help

parametersAndValues

IDL_Type:string IDL_Size:256 Units:unitless Count:1

Description: List of parameters and their values as a Json string

setAuthList

Subsystem:SALGeneric EFDB_Topic:SALGeneric_command_setAuthList Explanation:http://sal.lsst.org

authorizedUsers

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Comma seperated list of authorized users currently allowed to command this CSC.

nonAuthorizedCSCs

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Comma seperated list of CSC’s not currently allowed to command this CSC.

settingVersions

Description: Information about settings which can be specified in the start command.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_settingVersions Explanation:http://project.lsst.org/ts/sal_objects/help/SALGeneric_logevent_settingVersions.html

recommendedSettingsVersion

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: List of comma seperated recomended versions of settings sets

recommendedSettingsLabels

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: List of comma seperated names of settings sets

settingsUrl

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: The URL where the settings sets definitions can be found

errorCode

Description: Output when a CSC goes into the Fault state as an explanation of the problem.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_errorCode Explanation:http://project.lsst.org/ts/sal_objects/help/SALGeneric_logevent_errorCode.html

errorCode

IDL_Type:long Units:unitless Count:1

Description: A numeric error code

errorReport

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: An string providing detailed information about the error

traceback

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: An optional stack trace of the error condition

summaryState

Description: Current summary state of the CSC

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_summaryState Explanation:http://project.lsst.org/ts/sal_objects/help/SALGeneric_logevent_summaryState.html

summaryState

IDL_Type:long Units:unitless Count:1

Description: High level state machine state identifier

appliedSettingsMatchStart

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_appliedSettingsMatchStart Explanation:http://project.lsst.org/ts/sal_objects/help/SALGeneric_logevent_appliedSettingsMatchStart.html

appliedSettingsMatchStartIsTrue

IDL_Type:boolean Units:unitless Count:1

Description: True when the configuration matches the start conditions

logLevel

Description: Current logging level.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_logLevel

level

IDL_Type:int Units:unitless Count:1

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

logMessage

Description: A log message.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_logMessage

name

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Log name.

level

IDL_Type:int Units:unitless Count:1

Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.

message

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Log message.

traceback

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Exception traceback; “” if not an exception.

filePath

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Path to source file.

functionName

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Function or method name.

lineNumber

IDL_Type:long Units:unitless Count:1

Description: Line number in the file specified by filePath.

process

IDL_Type:long IDL_Size:1 Units:unitless Count:1

Description: Process ID.

settingsApplied

Description: Base settings applied.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_settingsApplied

settingsVersion

IDL_Type:string IDL_Size:256 Units:unitless Count:1

Description: The SHA or name corresponding to the published configuration

otherSettingsEvents

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary

simulationMode

Description: Current simulation mode.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_simulationMode

mode

IDL_Type:int Units:unitless Count:1

Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.

softwareVersions

Description: Current versions of software in use by CSC.

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_softwareVersions

salVersion

IDL_Type:string IDL_Size:16 Units:unitless Count:1

Description: This is the current version of SAL generation

xmlVersion

IDL_Type:string IDL_Size:16 Units:unitless Count:1

Description: This is the current version of CSC XML

openSpliceVersion

IDL_Type:string IDL_Size:16 Units:unitless Count:1

Description: This is the current version of OpenSplice

cscVersion

IDL_Type:string IDL_Size:16 Units:unitless Count:1

Description: This is the top-level version of the CSC

subsystemVersions

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within a CSC

heartbeat

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_heartbeat Explanation:http://sal.lsst.org

heartbeat

IDL_Type:boolean Units:unitless Count:1

Description: Beats the drum.

authList

Subsystem:SALGeneric EFDB_Topic:SALGeneric_logevent_authList Explanation:http://sal.lsst.org

authorizedUsers

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Comma seperated list of authorized users currently allowed to command this CSC.

nonAuthorizedCSCs

IDL_Type:string IDL_Size:1 Units:unitless Count:1

Description: Comma seperated list of CSC’s not currently allowed to command this CSC.