:tocdepth: 3 ############## ATSpectrograph ############## .. note:: This page is generated by python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _ATSpectrograph:Commands:changeDisperser: changeDisperser ~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_command_changeDisperser .. _ATSpectrograph:Commands:changeDisperser:disperser: 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) .. _ATSpectrograph:Commands:changeDisperser:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the grating to select. Command gets rejected if both are set. .. _ATSpectrograph:Commands:changeFilter: changeFilter ~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_command_changeFilter .. _ATSpectrograph:Commands:changeFilter:filter: 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) .. _ATSpectrograph:Commands:changeFilter:name: name **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the filter to select. Command gets rejected if both are set. .. _ATSpectrograph:Commands:homeLinearStage: homeLinearStage ~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_command_homeLinearStage .. _ATSpectrograph:Commands:homeLinearStage:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Needed by the SAL API, but is unused. .. _ATSpectrograph:Commands:moveLinearStage: moveLinearStage ~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_command_moveLinearStage .. _ATSpectrograph:Commands:moveLinearStage:distanceFromHome: distanceFromHome **************** :IDL_Type: double :Units: mm **Description**: The distance from home. .. _ATSpectrograph:Commands:stopAllAxes: stopAllAxes ~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_command_stopAllAxes .. _ATSpectrograph:Commands:stopAllAxes:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Needed by the SAL API, but is unused. 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 that start in Offline state 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 start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active. :EFDB_Topic: SALGeneric_command_exitControl setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _ATSpectrograph:setAuthList:authorizedUsers: 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. .. _ATSpectrograph:setAuthList:nonAuthorizedCSCs: 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 .. _ATSpectrograph:setLogLevel:level: 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 .. _ATSpectrograph:setValue:parametersAndValues: 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 start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _ATSpectrograph:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :Status: * Homing * Moving * Stationary * NotInPosition :Error: * None * Busy * NotInitialized * MoveTimeout :Port: * Nasmyth1 * Nasmyth2 Events ------ .. _ATSpectrograph:Events:detailedState: detailedState ~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_detailedState .. _ATSpectrograph:Events:detailedState:detailedState: detailedState ************* :IDL_Type: long :Units: unitless **Description**: The substate of the CSC. .. _ATSpectrograph:Events:disperserInPosition: disperserInPosition ~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_disperserInPosition .. _ATSpectrograph:Events:disperserInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: Is the grating/disperser in position? .. _ATSpectrograph:Events:filterInPosition: filterInPosition ~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_filterInPosition .. _ATSpectrograph:Events:filterInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: Is the filter in position? .. _ATSpectrograph:Events:fwState: fwState ~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_fwState .. _ATSpectrograph:Events:fwState:state: state ***** :IDL_Type: long :Units: unitless **Description**: The state of the filter wheel. .. _ATSpectrograph:Events:gwState: gwState ~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_gwState .. _ATSpectrograph:Events:gwState:state: state ***** :IDL_Type: long :Units: unitless **Description**: The state of the disperser. .. _ATSpectrograph:Events:linearStageInPosition: linearStageInPosition ~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_linearStageInPosition .. _ATSpectrograph:Events:linearStageInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: Is the linear stage in position? .. _ATSpectrograph:Events:lsState: lsState ~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_lsState .. _ATSpectrograph:Events:lsState:state: state ***** :IDL_Type: long :Units: unitless **Description**: The state of the linear stage. .. _ATSpectrograph:Events:reportedDisperserPosition: reportedDisperserPosition ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_reportedDisperserPosition .. _ATSpectrograph:Events:reportedDisperserPosition:slot: slot **** :IDL_Type: long :Units: unitless **Description**: The numbered slot indicated on the grating/disperser wheel (0 through 3). .. _ATSpectrograph:Events:reportedDisperserPosition:name: 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. .. _ATSpectrograph:Events:reportedDisperserPosition:band: band **** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Descriptive name associated with the grating/disperser in the beam (e.g. R100). .. _ATSpectrograph:Events:reportedDisperserPosition:focusOffset: 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. .. _ATSpectrograph:Events:reportedDisperserPosition:pointingOffsets: 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 .. _ATSpectrograph:Events:reportedFilterPosition: reportedFilterPosition ~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_reportedFilterPosition .. _ATSpectrograph:Events:reportedFilterPosition:slot: slot **** :IDL_Type: long :Units: unitless **Description**: The numbered slot indicated on the filter wheel (0 through 3). .. _ATSpectrograph:Events:reportedFilterPosition:name: 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. .. _ATSpectrograph:Events:reportedFilterPosition:band: 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). .. _ATSpectrograph:Events:reportedFilterPosition:centralWavelength: 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. .. _ATSpectrograph:Events:reportedFilterPosition:focusOffset: 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. .. _ATSpectrograph:Events:reportedFilterPosition:pointingOffsets: 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 .. _ATSpectrograph:Events:reportedLinearStagePosition: reportedLinearStagePosition ~~~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_reportedLinearStagePosition .. _ATSpectrograph:Events:reportedLinearStagePosition:position: position ******** :IDL_Type: float :Units: mm **Description**: The reported linear stage position. .. _ATSpectrograph:Events:settingsAppliedValues: settingsAppliedValues ~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATSpectrograph_logevent_settingsAppliedValues .. _ATSpectrograph:Events:settingsAppliedValues:host: host **** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: IP of the controller in the format XXX.XXX.XXX.XXX .. _ATSpectrograph:Events:settingsAppliedValues:port: port **** :IDL_Type: long :Units: unitless **Description**: Port to connect to controller. .. _ATSpectrograph:Events:settingsAppliedValues:connectionTimeout: connectionTimeout ***************** :IDL_Type: float :Units: second **Description**: How long to wait for a response from the low level controller when establishing the connection. .. _ATSpectrograph:Events:settingsAppliedValues:responseTimeout: 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. .. _ATSpectrograph:Events:settingsAppliedValues:moveTimeout: moveTimeout *********** :IDL_Type: float :Units: second **Description**: How long to wait for a move command to complete, for filter/grating wheels and linear stage. .. _ATSpectrograph:Events:settingsAppliedValues:linearStageMinPos: linearStageMinPos ***************** :IDL_Type: float :Units: mm **Description**: The minimum linear stage position. .. _ATSpectrograph:Events:settingsAppliedValues:linearStageMaxPos: linearStageMaxPos ***************** :IDL_Type: float :Units: mm **Description**: The maximum linear stage position. .. _ATSpectrograph:Events:settingsAppliedValues:linearStageSpeed: linearStageSpeed **************** :IDL_Type: float :Units: mm/s **Description**: The speed of the linear stage. .. _ATSpectrograph:Events:settingsAppliedValues:filterNames: filterNames *********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Comma separated list of filter names. .. _ATSpectrograph:Events:settingsAppliedValues:filterCentralWavelengths: filterCentralWavelengths ************************ :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Comma separated list of filter central wavelengths. .. _ATSpectrograph:Events:settingsAppliedValues:filterFocusOffsets: 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]. .. _ATSpectrograph:Events:settingsAppliedValues:filterPointingOffsets: 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]. .. _ATSpectrograph:Events:settingsAppliedValues:gratingNames: gratingNames ************ :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Comma separated list of disperser/grating names. .. _ATSpectrograph:Events:settingsAppliedValues:gratingFocusOffsets: 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]. .. _ATSpectrograph:Events:settingsAppliedValues:gratingPointingOffsets: 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]. .. _ATSpectrograph:Events:settingsAppliedValues:instrumentPort: instrumentPort ************** :IDL_Type: long :Units: unitless **Description**: Port the instrument is mounted in. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _ATSpectrograph:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _ATSpectrograph:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _ATSpectrograph:authList:nonAuthorizedCSCs: 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 .. _ATSpectrograph:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _ATSpectrograph:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _ATSpectrograph:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _ATSpectrograph:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _ATSpectrograph:logLevel:level: 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 .. _ATSpectrograph:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _ATSpectrograph:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _ATSpectrograph:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _ATSpectrograph:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _ATSpectrograph:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _ATSpectrograph:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _ATSpectrograph:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _ATSpectrograph:logMessage:process: 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 .. _ATSpectrograph:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _ATSpectrograph:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _ATSpectrograph:settingVersions:settingsUrl: 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 .. _ATSpectrograph:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _ATSpectrograph:settingsApplied:otherSettingsEvents: 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 .. _ATSpectrograph:simulationMode:mode: 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 .. _ATSpectrograph:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of SAL generation .. _ATSpectrograph:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of CSC XML .. _ATSpectrograph:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of OpenSplice .. _ATSpectrograph:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the top-level version of the CSC .. _ATSpectrograph:softwareVersions:subsystemVersions: 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 .. _ATSpectrograph:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier