:tocdepth: 3 ### DSM ### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _DSM:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _DSM:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _DSM:enable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used 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. :EFDB_Topic: SALGeneric_command_enterControl .. _DSM:enterControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used exitControl ~~~~~~~~~~~ **Description**: Transition from state Standby to Offline. For CSCs that are not "externally commandable" this makes the CSC quit. :EFDB_Topic: SALGeneric_command_exitControl .. _DSM:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _DSM:setAuthList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC, in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC's own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma. .. _DSM:setAuthList:nonAuthorizedCSCs: nonAuthorizedCSCs ***************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of CSC's not currently allowed to command this CSC, in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma. setLogLevel ~~~~~~~~~~~ **Description**: Set the logging level. :EFDB_Topic: SALGeneric_command_setLogLevel .. _DSM:setLogLevel:level: level ***** :IDL_Type: int :Units: unitless **Description**: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10. setValue ~~~~~~~~ :EFDB_Topic: SALGeneric_command_setValue .. _DSM:setValue:parametersAndValues: parametersAndValues ******************* :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: List of parameters and their values as a Json string standby ~~~~~~~ **Description**: Transition from state Offline, Disabled or Fault to Standby. :EFDB_Topic: SALGeneric_command_standby .. _DSM:standby:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _DSM:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Events ------ .. _DSM:Events:settingsAppliedSetup: settingsAppliedSetup ~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: DSM_logevent_settingsAppliedSetup .. _DSM:Events:settingsAppliedSetup:telemetryDirectory: telemetryDirectory ****************** :IDL_Type: string :Units: dimensionless :Count: 256 **Description**: The location where the telemetry data from the UI is written. If it starts with /tmp, the CSC was run in simulation mode. .. _DSM:Events:settingsAppliedSetup:simulationLoopTime: simulationLoopTime ****************** :IDL_Type: long :Units: second **Description**: The sleep time between successive writes of telemetry data in simulation mode. If this is -1, the CSC is run in standard mode. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _DSM:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _DSM:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _DSM:authList:nonAuthorizedCSCs: nonAuthorizedCSCs ***************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of CSC's not currently allowed to command this CSC. errorCode ~~~~~~~~~ **Description**: Output when a CSC goes into the Fault state as an explanation of the problem. :EFDB_Topic: SALGeneric_logevent_errorCode .. _DSM:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _DSM:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _DSM:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _DSM:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _DSM:logLevel:level: level ***** :IDL_Type: int :Units: unitless **Description**: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10. logMessage ~~~~~~~~~~ **Description**: A log message. :EFDB_Topic: SALGeneric_logevent_logMessage .. _DSM:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _DSM:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _DSM:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _DSM:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _DSM:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _DSM:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _DSM:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _DSM:logMessage:process: process ******* :IDL_Type: long :Units: unitless **Description**: Process ID. settingVersions ~~~~~~~~~~~~~~~ **Description**: Information about settings which can be specified in the start command. :EFDB_Topic: SALGeneric_logevent_settingVersions .. _DSM:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _DSM:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _DSM:settingVersions:settingsUrl: settingsUrl *********** :IDL_Type: string :Units: unitless **Description**: The URL where the settings sets definitions can be found settingsApplied ~~~~~~~~~~~~~~~ **Description**: Base settings applied. :EFDB_Topic: SALGeneric_logevent_settingsApplied .. _DSM:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _DSM:settingsApplied:otherSettingsEvents: otherSettingsEvents ******************* :IDL_Type: string :Units: unitless **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. :EFDB_Topic: SALGeneric_logevent_simulationMode .. _DSM:simulationMode:mode: mode **** :IDL_Type: int :Units: unitless **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. :EFDB_Topic: SALGeneric_logevent_softwareVersions .. _DSM:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _DSM:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _DSM:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _DSM:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _DSM:softwareVersions:subsystemVersions: subsystemVersions ***************** :IDL_Type: string :Units: unitless **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 summaryState ~~~~~~~~~~~~ **Description**: Current summary state of the CSC :EFDB_Topic: SALGeneric_logevent_summaryState .. _DSM:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _DSM:Telemetry:configuration: configuration ~~~~~~~~~~~~~ :EFDB_Topic: DSM_configuration .. _DSM:Telemetry:configuration:dsmIndex: dsmIndex ******** :IDL_Type: long :Units: dimensionless **Description**: The index of the DSM unit. .. _DSM:Telemetry:configuration:timestampConfigStart: timestampConfigStart ******************** :IDL_Type: double :Units: second **Description**: The TAI timestamp for the start of the current configuration. .. _DSM:Telemetry:configuration:uiVersionCode: uiVersionCode ************* :IDL_Type: string :Units: dimensionless :Count: 16 **Description**: The version of the DSM User Interface code. .. _DSM:Telemetry:configuration:uiVersionConfig: uiVersionConfig *************** :IDL_Type: string :Units: dimensionless :Count: 16 **Description**: The version of a Configuration passed to the DSM User Interface. .. _DSM:Telemetry:configuration:uiConfigFile: uiConfigFile ************ :IDL_Type: string :Units: dimensionless :Count: 256 **Description**: A possible configuration file used by the DSM User Interface. .. _DSM:Telemetry:configuration:cameraName: cameraName ********** :IDL_Type: string :Units: dimensionless :Count: 16 **Description**: The type of camera used by the DSM User Interface. .. _DSM:Telemetry:configuration:cameraFps: cameraFps ********* :IDL_Type: double :Units: 1/second **Description**: The Frames per Second rate of the camera. .. _DSM:Telemetry:configuration:dataBufferSize: dataBufferSize ************** :IDL_Type: long :Units: dimensionless **Description**: The size of the data buffer used in the calculations. .. _DSM:Telemetry:configuration:dataAcquisitionTime: dataAcquisitionTime ******************* :IDL_Type: double :Units: second **Description**: The total time is takes to fill a buffer for a calculation. .. _DSM:Telemetry:domeSeeing: domeSeeing ~~~~~~~~~~ :EFDB_Topic: DSM_domeSeeing .. _DSM:Telemetry:domeSeeing:dsmIndex: dsmIndex ******** :IDL_Type: long :Units: dimensionless **Description**: The index of the DSM unit. .. _DSM:Telemetry:domeSeeing:timestampCurrent: timestampCurrent **************** :IDL_Type: double :Units: second **Description**: The TAI timestamp of the current buffer measurement. .. _DSM:Telemetry:domeSeeing:timestampFirstMeasurement: timestampFirstMeasurement ************************* :IDL_Type: double :Units: second **Description**: The TAI timestamp of the first measurement in the buffer. .. _DSM:Telemetry:domeSeeing:timestampLastMeasurement: timestampLastMeasurement ************************ :IDL_Type: double :Units: second **Description**: The TAI timestamp of the last measurement in the buffer. .. _DSM:Telemetry:domeSeeing:rmsX: rmsX **** :IDL_Type: double :Units: arcsec **Description**: The standard deviation of the buffer centroids in the X direction. .. _DSM:Telemetry:domeSeeing:rmsY: rmsY **** :IDL_Type: double :Units: arcsec **Description**: The standard deviation of the buffer centroids in the Y direction. .. _DSM:Telemetry:domeSeeing:centroidX: centroidX ********* :IDL_Type: double :Units: pixel **Description**: The average spot position of the buffer centroids in the X direction. .. _DSM:Telemetry:domeSeeing:centroidY: centroidY ********* :IDL_Type: double :Units: pixel **Description**: The average spot position of the buffer centroids in the Y direction. .. _DSM:Telemetry:domeSeeing:flux: flux **** :IDL_Type: double :Units: unitless **Description**: The average of the frame fluxes (ADU) in the buffer tracking the centroids. .. _DSM:Telemetry:domeSeeing:maxADC: maxADC ****** :IDL_Type: double :Units: unitless **Description**: The average of the frame maximum ADC values in the buffer tracking the centroids. .. _DSM:Telemetry:domeSeeing:fwhm: fwhm **** :IDL_Type: double :Units: pixel **Description**: The average of the spot full-width, half-maxes in the buffer tracking the centroids.