TunableLaser#

Note

This page is generated by python script generate_cet.py.

Back to table

Commands#

changeTempCtrlSetpoint#

EFDB_Topic:: TunableLaser_command_changeTempCtrlSetpoint

setpoint#

IDL_Type:: float
Units:: deg_C

Description: Set point for the thermal sensor.

changeWavelength#

EFDB_Topic:: TunableLaser_command_changeWavelength

wavelength#

IDL_Type:: long
Units:: nanometer

Description: Wavelength to be set.

clearLaserFault#

EFDB_Topic:: TunableLaser_command_clearLaserFault

setBurstMode#

EFDB_Topic:: TunableLaser_command_setBurstMode

count#

IDL_Type:: long
Units:: nanometer

Description: Burst count to be set.

setContinuousMode#

EFDB_Topic:: TunableLaser_command_setContinuousMode

setOpticalConfiguration#

EFDB_Topic:: TunableLaser_command_setOpticalConfiguration

configuration#

IDL_Type:: string
Units:: unitless

Description: Optical alignment configuration to be set.

startPropagateLaser#

EFDB_Topic:: TunableLaser_command_startPropagateLaser

stopPropagateLaser#

EFDB_Topic:: TunableLaser_command_stopPropagateLaser

triggerBurst#

Description: Trigger an increased burst of energy.

EFDB_Topic:: TunableLaser_command_triggerBurst

turnOffTempCtrl#

Description: Send command to turn off thermal sensor.

EFDB_Topic:: TunableLaser_command_turnOffTempCtrl

turnOnTempCtrl#

Description: Send command to turn on thermal sensor.

EFDB_Topic:: TunableLaser_command_turnOnTempCtrl

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”.

Enumerations#

LaserDetailedState:

NonPropagatingState
PropagatingState
PropagatingBurstModeWaitingForTrigger
PropagatingBurstModeTriggered

LaserErrorCode:

ASCII_ERROR = 7301
GENERAL_ERROR = 7302
TIMEOUT_ERROR = 7303
HW_CPU_ERROR = 7304

Events#

burstCountSet#

EFDB_Topic:: TunableLaser_logevent_burstCountSet

count#

IDL_Type:: long
Units:: second

Description: The new burst count.

burstModeSet#

EFDB_Topic:: TunableLaser_logevent_burstModeSet

continuousModeSet#

EFDB_Topic:: TunableLaser_logevent_continuousModeSet

detailedState#

EFDB_Topic:: TunableLaser_logevent_detailedState

detailedState#

IDL_Type:: long
Units:: unitless

Description: The substate or extra states of the CSC.

interlockState#

EFDB_Topic:: TunableLaser_logevent_interlockState

interlockState#

IDL_Type:: boolean
Units:: unitless

Description: State of the interlock, True of ON, False if OFF.

laserFanState#

EFDB_Topic:: TunableLaser_logevent_laserFanState

laserFanState#

IDL_Type:: boolean
Units:: unitless

Description: State of the fan, True of ON, False if OFF.

laserInstabilityFlag#

EFDB_Topic:: TunableLaser_logevent_laserInstabilityFlag

opticalConfiguration#

EFDB_Topic:: TunableLaser_logevent_opticalConfiguration

configuration#

IDL_Type:: string
Units:: unitless

Description: The new optical alignment configuration.

setPointChanged#

EFDB_Topic:: TunableLaser_logevent_setPointChanged

setPoint#

IDL_Type:: float
Units:: deg_C

Description: Value of the temp control set point that was changed

tempCtrlOff#

EFDB_Topic:: TunableLaser_logevent_tempCtrlOff

tempCtrlOn#

EFDB_Topic:: TunableLaser_logevent_tempCtrlOn

wavelengthChanged#

EFDB_Topic:: TunableLaser_logevent_wavelengthChanged

wavelength#

IDL_Type:: double
Units:: nanometer

Description: The new wavelength.

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#

scannerTemperature#

Description: The average temperature of the Omrom scanner for measuring the cooling performance of the laser.

EFDB_Topic:: TunableLaser_scannerTemperature

scanner_temperature#

IDL_Type:: float
Units:: deg_C

Description: Rolling average temperature of all temps on the scanner.

temperature#

Description: The temperature sensors that are available from the laser. (deg_C)

EFDB_Topic:: TunableLaser_temperature

tk6_temperature#

IDL_Type:: float
Units:: deg_C

Description: The temperature sensors for the laser.