ATAOS¶
Note
This page is generated by python script generate_cet.py.
Commands¶
applyCorrection¶
- EFDB_Topic
ATAOS_command_applyCorrection
azimuth¶
- IDL_Type
double
- Units
degree
Description: Azimuth position for the correction (must be larger then 0).
elevation¶
- IDL_Type
double
- Units
degree
Description: Elevation position for the correction (must be larger then 0).
applyFocusOffset¶
- EFDB_Topic
ATAOS_command_applyFocusOffset
disableCorrection¶
- EFDB_Topic
ATAOS_command_disableCorrection
atspectrograph¶
- IDL_Type
boolean
- Units
unitless
- Description: If true, Disable focus correction based on atspectrograph (LATISS)
optical configuration.
moveWhileExposing¶
- IDL_Type
boolean
- Units
unitless
Description: Apply focus and hexapod corrections during exposures? (default is no)
enableCorrection¶
- EFDB_Topic
ATAOS_command_enableCorrection
atspectrograph¶
- IDL_Type
boolean
- Units
unitless
- Description: Enable focus correction based on atspectrograph (LATISS) optical configuration (filter/grating/wavelength)
(ignored if all)
moveWhileExposing¶
- IDL_Type
boolean
- Units
unitless
Description: Apply focus and hexapod corrections during exposures? (default is no)
offset¶
- EFDB_Topic
ATAOS_command_offset
x¶
- IDL_Type
float
- Units
mm
Description: Add this offset to the hexapod correction in the x-direction.
y¶
- IDL_Type
float
- Units
mm
Description: Add this offset to the hexapod correction in the y-direction.
z¶
- IDL_Type
float
- Units
mm
Description: Add this offset to the hexapod correction in the z-direction.
u¶
- IDL_Type
float
- Units
degree
Description: Add this offset to the angle correction applied to the hexapod with respect to the hexapod x-axis.
v¶
- IDL_Type
float
- Units
degree
Description: Add this offset to the angle correction applied to the hexapod with respect to the hexapod y-axis.
w¶
- IDL_Type
float
- Units
degree
Description: Add this offset to the angle correction applied to the hexapod with respect to the hexapod z-axis (Ignored).
resetOffset¶
- EFDB_Topic
ATAOS_command_resetOffset
axis¶
- IDL_Type
string
- IDL_Size
10
- Units
unitless
Description: Name of the axis to reset offset. Must be one of m1, m2, x, y, z, u, v, all or empty. If empty, reset all.
setCorrectionModelOffsets¶
- EFDB_Topic
ATAOS_command_setCorrectionModelOffsets
axis¶
- IDL_Type
string
- IDL_Size
10
- Units
unitless
- Description: Name of the axis to apply offset. Must be one of m1, m2, x, y, z, u, v.
This will override/zero out all other offsets that may be applied.
setWavelength¶
- EFDB_Topic
ATAOS_command_setWavelength
wavelength¶
- IDL_Type
float
- Units
nanometer
Description: The wavelength for which the focus to be set.
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
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
- 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”.
settingsToApply¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: DEPRECATED: uae override instead. Name of the selected settings set
Events¶
atspectrographCorrectionCompleted¶
- EFDB_Topic
ATAOS_logevent_atspectrographCorrectionCompleted
atspectrographCorrectionStarted¶
- EFDB_Topic
ATAOS_logevent_atspectrographCorrectionStarted
correctionEnabled¶
- EFDB_Topic
ATAOS_logevent_correctionEnabled
atspectrograph¶
- IDL_Type
boolean
- Units
unitless
Description: Focus correction for atspectrograph (LATISS) grating and filter selection enabled.
moveWhileExposing¶
- IDL_Type
boolean
- Units
unitless
Description: Move hexapod and focus while exposing enabled.
correctionOffsets¶
- EFDB_Topic
ATAOS_logevent_correctionOffsets
u¶
- IDL_Type
float
- Units
degree
Description: Offset to the angle correction applied to the hexapod with respect to the hexapod x-axis.
v¶
- IDL_Type
float
- Units
degree
Description: Offset to the angle correction applied to the hexapod with respect to the hexapod y-axis.
w¶
- IDL_Type
float
- Units
degree
Description: Offset to the angle correction applied to the hexapod with respect to the hexapod z-axis (Ignored).
detailedState¶
- EFDB_Topic
ATAOS_logevent_detailedState
substate¶
- IDL_Type
byte
- Units
unitless
Description: Integer state of the ATAOS activity. This is not an enumeration but a bitwise state.
focusCorrectionCompleted¶
- EFDB_Topic
ATAOS_logevent_focusCorrectionCompleted
focusCorrectionStarted¶
- EFDB_Topic
ATAOS_logevent_focusCorrectionStarted
focusOffsetSummary¶
- EFDB_Topic
ATAOS_logevent_focusOffsetSummary
hexapodCorrectionCompleted¶
- EFDB_Topic
ATAOS_logevent_hexapodCorrectionCompleted
hexapod_x¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical x-direction.
hexapod_y¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical y-direction.
hexapod_z¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical z-direction.
hexapod_u¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical x-axis.
hexapod_v¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical y-axis.
hexapod_w¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical w-axis.
hexapodCorrectionStarted¶
- EFDB_Topic
ATAOS_logevent_hexapodCorrectionStarted
hexapod_x¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical x-direction.
hexapod_y¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical y-direction.
hexapod_z¶
- IDL_Type
float
- Units
mm
Description: Position correction applied to the hexapod in the optical z-direction.
hexapod_u¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical x-axis.
hexapod_v¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical y-axis.
hexapod_w¶
- IDL_Type
float
- Units
degree
Description: Angle correction applied to the hexapod with respect to the optical w-axis.
m1CorrectionCompleted¶
- EFDB_Topic
ATAOS_logevent_m1CorrectionCompleted
m1CorrectionStarted¶
- EFDB_Topic
ATAOS_logevent_m1CorrectionStarted
m2CorrectionCompleted¶
- EFDB_Topic
ATAOS_logevent_m2CorrectionCompleted
m2CorrectionStarted¶
- EFDB_Topic
ATAOS_logevent_m2CorrectionStarted
pointingOffsetSummary¶
- EFDB_Topic
ATAOS_logevent_pointingOffsetSummary
appliedSettingsMatchStart¶
- EFDB_Topic
SALGeneric_logevent_appliedSettingsMatchStart
- Category
configurable
appliedSettingsMatchStartIsTrue¶
- IDL_Type
boolean
- Units
unitless
Description: DEPRECATED as a generic event. Few CSCs need something like this, and those that do should provide their own event. True when the configuration matches the start conditions
authList¶
- EFDB_Topic
SALGeneric_logevent_authList
- Category
csc
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.
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
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
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
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.
timestamp¶
- IDL_Type
double
- Units
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
settingVersions¶
Description: DEPRECATED: use configurationsAvailable instead. Information about settings which can be specified in the start command.
- EFDB_Topic
SALGeneric_logevent_settingVersions
- Category
configurable
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: DEPRECATED: use configurationApplied instead. Base settings applied.
- EFDB_Topic
SALGeneric_logevent_settingsApplied
- Category
configurable
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
- 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