DIMM#

Note

This page is generated by python script generate_cet.py.

Back to table

Commands#

changeDwellRate#

Description: Change dwell rate. Sample rate in ms for low level.

EFDB_Topic:

DIMM_command_changeDwellRate

sampleRate#

IDL_Type:

int

Units:

ms

Description: New sample rate.

changeMeasurementRate#

Description: Change measurement rate in Hz.

EFDB_Topic:

DIMM_command_changeMeasurementRate

measurementRate#

IDL_Type:

int

Units:

Hz

Description: New measurement rate.

gotoAltAz#

Description: Slew telescope to target Alt/Az.

EFDB_Topic:

DIMM_command_gotoAltAz

alt#

IDL_Type:

double

Units:

deg

Description: Altitude of target.

az#

IDL_Type:

double

Units:

deg

Description: Azimuth of target.

gotoRaDec#

Description: Slew telescope to target RA/DEC.

EFDB_Topic:

DIMM_command_gotoRaDec

ra#

IDL_Type:

double

Units:

deg

Description: RA of target.

decl#

IDL_Type:

double

Units:

deg

Description: Declination of target.

track#

IDL_Type:

boolean

Units:

unitless

Description: Track target.

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

setAuthList#

Description: Specify who can command this CSC.

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: 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#

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:

double

Units:

second

Description: The time of the event.

expiresAt#

IDL_Type:

double

Units:

second

Description: Timestamp (UTC) until when the measurement is deemed valid.

expiresIn#

IDL_Type:

float

Units:

second

Description: Duration the measurement is deemed valid since publication.

hrNum#

IDL_Type:

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:

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)

moduleStatus#

EFDB_Topic:

DIMM_logevent_moduleStatus

scopeStatus#

IDL_Type:

boolean

Units:

unitless

Description: Subsystem status for Scope module.

masterStatus#

IDL_Type:

boolean

Units:

unitless

Description: Subsystem status for Master module.

metrologyStatus#

IDL_Type:

boolean

Units:

unitless

Description: Subsystem status for Metrology module.

domeStatus#

IDL_Type:

boolean

Units:

unitless

Description: Subsystem status for Metrology module.

dimmStatus#

IDL_Type:

boolean

Units:

unitless

Description: Subsystem status for DIMM processing module.

authList#

Description: Who can command this CSC.

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.

configurationApplied#

Description: Information about this CSC’s current configuration overrides.

EFDB_Topic:

SALGeneric_logevent_configurationApplied

Category:

configurable

configurations#

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.

version#

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url#

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.

schemaVersion#

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.

otherInfo#

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by this CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable#

Description: Available configuration overrides for this CSC.

EFDB_Topic:

SALGeneric_logevent_configurationsAvailable

Category:

configurable

overrides#

IDL_Type:

string

Units:

unitless

Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.

version#

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url#

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.

schemaVersion#

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.

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#

meterology#

EFDB_Topic:

DIMM_meterology

ambientTemperature#

IDL_Type:

float

Units:

deg_C

Description: The ambient temperature.

dewpointTemperature#

IDL_Type:

float

Units:

deg_C

Description: The dewpoint temperature.

pressure#

IDL_Type:

double

Units:

mbar

Description: The pressure outside.

humidity#

IDL_Type:

double

Units:

%

Description: The humidity outside.

windSpeed#

IDL_Type:

float

Units:

m/s

Description: The wind speed.

windDirection#

IDL_Type:

float

Units:

deg

Description: The wind direction.

sky#

EFDB_Topic:

DIMM_sky

status#

IDL_Type:

long

Units:

unitless

Enumeration:

clear=0,lightcoverage=1,cloudy=2,rain=3,snow=4

Description: The current sky status.

status#

EFDB_Topic:

DIMM_status

status#

IDL_Type:

long

Units:

unitless

Description: The status of the DIMM.

hrNum#

IDL_Type:

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