ATSpectrograph¶
Note
This page is generated by the following python script generate_cet.py
.
Commands¶
changeDisperser¶
EFDB_Topic: | ATSpectrograph_command_changeDisperser |
---|
name¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Name of the grating to select. Command gets rejected if both are set.
changeFilter¶
EFDB_Topic: | ATSpectrograph_command_changeFilter |
---|
name¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Name of the filter to select. Command gets rejected if both are set.
homeLinearStage¶
EFDB_Topic: | ATSpectrograph_command_homeLinearStage |
---|
moveLinearStage¶
EFDB_Topic: | ATSpectrograph_command_moveLinearStage |
---|
stopAllAxes¶
EFDB_Topic: | ATSpectrograph_command_stopAllAxes |
---|
abort¶
EFDB_Topic: | SALGeneric_command_abort |
---|
disable¶
Description: Transition from state Enabled to Disabled.
EFDB_Topic: | SALGeneric_command_disable |
---|
enable¶
Description: Transition from state Disabled to Enabled.
EFDB_Topic: | SALGeneric_command_enable |
---|
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 |
---|
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 |
---|
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 |
---|
Enumerations¶
FilterPosition: |
|
---|---|
DisperserPosition: | |
|
|
Status: |
|
Error: |
|
Port: |
|
Events¶
detailedState¶
EFDB_Topic: | ATSpectrograph_logevent_detailedState |
---|
disperserInPosition¶
EFDB_Topic: | ATSpectrograph_logevent_disperserInPosition |
---|
filterInPosition¶
EFDB_Topic: | ATSpectrograph_logevent_filterInPosition |
---|
fwState¶
EFDB_Topic: | ATSpectrograph_logevent_fwState |
---|
gwState¶
EFDB_Topic: | ATSpectrograph_logevent_gwState |
---|
internalCommand¶
EFDB_Topic: | ATSpectrograph_logevent_internalCommand |
---|
commandObject¶
IDL_Type: | byte |
---|---|
Units: | unitless |
Count: | 950 |
Description: The internal command that occurred.
linearStageInPosition¶
EFDB_Topic: | ATSpectrograph_logevent_linearStageInPosition |
---|
loopTimeOutOfRange¶
EFDB_Topic: | ATSpectrograph_logevent_loopTimeOutOfRange |
---|
lsState¶
EFDB_Topic: | ATSpectrograph_logevent_lsState |
---|
rejectedCommand¶
EFDB_Topic: | ATSpectrograph_logevent_rejectedCommand |
---|
reportedDisperserPosition¶
EFDB_Topic: | ATSpectrograph_logevent_reportedDisperserPosition |
---|
focusOffset¶
IDL_Type: | float |
---|---|
Units: | mm |
- Description: Focus offset to be applied on the secondary mirror in units of mm, relative to no glass
- being installed. Positive values push the secondary down and increase the back focal distance, therefore adding glass thickness will result in positive focus offsets.
pointingOffsets¶
IDL_Type: | float |
---|---|
Units: | arcsec |
Count: | 2 |
- Description: Pointing offset to be applied to the boresight in units of arcseconds, relative
- to no glass being installed. Relative to the center of the detector,positive X-values result in moving along rows, to higher pixel values
reportedFilterPosition¶
EFDB_Topic: | ATSpectrograph_logevent_reportedFilterPosition |
---|
centralWavelength¶
IDL_Type: | float |
---|---|
Units: | nm |
- Description: Wavelength for which optical system will be optimized in units of nm.
- Approximations are sufficient as the focus dependence on wavelength is weak.
focusOffset¶
IDL_Type: | float |
---|---|
Units: | mm |
- Description: Focus offset to be applied on the secondary mirror in units of mm, relative to no glass
- being installed. Positive values push the secondary down and increase the back focal distance, therefore adding glass thickness will result in positive focus offsets.
pointingOffsets¶
IDL_Type: | float |
---|---|
Units: | arcsec |
Count: | 2 |
- Description: Pointing offset to be applied to the boresight in units of arcseconds, relative
- to no glass being installed. Relative to the center of the detector,positive X-values result in moving along rows, to higher pixel values
reportedLinearStagePosition¶
EFDB_Topic: | ATSpectrograph_logevent_reportedLinearStagePosition |
---|
settingsAppliedValues¶
EFDB_Topic: | ATSpectrograph_logevent_settingsAppliedValues |
---|
host¶
IDL_Type: | string |
---|---|
IDL_Size: | 16 |
Units: | unitless |
Description: IP of the controller in the format XXX.XXX.XXX.XXX
filterNames¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of filter names.
filterCentralWavelengths¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of filter central wavelengths.
filterFocusOffsets¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of filter focus offsets to be applied to the hexapod [in mm].
filterPointingOffsets¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of [X,Y] filter pointing offsets to be applied to boresight [in arcsec].
gratingNames¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of disperser/grating names.
gratingFocusOffsets¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of disperser/grating focus offsets to be applied to the hexapod [in mm].
gratingPointingOffsets¶
IDL_Type: | string |
---|---|
IDL_Size: | 256 |
Units: | unitless |
Description: Comma separated list of [X,Y] grating pointing offsets to be applied to boresight [in arcsec].
timeout¶
EFDB_Topic: | ATSpectrograph_logevent_timeout |
---|
timeout¶
IDL_Type: | boolean |
---|---|
Units: | unitless |
Description: Does time really exist? Or is it a product of society?
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 |
---|
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 |
---|
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 |
---|
level¶
IDL_Type: | int |
---|---|
Units: | unitless |
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
lineNumber¶
IDL_Type: | long |
---|---|
Units: | unitless |
Description: Line number in the file specified by filePath.
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