ATDome

Note

This page is generated by python script generate_cet.py.

Back to table

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

IDL_Type:

float

Units:

deg

Description: Desired azimuth. The dome will take the shortest route to the specified position (it has no azimuth rotation limits).

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

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. Most CSCs will quit, but CSCs that support the enterControl command will keep running.

EFDB_Topic:

SALGeneric_command_exitControl

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 this 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 this CSC itself.

standby

Description: Transition from state Offline/Available, 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

AzimuthCommandedState:

  • Unknown

  • GoToPosition

  • Home

  • Stop

AzimuthState:

  • NotInMotion

  • MovingCW

  • MovingCCW

ShutterDoorCommandedState:

  • Unknown

  • Closed

  • Opened

  • Stop

ShutterDoorState:

  • Closed

  • Opened

  • PartiallyOpened

  • Opening

  • Closing

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. An AzimuthCommandedState enumeration.

azimuth

IDL_Type:

float

Units:

deg

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. An AzimuthState enumeration.

homing

IDL_Type:

boolean

Units:

unitless

Description: Is azimuth being homed?

homed

IDL_Type:

boolean

Units:

unitless

Description: Has azimuth been homed since the CSC was started?

homeSwitch

IDL_Type:

boolean

Units:

unitless

Description: Is the azimuth home switch depressed? Note that it may not be depressed when homing is done.

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. A ShutterDoorCommandedState enumeration.

dropoutDoorState

Description: Current state of the dropout shutter door.

EFDB_Topic:

ATDome_logevent_dropoutDoorState

state

IDL_Type:

long

Units:

unitless

Description: Current state. A ShutterDoorState enumeration.

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

IDL_Type:

float

Units:

deg

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. A ShutterDoorCommandedState enumeration.

mainDoorState

Description: Current state of the main shutter door.

EFDB_Topic:

ATDome_logevent_mainDoorState

state

IDL_Type:

long

Units:

unitless

Description: Current state. A ShutterDoorState enumeration.

moveCode

Description: Move code bitmask reported by the low-level controller. This is an internal detail that is published primarily for diagnosing problems; please do not rely on it. The component values are: 1 moving azimuth +, 2 moving azimuth -, 4 closing main door, 8 opening main door, 16 closing dropout door, 32 opening dropout, 64 homing, 128 emergency stop.

EFDB_Topic:

ATDome_logevent_moveCode

code

IDL_Type:

long

Units:

unitless

Description: The move code.

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

IDL_Type:

float

Units:

deg

Description: A request to move less than this amount in azimuth is ignored.

homeAzimuth

IDL_Type:

float

Units:

deg

Description: Azimuth position of the home switch.

highSpeedDistance

IDL_Type:

float

Units:

deg

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

IDL_Type:

float

Units:

deg

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?

configurationApplied

Description: Information about this CSC’s current configuration overrides.

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 this 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 this CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable

Description: Available configuration overrides for this 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 this 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 this 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

Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.

EFDB_Topic:

SALGeneric_logevent_heartbeat

Category:

mandatory

heartbeat

IDL_Type:

boolean

Units:

unitless

Description: Deprecated field that you should ignore.

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 this 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 this 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: The software version of this 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 this CSC.

summaryState

Description: Current summary state of this CSC.

EFDB_Topic:

SALGeneric_logevent_summaryState

Category:

csc

summaryState

IDL_Type:

long

Units:

unitless

Description: High level state machine state identifier.

Telemetry

position

Description: Current position of azimuth and both shutter doors.

EFDB_Topic:

ATDome_position

dropoutDoorOpeningPercentage

IDL_Type:

float

Units:

unitless

Description: Current dropout shutter door opening percentage.

mainDoorOpeningPercentage

IDL_Type:

float

Units:

unitless

Description: Current main shutter door opening percentage.

azimuthPosition

IDL_Type:

double

Units:

deg

Description: Current azimuth position.

azimuthEncoderPosition

IDL_Type:

long long

Units:

unitless

Description: Current azimuth encoder reading.