:tocdepth: 3 ###### Guider ###### .. note:: This page is generated by python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _Guider:Commands:resumeGuiding: resumeGuiding ~~~~~~~~~~~~~ **Description**: Resume current guider operation. This command will restart a guider operation with the last values used in startGuiding. If no previous startGuiding command was issued, since the last time the CSC was enabled, the command will be rejected. :EFDB_Topic: Guider_command_resumeGuiding .. _Guider:Commands:startGuiding: startGuiding ~~~~~~~~~~~~ **Description**: Start guiding using the input information. The command returns as soon as guiding starts, before the first interation is completed. If it fails to find a guide star in the provided guider region, the CSC will go to fault state. :EFDB_Topic: Guider_command_startGuiding .. _Guider:Commands:startGuiding:roiXLeft: roiXLeft ******** :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the origin of the guider ROI window in the x-axis for each guider sensor. .. _Guider:Commands:startGuiding:roiXRight: roiXRight ********* :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the end of the guider ROI window in the x-axis for each guider sensor. If roiXLeft=roiXRight=0, for a particular element of both arrays, it assumes no guider region for the equivalent guider sensor. For each valid entry in roiXRight/roiXLeft the width must respect the ROI constrains (see requirement CA-TS-GDR-ICD-0006 in LSE-66). .. _Guider:Commands:startGuiding:roiYBottom: roiYBottom ********** :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the origin of the guider ROI window in the y-axis for each guider sensor. .. _Guider:Commands:startGuiding:roiYTop: roiYTop ******* :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the end of the guider ROI window in the y-axis for each guider sensor. If roiXBottom=roiXTop=0, for a particular element of both arrays, it assumes no guider region for the equivalent guider sensor. For each valid entry in roiXBottom/roiXTop the width must respect the ROI constrains (see requirement CA-TS-GDR-ICD-0006 in LSE-66). .. _Guider:Commands:startGuiding:expTime: expTime ******* :IDL_Type: float :Units: ms **Description**: Exposure time in milliseconds. All guider sensors will use the same exposure time (CA-TS-GDR-ICD-0034 LSE-66). Limits must respect detector integration time constrains (see requirement CA-TS-GDR-ICD-0034 in LSE-66). .. _Guider:Commands:startGuiding:binning: binning ******* :IDL_Type: long :Units: pixel **Description**: Binnig factor. All guider sensors will use the same binning factor. Limits must respect detector binning constrains (see requirement CA-TS-GDR-ICD-0042 in LSE-66). .. _Guider:Commands:stopGuiding: stopGuiding ~~~~~~~~~~~ **Description**: Stop current guider operation. :EFDB_Topic: Guider_command_stopGuiding 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 .. _Guider: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. .. _Guider: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 .. _Guider: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 .. _Guider: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 .. _Guider:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :GuiderStatus: * Stopped * Starting * Guiding * Error Events ------ .. _Guider:Events:guidingStatus: guidingStatus ~~~~~~~~~~~~~ **Description**: Event published when a guiding operatation starts, stops or resumes. It contains the parameters used to configure the guider (see startGuiding command) and the current status. :EFDB_Topic: Guider_logevent_guidingStatus .. _Guider:Events:guidingStatus:roiXLeft: roiXLeft ******** :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the origin of the guider ROI window in the x-axis for each guider sensor. .. _Guider:Events:guidingStatus:roiXRight: roiXRight ********* :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the end of the guider ROI window in the x-axis for each guider sensor. If roiXLeft=roiXRight=0, for a particular element of both arrays, it assumes no guider region for the equivalent guider sensor. For each valid entry in roiXRight/roiXLeft the width must respect the ROI constrains (see requirement CA-TS-GDR-ICD-0006 in LSE-66). .. _Guider:Events:guidingStatus:roiYBottom: roiYBottom ********** :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the origin of the guider ROI window in the y-axis for each guider sensor. .. _Guider:Events:guidingStatus:roiYTop: roiYTop ******* :IDL_Type: long :Units: pixel :Count: 8 **Description**: Vector with 8 elements specifying the end of the guider ROI window in the y-axis for each guider sensor. If roiXBottom=roiXTop=0, for a particular element of both arrays, it assumes no guider region for the equivalent guider sensor. For each valid entry in roiXBottom/roiXTop the width must respect the ROI constrains (see requirement CA-TS-GDR-ICD-0006 in LSE-66). .. _Guider:Events:guidingStatus:expTime: expTime ******* :IDL_Type: float :Units: ms **Description**: Exposure time in milliseconds. All guider sensors will use the same exposure time (CA-TS-GDR-ICD-0034 LSE-66). Limits must respect detector integration time constrains (see requirement CA-TS-GDR-ICD-0034 in LSE-66). .. _Guider:Events:guidingStatus:binning: binning ******* :IDL_Type: long :Units: pixel **Description**: Binnig factor. All guider sensors will use the same binning factor. Limits must respect detector bining constrains (see requirement CA-TS-GDR-ICD-0042 in LSE-66). .. _Guider:Events:guidingStatus:status: status ****** :IDL_Type: long :Units: unitless :Count: 8 **Description**: Enumeration with the current guiding status. When guider is not running status will be GuiderStatus_Stopped, this could either be when the guider is first enabled or after a stopGuiding command. When guider is initializing a guider sequence but has not achieved stable guiding operation status will be GuiderStatus_Starting. When stable guiding operation is stabilished, status will be GuiderStatus_Guiding. If an error occurred, and the guider is going to FAULT state, status is GuiderStatus_Error. Information about errors will be available in errorCode topic. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _Guider:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Guider:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Guider: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 .. _Guider:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _Guider:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _Guider:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _Guider:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Guider: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 .. _Guider:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Guider:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Guider:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Guider:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Guider:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Guider:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Guider:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Guider: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 .. _Guider:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _Guider:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _Guider: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 .. _Guider:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _Guider: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 .. _Guider: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 .. _Guider:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of SAL generation .. _Guider:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of CSC XML .. _Guider:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the current version of OpenSplice .. _Guider:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: This is the top-level version of the CSC .. _Guider: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 .. _Guider:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _Guider:Telemetry:offsets: offsets ~~~~~~~ **Description**: Computed guider offsets. The values are computed in the instrument reference frame and need to be de-rotated accordingly by the pointing. :EFDB_Topic: Guider_offsets .. _Guider:Telemetry:offsets:x: x * :IDL_Type: double :Units: mm **Description**: Guider offset in the (instrument) x-axis direction. .. _Guider:Telemetry:offsets:y: y * :IDL_Type: double :Units: mm **Description**: Guider offset in the (instrument) y-axis direction. .. _Guider:Telemetry:offsets:rotation: rotation ******** :IDL_Type: double :Units: arcsec **Description**: Guider rotation offset.