:tocdepth: 3 ########### MTAlignment ########### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _MTAlignment:Commands:healthCheck: healthCheck ~~~~~~~~~~~ :EFDB_Topic: MTAlignment_command_healthCheck .. _MTAlignment:Commands:healthCheck:healthCheck: healthCheck *********** :IDL_Type: boolean :Units: dimensionless **Description**: executes the health check script .. _MTAlignment:Commands:laserPower: laserPower ~~~~~~~~~~ :EFDB_Topic: MTAlignment_command_laserPower .. _MTAlignment:Commands:laserPower:power: power ***** :IDL_Type: boolean :Units: dimensionless **Description**: turns laser on and off .. _MTAlignment:Commands:measurePoint: measurePoint ~~~~~~~~~~~~ :EFDB_Topic: MTAlignment_command_measurePoint .. _MTAlignment:Commands:measurePoint:pointgroup: pointgroup ********** :IDL_Type: string :Units: dimensionless **Description**: name of pointgroup containing target point .. _MTAlignment:Commands:measurePoint:target: target ****** :IDL_Type: string :Units: dimensionless **Description**: name of point to target .. _MTAlignment:Commands:measureTarget: measureTarget ~~~~~~~~~~~~~ :EFDB_Topic: MTAlignment_command_measureTarget .. _MTAlignment:Commands:measureTarget:target: target ****** :IDL_Type: string :Units: dimensionless **Description**: target of measurement (M1M3, Camera, etc) abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _MTAlignment:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _MTAlignment:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _MTAlignment:enable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enterControl ~~~~~~~~~~~~ **Description**: Transition from state Offline to Standby. Only "externally commandable" CSCs support this command; other CSCs start in Standby state and quit when they go to Offline. :EFDB_Topic: SALGeneric_command_enterControl .. _MTAlignment:enterControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used exitControl ~~~~~~~~~~~ **Description**: Transition from state Standby to Offline. For CSCs that are not "externally commandable" this makes the CSC quit. :EFDB_Topic: SALGeneric_command_exitControl .. _MTAlignment:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _MTAlignment: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. .. _MTAlignment: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 .. _MTAlignment: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 .. _MTAlignment: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 .. _MTAlignment:standby:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used start ~~~~~ **Description**: Transition from state Standby to Disable, in a specified configuration. :EFDB_Topic: SALGeneric_command_start .. _MTAlignment:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :DetailedState: * DisabledState * EnabledState * FaultState * OfflineState * StandbyState Events ------ .. _MTAlignment:Events:offsetsPublish: offsetsPublish ~~~~~~~~~~~~~~ :EFDB_Topic: MTAlignment_logevent_offsetsPublish .. _MTAlignment:Events:offsetsPublish:target: target ****** :IDL_Type: string :Units: dimensionless **Description**: name of the object these offests belong to (M2, Camera, etc) .. _MTAlignment:Events:offsetsPublish:dX: dX ** :IDL_Type: float :Units: meter **Description**: Measured object offset in the x-axis relative to nominal. .. _MTAlignment:Events:offsetsPublish:dY: dY ** :IDL_Type: float :Units: meter **Description**: Measured object offset in the y-axis relative to nominal. .. _MTAlignment:Events:offsetsPublish:dZ: dZ ** :IDL_Type: float :Units: meter **Description**: Measured object offset in the z-axis relative to nominal. .. _MTAlignment:Events:offsetsPublish:dRX: dRX *** :IDL_Type: float :Units: degree **Description**: Measured object rotation with respect to the x-axis relative to nominal .. _MTAlignment:Events:offsetsPublish:dRY: dRY *** :IDL_Type: float :Units: degree **Description**: Measured object rotation with respect to the y-axis relative to nominal .. _MTAlignment:Events:offsetsPublish:dRZ: dRZ *** :IDL_Type: float :Units: degree **Description**: Measured object rotation with respect to the z-axis relative to nominal .. _MTAlignment:Events:positionPublish: positionPublish ~~~~~~~~~~~~~~~ :EFDB_Topic: MTAlignment_logevent_positionPublish .. _MTAlignment:Events:positionPublish:target: target ****** :IDL_Type: string :Units: dimensionless **Description**: name of the object these positions belong to (M2, Camera, etc) .. _MTAlignment:Events:positionPublish:dX: dX ** :IDL_Type: float :Units: meter **Description**: x positions of the measured object .. _MTAlignment:Events:positionPublish:dY: dY ** :IDL_Type: float :Units: meter **Description**: y positions of the measured object .. _MTAlignment:Events:positionPublish:dZ: dZ ** :IDL_Type: float :Units: meter **Description**: z positions of the measured object .. _MTAlignment:Events:positionPublish:dRX: dRX *** :IDL_Type: float :Units: degree **Description**: x rotation positions of the measured object .. _MTAlignment:Events:positionPublish:dRY: dRY *** :IDL_Type: float :Units: degree **Description**: y rotation positions of the measured object .. _MTAlignment:Events:positionPublish:dRZ: dRZ *** :IDL_Type: float :Units: degree **Description**: z rotation positions of the measured object .. _MTAlignment:Events:t2saError: t2saError ~~~~~~~~~ :EFDB_Topic: MTAlignment_logevent_t2saError .. _MTAlignment:Events:t2saError:t2saError: t2saError ********* :IDL_Type: int :Units: dimensionless **Description**: Error code received from T2SA appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _MTAlignment:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _MTAlignment:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _MTAlignment: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 .. _MTAlignment:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _MTAlignment:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _MTAlignment:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _MTAlignment:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _MTAlignment: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 .. _MTAlignment:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _MTAlignment:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _MTAlignment:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _MTAlignment:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _MTAlignment:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _MTAlignment:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _MTAlignment:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _MTAlignment: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 .. _MTAlignment:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _MTAlignment:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _MTAlignment: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 .. _MTAlignment:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _MTAlignment: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 .. _MTAlignment: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 .. _MTAlignment:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _MTAlignment:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _MTAlignment:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _MTAlignment:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _MTAlignment: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 .. _MTAlignment:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _MTAlignment:Telemetry:trackertemp: trackertemp ~~~~~~~~~~~ :EFDB_Topic: MTAlignment_trackertemp .. _MTAlignment:Telemetry:trackertemp:temperature: temperature *********** :IDL_Type: double :Units: deg_C **Description**: current temperature reported by the tracker sensor