ATMonochromator¶
Note
This page is generated by python script generate_cet.py.
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
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
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 the 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 the CSC itself.
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
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¶
- 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
unitless
- 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
unitless
Description: Indicates if the monochromator is inposition
device¶
- IDL_Type
long
- Units
unitless
- 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
unitless
- Count
900
Description: The error code being published.
loopTimeOutOfRange¶
Description: Exceeds loop time
- EFDB_Topic
ATMonochromator_logevent_loopTimeOutOfRange
loopTimeOutOfRange¶
- IDL_Type
boolean
- Units
unitless
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
unitless
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
unitless
Description: command value
detailedState¶
- IDL_Type
long
- Units
unitless
- 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
second
Description: Time at which event was detected (TAI unix seconds)
selectedGrating¶
Description: Event indicating the grating that was selected
- EFDB_Topic
ATMonochromator_logevent_selectedGrating
gratingType¶
- IDL_Type
long
- Units
unitless
- Enumeration
gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror
Description: Type of grating
timestamp¶
- IDL_Type
double
- Units
second
Description: Time at which event was detected (TAI unix seconds)
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
unitless
Description: IP address of the monochromator
portRange¶
- IDL_Type
long
- Units
unitless
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
unitless
- Enumeration
slit_Slit_Entry,slit_Slit_Exit
Description: Specifies which slit. Entry or exit slit
slitPosition¶
- IDL_Type
float
- Units
mm
Description: slit position
timestamp¶
- IDL_Type
double
- Units
second
Description: Time at which event was detected (TAI unix seconds)
status¶
Description: Controller status
- EFDB_Topic
ATMonochromator_logevent_status
status¶
- IDL_Type
long
- Units
unitless
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
second
Description: Time at which event was detected (TAI unix seconds)
authList¶
- EFDB_Topic
SALGeneric_logevent_authList
- Category
csc
configurationApplied¶
Description: Information about CSC’s configuration.
- 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 the 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 the CSC, and any other pertinent information. Ignore whitespace after commas.
configurationsAvailable¶
Description: Information about the source of configuration information for the 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 the 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 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.
largeFileObjectAvailable¶
Description: Large file object available event.
- EFDB_Topic
SALGeneric_logevent_largeFileObjectAvailable
url¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: A Uniform Resource Locator which links to a Large File Object either for ingest into the EFD Large File Annex, or to announce the successful copy of same to the EFD Large File Annex.Protocols are those supported by the cURL library.
generator¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: Name of the package which generated the file being announced
version¶
- IDL_Type
float
- Units
unitless
Description: A dotted x.y version number denoting the file format revision
byteSize¶
- IDL_Type
long
- Units
unitless
Description: Size of file in bytes
checkSum¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: Hexadecimal character string holding the checksum of the file
mimeType¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: Mime Type code for the file
id¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: A generic identifier field
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 the 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 the 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: 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
ATMonochromator_loopTime
loopTime¶
- IDL_Type
double
- Units
ms
Description: The actual loop time.
timestamp¶
- EFDB_Topic
ATMonochromator_timestamp
timestamp¶
- IDL_Type
double
- Units
second
Description: The system time (TAI unix seconds).