:tocdepth: 3 ######### ATHexapod ######### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _ATHexapod:Commands:applyPositionLimits: applyPositionLimits ~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_command_applyPositionLimits .. _ATHexapod:Commands:applyPositionLimits:xyMax: xyMax ***** :IDL_Type: double :Units: mm **Description**: X and Y maximum position. .. _ATHexapod:Commands:applyPositionLimits:zMin: zMin **** :IDL_Type: double :Units: mm **Description**: Z minimum position. .. _ATHexapod:Commands:applyPositionLimits:zMax: zMax **** :IDL_Type: double :Units: mm **Description**: Z Maximum position. .. _ATHexapod:Commands:applyPositionLimits:uvMax: uvMax ***** :IDL_Type: double :Units: deg **Description**: U and V Maximum position. .. _ATHexapod:Commands:applyPositionLimits:wMin: wMin **** :IDL_Type: double :Units: deg **Description**: W minimum position. .. _ATHexapod:Commands:applyPositionLimits:wMax: wMax **** :IDL_Type: double :Units: deg **Description**: W maximum position. .. _ATHexapod:Commands:applyPositionOffset: applyPositionOffset ~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_command_applyPositionOffset .. _ATHexapod:Commands:applyPositionOffset:x: x * :IDL_Type: double :Units: mm **Description**: X position offset. .. _ATHexapod:Commands:applyPositionOffset:y: y * :IDL_Type: double :Units: mm **Description**: Y position offset. .. _ATHexapod:Commands:applyPositionOffset:z: z * :IDL_Type: double :Units: mm **Description**: Z position offset. .. _ATHexapod:Commands:applyPositionOffset:u: u * :IDL_Type: double :Units: deg **Description**: U position offset. .. _ATHexapod:Commands:applyPositionOffset:v: v * :IDL_Type: double :Units: deg **Description**: V position offset. .. _ATHexapod:Commands:applyPositionOffset:w: w * :IDL_Type: double :Units: deg **Description**: W position offset. .. _ATHexapod:Commands:moveToPosition: moveToPosition ~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_command_moveToPosition .. _ATHexapod:Commands:moveToPosition:x: x * :IDL_Type: double :Units: mm **Description**: X position. .. _ATHexapod:Commands:moveToPosition:y: y * :IDL_Type: double :Units: mm **Description**: Y position. .. _ATHexapod:Commands:moveToPosition:z: z * :IDL_Type: double :Units: mm **Description**: Z position. .. _ATHexapod:Commands:moveToPosition:u: u * :IDL_Type: double :Units: deg **Description**: U position. .. _ATHexapod:Commands:moveToPosition:v: v * :IDL_Type: double :Units: deg **Description**: V position. .. _ATHexapod:Commands:moveToPosition:w: w * :IDL_Type: double :Units: deg **Description**: W position. .. _ATHexapod:Commands:pivot: pivot ~~~~~ :EFDB_Topic: ATHexapod_command_pivot .. _ATHexapod:Commands:pivot:x: x * :IDL_Type: double :Units: mm **Description**: X position to pivot. .. _ATHexapod:Commands:pivot:y: y * :IDL_Type: double :Units: mm **Description**: Y position to pivot. .. _ATHexapod:Commands:pivot:z: z * :IDL_Type: double :Units: mm **Description**: Z position to pivot. .. _ATHexapod:Commands:setMaxSystemSpeeds: setMaxSystemSpeeds ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_command_setMaxSystemSpeeds .. _ATHexapod:Commands:setMaxSystemSpeeds:speed: speed ***** :IDL_Type: double :Units: mm/s **Description**: Velocities in the range of under 1 mm/s are recommended. .. _ATHexapod:Commands:stopAllAxes: stopAllAxes ~~~~~~~~~~~ :EFDB_Topic: ATHexapod_command_stopAllAxes .. _ATHexapod:Commands:stopAllAxes:stopAllAxes: stopAllAxes *********** :IDL_Type: boolean :Units: unitless **Description**: Stop all axes. abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _ATHexapod:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _ATHexapod:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _ATHexapod: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 .. _ATHexapod: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 .. _ATHexapod:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _ATHexapod: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. .. _ATHexapod: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 .. _ATHexapod: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 .. _ATHexapod: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 .. _ATHexapod: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 .. _ATHexapod:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :SummaryState: * DisabledState * EnabledState * FaultState * OfflineState * StandbyState :DetailedState: * InMotionState * NotInMotionState Events ------ .. _ATHexapod:Events:detailedState: detailedState ~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_detailedState .. _ATHexapod:Events:detailedState:detailedState: detailedState ************* :IDL_Type: long :Units: unitless **Description**: Detailed state. .. _ATHexapod:Events:inPosition: inPosition ~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_inPosition .. _ATHexapod:Events:inPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: AT Hexapod in position. .. _ATHexapod:Events:inPosition:timestamp: timestamp ********* :IDL_Type: double :Units: unitless **Description**: Timestamp of telescope in position. .. _ATHexapod:Events:positionUpdate: positionUpdate ~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_positionUpdate .. _ATHexapod:Events:positionUpdate:positionX: positionX ********* :IDL_Type: double :Units: mm **Description**: New X position. .. _ATHexapod:Events:positionUpdate:positionY: positionY ********* :IDL_Type: double :Units: mm **Description**: New Y position. .. _ATHexapod:Events:positionUpdate:positionZ: positionZ ********* :IDL_Type: double :Units: mm **Description**: New Z position. .. _ATHexapod:Events:positionUpdate:positionU: positionU ********* :IDL_Type: double :Units: deg **Description**: New U position. .. _ATHexapod:Events:positionUpdate:positionV: positionV ********* :IDL_Type: double :Units: deg **Description**: New V position. .. _ATHexapod:Events:positionUpdate:positionW: positionW ********* :IDL_Type: double :Units: deg **Description**: New W position. .. _ATHexapod:Events:readyForCommand: readyForCommand ~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_readyForCommand .. _ATHexapod:Events:readyForCommand:ready: ready ***** :IDL_Type: boolean :Units: unitless **Description**: Hexapod ready to be commanded .. _ATHexapod:Events:settingsAppliedPivot: settingsAppliedPivot ~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_settingsAppliedPivot .. _ATHexapod:Events:settingsAppliedPivot:pivotX: pivotX ****** :IDL_Type: double :Units: mm **Description**: Pivot X position. .. _ATHexapod:Events:settingsAppliedPivot:pivotY: pivotY ****** :IDL_Type: double :Units: mm **Description**: Pivot Y position. .. _ATHexapod:Events:settingsAppliedPivot:pivotZ: pivotZ ****** :IDL_Type: double :Units: mm **Description**: Pivot Z position. .. _ATHexapod:Events:settingsAppliedPositionLimits: settingsAppliedPositionLimits ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_settingsAppliedPositionLimits .. _ATHexapod:Events:settingsAppliedPositionLimits:limitXYMax: limitXYMax ********** :IDL_Type: double :Units: mm **Description**: X and Y maximum limit. .. _ATHexapod:Events:settingsAppliedPositionLimits:limitZMin: limitZMin ********* :IDL_Type: double :Units: mm **Description**: Z minimum limit. .. _ATHexapod:Events:settingsAppliedPositionLimits:limitZMax: limitZMax ********* :IDL_Type: double :Units: mm **Description**: Z maximum limit. .. _ATHexapod:Events:settingsAppliedPositionLimits:limitUVMax: limitUVMax ********** :IDL_Type: double :Units: deg **Description**: U and V maximum limit. .. _ATHexapod:Events:settingsAppliedPositionLimits:limitWMin: limitWMin ********* :IDL_Type: double :Units: deg **Description**: W minimum limit. .. _ATHexapod:Events:settingsAppliedPositionLimits:limitWMax: limitWMax ********* :IDL_Type: double :Units: deg **Description**: W maximum limit. .. _ATHexapod:Events:settingsAppliedTcp: settingsAppliedTcp ~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_settingsAppliedTcp .. _ATHexapod:Events:settingsAppliedTcp:ip: ip ** :IDL_Type: string :IDL_Size: 15 :Units: unitless **Description**: IP address of the hexapod controller (XXX.XXX.XXX.XXX). .. _ATHexapod:Events:settingsAppliedTcp:port: port **** :IDL_Type: long :Units: unitless **Description**: port range, it will try to connect to any of the ports in this range .. _ATHexapod:Events:settingsAppliedTcp:readTimeout: readTimeout *********** :IDL_Type: float :Units: second **Description**: TCP/IP read timeout .. _ATHexapod:Events:settingsAppliedTcp:writeTimeout: writeTimeout ************ :IDL_Type: float :Units: second **Description**: TCP/IP write timeout .. _ATHexapod:Events:settingsAppliedTcp:connectionTimeout: connectionTimeout ***************** :IDL_Type: float :Units: second **Description**: TCP/IP open/close connection timeout .. _ATHexapod:Events:settingsAppliedVelocities: settingsAppliedVelocities ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_logevent_settingsAppliedVelocities .. _ATHexapod:Events:settingsAppliedVelocities:systemSpeed: systemSpeed *********** :IDL_Type: double :Units: mm/s **Description**: System speed. appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _ATHexapod:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _ATHexapod:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _ATHexapod: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 .. _ATHexapod:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _ATHexapod:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _ATHexapod:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _ATHexapod:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _ATHexapod: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 .. _ATHexapod:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _ATHexapod:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _ATHexapod:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _ATHexapod:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _ATHexapod:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _ATHexapod:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _ATHexapod:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _ATHexapod: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 .. _ATHexapod:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _ATHexapod:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _ATHexapod: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 .. _ATHexapod:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _ATHexapod: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 .. _ATHexapod: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 .. _ATHexapod:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _ATHexapod:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _ATHexapod:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _ATHexapod:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _ATHexapod: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 .. _ATHexapod:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _ATHexapod:Telemetry:positionStatus: positionStatus ~~~~~~~~~~~~~~ :EFDB_Topic: ATHexapod_positionStatus .. _ATHexapod:Telemetry:positionStatus:setpointPosition: setpointPosition **************** :IDL_Type: double :Units: mm :Count: 6 **Description**: http://sal.lsst.org/SAL/Telemetry/hexapod_Application_Demand.html .. _ATHexapod:Telemetry:positionStatus:reportedPosition: reportedPosition **************** :IDL_Type: double :Units: mm :Count: 6 **Description**: http://sal.lsst.org/SAL/Telemetry/hexapod_Application_Position.html .. _ATHexapod:Telemetry:positionStatus:positionFollowingError: positionFollowingError ********************** :IDL_Type: double :Units: mm :Count: 6 **Description**: http://sal.lsst.org/SAL/Telemetry/hexapod_Application_Error.html