ATAOS¶
Note
This page is generated by python script generate_cet.py.
Commands¶
applyCorrection¶
Description: Apply ATAOS corrections for the specified az/el.
- 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¶
Description: Apply offset to the AOS correction.
- EFDB_Topic:
ATAOS_command_applyFocusOffset
offset¶
- IDL_Type:
float
- Units:
millimeter
Description: The offset from the focus to be set.
disableCorrection¶
Description: Disable ATAOS corrections.
- EFDB_Topic:
ATAOS_command_disableCorrection
disableAll¶
- IDL_Type:
boolean
- Units:
unitless
Description: Disable all corrections.
m1¶
- IDL_Type:
boolean
- Units:
unitless
Description: If true, disable the m1 correction.
m2¶
- IDL_Type:
boolean
- Units:
unitless
Description: If true, disable the m2 correction.
hexapod¶
- IDL_Type:
boolean
- Units:
unitless
Description: If true, disable the hexapod correction.
focus¶
- IDL_Type:
boolean
- Units:
unitless
Description: If true, disable the focus correction.
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¶
Description: Enable ATAOS corrections.
- EFDB_Topic:
ATAOS_command_enableCorrection
enableAll¶
- IDL_Type:
boolean
- Units:
unitless
Description: Enable correction on all components.
m1¶
- IDL_Type:
boolean
- Units:
unitless
Description: Enable correction in M1 (ignored if all).
m2¶
- IDL_Type:
boolean
- Units:
unitless
Description: Enable correction in M2 (ignored if all).
hexapod¶
- IDL_Type:
boolean
- Units:
unitless
Description: Enable hexapod correction (ignored if all)
focus¶
- IDL_Type:
boolean
- Units:
unitless
Description: Enable focus correction (ignored if all)
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¶
Description: Add offset to the specified correction.
- 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).
m1¶
- IDL_Type:
float
- Units:
Pa
Description: Add this offset to the m1 correction.
m2¶
- IDL_Type:
float
- Units:
Pa
Description: Add this offset to the m2 correction.
resetOffset¶
Description: Reset offset for a specified correction.
- 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¶
Description: Set offset for specified correction to the specified value. Any pre-existing offset will be lost.
- 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.
offset¶
- IDL_Type:
float
- Units:
unitless
Description: Offset value. Unit depends on the axis.
setWavelength¶
Description: Set observation wavelength.
- 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. 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”.
Events¶
atspectrographCorrectionCompleted¶
Description: Indicates that atspectrograph corrections completed.
- EFDB_Topic:
ATAOS_logevent_atspectrographCorrectionCompleted
focusOffset¶
- IDL_Type:
float
- Units:
mm
Description: Focus offset applied.
pointingOffsets¶
- IDL_Type:
float
- Units:
arcsec
- Count:
2
Description: Pointing Offsets applied.
atspectrographCorrectionStarted¶
Description: Indicates that atspectrograph corrections started.
- EFDB_Topic:
ATAOS_logevent_atspectrographCorrectionStarted
focusOffset¶
- IDL_Type:
float
- Units:
mm
Description: Focus offset applied.
pointingOffsets¶
- IDL_Type:
float
- Units:
arcsec
- Count:
2
Description: Pointing Offsets applied.
correctionEnabled¶
Description: Publish which ATAOS corrections are enabled.
- EFDB_Topic:
ATAOS_logevent_correctionEnabled
m1¶
- IDL_Type:
boolean
- Units:
unitless
Description: M1 correction enabled.
m2¶
- IDL_Type:
boolean
- Units:
unitless
Description: M2 correction enabled.
hexapod¶
- IDL_Type:
boolean
- Units:
unitless
Description: Hexapod correction enabled.
focus¶
- IDL_Type:
boolean
- Units:
unitless
Description: Focus correction enabled.
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¶
Description: Summary of all the corrections offsets.
- EFDB_Topic:
ATAOS_logevent_correctionOffsets
x¶
- IDL_Type:
float
- Units:
mm
Description: Offset to the hexapod correction in the x-direction.
y¶
- IDL_Type:
float
- Units:
mm
Description: Offset to the hexapod correction in the y-direction.
z¶
- IDL_Type:
float
- Units:
mm
Description: Offset to the hexapod correction in the z-direction.
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).
m1¶
- IDL_Type:
float
- Units:
Pa
Description: Offset to the m1 correction.
m2¶
- IDL_Type:
float
- Units:
Pa
Description: Offset to the m2 correction.
detailedState¶
Description: ATAOS detailed state.
- 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¶
Description: Indicates that focus corrections completed.
- EFDB_Topic:
ATAOS_logevent_focusCorrectionCompleted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
focus¶
- IDL_Type:
float
- Units:
mm
Description: Focus correction.
focusCorrectionStarted¶
Description: Indicates that focus corrections started.
- EFDB_Topic:
ATAOS_logevent_focusCorrectionStarted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
focus¶
- IDL_Type:
float
- Units:
mm
Description: Focus correction.
focusOffsetSummary¶
Description: Summary of all the focus offsets.
- EFDB_Topic:
ATAOS_logevent_focusOffsetSummary
total¶
- IDL_Type:
float
- Units:
mm
Description: Sum total of all focus offsets.
userApplied¶
- IDL_Type:
float
- Units:
mm
Description: Cumulative User-provided focus-offset.
filter¶
- IDL_Type:
float
- Units:
degree
Description: Offset due to atspectrograph filter
disperser¶
- IDL_Type:
float
- Units:
degree
Description: Offset due to atspectrograph disperser.
wavelength¶
- IDL_Type:
float
- Units:
degree
Description: Offset due to selected wavelength.
hexapodCorrectionCompleted¶
Description: Indicates that the hexapod corrections completed.
- EFDB_Topic:
ATAOS_logevent_hexapodCorrectionCompleted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
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¶
Description: Indicates that the hexapod corrections started.
- EFDB_Topic:
ATAOS_logevent_hexapodCorrectionStarted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
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¶
Description: Indicates that the m1 correction completed.
- EFDB_Topic:
ATAOS_logevent_m1CorrectionCompleted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
pressure¶
- IDL_Type:
float
- Units:
Pa
Description: Pressure correction applied to M1.
m1CorrectionStarted¶
Description: Indicates that the m1 correction started.
- EFDB_Topic:
ATAOS_logevent_m1CorrectionStarted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
pressure¶
- IDL_Type:
float
- Units:
Pa
Description: Pressure correction applied to M1.
m2CorrectionCompleted¶
Description: Indicates that the m2 corrections completed.
- EFDB_Topic:
ATAOS_logevent_m2CorrectionCompleted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
pressure¶
- IDL_Type:
float
- Units:
Pa
Description: Pressure correction applied to M2.
m2CorrectionStarted¶
Description: Indicates that the m2 corrections started.
- EFDB_Topic:
ATAOS_logevent_m2CorrectionStarted
azimuth¶
- IDL_Type:
double
- Units:
degree
Description: Azimuth position for the correction.
elevation¶
- IDL_Type:
double
- Units:
degree
Description: Elevation position for the correction.
pressure¶
- IDL_Type:
float
- Units:
Pa
Description: Pressure correction applied to M2.
pointingOffsetSummary¶
Description: Summary of pointing related offsets.
- EFDB_Topic:
ATAOS_logevent_pointingOffsetSummary
total¶
- IDL_Type:
float
- Units:
arcsec
- Count:
2
Description: Sum total of all pointing offsets.
filter¶
- IDL_Type:
float
- Units:
arcsec
- Count:
2
Description: Offset due to atspectrograph filter
disperser¶
- IDL_Type:
float
- Units:
arcsec
- Count:
2
Description: Offset due to atspectrograph disperser.
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.
Telemetry¶
timestamp¶
Description: Publish the system current timestamp.
- EFDB_Topic:
ATAOS_timestamp
timestamp¶
- IDL_Type:
double
- Units:
second
Description: The system time (TAI).