DIMM¶

Note

This page is generated by python script generate_cet.py.

Back to table

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. For CSCs that start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active.

EFDB_Topic: SALGeneric_command_exitControl
Category: csc

setAuthList¶

EFDB_Topic: SALGeneric_command_setAuthList
Category: csc

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.

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
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: Subsystem this applies to. If empty, the change applies to all subsystems. Beyond that, the meaning depends on the CSC.

standby¶

Description: Transition from state Offline, 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

settingsToApply¶

IDL_Type: string
IDL_Size: 256
Units: unitless

Description: Name of the selected settings set

Enumerations¶

DetailedState

DisabledState
EnabledState
FaultState
OfflineState
StandbyState

Events¶

detailedState¶

EFDB_Topic: DIMM_logevent_detailedState

detailedState¶

IDL_Type: long
Units: unitless

Description: The substate of the CSC.

dimmData¶

EFDB_Topic: DIMM_logevent_dimmData

numFrames¶

IDL_Type: long
Units: unitless

Description: The number of frames.

spot1Flux¶

IDL_Type: long
Units: unitless

Description: The flux of spot 1

splot2Flux¶

IDL_Type: long
Units: unitless

Description: The flux of splot2.

spot1RMSFlux¶

IDL_Type: long
Units: unitless

Description: The RMS flux of spot1.

spot2RMSFlux¶

IDL_Type: long
Units: unitless

Description: The RMS flux of spot2.

spot1MaxInten¶

IDL_Type: long
Units: unitless

Description: The maximum Intention of spot 1.

spot2MaxInten¶

IDL_Type: long
Units: unitless

Description: The maximum intention of spot 2.

seperationX¶

IDL_Type: long
Units: unitless

Description: The separation of x axis.

seperationY¶

IDL_Type: long
Units: unitless

Description: The separation of the y axis.

seperationRMSX¶

IDL_Type: double
Units: unitless

Description: The separation of the RMS X axis.

seperationRMSY¶

IDL_Type: double
Units: unitless

Description: The seperation of the RMS Y axis.

covarianceX¶

IDL_Type: double
Units: unitless

Description: The covariance of the X axis.

covarianceY¶

IDL_Type: double
Units: unitless

Description: The covariance of the Y axis.

noiseRMSX¶

IDL_Type: double
Units: unitless

Description: The noise RMS of the X axis.

noiseRMSY¶

IDL_Type: double
Units: unitless

Description: The noise RMS of axis Y.

averagePositionX¶

IDL_Type: double
Units: unitless

Description: The average position of the X axis.

averagePositionY¶

IDL_Type: double
Units: unitless

Description: The average position of Y axis.

averagePositionRMSX¶

IDL_Type: double
Units: unitless

Description: The average position RMS of axis X.

averagePositionRMSY¶

IDL_Type: double
Units: unitless

Description: The average position RMS Y.

averageFWHMspot1¶

IDL_Type: double
Units: unitless

Description: The average FWHM of spot 1.

averageFWHMspot2¶

IDL_Type: double
Units: unitless

Description: The average FWHM of spot 2.

averageEllipticityspot1¶

IDL_Type: double
Units: unitless

Description: The average ellipticity of spot 1.

averageEllipticityspot2¶

IDL_Type: double
Units: unitless

Description: The average ellipticity of spot 2.

averageBackground¶

IDL_Type: double
Units: unitless

Description: The average background

backgroundRMS¶

IDL_Type: double
Units: unitless

Description: The background RMS.

dimmMeasurement¶

EFDB_Topic: DIMM_logevent_dimmMeasurement

timestamp¶

IDL_Type: float
Units: second

Description: The time of the event.

hrNum¶

IDL_Type: unsigned long
Units: unitless

Description: HR star number

secz¶

IDL_Type: float
Units: am

Description: Airmass of the observation

fwhm¶

IDL_Type: float
Units: arcsec

Description: Combined full width half maximum.

fwhmx¶

IDL_Type: float
Units: arcsec

Description: Full width half maximum in the x-axis.

fwhmy¶

IDL_Type: float
Units: arcsec

Description: Full width half maximum in the y-axis.

r0¶

IDL_Type: float
Units: cm

Description: Fried parameter

nimg¶

IDL_Type: unsigned long
Units: unitless

Description: Number of images used.

dx¶

IDL_Type: float
Units: arcsec

Description: Distance between spots in the x-axis

dy¶

IDL_Type: float
Units: arcsec

Description: Distance between spots in the y-axis

flux¶

IDL_Type: float
Units: adu

Description: Total average flux this time bin

fluxL¶

IDL_Type: float
Units: adu

Description: Flux (left spot)

scintL¶

IDL_Type: float
Units: unitless

Description: Scintillation-ratio (left spot)

strehlL¶

IDL_Type: float
Units: unitless

Description: Strehl-ratio (left spot)

fluxR¶

IDL_Type: float
Units: adu

Description: Flux (right spot)

scintR¶

IDL_Type: float
Units: unitless

Description: Scintillation-ratio (right spot)

strehlR¶

IDL_Type: float
Units: unitless

Description: Strehl-ratio (right spot)

internalCommand¶

EFDB_Topic: DIMM_logevent_internalCommand

commandObject¶

IDL_Type: byte
Units: unitless
Count: 800

Description: The error code being published.

loopTimeOutOfRange¶

EFDB_Topic: DIMM_logevent_loopTimeOutOfRange

loopTimeOutOfRange¶

IDL_Type: boolean
Units: unitless

Description: Whether the loop time is out of range.

appliedSettingsMatchStart¶

EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart
Category: configurable

appliedSettingsMatchStartIsTrue¶

IDL_Type: boolean
Units: unitless

Description: True when the configuration matches the start conditions

authList¶

EFDB_Topic: SALGeneric_logevent_authList
Category: csc

authorizedUsers¶

IDL_Type: string
Units: unitless

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

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
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¶

EFDB_Topic: SALGeneric_logevent_heartbeat
Category: mandatory

heartbeat¶

IDL_Type: boolean
Units: unitless

Description: Beats the drum.

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: Subsystem this applies to. The empty string if all subsystems. Beyond that, the meaning depends on the CSC.

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.

settingVersions¶

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

EFDB_Topic: SALGeneric_logevent_settingVersions
Category: configurable

recommendedSettingsVersion¶

IDL_Type: string
Units: unitless

Description: List of comma seperated recomended versions of settings sets

recommendedSettingsLabels¶

IDL_Type: string
Units: unitless

Description: List of comma seperated names of settings sets

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
Category: configurable

settingsVersion¶

IDL_Type: string
IDL_Size: 256
Units: unitless

Description: The SHA or name corresponding to the published configuration

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
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: This is the top-level version of the 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 a CSC

summaryState¶

Description: Current summary state of the CSC

EFDB_Topic: SALGeneric_logevent_summaryState
Category: csc

summaryState¶

IDL_Type: long
Units: unitless

Description: High level state machine state identifier

Telemetry¶

loopTime¶

EFDB_Topic: DIMM_loopTime

loopTime¶

IDL_Type: double
Units: millisecond

Description: The actual loop time is milliseconds.

status¶

EFDB_Topic: DIMM_status

status¶

IDL_Type: long
Units: unitless

Description: The status of the DIMM.

hrNum¶

IDL_Type: unsigned long
Units: unitless

Description: HR star number

altitude¶

IDL_Type: float
Units: degree

Description: The altitude position of the DIMM

azimuth¶

IDL_Type: float
Units: degree

Description: The azimuth position of the DIMM

ra¶

IDL_Type: float
Units: degree

Description: The right-ascension position of the DIMM

decl¶

IDL_Type: float
Units: degree

Description: The declination position of the DIMM

timestamp¶

EFDB_Topic: DIMM_timestamp

timestamp¶

IDL_Type: double
Units: second

Description: The system time (TAI).

Navigation

DIMM¶

Commands¶

disable¶

enable¶

exitControl¶

setAuthList¶

authorizedUsers¶

nonAuthorizedCSCs¶

setLogLevel¶

level¶

subsystem¶

standby¶

start¶

settingsToApply¶

Enumerations¶

Events¶

detailedState¶

detailedState¶

dimmData¶

numFrames¶

spot1Flux¶

splot2Flux¶

spot1RMSFlux¶

spot2RMSFlux¶

spot1MaxInten¶

spot2MaxInten¶

seperationX¶

seperationY¶

seperationRMSX¶

seperationRMSY¶

covarianceX¶

covarianceY¶

noiseRMSX¶

noiseRMSY¶

averagePositionX¶

averagePositionY¶

averagePositionRMSX¶

averagePositionRMSY¶

averageFWHMspot1¶

averageFWHMspot2¶

averageEllipticityspot1¶

averageEllipticityspot2¶

averageBackground¶

backgroundRMS¶

dimmMeasurement¶

timestamp¶

hrNum¶

secz¶

fwhm¶

fwhmx¶

fwhmy¶

r0¶

nimg¶

dx¶

dy¶

flux¶

fluxL¶

scintL¶

strehlL¶

fluxR¶

scintR¶

strehlR¶

internalCommand¶

commandObject¶

loopTimeOutOfRange¶

loopTimeOutOfRange¶

appliedSettingsMatchStart¶

appliedSettingsMatchStartIsTrue¶

authList¶

authorizedUsers¶

nonAuthorizedCSCs¶

errorCode¶

errorCode¶

errorReport¶

traceback¶

heartbeat¶

heartbeat¶

logLevel¶

level¶