DSM¶
Note
This page is generated by python script generate_cet.py.
Commands¶
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic:
SALGeneric_command_disable
- Category:
csc
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic:
SALGeneric_command_enable
- Category:
csc
exitControl¶
Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.
- EFDB_Topic:
SALGeneric_command_exitControl
- Category:
csc
setLogLevel¶
Description: Set the logging level.
- EFDB_Topic:
SALGeneric_command_setLogLevel
- Category:
csc
level¶
- IDL_Type:
int
- Units:
unitless
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
standby¶
Description: Transition from state Offline/Available, Disabled or Fault to Standby.
- EFDB_Topic:
SALGeneric_command_standby
- Category:
csc
start¶
Description: Transition from state Standby to Disable, in a specified configuration.
- EFDB_Topic:
SALGeneric_command_start
- Category:
csc
configurationOverride¶
- IDL_Type:
string
- Units:
unitless
- Description:
Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:
“foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.
“:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.
“bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.
Events¶
configuration¶
Description: Configuration of a DSM device including information from accompanying UI.
- EFDB_Topic:
DSM_logevent_configuration
dsmIndex¶
- IDL_Type:
long
- Units:
unitless
Description: The index of the DSM unit.
timestampConfigStart¶
- IDL_Type:
double
- Units:
second
Description: The TAI timestamp for the start of the current configuration.
uiVersionCode¶
- IDL_Type:
string
- Units:
unitless
Description: The version of the DSM User Interface code.
uiVersionConfig¶
- IDL_Type:
string
- Units:
unitless
Description: The version of a Configuration passed to the DSM User Interface.
uiConfigFile¶
- IDL_Type:
string
- Units:
unitless
Description: A possible configuration file used by the DSM User Interface.
cameraName¶
- IDL_Type:
string
- Units:
unitless
Description: The type of camera used by the DSM User Interface.
cameraFps¶
- IDL_Type:
double
- Units:
1/second
Description: The Frames per Second rate of the camera.
dataBufferSize¶
- IDL_Type:
long
- Units:
unitless
Description: The size of the data buffer used in the calculations.
dataAcquisitionTime¶
- IDL_Type:
double
- Units:
second
Description: The total time is takes to fill a buffer for a calculation.
errorCode¶
Description: Output when this CSC goes into the Fault state as an explanation of the problem.
- EFDB_Topic:
SALGeneric_logevent_errorCode
- Category:
csc
errorCode¶
- IDL_Type:
long
- Units:
unitless
Description: A numeric error code.
errorReport¶
- IDL_Type:
string
- Units:
unitless
Description: An string providing detailed information about the error.
traceback¶
- IDL_Type:
string
- Units:
unitless
Description: An optional stack trace of the error condition.
heartbeat¶
Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.
- EFDB_Topic:
SALGeneric_logevent_heartbeat
- Category:
mandatory
heartbeat¶
- IDL_Type:
boolean
- Units:
unitless
Description: Deprecated field that you should ignore.
logLevel¶
Description: Current logging level.
- EFDB_Topic:
SALGeneric_logevent_logLevel
- Category:
mandatory
level¶
- IDL_Type:
int
- Units:
unitless
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
logMessage¶
Description: A log message.
- EFDB_Topic:
SALGeneric_logevent_logMessage
- Category:
mandatory
name¶
- IDL_Type:
string
- Units:
unitless
Description: Log name.
level¶
- IDL_Type:
int
- Units:
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
message¶
- IDL_Type:
string
- Units:
unitless
Description: Log message.
traceback¶
- IDL_Type:
string
- Units:
unitless
Description: Exception traceback; “” if not an exception.
filePath¶
- IDL_Type:
string
- Units:
unitless
Description: Path to source file.
functionName¶
- IDL_Type:
string
- Units:
unitless
Description: Function or method name.
lineNumber¶
- IDL_Type:
long
- Units:
unitless
Description: Line number in the file specified by filePath.
process¶
- IDL_Type:
long
- Units:
unitless
Description: Process ID.
timestamp¶
- IDL_Type:
double
- Units:
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
simulationMode¶
Description: Current simulation mode.
- EFDB_Topic:
SALGeneric_logevent_simulationMode
- Category:
csc
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
- Category:
mandatory
salVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of SAL generation.
xmlVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of CSC XML.
openSpliceVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of OpenSplice.
cscVersion¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: The software version of this CSC.
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 this CSC.
summaryState¶
Description: Current summary state of this CSC.
- EFDB_Topic:
SALGeneric_logevent_summaryState
- Category:
csc
summaryState¶
- IDL_Type:
long
- Units:
unitless
Description: High level state machine state identifier.
Telemetry¶
domeSeeing¶
Description: Measured quantities associated with dome seeing from a DSM device.
- EFDB_Topic:
DSM_domeSeeing
dsmIndex¶
- IDL_Type:
long
- Units:
unitless
Description: The index of the DSM unit.
timestampCurrent¶
- IDL_Type:
double
- Units:
second
Description: The TAI timestamp of the current buffer measurement.
timestampFirstMeasurement¶
- IDL_Type:
double
- Units:
second
Description: The TAI timestamp of the first measurement in the buffer.
timestampLastMeasurement¶
- IDL_Type:
double
- Units:
second
Description: The TAI timestamp of the last measurement in the buffer.
rmsX¶
- IDL_Type:
double
- Units:
arcsec
Description: The standard deviation of the buffer centroids in the X direction.
rmsY¶
- IDL_Type:
double
- Units:
arcsec
Description: The standard deviation of the buffer centroids in the Y direction.
centroidX¶
- IDL_Type:
double
- Units:
pixel
Description: The average spot position of the buffer centroids in the X direction.
centroidY¶
- IDL_Type:
double
- Units:
pixel
Description: The average spot position of the buffer centroids in the Y direction.
flux¶
- IDL_Type:
double
- Units:
unitless
Description: The average of the frame fluxes (ADU) in the buffer tracking the centroids.
maxADC¶
- IDL_Type:
double
- Units:
unitless
Description: The average of the frame maximum ADC values in the buffer tracking the centroids.
fwhm¶
- IDL_Type:
double
- Units:
pixel
Description: The average of the spot full-width, half-maxes in the buffer tracking the centroids.