MTAlignment¶
Note
This page is generated by python script generate_cet.py.
Commands¶
- Target:
M2
M1M3
Camera
Dome
align¶
Description: Measures the specified target
- EFDB_Topic:
MTAlignment_command_align
target¶
- IDL_Type:
long
- Units:
unitless
Description: Name of target: M2, CAM, or DOME
tolerance¶
- IDL_Type:
float
- Units:
unitless
Description: Relative tolerance threshold after which we will stop the correction loop
maxIter¶
- IDL_Type:
int
- Units:
unitless
Description: Max iterations before we give up
halt¶
- EFDB_Topic:
MTAlignment_command_halt
halt¶
- IDL_Type:
boolean
- Units:
unitless
Description: Halt any executing measurement plan and return to ready state
healthCheck¶
- EFDB_Topic:
MTAlignment_command_healthCheck
healthCheck¶
- IDL_Type:
boolean
- Units:
unitless
Description: Execute the health check script
laserPower¶
- EFDB_Topic:
MTAlignment_command_laserPower
power¶
- IDL_Type:
boolean
- Units:
unitless
Description: Turn laser on and off
loadSATemplateFile¶
- EFDB_Topic:
MTAlignment_command_loadSATemplateFile
file¶
- IDL_Type:
string
- Units:
unitless
Description: SA Template file path and name. This is in the filesystem on the T2SA host.
measureDrift¶
- EFDB_Topic:
MTAlignment_command_measureDrift
pointgroup¶
- IDL_Type:
string
- Units:
unitless
Description: Nominal point group name in the default A collection to measure drift against.
measurePoint¶
- EFDB_Topic:
MTAlignment_command_measurePoint
collection¶
- IDL_Type:
string
- Units:
unitless
Description: Name of collection containing target point
pointgroup¶
- IDL_Type:
string
- Units:
unitless
Description: Name of pointgroup containing target point
target¶
- IDL_Type:
string
- Units:
unitless
Description: Name of point to target
measureTarget¶
Description: Measures the specified target
- EFDB_Topic:
MTAlignment_command_measureTarget
target¶
- IDL_Type:
string
- Units:
unitless
Description: target of measurement (M1M3, Camera, etc)
newStation¶
- EFDB_Topic:
MTAlignment_command_newStation
newStation¶
- IDL_Type:
boolean
- Units:
unitless
Description: Add a new station and make it the active instrument
pointDelta¶
- EFDB_Topic:
MTAlignment_command_pointDelta
collection_A¶
- IDL_Type:
string
- Units:
unitless
Description: Name of collection containing target point A
pointgroup_A¶
- IDL_Type:
string
- Units:
unitless
Description: Name of pointgroup containing target point A
target_A¶
- IDL_Type:
string
- Units:
unitless
Description: Name of point to target A
collection_B¶
- IDL_Type:
string
- Units:
unitless
Description: Name of collection containing target point B
pointgroup_B¶
- IDL_Type:
string
- Units:
unitless
Description: Name of pointgroup containing target point B
target_B¶
- IDL_Type:
string
- Units:
unitless
Description: Name of point to target B
powerOff¶
- EFDB_Topic:
MTAlignment_command_powerOff
powerOff¶
- IDL_Type:
boolean
- Units:
unitless
Description: Power off the tracker and controller, and close the interface
resetT2SA¶
- EFDB_Topic:
MTAlignment_command_resetT2SA
resetT2SA¶
- IDL_Type:
boolean
- Units:
unitless
Description: Reboot T2SA and SA components
saveJobfile¶
- EFDB_Topic:
MTAlignment_command_saveJobfile
file¶
- IDL_Type:
string
- Units:
unitless
Description: SA Job file name and path
setReferenceGroup¶
- EFDB_Topic:
MTAlignment_command_setReferenceGroup
referenceGroup¶
- IDL_Type:
string
- Units:
unitless
Description: Nominal point group to locate tracker station to and provide data relative to
setWorkingFrame¶
- EFDB_Topic:
MTAlignment_command_setWorkingFrame
workingFrame¶
- IDL_Type:
string
- Units:
unitless
Description: Attempt to set the passed string as the SpatialAnalyzer working frame
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¶
- DetailedState:
DisabledState
EnabledState
FaultState
OfflineState
StandbyState
Events¶
offsetsPublish¶
- EFDB_Topic:
MTAlignment_logevent_offsetsPublish
target¶
- IDL_Type:
string
- Units:
unitless
Description: name of the object these offests belong to (M2, Camera, etc)
dX¶
- IDL_Type:
float
- Units:
meter
Description: Measured object offset in the x-axis relative to nominal.
dY¶
- IDL_Type:
float
- Units:
meter
Description: Measured object offset in the y-axis relative to nominal.
dZ¶
- IDL_Type:
float
- Units:
meter
Description: Measured object offset in the z-axis relative to nominal.
dRX¶
- IDL_Type:
float
- Units:
degree
Description: Measured object rotation with respect to the x-axis relative to nominal
dRY¶
- IDL_Type:
float
- Units:
degree
Description: Measured object rotation with respect to the y-axis relative to nominal
dRZ¶
- IDL_Type:
float
- Units:
degree
Description: Measured object rotation with respect to the z-axis relative to nominal
positionPublish¶
- EFDB_Topic:
MTAlignment_logevent_positionPublish
target¶
- IDL_Type:
string
- Units:
unitless
Description: name of the object these positions belong to (M2, Camera, etc)
dX¶
- IDL_Type:
float
- Units:
meter
Description: x positions of the measured object
dY¶
- IDL_Type:
float
- Units:
meter
Description: y positions of the measured object
dZ¶
- IDL_Type:
float
- Units:
meter
Description: z positions of the measured object
dRX¶
- IDL_Type:
float
- Units:
degree
Description: x rotation positions of the measured object
dRY¶
- IDL_Type:
float
- Units:
degree
Description: y rotation positions of the measured object
dRZ¶
- IDL_Type:
float
- Units:
degree
Description: z rotation positions of the measured object
t2saError¶
- EFDB_Topic:
MTAlignment_logevent_t2saError
t2saError¶
- IDL_Type:
int
- Units:
unitless
Description: Error code received from T2SA
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¶
trackertemp¶
- EFDB_Topic:
MTAlignment_trackertemp
temperature¶
- IDL_Type:
double
- Units:
deg_C
Description: current temperature reported by the tracker sensor