ATSpectrograph¶
Note
This page is generated by python script generate_cet.py.
Commands¶
changeDisperser¶
Description: Change disperser.
- EFDB_Topic:
ATSpectrograph_command_changeDisperser
disperser¶
- IDL_Type:
long
- Units:
unitless
Description: ID of the disperser/grating slot to select corresponding to the markings on the disperser wheel (0 through 3)
name¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Name of the grating to select. Command gets rejected if both are set.
changeFilter¶
Description: Change filter.
- EFDB_Topic:
ATSpectrograph_command_changeFilter
filter¶
- IDL_Type:
long
- Units:
unitless
Description: ID of the filter slot to select corresponding to the markings on the filter wheel (0 through 3)
name¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Name of the filter to select. Command gets rejected if both are set.
homeLinearStage¶
Description: Home linear stage.
- EFDB_Topic:
ATSpectrograph_command_homeLinearStage
moveLinearStage¶
Description: Move the linear stage.
- EFDB_Topic:
ATSpectrograph_command_moveLinearStage
distanceFromHome¶
- IDL_Type:
double
- Units:
mm
Description: The distance from home.
stopAllAxes¶
Description: Stop motion on all elements.
- EFDB_Topic:
ATSpectrograph_command_stopAllAxes
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
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¶
- Status:
Homing
Moving
Stationary
NotInPosition
- Error:
None
Busy
NotInitialized
MoveTimeout
- Port:
Nasmyth1
Nasmyth2
- DisperserPosition:
DISPERSER0
DISPERSER1
DISPERSER2
DISPERSER3
INBETWEEN
- FilterPosition:
FILTER0
FILTER1
FILTER2
FILTER3
INBETWEEN
Events¶
detailedState¶
Description: CSC detailed state.
- EFDB_Topic:
ATSpectrograph_logevent_detailedState
detailedState¶
- IDL_Type:
long
- Units:
unitless
Description: The substate of the CSC.
disperserInPosition¶
Description: Is the disperser wheel in position?
- EFDB_Topic:
ATSpectrograph_logevent_disperserInPosition
inPosition¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is the grating/disperser in position?
filterInPosition¶
Description: Is the filter in position?
- EFDB_Topic:
ATSpectrograph_logevent_filterInPosition
inPosition¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is the filter in position?
fwState¶
Description: State of the filter wheel.
- EFDB_Topic:
ATSpectrograph_logevent_fwState
state¶
- IDL_Type:
long
- Units:
unitless
Description: The state of the filter wheel.
gwState¶
Description: State of the disperser/grating wheel.
- EFDB_Topic:
ATSpectrograph_logevent_gwState
state¶
- IDL_Type:
long
- Units:
unitless
Description: The state of the disperser.
linearStageInPosition¶
Description: Is the linear stage in position?
- EFDB_Topic:
ATSpectrograph_logevent_linearStageInPosition
inPosition¶
- IDL_Type:
boolean
- Units:
unitless
Description: Is the linear stage in position?
lsState¶
Description: State of the linear stage.
- EFDB_Topic:
ATSpectrograph_logevent_lsState
state¶
- IDL_Type:
long
- Units:
unitless
Description: The state of the linear stage.
reportedDisperserPosition¶
Description: Summary information about the position of the disperser wheel.
- EFDB_Topic:
ATSpectrograph_logevent_reportedDisperserPosition
slot¶
- IDL_Type:
long
- Units:
unitless
Description: The numbered slot indicated on the grating/disperser wheel (0 through 3).
name¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Name of the physical grating/disperser in the beam. Should be a unique identifier for the specific disperser.
band¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Descriptive name associated with the grating/disperser in the beam (e.g. R100).
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¶
Description: Summary information about the position of the filter wheel.
- EFDB_Topic:
ATSpectrograph_logevent_reportedFilterPosition
slot¶
- IDL_Type:
long
- Units:
unitless
Description: The numbered slot indicated on the filter wheel (0 through 3).
name¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Name of the physical filter in the beam. Should be a unique identifier for the specific filter.
band¶
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: Descriptive bandpass associated with the filter in the beam (e.g. u,g,r,i,z,y).
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¶
Description: Position of the liner stage.
- EFDB_Topic:
ATSpectrograph_logevent_reportedLinearStagePosition
position¶
- IDL_Type:
float
- Units:
mm
Description: The reported linear stage position.
settingsAppliedValues¶
Description: Additional settings information.
- 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
port¶
- IDL_Type:
long
- Units:
unitless
Description: Port to connect to controller.
connectionTimeout¶
- IDL_Type:
float
- Units:
second
Description: How long to wait for a response from the low level controller when establishing the connection.
responseTimeout¶
- IDL_Type:
float
- Units:
second
- Description: How long to wait for a response from low level controller when a command
or request is sent.
moveTimeout¶
- IDL_Type:
float
- Units:
second
Description: How long to wait for a move command to complete, for filter/grating wheels and linear stage.
linearStageMinPos¶
- IDL_Type:
float
- Units:
mm
Description: The minimum linear stage position.
linearStageMaxPos¶
- IDL_Type:
float
- Units:
mm
Description: The maximum linear stage position.
linearStageSpeed¶
- IDL_Type:
float
- Units:
mm/s
Description: The speed of the linear stage.
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].
instrumentPort¶
- IDL_Type:
long
- Units:
unitless
Description: Port the instrument is mounted in.
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.