ATMonochromator

Note

This page is generated by the following python script generate_cet.py.

Back to table

Commands

calibrateWavelength

Description: Command to calibrate the wavelength

EFDB_Topic:ATMonochromator_command_calibrateWavelength

wavelength

IDL_Type:float Units:meter

Description: wavelength

changeSlitWidth

Description: Command to change Front enterance or Front exit slit width to width specified

EFDB_Topic:ATMonochromator_command_changeSlitWidth

slit

IDL_Type:long Units:unitless Enumeration:slit_Slit_FrontEntrance,slit_Slit_FrontExit

Description: slit

slitWidth

IDL_Type:float Units:unitless

Description: slitWidth

changeWavelength

Description: Command to change the wavelength of the monochromator

EFDB_Topic:ATMonochromator_command_changeWavelength

wavelength

IDL_Type:float Units:meter

Description: wavelength

power

Description: Command to turn the power ON and OFF

EFDB_Topic:ATMonochromator_command_power

power

IDL_Type:boolean Units:unitless

Description: power

selectGrating

Description: Select the grating (Blue,Red, Mirror) that will be in the path of light

EFDB_Topic:ATMonochromator_command_selectGrating

gratingType

IDL_Type:long Units:unitless Enumeration:gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror

Description: grating type

updateMonochromatorSetup

Description: Command used to setup monochromator with a single command

EFDB_Topic:ATMonochromator_command_updateMonochromatorSetup

gratingType

IDL_Type:long Units:unitless Enumeration:gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror

Description: Grating type

fontExitSlitWidth

IDL_Type:double Units:unitless

Description: slitwidth for front exit

fontEntranceSlitWidth

IDL_Type:double Units:unitless

Description: slitwidth for front entrance

wavelength

IDL_Type:double Units:meter

Description: wavelength

abort

EFDB_Topic:SALGeneric_command_abort

value

IDL_Type:boolean Units:unitless

Description: Not used

disable

Description: Transition from state Enabled to Disabled.

EFDB_Topic:SALGeneric_command_disable

value

IDL_Type:boolean Units:unitless

Description: Not used

enable

Description: Transition from state Disabled to Enabled.

EFDB_Topic:SALGeneric_command_enable

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

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

value

IDL_Type:boolean Units:unitless

Description: Not used

setAuthList

EFDB_Topic:SALGeneric_command_setAuthList

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

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

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

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

settingsToApply

IDL_Type:string IDL_Size:256 Units:unitless

Description: Name of the selected settings set

Enumerations

SummaryState:

• DisabledState
• EnabledState
• FaultState
• OfflineState
• StandbyState

DetailedState:

• NotEnabled
• Ready
• ChangingWavelength
• CalibratingWavelength
• Powering
• SelectingGrating
• ChangingSlitWidth
• UpdatingMonochromatorSetup

Status:

• SettingUp
• Ready
• Offline
• Fault

Grating:

• Blue
• Red
• Mirror

Slit:

• Entry
• Exit

LightStatus:

• On
• Off

Device:

• Monochromator
• LightSource
• ThermoelectricCooler

Events

detailedState

Description: Detailed State

EFDB_Topic:ATMonochromator_logevent_detailedState

detailedState

IDL_Type:long Units:dimensionless Enumeration:detailedState_DetailedState_DisabledState,detailedState_DetailedState_EnabledState,detailedState_DetailedState_FaultState,detailedState_DetailedState_OfflineState,detailedState_DetailedState_StandbyState,detailedState_DetailedState_MonoSettingUpState,detailedState_DetailedState_StoppedState,detailedState_DetailedState_StoppedCoolerOffState,detailedState_DetailedState_StoppedLightOffState,detailedState_DetailedState_StoppedLightOnState,detailedState_DetailedState_MonoManualSetup,detailedState_DetailedState_MonoAutomaticSetup

Description: An enumeration indicating the detailed state. See the DetailedStateValue enumeration defined in the Typedefs package.

entrySlitWidth

Description: Publishes the slitwidth

EFDB_Topic:ATMonochromator_logevent_entrySlitWidth

width

IDL_Type:float Units:mm

Description: Entry slit width

exitSlitWidth

Description: Publishes the slitwidth

EFDB_Topic:ATMonochromator_logevent_exitSlitWidth

width

IDL_Type:float Units:mm

Description: Exit slit width

inPosition

Description: Indicates if the monochromator is inposition

EFDB_Topic:ATMonochromator_logevent_inPosition

inPosition

IDL_Type:boolean Units:dimensionless

Description: Indicates if the monochromator is inposition

device

IDL_Type:long Units:dimensionless Enumeration:device_Device_Monochromator,device_Device_LightSource,device_Device_ThermoelectricCooler

Description: device

internalCommand

Description: internalcommand

EFDB_Topic:ATMonochromator_logevent_internalCommand

commandObject

IDL_Type:byte Units:dimensionless Count:900

Description: The error code being published.

loopTimeOutOfRange

Description: Exceeds loop time

EFDB_Topic:ATMonochromator_logevent_loopTimeOutOfRange

loopTimeOutOfRange

IDL_Type:boolean Units:dimensionless

Description: loop Time is not in range

monochromatorConnected

Description: Event to inform if the monochromator is connected or not

EFDB_Topic:ATMonochromator_logevent_monochromatorConnected

connected

IDL_Type:boolean Units:dimensionless

Description: connected

rejectedCommand

Description: Event published when a command is rejected either because command is received when in incorrect state or parameters of command are invalid

EFDB_Topic:ATMonochromator_logevent_rejectedCommand

commandValue

IDL_Type:unsigned short Units:dimensionless

Description: command value

detailedState

IDL_Type:long Units:dimensionless Enumeration:detailedState_DetailedState_DisabledState,detailedState_DetailedState_EnabledState,detailedState_DetailedState_FaultState,detailedState_DetailedState_OfflineState,detailedState_DetailedState_StandbyState,detailedState_DetailedState_MonoSettingUpState,detailedState_DetailedState_StoppedState,detailedState_DetailedState_StoppedCoolerOffState,detailedState_DetailedState_StoppedLightOffState,detailedState_DetailedState_StoppedLightOnState,detailedState_DetailedState_MonoManualSetup,detailedState_DetailedState_MonoAutomaticSetup

Description: detailed state

timestamp

IDL_Type:double Units:dimensionless

Description: time when the event occurred

selectedGrating

Description: Event indicating the grating that was selected

EFDB_Topic:ATMonochromator_logevent_selectedGrating

gratingType

IDL_Type:long Units:dimensionless Enumeration:gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror

Description: Type of grating

timestamp

IDL_Type:double Units:dimensionless

Description: timestamp when selected grating event occurs

settingsAppliedLoop

Description: Settings applied loop

EFDB_Topic:ATMonochromator_logevent_settingsAppliedLoop

period

IDL_Type:double Units:second

Description: period

periodAllowedJitter

IDL_Type:double Units:second

Description: Period when jitter is allowed

settingsAppliedMonoCommunication

Description: setting of the monochromator

EFDB_Topic:ATMonochromator_logevent_settingsAppliedMonoCommunication

ip

IDL_Type:string IDL_Size:15 Units:dimensionless

Description: IP address of the monochromator

portRange

IDL_Type:long Units:dimensionless

Description: port range, it will try to connect to any of the ports in this range

readTimeout

IDL_Type:float Units:second

Description: Read timeout value

writeTimeout

IDL_Type:float Units:second

Description: Write timeout value

connectionTimeout

IDL_Type:float Units:second

Description: connection time out setting

settingsAppliedMonoHeartbeat

Description: Internal heartbeat of the application to indicate if communication between linux and windows controlled is active or not

EFDB_Topic:ATMonochromator_logevent_settingsAppliedMonoHeartbeat

period

IDL_Type:float Units:second

Description: period

timeout

IDL_Type:float Units:second

Description: Time out for the heartbeat to test communication between linux and windows controller

settingsAppliedMonochromatorRanges

Description: Allowed range of different settings

EFDB_Topic:ATMonochromator_logevent_settingsAppliedMonochromatorRanges

wavelengthGR1

IDL_Type:float Units:nm

Description: Minimum wavelength to use with Grating 1

wavelengthGR1_GR2

IDL_Type:float Units:nm

Description: Wavelength to use to change to Grating 2

wavelengthGR2

IDL_Type:float Units:nm

Description: Maximum wavelength to use with Grating 2

minSlitWidth

IDL_Type:float Units:mm

Description: Minimum acceptable Slit width

maxSlitWidth

IDL_Type:float Units:mm

Description: Maximum acceptable Slit Width

minWavelength

IDL_Type:float Units:nm

Description: Minimum acceptable wavelength

maxWavelength

IDL_Type:float Units:nm

Description: Maximum acceptable Wavelength

slitWidth

Description: Publishes the slitwidth

EFDB_Topic:ATMonochromator_logevent_slitWidth

slit

IDL_Type:long Units:dimensionless Enumeration:slit_Slit_Entry,slit_Slit_Exit

Description: Specifies which slit. Entry or exit slit

slitPosition

IDL_Type:float Units:dimensionless

Description: slit position

timestamp

IDL_Type:double Units:unitless

Description: timestamp

status

Description: Controller status

EFDB_Topic:ATMonochromator_logevent_status

status

IDL_Type:long Units:dimensionless

Description: An enumeration indicating the controller status.

wavelength

Description: Publishes wavelength

EFDB_Topic:ATMonochromator_logevent_wavelength

wavelength

IDL_Type:float Units:m

Description: wavelength

timestamp

IDL_Type:double Units:dimensionless

Description: timestamp

appliedSettingsMatchStart

EFDB_Topic:SALGeneric_logevent_appliedSettingsMatchStart

appliedSettingsMatchStartIsTrue

IDL_Type:boolean Units:unitless

Description: True when the configuration matches the start conditions

authList

EFDB_Topic:SALGeneric_logevent_authList

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

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

heartbeat

IDL_Type:boolean Units:unitless

Description: Beats the drum.

logLevel

Description: Current logging level.

EFDB_Topic:SALGeneric_logevent_logLevel

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

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.

settingVersions

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

EFDB_Topic:SALGeneric_logevent_settingVersions

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

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

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

salVersion

IDL_Type:string IDL_Size:16 Units:unitless

Description: This is the current version of SAL generation

xmlVersion

IDL_Type:string IDL_Size:16 Units:unitless

Description: This is the current version of CSC XML

openSpliceVersion

IDL_Type:string IDL_Size:16 Units:unitless

Description: This is the current version of OpenSplice

cscVersion

IDL_Type:string IDL_Size:16 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

summaryState

IDL_Type:long Units:unitless

Description: High level state machine state identifier

Telemetry

loopTime

EFDB_Topic:ATMonochromator_loopTime

loopTime

IDL_Type:double Units:ms

Description: The actual loop time is ms.

timestamp

EFDB_Topic:ATMonochromator_timestamp

timestamp

IDL_Type:double Units:unitless

Description: The system time (TAI).