:tocdepth: 3 ###### ATDome ###### .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _ATDome:Commands:closeShutter: closeShutter ~~~~~~~~~~~~ **Description**: Close both shutter doors. This is the preferred way to close the shutter, because it automatically sequences the doors to prevent the main door from interfering with the dropout door. :EFDB_Topic: ATDome_command_closeShutter .. _ATDome:Commands:homeAzimuth: homeAzimuth ~~~~~~~~~~~ **Description**: Home the azimuth axis. :EFDB_Topic: ATDome_command_homeAzimuth .. _ATDome:Commands:moveAzimuth: moveAzimuth ~~~~~~~~~~~ **Description**: Rotate the dome to the specified azimuth. :EFDB_Topic: ATDome_command_moveAzimuth .. _ATDome:Commands:moveAzimuth:azimuth: azimuth ******* :IDL_Type: float :Units: deg **Description**: Desired azimuth; must be in the range 0 to 360. The dome will take the shortest route to the specified position. .. _ATDome:Commands:moveShutterDropoutDoor: moveShutterDropoutDoor ~~~~~~~~~~~~~~~~~~~~~~ **Description**: Open or close the shutter dropout door. Intended for engineering; use the openShutter and closeShutter commands for normal operation since they automatically sequence the doors to prevent the main door from interfering with the dropout door. :EFDB_Topic: ATDome_command_moveShutterDropoutDoor .. _ATDome:Commands:moveShutterDropoutDoor:open: open **** :IDL_Type: boolean :Units: unitless **Description**: Open the door if true, close it if false. .. _ATDome:Commands:moveShutterMainDoor: moveShutterMainDoor ~~~~~~~~~~~~~~~~~~~ **Description**: Open or close the main shutter door. Intended for engineering; use the openShutter and closeShutter commands for normal operation since they automatically sequence the doors to prevent the main door from interfering with the dropout. :EFDB_Topic: ATDome_command_moveShutterMainDoor .. _ATDome:Commands:moveShutterMainDoor:open: open **** :IDL_Type: boolean :Units: unitless **Description**: Open the door if true, close it if false. .. _ATDome:Commands:openShutter: openShutter ~~~~~~~~~~~ **Description**: Open both shutter doors. This is the preferred way to open the shutter because it automatically sequences the doors to prevent the main door from interfering with the dropout door. :EFDB_Topic: ATDome_command_openShutter .. _ATDome:Commands:stopMotion: stopMotion ~~~~~~~~~~ **Description**: Stop all motion: azimuth, dropout door and main door. :EFDB_Topic: ATDome_command_stopMotion abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _ATDome:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _ATDome:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _ATDome: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 .. _ATDome: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 .. _ATDome:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _ATDome: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. .. _ATDome: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 .. _ATDome: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 .. _ATDome: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 .. _ATDome: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 .. _ATDome:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :AzimuthCommandedState: * Unknown * GoToPosition * Home * Stop :AzimuthState: * NotInMotion * MovingCW * MovingCCW :ShutterDoorCommandedState: * Unknown * Closed * Opened * Stop :ShutterDoorState: * Closed * Opened * PartiallyOpened * Opening * Closing Events ------ .. _ATDome:Events:allAxesInPosition: allAxesInPosition ~~~~~~~~~~~~~~~~~ **Description**: Are all axes (azimuth and both shutter doors) in position? :EFDB_Topic: ATDome_logevent_allAxesInPosition .. _ATDome:Events:allAxesInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: In position? .. _ATDome:Events:azimuthCommandedState: azimuthCommandedState ~~~~~~~~~~~~~~~~~~~~~ **Description**: Commanded state of azimuth drive. :EFDB_Topic: ATDome_logevent_azimuthCommandedState .. _ATDome:Events:azimuthCommandedState:commandedState: commandedState ************** :IDL_Type: long :Units: unitless **Description**: Commanded state. .. _ATDome:Events:azimuthCommandedState:azimuth: azimuth ******* :IDL_Type: float :Units: deg **Description**: Position commanded by the most recent moveAzimuth command; nan when the CSC starts up or when homing. .. _ATDome:Events:azimuthInPosition: azimuthInPosition ~~~~~~~~~~~~~~~~~ **Description**: Is the dome azimuth in the commanded position? Note: this will be false when the CSC starts up until a position is commanded. :EFDB_Topic: ATDome_logevent_azimuthInPosition .. _ATDome:Events:azimuthInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: In position? .. _ATDome:Events:azimuthState: azimuthState ~~~~~~~~~~~~ **Description**: Current state of azimuth drive. :EFDB_Topic: ATDome_logevent_azimuthState .. _ATDome:Events:azimuthState:state: state ***** :IDL_Type: long :Units: unitless **Description**: Current state. .. _ATDome:Events:azimuthState:homing: homing ****** :IDL_Type: boolean :Units: unitless **Description**: Is azimuth being homed? .. _ATDome:Events:doorEncoderExtremes: doorEncoderExtremes ~~~~~~~~~~~~~~~~~~~ **Description**: Encoder values of the doors when fully closed or fully opened. Reported in full status as `Main Door Encoder Closed`, etc. :EFDB_Topic: ATDome_logevent_doorEncoderExtremes .. _ATDome:Events:doorEncoderExtremes:mainClosed: mainClosed ********** :IDL_Type: long long :Units: unitless **Description**: Encoder position for main door when fully closed. .. _ATDome:Events:doorEncoderExtremes:mainOpened: mainOpened ********** :IDL_Type: long long :Units: unitless **Description**: Encoder position for main door when fully opened. .. _ATDome:Events:doorEncoderExtremes:dropoutClosed: dropoutClosed ************* :IDL_Type: long long :Units: unitless **Description**: Encoder position for dropout door when fully closed. .. _ATDome:Events:doorEncoderExtremes:dropoutOpened: dropoutOpened ************* :IDL_Type: long long :Units: unitless **Description**: Encoder position for dropout door when fully opened. .. _ATDome:Events:dropoutDoorCommandedState: dropoutDoorCommandedState ~~~~~~~~~~~~~~~~~~~~~~~~~ **Description**: Commanded state of the dropout shutter door. :EFDB_Topic: ATDome_logevent_dropoutDoorCommandedState .. _ATDome:Events:dropoutDoorCommandedState:commandedState: commandedState ************** :IDL_Type: long :Units: unitless **Description**: Commanded state. .. _ATDome:Events:dropoutDoorState: dropoutDoorState ~~~~~~~~~~~~~~~~ **Description**: Current state of the dropout shutter door. :EFDB_Topic: ATDome_logevent_dropoutDoorState .. _ATDome:Events:dropoutDoorState:state: state ***** :IDL_Type: long :Units: unitless **Description**: Current state. .. _ATDome:Events:emergencyStop: emergencyStop ~~~~~~~~~~~~~ **Description**: Has the emergency stop button been activated? :EFDB_Topic: ATDome_logevent_emergencyStop .. _ATDome:Events:emergencyStop:active: active ****** :IDL_Type: boolean :Units: unitless **Description**: Is the estop active (e.g. estop button pressed)? .. _ATDome:Events:lastAzimuthGoTo: lastAzimuthGoTo ~~~~~~~~~~~~~~~ **Description**: The most recently commanded azimuth position. :EFDB_Topic: ATDome_logevent_lastAzimuthGoTo .. _ATDome:Events:lastAzimuthGoTo:position: position ******** :IDL_Type: float :Units: deg **Description**: Reported position. .. _ATDome:Events:mainDoorCommandedState: mainDoorCommandedState ~~~~~~~~~~~~~~~~~~~~~~ **Description**: Commanded state of the main shutter door. :EFDB_Topic: ATDome_logevent_mainDoorCommandedState .. _ATDome:Events:mainDoorCommandedState:commandedState: commandedState ************** :IDL_Type: long :Units: unitless **Description**: Commanded state. .. _ATDome:Events:mainDoorState: mainDoorState ~~~~~~~~~~~~~ **Description**: Current state of the main shutter door. :EFDB_Topic: ATDome_logevent_mainDoorState .. _ATDome:Events:mainDoorState:state: state ***** :IDL_Type: long :Units: unitless **Description**: Current state. .. _ATDome:Events:scbLink: scbLink ~~~~~~~ **Description**: Can the main controller box (MCB) communicate with the shutter control box (SCB)? :EFDB_Topic: ATDome_logevent_scbLink .. _ATDome:Events:scbLink:active: active ****** :IDL_Type: boolean :Units: unitless **Description**: Communicating? .. _ATDome:Events:settingsAppliedDomeController: settingsAppliedDomeController ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Description**: Settings internal to the ATDome TCP/IP controller. :EFDB_Topic: ATDome_logevent_settingsAppliedDomeController .. _ATDome:Events:settingsAppliedDomeController:rainSensorEnabled: rainSensorEnabled ***************** :IDL_Type: boolean :Units: unitless **Description**: Is the rain/snow sensor enabled? .. _ATDome:Events:settingsAppliedDomeController:cloudSensorEnabled: cloudSensorEnabled ****************** :IDL_Type: boolean :Units: unitless **Description**: Is the cloud sensor enabled? .. _ATDome:Events:settingsAppliedDomeController:tolerance: tolerance ********* :IDL_Type: float :Units: deg **Description**: A request to move less than this amount in azimuth is ignored. .. _ATDome:Events:settingsAppliedDomeController:homeAzimuth: homeAzimuth *********** :IDL_Type: float :Units: deg **Description**: Azimuth position of the home switch. .. _ATDome:Events:settingsAppliedDomeController:highSpeedDistance: highSpeedDistance ***************** :IDL_Type: float :Units: deg **Description**: The minimum distance in azimuth that the dome must move to invoke high speed motion. .. _ATDome:Events:settingsAppliedDomeController:watchdogTimer: watchdogTimer ************* :IDL_Type: float :Units: second **Description**: The time interval between loss of communication between the shutter control box (SCB) and main control box (MCB) and the SCB closing the shutter. .. _ATDome:Events:settingsAppliedDomeController:dropoutTimer: dropoutTimer ************ :IDL_Type: float :Units: second **Description**: What is this? How does it differ from doorMoveTimeout? .. _ATDome:Events:settingsAppliedDomeController:reversalDelay: reversalDelay ************* :IDL_Type: float :Units: second **Description**: The delay between reversing motor directions for the shutter doors, where 0 < t <= 6. For a 240 VAC system this parameter can be set to 0. .. _ATDome:Events:settingsAppliedDomeController:autoShutdownEnabled: autoShutdownEnabled ******************* :IDL_Type: boolean :Units: unitless **Description**: Is automatic closing of the shutter enabled? If enabled then the shutter will be closed if rain, snow or clouds are detected, or if the shutter control box (SCB) loses radio contact with the main control box (MCB). .. _ATDome:Events:settingsAppliedDomeController:coast: coast ***** :IDL_Type: float :Units: deg **Description**: Azimuth coasting distance. .. _ATDome:Events:settingsAppliedDomeController:encoderCountsPer360: encoderCountsPer360 ******************* :IDL_Type: long long :Units: unitless **Description**: Number of azimuth encoder counts per full rotation. .. _ATDome:Events:settingsAppliedDomeController:azimuthMoveTimeout: azimuthMoveTimeout ****************** :IDL_Type: float :Units: second **Description**: Timeout for azimuth moves. .. _ATDome:Events:settingsAppliedDomeController:doorMoveTimeout: doorMoveTimeout *************** :IDL_Type: float :Units: second **Description**: Timeout for opening or closing (what? either shutter door?). .. _ATDome:Events:settingsAppliedDomeTcp: settingsAppliedDomeTcp ~~~~~~~~~~~~~~~~~~~~~~ **Description**: Settings related to communication between the ATDome CSC and the ATDome TCP/IP controller. :EFDB_Topic: ATDome_logevent_settingsAppliedDomeTcp .. _ATDome:Events:settingsAppliedDomeTcp:host: host **** :IDL_Type: string :Units: unitless **Description**: Host name of the ATDome TCP/IP controller. .. _ATDome:Events:settingsAppliedDomeTcp:port: port **** :IDL_Type: long :Units: unitless **Description**: Port number of the ATDome TCP/IP controller. .. _ATDome:Events:settingsAppliedDomeTcp:readTimeout: readTimeout *********** :IDL_Type: float :Units: second **Description**: Read timeout before going into a fault state. .. _ATDome:Events:settingsAppliedDomeTcp:connectionTimeout: connectionTimeout ***************** :IDL_Type: float :Units: second **Description**: Connection timeout before going into a fault state. .. _ATDome:Events:shutterInPosition: shutterInPosition ~~~~~~~~~~~~~~~~~ **Description**: Are the shutter doors in their commanded positions? Note: this will be false when the CSC starts up until a position is commanded for both doors. :EFDB_Topic: ATDome_logevent_shutterInPosition .. _ATDome:Events:shutterInPosition:inPosition: inPosition ********** :IDL_Type: boolean :Units: unitless **Description**: In position? appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _ATDome:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _ATDome:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _ATDome: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 .. _ATDome:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _ATDome:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _ATDome:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _ATDome:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _ATDome: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 .. _ATDome:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _ATDome:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _ATDome:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _ATDome:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _ATDome:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _ATDome:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _ATDome:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _ATDome: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 .. _ATDome:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _ATDome:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _ATDome: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 .. _ATDome:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _ATDome: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 .. _ATDome: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 .. _ATDome:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _ATDome:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _ATDome:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _ATDome:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _ATDome: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 .. _ATDome:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier Telemetry --------- .. _ATDome:Telemetry:position: position ~~~~~~~~ **Description**: Current position of azimuth and both shutter doors. :EFDB_Topic: ATDome_position .. _ATDome:Telemetry:position:dropoutDoorOpeningPercentage: dropoutDoorOpeningPercentage **************************** :IDL_Type: float :Units: unitless **Description**: Current dropout shutter door opening percentage. .. _ATDome:Telemetry:position:mainDoorOpeningPercentage: mainDoorOpeningPercentage ************************* :IDL_Type: float :Units: unitless **Description**: Current main shutter door opening percentage. .. _ATDome:Telemetry:position:azimuthPosition: azimuthPosition *************** :IDL_Type: double :Units: deg **Description**: Current azimuth position. .. _ATDome:Telemetry:position:azimuthEncoderPosition: azimuthEncoderPosition ********************** :IDL_Type: long long :Units: unitless **Description**: Current azimuth encoder reading.