:tocdepth: 3 #### DIMM #### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _DIMM:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _DIMM:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _DIMM: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 .. _DIMM: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 .. _DIMM:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _DIMM: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. .. _DIMM: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 .. _DIMM: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 .. _DIMM: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 .. _DIMM: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 .. _DIMM:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :DetailedState: * DisabledState * EnabledState * FaultState * OfflineState * StandbyState Events ------ .. _DIMM:Events:detailedState: detailedState ~~~~~~~~~~~~~ :EFDB_Topic: DIMM_logevent_detailedState .. _DIMM:Events:detailedState:detailedState: detailedState ************* :IDL_Type: long :Units: unitless **Description**: The substate of the CSC. .. _DIMM:Events:dimmData: dimmData ~~~~~~~~ :EFDB_Topic: DIMM_logevent_dimmData .. _DIMM:Events:dimmData:numFrames: numFrames ********* :IDL_Type: long :Units: unitless **Description**: The number of frames. .. _DIMM:Events:dimmData:spot1Flux: spot1Flux ********* :IDL_Type: long :Units: unitless **Description**: The flux of spot 1 .. _DIMM:Events:dimmData:splot2Flux: splot2Flux ********** :IDL_Type: long :Units: unitless **Description**: The flux of splot2. .. _DIMM:Events:dimmData:spot1RMSFlux: spot1RMSFlux ************ :IDL_Type: long :Units: unitless **Description**: The RMS flux of spot1. .. _DIMM:Events:dimmData:spot2RMSFlux: spot2RMSFlux ************ :IDL_Type: long :Units: unitless **Description**: The RMS flux of spot2. .. _DIMM:Events:dimmData:spot1MaxInten: spot1MaxInten ************* :IDL_Type: long :Units: unitless **Description**: The maximum Intention of spot 1. .. _DIMM:Events:dimmData:spot2MaxInten: spot2MaxInten ************* :IDL_Type: long :Units: unitless **Description**: The maximum intention of spot 2. .. _DIMM:Events:dimmData:seperationX: seperationX *********** :IDL_Type: long :Units: unitless **Description**: The separation of x axis. .. _DIMM:Events:dimmData:seperationY: seperationY *********** :IDL_Type: long :Units: unitless **Description**: The separation of the y axis. .. _DIMM:Events:dimmData:seperationRMSX: seperationRMSX ************** :IDL_Type: double :Units: unitless **Description**: The separation of the RMS X axis. .. _DIMM:Events:dimmData:seperationRMSY: seperationRMSY ************** :IDL_Type: double :Units: unitless **Description**: The seperation of the RMS Y axis. .. _DIMM:Events:dimmData:covarianceX: covarianceX *********** :IDL_Type: double :Units: unitless **Description**: The covariance of the X axis. .. _DIMM:Events:dimmData:covarianceY: covarianceY *********** :IDL_Type: double :Units: unitless **Description**: The covariance of the Y axis. .. _DIMM:Events:dimmData:noiseRMSX: noiseRMSX ********* :IDL_Type: double :Units: unitless **Description**: The noise RMS of the X axis. .. _DIMM:Events:dimmData:noiseRMSY: noiseRMSY ********* :IDL_Type: double :Units: unitless **Description**: The noise RMS of axis Y. .. _DIMM:Events:dimmData:averagePositionX: averagePositionX **************** :IDL_Type: double :Units: unitless **Description**: The average position of the X axis. .. _DIMM:Events:dimmData:averagePositionY: averagePositionY **************** :IDL_Type: double :Units: unitless **Description**: The average position of Y axis. .. _DIMM:Events:dimmData:averagePositionRMSX: averagePositionRMSX ******************* :IDL_Type: double :Units: unitless **Description**: The average position RMS of axis X. .. _DIMM:Events:dimmData:averagePositionRMSY: averagePositionRMSY ******************* :IDL_Type: double :Units: unitless **Description**: The average position RMS Y. .. _DIMM:Events:dimmData:averageFWHMspot1: averageFWHMspot1 **************** :IDL_Type: double :Units: unitless **Description**: The average FWHM of spot 1. .. _DIMM:Events:dimmData:averageFWHMspot2: averageFWHMspot2 **************** :IDL_Type: double :Units: unitless **Description**: The average FWHM of spot 2. .. _DIMM:Events:dimmData:averageEllipticityspot1: averageEllipticityspot1 *********************** :IDL_Type: double :Units: unitless **Description**: The average ellipticity of spot 1. .. _DIMM:Events:dimmData:averageEllipticityspot2: averageEllipticityspot2 *********************** :IDL_Type: double :Units: unitless **Description**: The average ellipticity of spot 2. .. _DIMM:Events:dimmData:averageBackground: averageBackground ***************** :IDL_Type: double :Units: unitless **Description**: The average background .. _DIMM:Events:dimmData:backgroundRMS: backgroundRMS ************* :IDL_Type: double :Units: unitless **Description**: The background RMS. .. _DIMM:Events:dimmMeasurement: dimmMeasurement ~~~~~~~~~~~~~~~ :EFDB_Topic: DIMM_logevent_dimmMeasurement .. _DIMM:Events:dimmMeasurement:timestamp: timestamp ********* :IDL_Type: float :Units: second **Description**: The time of the event. .. _DIMM:Events:dimmMeasurement:hrNum: hrNum ***** :IDL_Type: unsigned long :Units: unitless **Description**: HR star number .. _DIMM:Events:dimmMeasurement:secz: secz **** :IDL_Type: float :Units: am **Description**: Airmass of the observation .. _DIMM:Events:dimmMeasurement:fwhm: fwhm **** :IDL_Type: float :Units: arcsec **Description**: Combined full width half maximum. .. _DIMM:Events:dimmMeasurement:fwhmx: fwhmx ***** :IDL_Type: float :Units: arcsec **Description**: Full width half maximum in the x-axis. .. _DIMM:Events:dimmMeasurement:fwhmy: fwhmy ***** :IDL_Type: float :Units: arcsec **Description**: Full width half maximum in the y-axis. .. _DIMM:Events:dimmMeasurement:r0: r0 ** :IDL_Type: float :Units: cm **Description**: Fried parameter .. _DIMM:Events:dimmMeasurement:nimg: nimg **** :IDL_Type: unsigned long :Units: unitless **Description**: Number of images used. .. _DIMM:Events:dimmMeasurement:dx: dx ** :IDL_Type: float :Units: arcsec **Description**: Distance between spots in the x-axis .. _DIMM:Events:dimmMeasurement:dy: dy ** :IDL_Type: float :Units: arcsec **Description**: Distance between spots in the y-axis .. _DIMM:Events:dimmMeasurement:flux: flux **** :IDL_Type: float :Units: adu **Description**: Total average flux this time bin .. _DIMM:Events:dimmMeasurement:fluxL: fluxL ***** :IDL_Type: float :Units: adu **Description**: Flux (left spot) .. _DIMM:Events:dimmMeasurement:scintL: scintL ****** :IDL_Type: float :Units: unitless **Description**: Scintillation-ratio (left spot) .. _DIMM:Events:dimmMeasurement:strehlL: strehlL ******* :IDL_Type: float :Units: unitless **Description**: Strehl-ratio (left spot) .. _DIMM:Events:dimmMeasurement:fluxR: fluxR ***** :IDL_Type: float :Units: adu **Description**: Flux (right spot) .. _DIMM:Events:dimmMeasurement:scintR: scintR ****** :IDL_Type: float :Units: unitless **Description**: Scintillation-ratio (right spot) .. _DIMM:Events:dimmMeasurement:strehlR: strehlR ******* :IDL_Type: float :Units: unitless **Description**: Strehl-ratio (right spot) .. _DIMM:Events:internalCommand: internalCommand ~~~~~~~~~~~~~~~ :EFDB_Topic: DIMM_logevent_internalCommand .. _DIMM:Events:internalCommand:commandObject: commandObject ************* :IDL_Type: byte :Units: unitless :Count: 800 **Description**: The error code being published. .. _DIMM:Events:loopTimeOutOfRange: loopTimeOutOfRange ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: DIMM_logevent_loopTimeOutOfRange .. _DIMM:Events:loopTimeOutOfRange:loopTimeOutOfRange: loopTimeOutOfRange ****************** :IDL_Type: boolean :Units: unitless **Description**: Whether the loop time is out of range. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _DIMM:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _DIMM:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _DIMM: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 .. _DIMM:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _DIMM:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _DIMM:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _DIMM:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _DIMM: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 .. _DIMM:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _DIMM:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _DIMM:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _DIMM:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _DIMM:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _DIMM:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _DIMM:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _DIMM: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 .. _DIMM:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _DIMM:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _DIMM: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 .. _DIMM:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _DIMM: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 .. _DIMM: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 .. _DIMM:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _DIMM:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _DIMM:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _DIMM:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _DIMM: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 .. _DIMM:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _DIMM:Telemetry:loopTime: loopTime ~~~~~~~~ :EFDB_Topic: DIMM_loopTime .. _DIMM:Telemetry:loopTime:loopTime: loopTime ******** :IDL_Type: double :Units: millisecond **Description**: The actual loop time is milliseconds. .. _DIMM:Telemetry:status: status ~~~~~~ :EFDB_Topic: DIMM_status .. _DIMM:Telemetry:status:status: status ****** :IDL_Type: long :Units: unitless **Description**: The status of the DIMM. .. _DIMM:Telemetry:status:hrNum: hrNum ***** :IDL_Type: unsigned long :Units: unitless **Description**: HR star number .. _DIMM:Telemetry:status:altitude: altitude ******** :IDL_Type: float :Units: degree **Description**: The altitude position of the DIMM .. _DIMM:Telemetry:status:azimuth: azimuth ******* :IDL_Type: float :Units: degree **Description**: The azimuth position of the DIMM .. _DIMM:Telemetry:status:ra: ra ** :IDL_Type: float :Units: degree **Description**: The right-ascension position of the DIMM .. _DIMM:Telemetry:status:decl: decl **** :IDL_Type: float :Units: degree **Description**: The declination position of the DIMM .. _DIMM:Telemetry:timestamp: timestamp ~~~~~~~~~ :EFDB_Topic: DIMM_timestamp .. _DIMM:Telemetry:timestamp:timestamp: timestamp ********* :IDL_Type: double :Units: second **Description**: The system time (TAI).