Commands
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 |
homeAzimuth
Description: Home the azimuth axis.
| EFDB_Topic: | ATDome_command_homeAzimuth |
moveAzimuth
Description: Rotate the dome to the specified azimuth.
| EFDB_Topic: | ATDome_command_moveAzimuth |
azimuth
Description: Desired azimuth; must be in the range 0 to 360. The dome will take the shortest route to the specified position.
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 |
open
| IDL_Type: | boolean |
| Units: | unitless |
Description: Open the door if true, close it if false.
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 |
open
| IDL_Type: | boolean |
| Units: | unitless |
Description: Open the door if true, close it if false.
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 |
stopMotion
Description: Stop all motion: azimuth, dropout door and main door.
| EFDB_Topic: | ATDome_command_stopMotion |
abort
| EFDB_Topic: | SALGeneric_command_abort |
value
| IDL_Type: | boolean |
| Units: | unitless |
Description: Not used
disable
Description: Transition from state Enabled to Disabled.
| EFDB_Topic: | SALGeneric_command_disable |
value
| IDL_Type: | boolean |
| Units: | unitless |
Description: Not used
enable
Description: Transition from state Disabled to Enabled.
| EFDB_Topic: | SALGeneric_command_enable |
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 |
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 |
value
| IDL_Type: | boolean |
| Units: | unitless |
Description: Not used
setAuthList
| EFDB_Topic: | SALGeneric_command_setAuthList |
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.
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 |
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 |
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 |
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 |
settingsToApply
| IDL_Type: | string |
| IDL_Size: | 256 |
| Units: | unitless |
Description: Name of the selected settings set
Events
allAxesInPosition
Description: Are all axes (azimuth and both shutter doors) in position?
| EFDB_Topic: | ATDome_logevent_allAxesInPosition |
inPosition
| IDL_Type: | boolean |
| Units: | unitless |
Description: In position?
azimuthCommandedState
Description: Commanded state of azimuth drive.
| EFDB_Topic: | ATDome_logevent_azimuthCommandedState |
commandedState
| IDL_Type: | long |
| Units: | unitless |
Description: Commanded state.
azimuth
Description: Position commanded by the most recent moveAzimuth command; nan when the CSC starts up or when homing.
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 |
inPosition
| IDL_Type: | boolean |
| Units: | unitless |
Description: In position?
azimuthState
Description: Current state of azimuth drive.
| EFDB_Topic: | ATDome_logevent_azimuthState |
state
| IDL_Type: | long |
| Units: | unitless |
Description: Current state.
homing
| IDL_Type: | boolean |
| Units: | unitless |
Description: Is azimuth being homed?
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 |
mainClosed
| IDL_Type: | long long |
| Units: | unitless |
Description: Encoder position for main door when fully closed.
mainOpened
| IDL_Type: | long long |
| Units: | unitless |
Description: Encoder position for main door when fully opened.
dropoutClosed
| IDL_Type: | long long |
| Units: | unitless |
Description: Encoder position for dropout door when fully closed.
dropoutOpened
| IDL_Type: | long long |
| Units: | unitless |
Description: Encoder position for dropout door when fully opened.
dropoutDoorCommandedState
Description: Commanded state of the dropout shutter door.
| EFDB_Topic: | ATDome_logevent_dropoutDoorCommandedState |
commandedState
| IDL_Type: | long |
| Units: | unitless |
Description: Commanded state.
dropoutDoorState
Description: Current state of the dropout shutter door.
| EFDB_Topic: | ATDome_logevent_dropoutDoorState |
state
| IDL_Type: | long |
| Units: | unitless |
Description: Current state.
emergencyStop
Description: Has the emergency stop button been activated?
| EFDB_Topic: | ATDome_logevent_emergencyStop |
active
| IDL_Type: | boolean |
| Units: | unitless |
Description: Is the estop active (e.g. estop button pressed)?
lastAzimuthGoTo
Description: The most recently commanded azimuth position.
| EFDB_Topic: | ATDome_logevent_lastAzimuthGoTo |
position
Description: Reported position.
mainDoorCommandedState
Description: Commanded state of the main shutter door.
| EFDB_Topic: | ATDome_logevent_mainDoorCommandedState |
commandedState
| IDL_Type: | long |
| Units: | unitless |
Description: Commanded state.
mainDoorState
Description: Current state of the main shutter door.
| EFDB_Topic: | ATDome_logevent_mainDoorState |
state
| IDL_Type: | long |
| Units: | unitless |
Description: Current state.
scbLink
Description: Can the main controller box (MCB) communicate with the shutter control box (SCB)?
| EFDB_Topic: | ATDome_logevent_scbLink |
active
| IDL_Type: | boolean |
| Units: | unitless |
Description: Communicating?
settingsAppliedDomeController
Description: Settings internal to the ATDome TCP/IP controller.
| EFDB_Topic: | ATDome_logevent_settingsAppliedDomeController |
rainSensorEnabled
| IDL_Type: | boolean |
| Units: | unitless |
Description: Is the rain/snow sensor enabled?
cloudSensorEnabled
| IDL_Type: | boolean |
| Units: | unitless |
Description: Is the cloud sensor enabled?
tolerance
Description: A request to move less than this amount in azimuth is ignored.
homeAzimuth
Description: Azimuth position of the home switch.
highSpeedDistance
Description: The minimum distance in azimuth that the dome must move to invoke high speed motion.
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.
dropoutTimer
| IDL_Type: | float |
| Units: | second |
Description: What is this? How does it differ from doorMoveTimeout?
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.
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).
coast
Description: Azimuth coasting distance.
encoderCountsPer360
| IDL_Type: | long long |
| Units: | unitless |
Description: Number of azimuth encoder counts per full rotation.
azimuthMoveTimeout
| IDL_Type: | float |
| Units: | second |
Description: Timeout for azimuth moves.
doorMoveTimeout
| IDL_Type: | float |
| Units: | second |
Description: Timeout for opening or closing (what? either shutter door?).
settingsAppliedDomeTcp
Description: Settings related to communication between the ATDome CSC and the ATDome TCP/IP controller.
| EFDB_Topic: | ATDome_logevent_settingsAppliedDomeTcp |
host
| IDL_Type: | string |
| Units: | unitless |
Description: Host name of the ATDome TCP/IP controller.
port
| IDL_Type: | long |
| Units: | unitless |
Description: Port number of the ATDome TCP/IP controller.
readTimeout
| IDL_Type: | float |
| Units: | second |
Description: Read timeout before going into a fault state.
connectionTimeout
| IDL_Type: | float |
| Units: | second |
Description: Connection timeout before going into a fault state.
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 |
inPosition
| IDL_Type: | boolean |
| Units: | unitless |
Description: In position?
appliedSettingsMatchStart
| EFDB_Topic: | SALGeneric_logevent_appliedSettingsMatchStart |
appliedSettingsMatchStartIsTrue
| IDL_Type: | boolean |
| Units: | unitless |
Description: True when the configuration matches the start conditions
authList
| EFDB_Topic: | SALGeneric_logevent_authList |
authorizedUsers
| IDL_Type: | string |
| Units: | unitless |
Description: Comma seperated list of authorized users currently allowed to command this CSC.
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 |
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 |
heartbeat
| IDL_Type: | boolean |
| Units: | unitless |
Description: Beats the drum.
logLevel
Description: Current logging level.
| EFDB_Topic: | SALGeneric_logevent_logLevel |
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 |
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.
settingVersions
Description: Information about settings which can be specified in the start command.
| EFDB_Topic: | SALGeneric_logevent_settingVersions |
recommendedSettingsVersion
| IDL_Type: | string |
| Units: | unitless |
Description: List of comma seperated recomended versions of settings sets
recommendedSettingsLabels
| IDL_Type: | string |
| Units: | unitless |
Description: List of comma seperated names of settings sets
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 |
settingsVersion
| IDL_Type: | string |
| IDL_Size: | 256 |
| Units: | unitless |
Description: The SHA or name corresponding to the published configuration
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 |
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 |
salVersion
| IDL_Type: | string |
| IDL_Size: | 16 |
| Units: | unitless |
Description: This is the current version of SAL generation
xmlVersion
| IDL_Type: | string |
| IDL_Size: | 16 |
| Units: | unitless |
Description: This is the current version of CSC XML
openSpliceVersion
| IDL_Type: | string |
| IDL_Size: | 16 |
| Units: | unitless |
Description: This is the current version of OpenSplice
cscVersion
| IDL_Type: | string |
| IDL_Size: | 16 |
| 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 |
summaryState
| IDL_Type: | long |
| Units: | unitless |
Description: High level state machine state identifier