Guider¶
Note
This page is generated by python script generate_cet.py.
Commands¶
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
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
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.
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).
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.
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).
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).
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).
stopGuiding¶
Description: Stop current guider operation.
- EFDB_Topic
Guider_command_stopGuiding
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¶
- GuiderStatus
Stopped
Starting
Guiding
Error
Events¶
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
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.
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).
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.
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).
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).
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).
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.
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.
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¶
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
x¶
- IDL_Type
double
- Units
mm
Description: Guider offset in the (instrument) x-axis direction.
y¶
- IDL_Type
double
- Units
mm
Description: Guider offset in the (instrument) y-axis direction.
rotation¶
- IDL_Type
double
- Units
arcsec
Description: Guider rotation offset.